Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zai

Zai Assembly API

Zai's core payments platform API. Onboard users, create and manage wallet accounts, items (transaction records), bank and card accounts, companies, fees, tokens, callbacks and batch transactions to collect pay-ins and disburse multi-party pay-outs across a marketplace or platform. OpenAPI 3.0.0, version 2.3, 89 documented paths, secured with OAuth2 client-credentials.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zai Assembly API is one of 4 APIs that Zai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments, Wallet Accounts, Marketplace, Pay-ins, and Payouts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 106 operations across 89 paths, organized into 21 resource areas, and defines 119 schemas. It is described by OpenAPI 3.0.0, at version 2.3.

Requests are made against 5 base URLs: https://test.api.promisepay.com, https://secure.api.promisepay.com, https://au-0000.sandbox.auth.assemblypay.com, https://au-0000.auth.assemblypay.com, https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3.

106 operations 89 paths 119 schemas 5 DELETE65 GET19 PATCH17 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.3
Base URL
https://secure.api.promisepay.com
Authentication
OAuth 2.0
Contact
http://docs.assemblypayments.com/
Resource Areas
21

Authentication & Security 1

Zai Assembly API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

  • oAuth2ClientCredentials — Please refer to Authentication section within https://developer.assemblypayments.com/referenceauthentication

Paths & Operations 106

Across 89 paths, the API surfaces 106 operations — 5 DELETE, 65 GET, 19 PATCH, 17 POST. They span 21 resource areas, including Authentication, Addresses, Bank Accounts, BPay Accounts, Wallet Accounts, Sub-wallets, Users, Callbacks, and 13 more. Each is listed below with its method, path, parameters, and response codes.

Authentication 1
POST
/tokens
Token
token body → 200400401422500
Addresses 1
GET
/addresses/{id}
Show Address
showAddress 1 param → 200
Bank Accounts 7
GET
/bank_accounts/{id}
Show Bank Account
showBankAccount 2 params → 200
DELETE
/bank_accounts/{id}
Redact Bank Account
redactBankAccount 1 param → 200
PATCH
/bank_accounts/{id}/penny_send
Send Penny Amount
sendPennyAmount 1 param → 200
POST
/bank_accounts
Create Bank Account
createBankAccount body → 201
PATCH
/bank_accounts/{id}/penny_verify
Verify Penny Amount
verifyPennyAmount 1 param body → 200
GET
/bank_accounts/{id}/users
Show Bank Account User
showBankAccountUser 1 param → 200
GET
/tools/routing_number
Validate Routing Number
validateRoutingNumber 1 param → 200
BPay Accounts 3
GET
/bpay_accounts/{id}
Show BPay Account
showBPayAccount 1 param → 200
POST
/bpay_accounts
Create BPay Account
createBPayAccount body → 201
GET
/bpay_accounts/{id}/users
Show BPay Account User
showBPayAccountUser 1 param → 200
Wallet Accounts 6
POST
/wallet_accounts/{id}/bill_payment
Pay a Bill
billPayment 1 param body → 201
GET
/wallet_accounts/{id}/users
Show Wallet Account User
showWalletAccountUser 1 param → 200
POST
/wallet_accounts/{id}/withdraw
Withdraw Funds
withdrawFunds 1 param body → 201
GET
/wallet_accounts/{id}
Show Wallet Account
showWalletAccount 1 param → 200
GET
/wallet_accounts/{id}/npp_details
Show Wallet Account NPP Details
showWalletAccountNPPDetails 1 param → 200
GET
/wallet_accounts/{id}/bpay_details
Show Wallet Account BPAY Details
showWalletAccountNBPAYDetails 1 param → 200
Sub-wallets 11
GET
/sub_wallets/{account_id}
List Sub-wallets
listSubWallets 3 params → 200422
POST
/sub_wallets
Create Sub-wallet
createSubWallet body → 201422
GET
/sub_wallets/{id}
Show Sub-wallet
showSubWallet 1 param → 200422
DELETE
/sub_wallets/{id}
Redact Sub-wallet
deleteSubWallet 1 param → 200422
PATCH
/sub_wallets/{id}
Update Sub-wallet
updateSubWallet 1 param body → 200422
PATCH
/sub_wallets/transfer
Fund transfers
transferSubWallet body → 201422
GET
/sub_wallets/{id}/transactions
List Sub-wallet transactions
showSubWalletTransactions 1 param → 200422
POST
/sub_wallets/{id}/bill_payment
Pay a Bill
billPaymentSubWallet 1 param body → 201422
POST
/sub_wallets/{id}/withdraw
Withdraw Funds
withdrawFundsSubWallet 1 param body → 201422
GET
/sub_wallets/{id}/users
Show Sub-wallet User
showSubWalletUser 1 param → 200422
GET
/sub_wallets/{id}/wallet_accounts
Show the Wallet Account of a Sub-wallet
showSubWalletWalletAccount 1 param → 200422
Users 11
GET
/users/{id}/bpay_accounts
List User's BPay Accounts
listUserBPayAccounts 1 param → 200
GET
/users/{id}/card_accounts
Show User Card Account
showUserCardAccount 1 param → 200
GET
/users/{id}
Show User
showUser 1 param → 200
PATCH
/users/{id}
Update User
updateUser 1 param body → 200
PATCH
/users/{id}/identity_verified
Verify User (Prelive Only)
verifyUser 1 param → 200
GET
/users/{id}/bank_accounts
Show User Bank Account
showUserBankAccount 1 param → 200
PATCH
/users/{id}/disbursement_account
Set User Disbursement Account
setUserDisbursementAccount 1 param body → 200
GET
/users
List Users
listUsers 3 params → 200
POST
/users
Create User
createUser body → 201
GET
/users/{id}/items
List User Items
listUserItems 3 params → 200
GET
/users/{id}/wallet_accounts
Show User Wallet Account
showUserWalletAccounts 1 param → 200
Callbacks 7
GET
/callbacks/{id}
Show Callback
showCallback 1 param → 200
DELETE
/callbacks/{id}
Delete Callback
deleteCallback 1 param → 200
PATCH
/callbacks/{id}
Update Callback
updateCallback 1 param body → 200
GET
/callbacks/{id}/responses
List Callback Responses
listCallbackResponse 3 params → 200
GET
/callbacks/{callback_id}/responses/{id}
Show Callback Response
showCallbackResponse 2 params → 200
GET
/callbacks
List Callbacks
listCallbacks 3 params → 200
POST
/callbacks
Create Callback
createCallback body → 201
Card Accounts 5
POST
/card_accounts
Create Card Account
createCardAccount body → 201
GET
/card_accounts/{id}/users
Show Card Account User
showCardAccountUser 1 param → 200
PATCH
/card_accounts/{id}/verify
Verify Card
verifyCard 1 param body → 200
GET
/card_accounts/{id}
Show Card Account
showCardAccount 1 param → 200
DELETE
/card_accounts/{id}
Redact Card Account
redactCardAccount 1 param → 200
Companies 4
GET
/companies
List Companies
listCompanies 2 params → 200
POST
/companies
Create Company
createCompany body → 201
GET
/companies/{id}
Show Company
showCompany 1 param → 200
PATCH
/companies/{id}
Update Company
updateCompany 1 param body → 200
Direct Debit Authorities 3
GET
/direct_debit_authorities
List Direct Debit Authorities
listDirectDebitAuthorities 3 params → 200
POST
/direct_debit_authorities
Create Direct Debit Authority
createDirectDebitAuthority body → 201
GET
/direct_debit_authorities/{id}
Show Direct Debit Authority
showDirectDebitAuthority 1 param → 200
Fees 3
GET
/fees
List Fees
listFees 2 params → 200
POST
/fees
Create fee
createFee body → 201
GET
/fees/{id}
Show Fee
showFee 2 params → 200
Charges 5
GET
/charges
List Charges
listCharges 2 params → 200
POST
/charges
Create Charge
createCharge body → 201
GET
/charges/{id}
Show Charge
showCharge 1 param → 200
GET
/charges/{id}/status
Show Charge Status
showChargeStatus 1 param → 200
GET
/charges/{id}/buyers
Show Charge Buyer
showChargeBuyer 1 param → 200
Marketplaces 1
GET
/marketplace
Show Marketplace
showMarketplace → 200
Token Auth 1
POST
/token_auths
Generate Token
generateToken body → 200
Tools 1
GET
/tools/status
Health check
healthCheck → 200
Transactions 7
GET
/transactions
List Transactions
listTransactions 10 params → 200
GET
/transactions/{id}/bank_accounts
Show Transaction Bank Account
showTransactionBankAccount 1 param → 200
GET
/transactions/{id}
Show Transaction
showTransaction 1 param → 200
GET
/transactions/{id}/card_accounts
Show Transaction Card Account
showTransactionCardAccount 1 param → 200
GET
/transactions/{id}/fees
Show Transaction Fees
showTransactionFees 1 param → 200
GET
/transactions/{id}/wallet_accounts
Show Transaction Wallet Account
showTransactionWalletAccount 1 param → 200
GET
/transactions/{id}/users
Show Transaction User
showTransactionUser 1 param → 200
Batch Transactions 2
GET
/batch_transactions
List Batch Transactions
listBatchTransactions 12 params → 200
GET
/batch_transactions/{id}
Show Batch Transaction
showBatchTransaction 1 param → 200
Disbursements 7
GET
/disbursements
List Disbursements
listDisbursement 3 params → 200
GET
/disbursements/{id}
Show Disbursement
showDisbursement 1 param → 200
GET
/disbursements/{id}/transactions
Show Disbursement Transactions
showDisbursementTransactions 3 params → 200
GET
/disbursements/{id}/wallet_accounts
Show Disbursement Wallet Accounts
showDisbursementWalletAccounts 1 param → 200
GET
/disbursements/{id}/bank_accounts
Show Disbursement Bank Accounts
showDisbursementBankAccounts 1 param → 200
GET
/disbursements/{id}/users
Show Disbursement Users
showDisbursementUsers 1 param → 200
GET
/disbursements/{id}/items
Show Disbursement Items
showDisbursementItems 1 param → 200
Items 12
GET
/items
List Items
listItems 5 params → 200
POST
/items
Create Item
createItem body → 201
GET
/items/{id}
Show Item
showItem 1 param → 200
DELETE
/items/{id}
Delete Item
deleteItem 1 param → 200
PATCH
/items/{id}
Update Item
updateItem 1 param body → 200
GET
/items/{id}/sellers
Show Item Seller
showItemSeller 1 param → 200
GET
/items/{id}/buyers
Show Item Buyer
showItemBuyer 1 param → 200
GET
/items/{id}/fees
Show Item Fees
showItemFees 1 param → 200
GET
/items/{id}/wire_details
Show Item Wire Details
showItemWireDetails 1 param → 200
GET
/items/{id}/transactions
List Item Transactions
listItemTransactions 1 param → 200
GET
/items/{id}/batch_transactions
List Item Batch Transactions
listItemBatchTransactions 1 param → 200
GET
/items/{id}/status
Show Item Status
showItemStatus 1 param → 200
Item Actions 8
PATCH
/items/{id}/make_payment
Make Payment
makePayment 1 param body → 200
PATCH
/items/{id}/make_payment_async
Make an async Payment
makePaymentAsync 1 param body → 200
PATCH
/items/{id}/cancel
Cancel
cancelItem 1 param → 200
PATCH
/items/{id}/refund
Refund
refund 1 param body → 200
PATCH
/items/{id}/authorize_payment
Authorize Payment
authorizePayment 1 param body → 200
PATCH
/items/{id}/capture_payment
Capture Payment
capturePayment 1 param body → 200
PATCH
/items/{id}/void_payment
Void Payment
voidPayment 1 param → 200
PATCH
/items/{id}/release_payment
Release Payment (Deprecated - Do Not Use)
releasePayment 1 param body → 200

Schemas 119

The contract defines 119 schemas that model the data the API accepts and returns. The most detailed are batch_transaction (51 properties), item (46 properties), charge (28 properties), user (23 properties). Each schema is shown below with its type and property counts.

marketplace
object
1 property
tools_status
object
1 property
address
object
1 property
acknowledge_payment
object
4 properties
bank_account_deletion
object
1 property
bank_account_au
object
1 property
card_account_deletion
object
1 property
card_account
object
1 property
sub_wallet
object
1 property
sub_wallets
object
1 property
sub_wallet_create_requestBody
object
2 properties 1 required
sub_wallet_update_requestBody1
object
2 properties
sub_wallet_update_requestBody2
object
1 property
sub_wallet_update_requestBody3
object
1 property
sub_wallet_error_responseBody
object
1 property
sub_wallet_create_responseBody
object
1 property
sub_wallet_transfer_requestBody
object
3 properties 3 required
sub_wallet_transactions_index
object
3 properties
meta
object
3 properties
sub_wallet_transfer_responseBody
object
1 property
sub_wallet_transactions
object
19 properties
sub_wallet_transactions_mp
object
4 properties
sub_wallet_related
object
1 property
sub_wallet_related_transactions
array
sub_wallet_tr
object
5 properties
sub_wallet_transaction_links
object
1 property
wallet_account
object
1 property
wallet_account_npp_details
object
2 properties
wallet_account_bpay_details
object
2 properties
wallet_account_payin_details
object
2 properties
list_bpay_accounts
object
3 properties
bpay_account_deletion
object
1 property
bpay_account
object
1 property
single_user
object
1 property
partial_payment
object
1 property
users
object
1 property
user
object
23 properties
single_routing_number
object
1 property
single_item
object
1 property
items
object
3 properties
item
object
46 properties 6 required
single_charge_status
object
1 property
charge_status
object
3 properties
single_charge
object
1 property
charges
object
1 property
charge
object
28 properties
single_batch_transaction
object
1 property
list_batch_transactions
object
3 properties
batch_transaction
object
51 properties 4 required
single_callback
object
1 property
callback_deletion
object
1 property
callbacks
object
1 property
callback
object
10 properties
single_callback_response
object
1 property
list_callback_responses
object
3 properties
callback_response
object
6 properties
simple_company
object
4 properties
simple_companies
object
1 property
single_company
object
1 property
company
object
9 properties
single_direct_debit_authority
object
1 property
list_direct_debit_authorities
object
1 property
direct_debit_authority
object
9 properties
single_fee
object
1 property
fees
object
3 properties
fee
object
12 properties
single_transaction
object
1 property
transactions
object
3 properties
transaction
object
22 properties
disbursements
object
2 properties
single_disbursement
object
1 property
withdraw_disbursement
object
disbursement
object
20 properties
wire_details
object
13 properties
wire_details_with_id
object
2 properties
single_wire_details_with_id
object
1 property
single_status
object
1 property
status
object
3 properties
error
object
1 property
tokens_request_body
object
4 properties 4 required
tokens_response
object
3 properties
sub_wallet_sub_wallets_links
object
4 properties
sub_wallet_sub_wallets
object
8 properties
sub_wallet_error_responseBody_errors
object
1 property
sub_wallet_create_responseBody_sub_wallets_links
object
3 properties
sub_wallet_create_responseBody_sub_wallets
object
8 properties
bank_account_requestBody_au
object
10 properties 8 required
penny_verify_requestBody
object
2 properties 2 required
bpay_account_requestBody
object
4 properties 4 required
bill_payment_requestBody
object
3 properties 2 required
callback_requestBody
object
3 properties 4 required
card_account_requestBody
object
6 properties 6 required
card_account_verify_requestBody
object
1 property
company_requestBody
object
13 properties 5 required
direct_debit_authority_requestBody
object
2 properties 2 required
fee_requestBody
object
7 properties 3 required
charge_requestBody
object
14 properties 5 required
token_auth_requestBody
object
2 properties 2 required
update_user_requestBody
object
20 properties 1 required
bank_account_id_requestBody
object
1 property 1 required
user_requestBody
object
22 properties 5 required
withdraw_requestBody
object
6 properties 2 required
sub_wallet_withdraw_requestBody
object
4 properties 2 required
item_requestBody
object
13 properties 6 required
update_item_requestBody
object
6 properties
account_id_requestBody
object
5 properties 1 required
account_id_asyncRequestBody
object
2 properties 1 required
refund_requestBody
object
3 properties
card_account_id_requestBody
object
3 properties 1 required
release_payment_requestBody
object
2 properties
sub_wallets_id_body
party_identification
object
8 properties
ifti_address
object
This represents address of an individual or non-individual customer of a NPP participant. This object could be populated in one of formats below:
10 properties
address_type
string
Address Type ADDR - Postal Address is the complete postal address BIZZ - Business Address is the business address DLVY - Delivery To Address is the address to…
date_and_place_of_birth
object
4 properties 3 required
contact_details
object
7 properties
generic_identification
object
4 properties 1 required
ifti_information_response
object
14 properties
party_identification_sample
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-assembly-api.json Raw ↑

Other APIs Zai publishes across the network.

Zai Virtual Accounts and PayIDs API
AE Profile APIs.io
Zai PayTo API
AE Profile APIs.io
Zai Asynchronous API
AE Profile APIs.io
#Payments#Wallet Accounts#Marketplace#Pay-ins#Payouts
← Back to Z APIs
API Details
ID
zai:zai-assembly-api
Base URL
https://secure.api.promisepay.com
Docs
https://developer.hellozai.com/reference/overview
Provider
Zai
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network