Webhooks
Use webhooks to enable Zai to push real-time notifications to your application.
Coming soon
Credit card and direct debit transactions within the UK are not yet available.
Webhooks are an improved version of the legacy implementation, callbacks, designed to provide your platform with enhanced features such as automated retries and self-service options.
An example of our webhooks is if an Item changes state because we have processed a Direct Debit/ACH payment, we will POST a JSON payload with the Item object attributes to the URL provided. These notifications are classified as webhooks jobs which will be sent out once actual changes are done within the platform.
Similar to callbacks, webhooks also allow you to initiate dependent processes or notifications based on updates from Zai. In the event that a webhook job fails to be sent, the new retry capability built as part of this service will be responsible for resending the said failed webhook job for up to 24 hours with an exponential backoff capability.
For more information on webhook security and the retry feature, see Best Practices for Webhooks.
Prerequisites
Before using these APIs please ensure you have implemented and migrated over to our OAuth authentication framework.
Types of webhooks
Only one webhook can be enabled for an object type. Each of these webhooks will return the response of the ‘Show’ of that object. For example, a webhook for Items will return the GET /items/:id response.
Webhooks are not set up for every customer
Also, note that you do not register for each item transaction. You should register a webhook for any change to the state of all item transactions that you wish to monitor.
| Webhooks (object_type) | Triggers | Examples |
|---|---|---|
Itemsitems | Any data changes for that Item. Typically used whenever the state of the object changes. | Checking that an Item has had a payment made Checking if a payment has been held Checking if a payment has been refunded |
Usersusers | Any data changes for that User. Typically used whenever the state of the object changes. | Checking when a user’s KYC state has been approved Checking if a user has been 'KYC held' |
Batch Transactionsbatch_transactions | On creation of any Batch Transactions and whenever the state changes. | Checking the status of a direct debit/ACH payment Checking the details of a disbursement for a User or Item |
Accountsaccounts | When the state or enabled status of an account changes. This includes creating one and covers all types of accounts (bank, card, wallets...etc). No data can be changed on an existing account. | Checking if a bank account has invalid details, received after a failed disbursement |
Transactionstransactions | On creation of any Transactions and whenever the state changes. | Checking that a transaction has been created for a wallet account payment |
Disbursementsdisbursements | On creation of any disbursement. | Checking that payout has been created for a seller or platform disbursement account |
Companiescompanies | On creation or change of a company. | Checking if a company's details have changed |
Virtual Accounts (Australia)virtual_accounts | When the virtual account status changes from pending_activation to activeor pending_activation to activation_failed. | Checking if a virtual account's status has changed |
PayIDs (Australia)pay_ids | When the PayID status changes from pending_activation to activeor pending_activation to activation_failed. | Checking if PayID status has changed |
PayTo Agreements (Australia)payto_agreements | Triggered whenever the agreement status changes as below: - pending_creation -> created (AUPM agreements)- created -> active (AUPM agreements)- pending_creation -> active (MGCR agreements)- pending_creation -> creation_failed- created -> cancelled- active -> suspended- suspended -> active- suspended -> cancelled- active -> cancelled | This notification is triggered whenever the agreement status changes. Example - When the payer approves/rejects the agreement via their banking portal, Zai would notify you about the same. |
PayTo Payment Initiation Request (Australia)payto_payments | Triggered whenever the payment initiation request status changes as below: - pending_payment_initiation -> payment_initiation_completed- pending_payment_initiation-> payment_initiation_rejected- payment_initiated -> payment_initiation_completed- payment_initiated -> payment_initiation_rejected | This notification is triggered whenever the payment initiation request status changes Example - when the payment initiation requested has been cleared and settled with the payer bank |
Transaction Failure Advicetransaction_failure_advice | Triggered whenever funds have been debited from the payer's bank account, however, failed to be matched with the payer's digital wallet in Zai. | This notification is triggered whenever reconciliation of funds (received via PayTo) fails on user's wallet Example - when the user is in held status in Zai due to any reason |
Steps to receive webhooks
- Decide which objects you'll want to be notified of and monitor.
- Create the required webhook configuration for each object and specify URLs to be used on your local server (where notifications will be received).
- Handle requests received from Zai. Process the payload from the notifications and ensure they return the proper response status code.
- Ensure that the objects are also created in callbacks.
Create a webhook
Refer to the API to create webhooks within Zai. Pass a valid HTTPS URL that will accept a POST request. This URL will receive a POST call when the webhook object is triggered. When creating a webhook object, the URL provided will be sent a test JSON payload and will only be successfully created if the response created is successful.
The output of the test you will receive from us is:
{ message: 'Zai callback test'}
Trigger webhooks
To trigger a webhook, update the object you have created a webhook for. An example of this would be to Make Payment for an Item (if the webhook you created was for an Item).
List webhook jobs
Use List jobs to view a list of the triggers for the Webhooks you created. Each time the Webhook is triggered, a response will be added.
You may now search for webhook jobs that failed to be delivered within your platform by just adding a new field “status” as part of the request payload and setting its value to failed.
Verify retry attempt for a webhook job
Use the GET jobs associated to Webhook to view a specific webhooks jobs record, within the response payload includes a request_response section which contains retry attempts done for the said job together with its status. This is in asynchronous mode which may not immediately reflect the recent retry attempt.
Webhooks by payment
Please note
We can’t guarantee the order of delivery for the following webhook examples.
You can check a webhook payload’s
updated_atfield to determine whether the data is newer or older than the data that you currently have stored in your system.For example, when receiving a
Userswebhook payload, you could compare your own data against theusers.updated_atfield. Similarly, when receiving aBatch Transactionswebhook payload, you could compare your own data against thebatch_transactions.updated_atfield.
| Payment | Example 1 | Example 2 | Example 3 |
|---|---|---|---|
| Direct Credit Payout | batch_transactions: -type: disbursement-type_method: direct_credit-state: batched | batch_transactions: -type: disbursement-type_method: direct_credit-state: bank_processing | batch_transactions: -type: disbursement-type_method: direct_credit-state: successful OR invalid_account_details |
| BPAY Payout (Australia) | batch_transactions: -type: disbursement-type_method: bpay-state: bank_processing | batch_transactions: -type: disbursement-type_method: bpay-state: successful OR invalid_account_details | |
| Realtime Payout (Australia) | disbursements: -state: successfulor -state: cancelled-npp_payout_state: failed | ||
| Card Payin (Australia) | transactions: -type: payment-type_method: credit_card-state: successful-account_id: item.id -account_type: item-related.transactions.id: transactions.id (this one) -related.transactions.account_id: card account id -related.transactions.account_type: card_account- related.transactions.user_id: user id of the buyer | This will be received once the funds have been settled to the seller/payees wallet batch_transactions: -type: payment_funding-type_method: credit_card-state: successful-account_id: item.id -account_type: item-related.account_to.id: account if of the wallet -related.account_to.account_type: wallet_account | |
| Direct Debit Payin (Australia) | batch_transactions: -type: payment-type_method: direct_debit-account_id: user.bank_account_id -account_type: bank_account-related.account_to.id: item.id -related.account_to.account_type: item-state: batched | batch_transactions: -type: payment-type_method: direct_debit-account_id: user.bank_account_id -account_type: bank_account-related.account_to.id: item.id -related.account_to.account_type: item-state: bank_processing | batch_transactions: -type: payment-type_method: direct_debit-account_id: user.bank_account_id -account_type: bank_account-related.account_to.id: item.id -related.account_to.account_type: item-state: successful OR invalid_account_details |
| BPAY Payin (Australia) | batch_transactions: -type: bpay-type_method: bpay-state: bpay_pending | These will be received once the funds have been settled to the wallet batch_transactions: -type: bpay-type_method: bpay-state: successfulAND transactions: -type: deposit-type_method: bpay-state: successful | |
| NPP Payin (Australia) | transactions: -type: deposit-type_method: npp_payin-state: successful | ||
| Direct Credit Payin | transactions: -type: deposit-type_method: direct_credit-state: successful | ||
| Wallet to Item Transfer | transactions: -type: payment-type_method: wallet_account_transfer-state: successful |
Examples
Transactions object
NPP Payin via PayID and CRN (Australia)
type: deposit
type_method: npp_payin
{
"transactions": {
"id": "49f1cb10-0202-0138-225b-028e897a70a5",
"created_at": "2019-12-16T07:19:14.966Z",
"updated_at": "2019-12-16T07:19:14.968Z",
"description": "Credit of $100,000.00 to Wallet Account by Debit of $100,000.00 from NPP Payin Funding Account",
"payee_name": "ASSEMBLY TEST",
"type": "deposit",
"type_method": "npp_payin",
"state": "successful",
"user_id": "449416d8-ec3c-4c0b-a326-e2cfaadaa3a6",
"user_name": "Neol Buyer",
"account_id": "89290ee0-7510-0137-fdc6-06502c58c658",
"account_type": "wallet_account",
"amount": 10000000,
"currency": "AUD",
"debit_credit": "credit",
"marketplace": {
"group_name": null,
"name": "Assembly Production",
"short_name": null,
"uuid": "cbec69ee-2153-4ac0-940c-cca51a0ff2e8"
},
"related": {
"transactions": [{
"id": "49f1b7f0-0202-0138-1aab-028e897a70a5",
"account_id": "7cfcf2ac-f274-4793-a47c-08c8bc82234f",
"account_type": "npp_payin_account",
"user_id": "449416d8-ec3c-4c0b-a326-e2cfaadaa3a6"
}]
},
"payin_details": {
"debtor_name": "ASSEMBLY TEST",
"debtor_legal_name": "ASSEMBLY TEST",
"debtor_bsb": "098765",
"debtor_account": "09876512345678",
"clearing_system_transaction_id": "CTBAAUSNXXXN20191216050126353211111",
"remittance_information": "100014014111111",
"pay_id": "[email protected]",
"pay_id_type": "/EMAL",
"end_to_end_id": "NOTPROVIDED",
"npp_payin_internal_id": "5ce94260-1fd4-11ea-bc20-efacc9a3e552"
},
"links": {
"self": null,
"users": "/transactions/49f1cb10-0202-0138-225b-028e897a70a5/users",
"fees": "/transactions/49f1cb10-0202-0138-225b-028e897a70a5/fees",
"wallet_accounts": "/transactions/49f1cb10-0202-0138-225b-028e897a70a5/wallet_accounts",
"card_accounts": "/transactions/49f1cb10-0202-0138-225b-028e897a70a5/card_accounts",
"paypal_accounts": "/transactions/49f1cb10-0202-0138-225b-028e897a70a5/paypal_accounts",
"bank_accounts": "/transactions/49f1cb10-0202-0138-225b-028e897a70a5/bank_accounts",
"items": "/transactions/49f1cb10-0202-0138-225b-028e897a70a5/items",
"marketplaces": "/transactions/49f1cb10-0202-0138-225b-028e897a70a5/marketplaces",
"npp_payin_transaction_detail": "/transactions/49f1cb10-0202-0138-225b-028e897a70a5/npp_payin_transaction_detail"
}
}
}
NPP Payin via Virtual Account BSB and Account Number (Australia)
type: deposit
type_method: npp_payin
{
"transactions": {
"id": "4fe213f0-a4a1-0139-7adf-0a58a9feac03",
"created_at": "2021-06-01T00:50:40.960Z",
"updated_at": "2021-06-01T00:50:40.965Z",
"description": "Credit of $1.00 to Wallet Account by Debit of $1.00 from NPP Payin Funding Account",
"payee_name": null,
"type": "deposit",
"type_method": "npp_payin",
"state": "successful",
"user_id": "buyer-1052152410015",
"user_name": "Neol Buyer",
"account_id": "3bf86450-a498-0139-7556-0a58a9feac03",
"account_type": "wallet_account",
"amount": 100,
"currency": "AUD",
"debit_credit": "credit",
"marketplace": {
"group_name": null,
"name": "platform neol 1622181174",
"short_name": null,
"uuid": "87094560-9fad-4ade-945b-d048507ac966"
},
"related": {
"transactions": [
{
"id": "4fe207a0-a4a1-0139-0e02-0a58a9feac03",
"account_id": "9d414fe1-3668-4ce6-8fa8-ddb80fc8ab43",
"account_type": "npp_payin_account",
"user_id": "buyer-1052152410015",
"user_name": "Neol Buyer"
}
]
},
"payin_details": null,
"links": {
"self": null,
"users": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/users",
"fees": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/fees",
"wallet_accounts": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/wallet_accounts",
"card_accounts": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/card_accounts",
"paypal_accounts": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/paypal_accounts",
"bank_accounts": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/bank_accounts",
"items": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/items",
"marketplaces": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/marketplaces",
"npp_payin_transaction_detail": null,
"supplementary_data": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/supplementary_data"
}
}
}
NPP Payin via PayID (associated with user's virtual account) (Australia)
type: deposit
type_method: npp_payin
{
"transactions": {
"id": "4fe213f0-a4a1-0139-7adf-0a58a9feac03",
"created_at": "2021-06-01T00:50:40.960Z",
"updated_at": "2021-06-01T00:50:40.965Z",
"description": "Credit of $1.00 to Wallet Account by Debit of $1.00 from NPP Payin Funding Account",
"payee_name": null,
"type": "deposit",
"type_method": "npp_payin",
"state": "successful",
"user_id": "buyer-1052152410015",
"user_name": "Neol Buyer",
"account_id": "3bf86450-a498-0139-7556-0a58a9feac03",
"account_type": "wallet_account",
"amount": 100,
"currency": "AUD",
"debit_credit": "credit",
"marketplace": {
"group_name": null,
"name": "platform neol 1622181174",
"short_name": null,
"uuid": "87094560-9fad-4ade-945b-d048507ac966"
},
"related": {
"transactions": [
{
"id": "4fe207a0-a4a1-0139-0e02-0a58a9feac03",
"account_id": "9d414fe1-3668-4ce6-8fa8-ddb80fc8ab43",
"account_type": "npp_payin_account",
"user_id": "buyer-1052152410015",
"user_name": "Neol Buyer"
}
]
},
"payin_details": null,
"links": {
"self": null,
"users": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/users",
"fees": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/fees",
"wallet_accounts": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/wallet_accounts",
"card_accounts": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/card_accounts",
"paypal_accounts": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/paypal_accounts",
"bank_accounts": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/bank_accounts",
"items": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/items",
"marketplaces": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/marketplaces",
"npp_payin_transaction_detail": null,
"supplementary_data": "/transactions/4fe213f0-a4a1-0139-7adf-0a58a9feac03/supplementary_data"
}
}
}
DE Payin via Virtual Account BSB and Account Number (Australia)
type: deposit
type_method: direct_credit
{
"transactions": {
"id": "6eaf2790-a4a1-0139-b8b5-0a58a9feac03",
"created_at": "2021-06-01T00:51:32.636Z",
"updated_at": "2021-06-01T00:51:32.640Z",
"description": "Credit of $1.00 to Wallet Account by Debit of $1.00 from Direct Entry Funding Account",
"payee_name": null,
"type": "deposit",
"type_method": "direct_credit",
"state": "successful",
"user_id": "buyer-1052152410015",
"user_name": "Neol Buyer",
"account_id": "3bf86450-a498-0139-7556-0a58a9feac03",
"account_type": "wallet_account",
"amount": 100,
"currency": "AUD",
"debit_credit": "credit",
"marketplace": {
"group_name": null,
"name": "platform neol 1622181174",
"short_name": null,
"uuid": "87094560-9fad-4ade-945b-d048507ac966"
},
"related": {
"transactions": [
{
"id": "6eaf1a30-a4a1-0139-564a-0a58a9feac03",
"account_id": "1d6bb590-0c51-0139-5acb-0a58a9feac2a",
"account_type": "de_payin_account",
"user_id": "buyer-1052152410015",
"user_name": "Neol Buyer"
}
]
},
"links": {
"self": null,
"users": "/transactions/6eaf2790-a4a1-0139-b8b5-0a58a9feac03/users",
"fees": "/transactions/6eaf2790-a4a1-0139-b8b5-0a58a9feac03/fees",
"wallet_accounts": "/transactions/6eaf2790-a4a1-0139-b8b5-0a58a9feac03/wallet_accounts",
"card_accounts": "/transactions/6eaf2790-a4a1-0139-b8b5-0a58a9feac03/card_accounts",
"paypal_accounts": "/transactions/6eaf2790-a4a1-0139-b8b5-0a58a9feac03/paypal_accounts",
"bank_accounts": "/transactions/6eaf2790-a4a1-0139-b8b5-0a58a9feac03/bank_accounts",
"items": "/transactions/6eaf2790-a4a1-0139-b8b5-0a58a9feac03/items",
"marketplaces": "/transactions/6eaf2790-a4a1-0139-b8b5-0a58a9feac03/marketplaces",
"npp_payin_transaction_detail": null,
"supplementary_data": "/transactions/6eaf2790-a4a1-0139-b8b5-0a58a9feac03/supplementary_data"
}
}
}
type: deposit
type_method: bpay (Australia)
{
"transactions": {
"id": "c7dfc660-01d5-0138-f9ed-0292c5a1dee7",
"created_at": "2019-12-16T02:00:38.884Z",
"updated_at": "2019-12-16T02:00:38.886Z",
"description": "Credit of $1,153.46 to Wallet Account by Debit of $1,153.46 from BPAY Funding Account",
"payee_name": null,
"type": "deposit",
"type_method": "bpay",
"state": "successful",
"user_id": "c934dc1e-a646-4972-b1c4-ef0f77337298",
"user_name": "Neol Buyer",
"account_id": "d92296c0-8f32-0137-95dd-06ddcda9b4cc",
"account_type": "wallet_account",
"amount": 115346,
"currency": "AUD",
"debit_credit": "credit",
"marketplace": {
"group_name": null,
"name": "Assembly Production",
"short_name": null,
"uuid": "7e2f32da-eaaf-41b0-b31d-1a79823de1cf"
},
"related": {
"transactions": [{
"id": "c7dfb260-01d5-0138-73ca-0292c5a1dee7",
"account_id": null,
"account_type": "bpay_funding_account",
"user_id": "d5556ed140a90e9fe23575f7e2191072"
}]
},
"links": {
"self": null,
"users": "/transactions/c7dfc660-01d5-0138-f9ed-0292c5a1dee7/users",
"fees": "/transactions/c7dfc660-01d5-0138-f9ed-0292c5a1dee7/fees",
"wallet_accounts": "/transactions/c7dfc660-01d5-0138-f9ed-0292c5a1dee7/wallet_accounts",
"card_accounts": "/transactions/c7dfc660-01d5-0138-f9ed-0292c5a1dee7/card_accounts",
"paypal_accounts": "/transactions/c7dfc660-01d5-0138-f9ed-0292c5a1dee7/paypal_accounts",
"bank_accounts": "/transactions/c7dfc660-01d5-0138-f9ed-0292c5a1dee7/bank_accounts",
"items": "/transactions/c7dfc660-01d5-0138-f9ed-0292c5a1dee7/items",
"marketplaces": "/transactions/c7dfc660-01d5-0138-f9ed-0292c5a1dee7/marketplaces",
"npp_payin_transaction_detail": null
}
}
}
type: payment
type_method: wallet_account_transfer
{
"transactions": {
"id": "153a9210-01ea-0138-5352-06c7c110a877",
"created_at": "2019-12-16T04:25:58.599Z",
"updated_at": "2019-12-16T04:25:58.663Z",
"description": "Debit of $1,080.00 from Wallet Account for Credit of $1,080.00 to Item",
"payee_name": null,
"type": "payment",
"type_method": "wallet_account_transfer",
"state": "successful",
"user_id": "449416d8-ec3c-4c0b-a326-e2cfaadaa3a6",
"user_name": "Neol Buyer",
"account_id": "89290ee0-7510-0137-fdc6-06502c58c658",
"account_type": "wallet_account",
"amount": 108000,
"currency": "AUD",
"debit_credit": "debit",
"marketplace": {
"group_name": null,
"name": "Assembly Production",
"short_name": null,
"uuid": "cbec69ee-2153-4ac0-940c-cca51a0ff2e8"
},
"related": {
"transactions": [{
"id": "153aada0-01ea-0138-9944-06c7c110a877",
"account_id": "16017",
"account_type": "item",
"user_id": "9e9f44d19d65d92ca7ca3b777f9d270e"
}]
},
"links": {
"self": null,
"users": "/transactions/153a9210-01ea-0138-5352-06c7c110a877/users",
"fees": "/transactions/153a9210-01ea-0138-5352-06c7c110a877/fees",
"wallet_accounts": "/transactions/153a9210-01ea-0138-5352-06c7c110a877/wallet_accounts",
"card_accounts": "/transactions/153a9210-01ea-0138-5352-06c7c110a877/card_accounts",
"paypal_accounts": "/transactions/153a9210-01ea-0138-5352-06c7c110a877/paypal_accounts",
"bank_accounts": "/transactions/153a9210-01ea-0138-5352-06c7c110a877/bank_accounts",
"items": "/transactions/153a9210-01ea-0138-5352-06c7c110a877/items",
"marketplaces": "/transactions/153a9210-01ea-0138-5352-06c7c110a877/marketplaces",
"npp_payin_transaction_detail": null
}
}
}
type: disbursement
type_method: direct_credit
{
"transactions": {
"id": "70308b80-01e6-0138-f122-0604ddcc546b",
"created_at": "2019-12-16T03:59:53.227Z",
"updated_at": "2019-12-16T03:59:53.267Z",
"description": "Debit of $637.83 from Wallet Account for Credit of $637.83 to Bank Account",
"payee_name": null,
"type": "disbursement",
"type_method": "direct_credit",
"state": "successful",
"user_id": "14461",
"dynamic_descriptor": null,
"account_id": "68cd4ef0-01e6-0138-52c2-0604ddcc546b",
"account_type": "wallet_account",
"amount": 63783,
"currency": "AUD",
"debit_credit": "debit",
"marketplace": {
"group_name": null,
"name": "Assembly Production",
"short_name": null,
"uuid": "cbec69ee-2153-4ac0-940c-cca51a0ff2e8"
},
"related": {
"transactions": [{
"id": "703167c0-01e6-0138-87d6-0604ddcc546b",
"account_id": "69b55d90-01e6-0138-6255-0604ddcc546b",
"account_type": "bank_account",
"user_id": "14461"
}]
},
"links": {
"self": null,
"users": "/transactions/70308b80-01e6-0138-f122-0604ddcc546b/users",
"fees": "/transactions/70308b80-01e6-0138-f122-0604ddcc546b/fees",
"wallet_accounts": "/transactions/70308b80-01e6-0138-f122-0604ddcc546b/wallet_accounts",
"card_accounts": "/transactions/70308b80-01e6-0138-f122-0604ddcc546b/card_accounts",
"paypal_accounts": "/transactions/70308b80-01e6-0138-f122-0604ddcc546b/paypal_accounts",
"bank_accounts": "/transactions/70308b80-01e6-0138-f122-0604ddcc546b/bank_accounts",
"items": "/transactions/70308b80-01e6-0138-f122-0604ddcc546b/items",
"marketplaces": "/transactions/70308b80-01e6-0138-f122-0604ddcc546b/marketplaces",
"npp_payin_transaction_detail": null
}
}
}
Items object
{
"items": {
"id": "75d07055-5141-4729-a26a-31875e45d7cc",
"name": "Assembly test transaction",
"description": null,
"custom_descriptor": "Assembly test transaction",
"payout_descriptor": null,
"created_at": "2019-12-16T03:10:49.872Z",
"updated_at": "2019-12-16T03:10:49.872Z",
"state": "pending",
"net_amount": 55000,
"chargedback_amount": 0,
"refunded_amount": 0,
"released_amount": 0,
"seller_url": "",
"buyer_url": "",
"remaining_amount": 55000,
"status": 22000,
"amount": 55000,
"payment_type_id": 2,
"due_date": null,
"requested_release_amount": 0,
"pending_release_amount": 0,
"dynamic_descriptor": null,
"invoice_url": null,
"deposit_reference": "100014091971111",
"buyer_fees": 0,
"seller_fees": 1100,
"credit_card_fee": 0,
"direct_debit_fee": 0,
"paypal_fee": 0,
"promisepay_fee": 0,
"batch_state": null,
"total_outstanding": 55000,
"total_amount": 55000,
"currency": "AUD",
"payment_method": "pending",
"buyer_name": "Assembly Buyer",
"buyer_email": "[email protected]",
"buyer_country": "AUS",
"seller_name": "Assembly Seller",
"seller_email": "[email protected]",
"seller_country": "AUS",
"payment_credit_card_enabled": true,
"payment_direct_debit_enabled": true,
"tds_check_state": null,
"related": {
"buyers": "6385542f-c7ab-4fae-82b2-a76a1ce0e531",
"sellers": "e0e30fb0-ad7e-46c1-8fe0-317ab4167745"
},
"links": {
"self": null,
"buyers": "/items/75d07055-5141-4729-a26a-31875e45d7cc/buyers",
"sellers": "/items/75d07055-5141-4729-a26a-31875e45d7cc/sellers",
"status": "/items/75d07055-5141-4729-a26a-31875e45d7cc/status",
"fees": "/items/75d07055-5141-4729-a26a-31875e45d7cc/fees",
"transactions": "/items/75d07055-5141-4729-a26a-31875e45d7cc/transactions",
"batch_transactions": "/items/75d07055-5141-4729-a26a-31875e45d7cc/batch_transactions",
"wire_details": "/items/75d07055-5141-4729-a26a-31875e45d7cc/wire_details",
"bpay_details": "/items/75d07055-5141-4729-a26a-31875e45d7cc/bpay_details",
"tds_checks": "/items/75d07055-5141-4729-a26a-31875e45d7cc/tds_checks"
}
}
}
Users object
{
"users": {
"created_at": "2019-06-14T06:14:50.522Z",
"updated_at": "2019-12-16T07:58:55.006Z",
"full_name": "Assembly User",
"email": "[email protected]",
"mobile": null,
"phone": null,
"logo_url": null,
"color_1": null,
"color_2": null,
"first_name": "Assembly",
"last_name": "User",
"id": "40b42c86-637d-4d07-9451-e0b59b5429b9",
"custom_descriptor": "Test payment",
"location": "AUS",
"verification_state": "approved",
"held_state": false,
"roles": ["customer"],
"dob": "encrypted",
"government_number": null,
"drivers_license": null,
"flags": {},
"related": {
"addresses": "a4047090-7099-0137-2eaa-02440f902894",
"payout_account": "7665ad80-727d-0137-9d4d-024c25d37cba"
},
"links": {
"self": null,
"items": "/users/40b42c86-637d-4d07-9451-e0b59b5429b9/items",
"card_accounts": "/users/40b42c86-637d-4d07-9451-e0b59b5429b9/card_accounts",
"paypal_accounts": "/users/40b42c86-637d-4d07-9451-e0b59b5429b9/paypal_accounts",
"payid_accounts": "/users/40b42c86-637d-4d07-9451-e0b59b5429b9/payid_accounts",
"bank_accounts": "/users/40b42c86-637d-4d07-9451-e0b59b5429b9/bank_accounts",
"wallet_accounts": "/users/40b42c86-637d-4d07-9451-e0b59b5429b9/wallet_accounts"
}
}
}
Batch Transactions object
type: payment
type_method: direct_debit (Australia)
state: bank processing
{
"batch_transactions": {
"created_at": "2019-12-10T04:20:58.889Z",
"updated_at": "2019-12-10T23:13:28.290Z",
"id": "112b31ad-3ea8-4a17-b22e-ea501f718348",
"account_type": "bank_account",
"type": "payment",
"type_method": "direct_debit",
"batch_id": 3674,
"cuscal_payment_transaction_id": null,
"reference": "3674: Assembly Production",
"deposit_reference": null,
"state": "bank_processing",
"status": 12700,
"user_id": "cb055352-793e-4375-ba1a-765195b3e431",
"account_id": "5991bac0-9a4c-0137-4dae-02e1afd1c777",
"amount": 26490,
"currency": "AUD",
"debit_credit": "debit",
"description": "Debit of $264.90 from Bank Account for Credit of $264.90 to Item",
"related": {
"account_to": {
"id": "e2ef8fd1-5cef-49db-88ab-9d24cfd95131",
"account_type": "item",
"user_id": "a0973e1b072101871466a6bb7b6c7e6f"
}
},
"links": {
"self": null,
"users": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/users",
"fees": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/fees",
"wallet_accounts": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/wallet_accounts",
"card_accounts": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/card_accounts",
"paypal_accounts": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/paypal_accounts",
"bank_accounts": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/bank_accounts",
"items": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/items"
}
}
}
type: payment
type_method: direct_debit (Australia)
state: successful
{
"batch_transactions": {
"created_at": "2019-12-10T04:20:58.889Z",
"updated_at": "2019-12-16T00:01:58.498Z",
"id": "112b31ad-3ea8-4a17-b22e-ea501f718348",
"account_type": "bank_account",
"type": "payment",
"type_method": "direct_debit",
"batch_id": 3674,
"cuscal_payment_transaction_id": null,
"reference": "3674: Assembly Production",
"deposit_reference": null,
"state": "successful",
"status": 12000,
"user_id": "cb055352-793e-4375-ba1a-765195b3e431",
"account_id": "5991bac0-9a4c-0137-4dae-02e1afd1c777",
"amount": 26490,
"currency": "AUD",
"debit_credit": "debit",
"description": "Debit of $264.90 from Bank Account for Credit of $264.90 to Item",
"related": {
"account_to": {
"id": "e2ef8fd1-5cef-49db-88ab-9d24cfd95131",
"account_type": "item",
"user_id": "a0973e1b072101871466a6bb7b6c7e6f"
}
},
"links": {
"self": null,
"users": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/users",
"fees": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/fees",
"wallet_accounts": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/wallet_accounts",
"card_accounts": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/card_accounts",
"paypal_accounts": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/paypal_accounts",
"bank_accounts": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/bank_accounts",
"items": "/batch_transactions/112b31ad-3ea8-4a17-b22e-ea501f718348/items"
}
}
}
type: payment
type_method: direct_debit (Australia)
state: invalid_account_details
{
"batch_transactions": {
"created_at": "2019-11-15T01:14:29.000Z",
"updated_at": "2019-11-18T22:46:49.802Z",
"id": "40aa9259-74a9-4b39-8dae-b82d86a6b64c",
"account_type": "bank_account",
"type": "payment",
"type_method": "direct_debit",
"batch_id": 3623,
"cuscal_payment_transaction_id": null,
"reference": "Assembly Test transaction",
"deposit_reference": null,
"state": "invalid_account_details",
"status": 12360,
"user_id": "fe2f155a-5885-42f2-9d18-54052d560919",
"account_id": "01152150-e973-0137-64ca-061f94c317bf",
"amount": 71,
"currency": "AUD",
"debit_credit": "debit",
"description": "Debit of $0.71 from Bank Account for Credit of $0.71 to Item",
"related": {
"account_to": {
"id": "7fee0c57-5798-4310-965f-6ce27ba1c68d",
"account_type": "item",
"user_id": "43927c80bb2d591d56d0934fdd3f3868"
}
},
"links": {
"self": null,
"users": "/batch_transactions/40aa9259-74a9-4b39-8dae-b82d86a6b64c/users",
"fees": "/batch_transactions/40aa9259-74a9-4b39-8dae-b82d86a6b64c/fees",
"wallet_accounts": "/batch_transactions/40aa9259-74a9-4b39-8dae-b82d86a6b64c/wallet_accounts",
"card_accounts": "/batch_transactions/40aa9259-74a9-4b39-8dae-b82d86a6b64c/card_accounts",
"paypal_accounts": "/batch_transactions/40aa9259-74a9-4b39-8dae-b82d86a6b64c/paypal_accounts",
"bank_accounts": "/batch_transactions/40aa9259-74a9-4b39-8dae-b82d86a6b64c/bank_accounts",
"items": "/batch_transactions/40aa9259-74a9-4b39-8dae-b82d86a6b64c/items"
}
}
}
type: payment
type_method: direct_debit (Australia)
state: failed_direct_debit
{
"batch_transactions": {
"created_at": "2019-12-11T18:00:24.365Z",
"updated_at": "2019-12-15T22:53:39.926Z",
"id": "eacbd2c8-631f-407c-8a3e-f7bc7b2f9d55",
"account_type": "bank_account",
"type": "payment",
"type_method": "direct_debit",
"batch_id": 3676,
"cuscal_payment_transaction_id": null,
"reference": "Assembly Test Transaction",
"deposit_reference": null,
"state": "failed_direct_debit",
"status": 12370,
"user_id": "1bb6e370-edc0-4a9c-857f-66f599f9739a",
"account_id": "338f4ba0-2c84-0137-0fb9-0250ddecdcda",
"amount": 52000,
"currency": "AUD",
"debit_credit": "debit",
"description": "Debit of $520.00 from Bank Account for Credit of $520.00 to Item",
"related": {
"account_to": {
"id": "d6faa441-b73c-404c-a992-ad32ab08d743",
"account_type": "item",
"user_id": "43927c80bb2d591d56d0934fdd3f3868"
}
},
"links": {
"self": null,
"users": "/batch_transactions/eacbd2c8-631f-407c-8a3e-f7bc7b2f9d55/users",
"fees": "/batch_transactions/eacbd2c8-631f-407c-8a3e-f7bc7b2f9d55/fees",
"wallet_accounts": "/batch_transactions/eacbd2c8-631f-407c-8a3e-f7bc7b2f9d55/wallet_accounts",
"card_accounts": "/batch_transactions/eacbd2c8-631f-407c-8a3e-f7bc7b2f9d55/card_accounts",
"paypal_accounts": "/batch_transactions/eacbd2c8-631f-407c-8a3e-f7bc7b2f9d55/paypal_accounts",
"bank_accounts": "/batch_transactions/eacbd2c8-631f-407c-8a3e-f7bc7b2f9d55/bank_accounts",
"items": "/batch_transactions/eacbd2c8-631f-407c-8a3e-f7bc7b2f9d55/items"
}
}
}
Credit Card Settlement (Australia)
type: payment_funding
type_method: credit_card
state: successful
{
"batch_transactions": {
"created_at": "2020-03-25T00:42:20.658Z",
"updated_at": "2020-03-27T04:02:49.933Z",
"id": "eefb4116-a2c5-4004-ada5-73d11eb8330f",
"account_type": "item",
"type": "payment_funding",
"type_method": "credit_card",
"batch_id": null,
"cuscal_payment_transaction_id": null,
"reference": "Assembly Production",
"deposit_reference": null,
"state": "successful",
"status": 12000,
"user_id": "874ed0ba-1876-44f6-57a7-b1c748844398",
"account_id": "52ef87de-d84d-8606-9be7-8f1303f2c696",
"amount": 100,
"currency": "AUD",
"debit_credit": "credit",
"description": "Credit of $1.00 to Item by Debit of $1.00 from Wallet Account",
"related": {
"account_to": {
"id": "fb237a00-feb5-0137-af74-06d22325d243",
"account_type": "wallet_account",
"user_id": "5"
}
},
"links": {
"self": "/batch_transactions/eefb4116-a2c5-4004-ada5-73d11eb8330f",
"users": "/batch_transactions/eefb4116-a2c5-4004-ada5-73d11eb8330f/users",
"fees": "/batch_transactions/eefb4116-a2c5-4004-ada5-73d11eb8330f/fees",
"wallet_accounts": "/batch_transactions/eefb4116-a2c5-4004-ada5-73d11eb8330f/wallet_accounts",
"card_accounts": "/batch_transactions/eefb4116-a2c5-4004-ada5-73d11eb8330f/card_accounts",
"paypal_accounts": "/batch_transactions/eefb4116-a2c5-4004-ada5-73d11eb8330f/paypal_accounts",
"bank_accounts": "/batch_transactions/eefb4116-a2c5-4004-ada5-73d11eb8330f/bank_accounts",
"items": "/batch_transactions/eefb4116-a2c5-4004-ada5-73d11eb8330f/items"
}
}
}
type: disbursement
type_method: direct_credit
state: successful
{
"batch_transactions": {
"created_at": "2019-12-10T05:50:42.384Z",
"updated_at": "2019-12-16T06:00:56.206Z",
"id": "02516f0e-1736-4172-a07d-13c4d8da4f7c",
"account_type": "wallet_account",
"type": "disbursement",
"type_method": "direct_credit",
"batch_id": 3674,
"cuscal_payment_transaction_id": null,
"reference": "3674: Assembly Production",
"deposit_reference": null,
"state": "successful",
"status": 12000,
"user_id": "a2707d3c-873a-4daa-b820-1a56f1c330cb",
"account_id": "da771b90-bbfa-0137-7c7e-06991e94040f",
"amount": 64039,
"currency": "AUD",
"debit_credit": "credit",
"description": "Debit of $640.39 from Wallet Account for Credit of $640.39 to Bank Account",
"related": {
"account_to": {
"id": "fd0c6160-bbfa-0137-d56a-0674a3bcef4d",
"account_type": "bank_account",
"user_id": "a2707d3c-873a-4daa-b820-1a56f1c330cb"
}
},
"links": {
"self": null,
"users": "/batch_transactions/02516f0e-1736-4172-a07d-13c4d8da4f7c/users",
"fees": "/batch_transactions/02516f0e-1736-4172-a07d-13c4d8da4f7c/fees",
"wallet_accounts": "/batch_transactions/02516f0e-1736-4172-a07d-13c4d8da4f7c/wallet_accounts",
"card_accounts": "/batch_transactions/02516f0e-1736-4172-a07d-13c4d8da4f7c/card_accounts",
"paypal_accounts": "/batch_transactions/02516f0e-1736-4172-a07d-13c4d8da4f7c/paypal_accounts",
"bank_accounts": "/batch_transactions/02516f0e-1736-4172-a07d-13c4d8da4f7c/bank_accounts",
"items": "/batch_transactions/02516f0e-1736-4172-a07d-13c4d8da4f7c/items"
}
}
}
type: disbursement
type_method: direct_credit
state: invalid_account_details
{
"batch_transactions": {
"created_at": "2019-11-15T04:14:51.058Z",
"updated_at": "2019-11-18T22:46:45.453Z",
"id": "ffecfe55-4a38-4aea-a2d7-9ce17d50a728",
"account_type": "wallet_account",
"type": "disbursement",
"type_method": "direct_credit",
"batch_id": 3623,
"cuscal_payment_transaction_id": null,
"reference": "3623: Assembly Production",
"deposit_reference": null,
"state": "invalid_account_details",
"status": 12360,
"user_id": "fe2f155a-5885-42f2-9d18-54052d560919",
"account_id": "33462a80-e422-0137-abbb-06615306b937",
"amount": 71,
"currency": "AUD",
"debit_credit": "credit",
"description": "Debit of $0.71 from Wallet Account for Credit of $0.71 to Bank Account",
"related": {
"account_to": {
"id": "01152150-e973-0137-64ca-061f94c317bf",
"account_type": "bank_account",
"user_id": "fe2f155a-5885-42f2-9d18-54052d560919"
}
},
"links": {
"self": null,
"users": "/batch_transactions/ffecfe55-4a38-4aea-a2d7-9ce17d50a728/users",
"fees": "/batch_transactions/ffecfe55-4a38-4aea-a2d7-9ce17d50a728/fees",
"wallet_accounts": "/batch_transactions/ffecfe55-4a38-4aea-a2d7-9ce17d50a728/wallet_accounts",
"card_accounts": "/batch_transactions/ffecfe55-4a38-4aea-a2d7-9ce17d50a728/card_accounts",
"paypal_accounts": "/batch_transactions/ffecfe55-4a38-4aea-a2d7-9ce17d50a728/paypal_accounts",
"bank_accounts": "/batch_transactions/ffecfe55-4a38-4aea-a2d7-9ce17d50a728/bank_accounts",
"items": "/batch_transactions/ffecfe55-4a38-4aea-a2d7-9ce17d50a728/items"
}
}
}
type: disbursement
type_method: bpay (Australia)
state: bank_processing
{
"batch_transactions": {
"created_at": "2020-07-27T22:50:27.654Z",
"updated_at": "2020-07-27T22:52:41.014Z",
"id": 31622,
"uuid": "486a51f2-099c-4eba-9e83-a854fec01484",
"external_reference": null,
"reference_amount": null,
"account_external": {
"account_type_id": 9700,
"currency": {
"code": "AUD"
}
},
"internal_state": null,
"internal_status": null,
"user_email": "[email protected]",
"first_name": "Neol",
"last_name": "BPay User",
"legal_entity_id": "59f99bc2-87e5-4359-af56-6dac32d650d3",
"user_external_id": "bpayUser-78600683",
"phone": "+1595890183",
"marketplace": {
"group_name": null,
"name": "Bpay MP 1595890175",
"short_name": null,
"uuid": "9b99d86f-4376-42c0-9e09-d0fd087b8ae7",
"account_details": null,
"account_details_encrypted": null
},
"company": null,
"payout_currency": null,
"address_line1": "Courtland Ave.",
"address_line2": "Courtland Ave.",
"address_city": "Macon",
"address_state": "GA",
"address_postcode": "31204",
"address_country": {
"id": 1,
"name": "Australia",
"three_code": "AUS",
"two_code": "au",
"currency_id": 1,
"numeric_code": "36"
},
"account_type": 9700,
"type": "disbursement",
"type_method": "bpay",
"batch_id": null,
"cuscal_payment_transaction_id": null,
"reference": null,
"deposit_reference": null,
"state": "bank_processing",
"status": 12700,
"user_id": "6350f240-b289-0138-1ab1-0a58a9feac37",
"account_id": "6362eb40-b289-0138-e4bd-0a58a9feac37",
"amount": 10005,
"currency": "AUD",
"debit_credit": "credit",
"description": "Debit of $100.05 from Wallet Account for Credit of $100.05 to BPay Disbursement Account",
"related": {
"account_to": {
"id": "71b6b790-b289-0138-bb57-0a58a9feac37",
"account_type": "bpay_disbursement_account",
"user_id": "6350f240-b289-0138-1ab1-0a58a9feac37"
}
},
"links": {
"self": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484",
"users": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/users",
"fees": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/fees",
"wallet_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/wallet_accounts",
"card_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/card_accounts",
"paypal_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/paypal_accounts",
"bank_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/bank_accounts",
"bpay_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/bpay_accounts",
"items": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/items",
"marketplace": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/marketplaces"
}
}
}
type: disbursement
type_method: bpay (Australia)
state: successful
{
"batch_transactions": {
"created_at": "2020-07-27T22:50:27.654Z",
"updated_at": "2020-07-27T23:02:52.157Z",
"id": 31622,
"uuid": "486a51f2-099c-4eba-9e83-a854fec01484",
"external_reference": null,
"reference_amount": null,
"account_external": {
"account_type_id": 9700,
"currency": {
"code": "AUD"
}
},
"internal_state": null,
"internal_status": null,
"user_email": "[email protected]",
"first_name": "Neol",
"last_name": "BPay User",
"legal_entity_id": "59f99bc2-87e5-4359-af56-6dac32d650d3",
"user_external_id": "bpayUser-78600683",
"phone": "+1595890183",
"marketplace": {
"group_name": null,
"name": "Bpay MP 1595890175",
"short_name": null,
"uuid": "9b99d86f-4376-42c0-9e09-d0fd087b8ae7",
"account_details": null,
"account_details_encrypted": null
},
"company": null,
"payout_currency": null,
"address_line1": "Courtland Ave.",
"address_line2": "Courtland Ave.",
"address_city": "Macon",
"address_state": "GA",
"address_postcode": "31204",
"address_country": {
"id": 1,
"name": "Australia",
"three_code": "AUS",
"two_code": "au",
"currency_id": 1,
"numeric_code": "36"
},
"account_type": 9700,
"type": "disbursement",
"type_method": "bpay",
"batch_id": null,
"cuscal_payment_transaction_id": null,
"reference": null,
"deposit_reference": null,
"state": "successful",
"status": 12000,
"user_id": "6350f240-b289-0138-1ab1-0a58a9feac37",
"account_id": "6362eb40-b289-0138-e4bd-0a58a9feac37",
"amount": 10005,
"currency": "AUD",
"debit_credit": "credit",
"description": "Debit of $100.05 from Wallet Account for Credit of $100.05 to BPay Disbursement Account",
"related": {
"account_to": {
"id": "71b6b790-b289-0138-bb57-0a58a9feac37",
"account_type": "bpay_disbursement_account",
"user_id": "6350f240-b289-0138-1ab1-0a58a9feac37"
}
},
"links": {
"self": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484",
"users": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/users",
"fees": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/fees",
"wallet_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/wallet_accounts",
"card_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/card_accounts",
"paypal_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/paypal_accounts",
"bank_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/bank_accounts",
"bpay_accounts": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/bpay_accounts",
"items": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/items",
"marketplace": "/batch_transactions/486a51f2-099c-4eba-9e83-a854fec01484/marketplaces"
}
}
}
Disbursements object
state: bank_processing
{
"disbursements": {
"id": "1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd",
"amount": 100000,
"currency": "AUD",
"batch_id": null,
"cuscal_payment_transaction_id": null,
"created_at": "2019-12-16T04:06:48.329Z",
"updated_at": "2019-12-16T04:06:50.181Z",
"state": "bank_processing",
"to": "Bank Account",
"bank_name": "BWA",
"bank_account_name": "ASSEMBLY TEST",
"bank_account_number": "XXX975",
"bank_routing_number": "XXXXX1",
"npp_payout_state": "trying",
"links": {
"transactions": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/transactions",
"wallet_accounts": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/wallet_accounts",
"bank_accounts": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/bank_accounts",
"paypal_accounts": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/paypal_accounts",
"items": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/items",
"users": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/users"
}
}
}
state: successful
{
"disbursements": {
"id": "1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd",
"amount": 100000,
"currency": "AUD",
"batch_id": null,
"cuscal_payment_transaction_id": "PRTYAU31XXXN20191216000000000111111",
"created_at": "2019-12-16T04:06:48.329Z",
"updated_at": "2019-12-16T04:06:52.977Z",
"state": "successful",
"to": "Bank Account",
"bank_name": "BWA",
"bank_account_name": "ASSEMBLY TEST",
"bank_account_number": "XXX975",
"bank_routing_number": "XXXXX1",
"npp_payout_state": "successful",
"links": {
"transactions": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/transactions",
"wallet_accounts": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/wallet_accounts",
"bank_accounts": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/bank_accounts",
"paypal_accounts": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/paypal_accounts",
"items": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/items",
"users": "/disbursements/1c0916c6-e4ef-4d9f-9548-974e2b5cb5cd/users"
}
}
}
Accounts object
{
"accounts": {
"id": 8100683,
"created_at": "2019-12-16T00:08:54.823Z",
"updated_at": "2019-12-16T00:08:54.823Z",
"currency_id": 1,
"account_type_id": 2000,
"amount": 0,
"legal_entity_id": 2561348,
"uuid": "2bf1ea30-01c6-0138-94dd-06c7c110a877",
"links": {
"self": null
}
}
}
Virtual Accounts object (Australia)
{
"event": "status_updated",
"id": "123e4567-e89b-12d3-a456-426614174000"
"link": "/virtual_accounts/123e4567-e89b-12d3-a456-426614174000",
"name": "virtual_accounts",
"updatedAt": "2021-08-11T18:00:00+12:00"
}
PayID object (Australia)
{
"event": "status_updated",
"id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
"name": "payid",
"newStatus": "active",
"oldStatus": "pending_activation",
"updatedAt": "2022-04-21T08:57:54Z",
"link": "/payid/46deb476-c1a6-41eb-8eb7-26a695bbe5bc"
}
PayTo object - payto_agreements (Australia)
event_type: AGREEMENT_CREATION_SUCCESS
{
"event_type" : "AGREEMENT_CREATION_SUCCESS",
"id" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"original_request" : {
"user_external_id" : "buyer-149930547",
"priority" : "ATTENDED",
"agreement_info" : {
"description" : "desc",
"short_description" : "short desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2023-10-31",
"validity_end_date" : "2048-08-25",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id_type" : "PAYID",
"payid_details" : {
"payid_type" : "TELI",
"payid" : "+61-474109810"
}
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUCN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2048-07-30"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2048-07-31"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"count_per_period" : "3",
"frequency" : "INTRDY"
}
}
},
"data" : {
"agreement_uuid" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"user_external_id" : "buyer-149930547",
"status" : "CREATED",
"status_description" : "Agreement has been created successfully.",
"created_at" : "2022-11-01 06:50:05.196983",
"updated_at" : "2022-11-01 06:50:37.312155",
"agreement_info" : {
"agreement_id" : "83da8db97d921c20bbcacacc30b09aae",
"description" : "desc",
"short_description" : "short desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2023-10-31",
"validity_end_date" : "2048-08-25",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id_type" : "PAYID",
"payid_details" : {
"payid_type" : "TELI",
"payid" : "+61-474109810",
"payid_name" : "Test"
}
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUCN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2048-07-30"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2048-07-31"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"count_per_period" : "3",
"frequency" : "INTRDY"
}
}
},
"message" : "Agreement has been created successfully."
}
event_type: AGREEMENT_ACTIVATION_SUCCESS
Payer approves the agreement
{
"event_type" : "AGREEMENT_ACTIVATION_SUCCESS",
"id" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"data" : {
"agreement_uuid" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"user_external_id" : "buyer-149930547",
"status" : "ACTIVE",
"status_description" : "Agreement has been approved by the debtor",
"created_at" : "2022-11-01 06:50:05.196983",
"updated_at" : "2022-11-01 06:52:27.312155",
"agreement_info" : {
"agreement_id" : "83da8db97d921c20bbcacacc30b09aae",
"description" : "desc",
"short_description" : "short desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2023-10-31",
"validity_end_date" : "2048-08-25",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id_type" : "PAYID",
"payid_details" : {
"payid_type" : "TELI",
"payid" : "+61-474109810",
"payid_name" : "Test"
}
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUCN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2048-07-30"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2048-07-31"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"count_per_period" : "3",
"frequency" : "INTRDY"
}
}
},
"message" : "Agreement has been approved by the debtor"
}
event_type: AGREEMENT_REJECTION_SUCCESS
Payer rejects the agreement
{
"event_type" : "AGREEMENT_REJECTION_SUCCESS",
"id" : "9d087d28-327f-45ed-800f-0572bcd76598",
"data" : {
"agreement_uuid" : "9d087d28-327f-45ed-800f-0572bcd76598",
"user_external_id" : "buyer-149930547",
"status" : "CANCELLED",
"status_description" : "Agreement has been either rejected by the debtor or the authorisation request has expired",
"status_reason_code" : "PayerAccountTypeInvalid",
"status_reason_description" : "Payer account type is invalid - unable to debit funds within NPP. Additional Information: acc not suported , declining agreement creation",
"created_at" : "2022-11-01 07:14:59.196983",
"updated_at" : "2022-11-01 07:15:42.312155",
"agreement_info" : {
"agreement_id" : "cc3ca29def0b1a24abf9522cfcca549d",
"description" : "desc",
"short_description" : "short desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2022-11-01",
"validity_end_date" : "2022-11-01",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id_type" : "PAYID",
"payid_details" : {
"payid_type" : "TELI",
"payid" : "+61-474109810",
"payid_name" : "Test"
}
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUCN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2022-11-01"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2022-11-01"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"count_per_period" : "3",
"frequency" : "INTRDY"
}
}
},
"message" : "Agreement has been either rejected by the debtor or the authorisation request has expired"
}
event_type: AGREEMENT_EXPIRATION_SUCCESS
Payer fails to respond to the agreement authorisation request
{
"event_type" : "AGREEMENT_EXPIRATION_SUCCESS",
"id" : "3949c423-20da-4897-b832-2376d96bdb82",
"data" : {
"agreement_uuid" : "3949c423-20da-4897-b832-2376d96bdb82",
"user_external_id" : "buyer-149474132",
"status" : "CANCELLED",
"status_description" : "Agreement has been cancelled",
"status_reason_code" : "UnapprovedAgreementValidityExpired",
"status_reason_description" : "Validity of the agreement has expired before Payer authorization.",
"created_at" : "2022-10-31 04:59:08.196983",
"updated_at" : "2022-10-31 14:00:31.312155",
"agreement_info" : {
"agreement_id" : "fe57359f2bd317b796df377c3ef5d138",
"description" : "agreement desc",
"short_description" : "short desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2022-10-31",
"validity_end_date" : "2022-10-31",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id" : "802950111111111",
"account_id_type" : "BBAN"
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "J5865SAE",
"debtor_id_type" : "BANK",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUBN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "BALN"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2022-10-31"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2022-10-31"
},
"payment_executed_not_before_time" : "02:30:19Z",
"count_per_period" : "200",
"frequency" : "ADHOC"
}
}
},
"message" : "Agreement has been cancelled"
}
event_type: AGREEMENT_PAUSE_SUCCESS
Agreement status change success
{
"event_type" : "AGREEMENT_PAUSE_SUCCESS",
"id" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"data" : {
"agreement_uuid" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"user_external_id" : "buyer-149930547",
"status" : "SUSPENDED",
"status_description" : "Agreement has been suspended by debtor",
"status_reason_code" : "ContractAmended",
"status_reason_description" : "External arrangement (or contract) between the Payer and the Initiating Party has been amended. Additional Information: suspending agreement",
"created_at" : "2022-11-01 06:50:05.196983",
"updated_at" : "2022-11-01 06:59:13.312155",
"agreement_info" : {
"agreement_id" : "83da8db97d921c20bbcacacc30b09aae",
"description" : "desc",
"short_description" : "short desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2023-10-31",
"validity_end_date" : "2048-08-25",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id_type" : "PAYID",
"payid_details" : {
"payid_type" : "TELI",
"payid" : "+61-474109810",
"payid_name" : "Test"
}
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUCN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2048-07-30"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2048-07-31"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"count_per_period" : "3",
"frequency" : "INTRDY"
}
}
},
"message" : "Agreement has been suspended by debtor"
}
event_type: AGREEMENT_RESUME_SUCCESS
Agreement status change success
{
"event_type" : "AGREEMENT_RESUME_SUCCESS",
"id" : "0f40d2f0-ca8f-4b5d-9724-a5eb817c52f0",
"data" : {
"agreement_uuid" : "0f40d2f0-ca8f-4b5d-9724-a5eb817c52f0",
"user_external_id" : "buyer-179113324",
"status" : "ACTIVE",
"status_description" : "Agreement has been resumed by debtor",
"created_at" : "2023-10-04 07:01:41.006546",
"updated_at" : "2023-10-04 07:02:37.503046",
"agreement_info" : {
"agreement_id" : "d81ca6ecd43b1c8e826031a671dbe621",
"description" : "desc",
"purpose_code" : "MORT",
"agreement_type" : "MGCR",
"automatic_renewal" : false,
"validity_start_date" : "2023-10-04",
"validity_end_date" : "2023-10-11",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id" : "802950123456780",
"account_id_type" : "BBAN"
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320123456789",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUBN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2023-10-05"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2023-10-05"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"point_in_time" : "05",
"frequency" : "INTRDY"
}
}
},
"message" : "Agreement has been resumed by debtor"
}
event_type: AGREEMENT_CANCELLATION_SUCCESS
Agreement status change succes
{
"event_type" : "AGREEMENT_CANCELLATION_SUCCESS",
"id" : "0d934ff2-2445-4636-bdbc-329063ffa1a1",
"data" : {
"agreement_uuid" : "0d934ff2-2445-4636-bdbc-329063ffa1a1",
"user_external_id" : "buyer-179113324",
"status" : "CANCELLED",
"status_description" : "Agreement has been cancelled",
"status_reason_code" : "ClosedAccount",
"status_reason_description" : "Account provided is closed.",
"created_at" : "2023-10-05 04:04:58.858483",
"updated_at" : "2023-10-05 04:08:44.773817",
"agreement_info" : {
"agreement_id" : "7dbada3eecc717aa822b5a5ccebb05a6",
"description" : "desc",
"purpose_code" : "MORT",
"agreement_type" : "MGCR",
"automatic_renewal" : false,
"validity_start_date" : "2023-10-05",
"validity_end_date" : "2023-10-12",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id" : "802950123456780",
"account_id_type" : "BBAN"
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320123456789",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUBN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2023-10-06"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2023-10-06"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"point_in_time" : "05",
"frequency" : "INTRDY"
}
}
},
"message" : "Agreement has been cancelled"
}
event_type: AGREEMENT_AMENDMENT_SUCCESS
Unilateral amendment success
{
"event_type" : "AGREEMENT_AMENDMENT_SUCCESS",
"id" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"original_request" : {
"priority" : "ATTENDED",
"unilateral_amendments" : {
"description" : "desc updated wapi"
}
},
"data" : {
"agreement_uuid" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"user_external_id" : "buyer-149930547",
"status" : "SUSPENDED",
"status_description" : "",
"status_reason_code" : "ContractAmended",
"status_reason_description" : "External arrangement (or contract) between the Payer and the Initiating Party has been amended. Additional Information: suspending agreement",
"created_at" : "2022-11-01 06:50:05.196983",
"updated_at" : "2022-11-01 07:00:16.312155",
"agreement_info" : {
"agreement_id" : "83da8db97d921c20bbcacacc30b09aae",
"description" : "desc updated wapi",
"short_description" : "short desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2023-10-31",
"validity_end_date" : "2048-08-25",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id_type" : "PAYID",
"payid_details" : {
"payid_type" : "TELI",
"payid" : "+61-474109810",
"payid_name" : "Test"
}
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUCN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2048-07-30"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2048-07-31"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"count_per_period" : "3",
"frequency" : "INTRDY"
}
}
}
}
event_type: AGREEMENT_AMENDMENT_SUCCESS
Payer approves bilateral amendment
{
"event_type" : "AGREEMENT_AMENDMENT_SUCCESS",
"id" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"data" : {
"agreement_uuid" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"user_external_id" : "buyer-149930547",
"status" : "SUSPENDED",
"status_description" : "Agreement has been suspended by debtor",
"status_reason_code" : "ContractAmended",
"status_reason_description" : "External arrangement (or contract) between the Payer and the Initiating Party has been amended. Additional Information: suspending agreement",
"created_at" : "2022-11-01 06:50:05.196983",
"updated_at" : "2022-11-01 07:04:55.312155",
"agreement_info" : {
"agreement_id" : "83da8db97d921c20bbcacacc30b09aae",
"description" : "desc updated wapi",
"short_description" : "short desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2023-10-31",
"validity_end_date" : "2048-08-25",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id_type" : "PAYID",
"payid_details" : {
"payid_type" : "TELI",
"payid" : "+61-474109810",
"payid_name" : "Test"
}
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUCN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1001",
"currency" : "AUD",
"type" : "VARI"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2048-07-30"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2048-07-31"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:31:19Z",
"count_per_period" : "4",
"frequency" : "DAILY"
}
}
},
"message" : "Amend details request is confirmed by debtor."
}
event_type: AGREEMENT_AMENDMENT_REJECTION_SUCCESS
Payer rejects bilateral amendment
{
"event_type" : "AGREEMENT_AMENDMENT_REJECTION_SUCCESS",
"id" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"data" : {
"agreement_uuid" : "e8632769-3d26-4f7f-98b0-eb6d92a4bd83",
"user_external_id" : "buyer-149930547",
"status" : "SUSPENDED",
"status_description" : "Agreement has been suspended by debtor",
"status_reason_code" : "ContractAmended",
"status_reason_description" : "External arrangement (or contract) between the Payer and the Initiating Party has been amended. Additional Information: suspending agreement",
"reject_reason_code" : "NPPTransactionNotSupported",
"reject_reason_description" : "Transaction not supported on the provided Payer account - does not support NPP payments. Additional Information: tx not suported decline amendment",
"created_at" : "2022-11-01 06:50:05.196983",
"updated_at" : "2022-11-01 07:07:40.312155",
"agreement_info" : {
"agreement_id" : "83da8db97d921c20bbcacacc30b09aae",
"description" : "desc updated wapi",
"short_description" : "short desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2023-10-31",
"validity_end_date" : "2048-08-25",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id_type" : "PAYID",
"payid_details" : {
"payid_type" : "TELI",
"payid" : "+61-474109810",
"payid_name" : "Test"
}
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUCN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1001",
"currency" : "AUD",
"type" : "VARI"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2048-07-30"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2048-07-31"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:31:19Z",
"count_per_period" : "4",
"frequency" : "DAILY"
}
}
},
"message" : "Amend details request is declined by debtor."
}
event_type: AGREEMENT_AMENDMENT_EXPIRATION_SUCCESS
Payer did not respond to the bilateral amendment request
{
"event_type" : "AGREEMENT_AMENDMENT_EXPIRATION_SUCCESS",
"id" : "fe7a96d5-273b-4de6-bc9c-6180e1cdde7c",
"original_request" : {
"priority" : "ATTENDED",
"bilateral_amendments" : {
"transfer_arrangement" : "NEW TRANSFER ARRANGEMENT 4"
}
},
"data" : {
"agreement_uuid" : "fe7a96d5-273b-4de6-bc9c-6180e1cdde7c",
"user_external_id" : "buyer-145871516",
"status" : "ACTIVE",
"status_reason_code" : "",
"created_at" : "2022-09-14 13:10:45.196983",
"updated_at" : "2022-09-14 13:30:24.312155",
"agreement_info" : {
"agreement_id" : "de93bdcb6a4410e0b720f840fba4e2e2",
"description" : "desc",
"purpose_code" : "MORT",
"agreement_type" : "MGCR",
"automatic_renewal" : false,
"validity_start_date" : "2022-09-14",
"validity_end_date" : "2022-09-21",
"transfer_arrangement" : "NEW TRANSFER ARRANGEMENT 2",
"debtor_info" : {
"debtor_account_details" : {
"account_id" : "802950123456780",
"account_id_type" : "BBAN"
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUBN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2022-09-15"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2022-09-15"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"point_in_time" : "05",
"frequency" : "INTRDY"
}
}
},
"message" : "Amend details request is expired by debtor."
}
event_type: AGREEMENT_RECALL_SUCCESS
Agreement creation/bilateral amendment has been successfully recalled
{
"event_type" : "AGREEMENT_RECALL_SUCCESS",
"id" : "75244919-f02c-4f19-b4a1-35a5ed440baf",
"data" : {
"agreement_uuid" : "75244919-f02c-4f19-b4a1-35a5ed440baf",
"user_external_id" : "buyer-162681335",
"status" : "CANCELLED",
"status_description" : "Agreement has been cancelled",
"created_at" : "2023-03-28 03:31:10",
"updated_at" : "2023-03-28 03:31:30",
"agreement_info" : {
"agreement_id" : "64acd7904e4b1f9c82282d46a541da62",
"description" : "desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2023-03-28",
"validity_end_date" : "2023-04-04",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id" : "802950123456780",
"account_id_type" : "BBAN"
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUBN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2023-03-29"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2023-03-29"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"point_in_time" : "05",
"frequency" : "INTRDY"
}
}
},
"message" : "Agreement recall action has been resolved successfully"
}
event_type: AGREEMENT_RECALL_REJECTED
Agreement creation/bilateral amendment request cannot be recalled as either the agreement is not in valid state or the debtor has already approved the agreement or amendment request.
{
"event_type" : "AGREEMENT_RECALL_REJECTED",
"id" : "489793ec-7489-453c-8a2b-9fe64c878168",
"data" : {
"agreement_uuid" : "489793ec-7489-453c-8a2b-9fe64c878168",
"user_external_id" : "buyer-162681335",
"status" : "ACTIVE",
"status_description" : "Agreement has been approved by the debtor",
"reject_reason_code" : "RecallCreationRejectApprove",
"reject_reason_description" : "Recall creation was rejected - Agreement was approved by payer",
"created_at" : "2023-03-28 04:39:14",
"updated_at" : "2023-03-28 04:44:14",
"agreement_info" : {
"agreement_id" : "e831f594c1fe143d9e8f42fed812ec7a",
"description" : "desc",
"purpose_code" : "MORT",
"agreement_type" : "AUPM",
"automatic_renewal" : false,
"validity_start_date" : "2023-03-28",
"validity_end_date" : "2023-04-04",
"transfer_arrangement" : "transfer arrangement",
"debtor_info" : {
"debtor_account_details" : {
"account_id" : "802950123456780",
"account_id_type" : "BBAN"
},
"debtor_details" : {
"debtor_name" : "paytozaitest",
"debtor_type" : "ORGN",
"ultimate_debtor_name" : "ultimate name",
"debtor_id" : "[email protected]",
"debtor_id_type" : "EMPL",
"debtor_reference" : "debtor reference"
}
},
"creditor_info" : {
"creditor_account_details" : {
"account_id" : "803320222222222",
"account_id_type" : "BBAN"
},
"creditor_details" : {
"creditor_id" : "96637632645",
"creditor_id_type" : "AUBN",
"creditor_name" : "Zai Australia Pty. Ltd.",
"creditor_type" : "ORGN",
"ultimate_creditor_name" : "ultimate creditor name",
"creditor_reference" : "creditor reference"
}
},
"payment_initiator_info" : {
"initiator_id" : "96637632645",
"initiator_id_type_code" : "AUBN",
"initiator_legal_name" : "Zai Australia Pty. Ltd.",
"initiator_name" : "Zai"
},
"payment_terms" : {
"payment_amount_info" : {
"amount" : "1000",
"currency" : "AUD",
"type" : "USGB"
},
"first_payment_info" : {
"amount" : "1500",
"currency" : "AUD",
"date" : "2023-03-29"
},
"last_payment_info" : {
"amount" : "2000",
"currency" : "AUD",
"date" : "2023-03-29"
},
"maximum_amount_info" : {
"amount" : "5000",
"currency" : "AUD"
},
"payment_executed_not_before_time" : "02:30:19Z",
"point_in_time" : "05",
"frequency" : "INTRDY"
}
}
},
"message" : "Agreement recall action has been rejected"
}
PayTo Payments object - payto_payments (Australia)
event_type: PAYMENT_INITIATION_COMPLETED
{
"event_type" : "PAYMENT_INITIATION_COMPLETED",
"id" : "689de714-06a6-4bf1-9a38-0dd437cb800a",
"original_request" : {
"priority" : "ATTENDED",
"payment_info" : {
"instructed_amount" : "20",
"last_payment" : false,
"end_to_end_id" : "0h40f9595b7449b98353c97c039436",
"remittance_info" : "Remittance Info",
"unique_superannuation_id" : "unique superannuation id",
"unique_superannuation_code" : "unique superannuation code"
},
"retry_info": {
"payment_request_uuid": "79ed9367-d489-40f6-89c2-dd2bf4302efc"
}
},
"data" : {
"payment_request_uuid" : "689de714-06a6-4bf1-9a38-0dd437cb800a",
"instruction_id" : "PRTYAU31XXXI20221101000000000007570",
"agreement_uuid" : "f4294266-01f2-467c-b178-20f128a5006e",
"agreement_id" : "1858c27fff8c1d6e813ecfccecfbeebd",
"status" : "PAYMENT_INITIATION_COMPLETED",
"status_description" : "Payment initiation request has completed - funds have been collected from debtor's account",
"payment_reconciled" : null,
"created_at" : "2022-11-01 07:55:52",
"updated_at" : "2022-11-01 07:55:56",
"payment_info" : {
"instruction_id" : "PRTYAU31XXXI20221101000000000007570",
"instructed_amount" : "20",
"last_payment" : false,
"end_to_end_id" : "0h40f9595b7449b98353c97c039436",
"remittance_info" : "Remittance Info",
"unique_superannuation_id" : "unique superannuation id",
"unique_superannuation_code" : "unique superannuation code"
}
},
"message" : "SUCCESSFUL"
}
event_type: PAYMENT_INITIATION_REJECTED
{
"event_type" : "PAYMENT_INITIATION_REJECTED",
"id" : "4b6305ed-16ad-46ac-8a7f-69c0f52ca7c5",
"original_request" : {
"priority" : "ATTENDED",
"payment_info" : {
"instructed_amount" : "160",
"last_payment" : false,
"remittance_info" : "REJECT_PAYMENT_NO_RETRY",
"unique_superannuation_id" : "unique superannuation id",
"unique_superannuation_code" : "unique superannuation code"
},
"retry_info": {
"payment_request_uuid": "79ed9367-d489-40f6-89c2-dd2bf4302efc"
}
},
"data" : {
"payment_request_uuid" : "4b6305ed-16ad-46ac-8a7f-69c0f52ca7c5",
"instruction_id" : "PRTYAU31XXXI20230117000000000000870",
"agreement_uuid" : "8675651c-3a84-403f-b026-5b54605852d3",
"agreement_id" : "16867940963811edadf5c3b773f26339",
"status" : "PAYMENT_INITIATION_REJECTED",
"status_description" : "Payment initiation request has been rejected",
"status_reason_code" : "PayerAccountClosed",
"status_reason_description" : "Payer account provided is closed. Please update the agreement with correct account details and try again.",
"payment_reconciled" : null,
"created_at" : "2023-01-17 07:26:43",
"updated_at" : "2023-01-17 07:26:49",
"payment_info" : {
"instruction_id" : "PRTYAU31XXXI20230117000000000000870",
"instructed_amount" : "160",
"last_payment" : false,
"remittance_info" : "REJECT_PAYMENT_NO_RETRY",
"unique_superannuation_id" : "unique superannuation id",
"unique_superannuation_code" : "unique superannuation code"
}
},
"message" : "FAILED"
}
Transaction Failure Advice object - transaction_failure_advice (Australia)
event_type: transaction_failure_advice
PayTo payment cannot be reconciled in the debtor user's wallet in Zai. Funds debited from the debtor user's bank account will be refunded back automatically by Zai.
{
"event_type": "transaction_failure_advice",
"id": "0e689310-91a1-11ed-8336-f9f541d2eff8",
"debtor_name": "Test Assembly",
"debtor_bsb": "814283",
"debtor_account": "814283711967000",
"creditor_account": "230680100000016",
"creditor_name": "Creditor Name",
"remittance_information": "Remittance Info",
"type": "deposit",
"type_method": "npp_payin",
"error_message": "Payment reconciliation failed on the user's wallet as the agreement associated with it is not active.",
"npp_details": {
"pay_id": "",
"pay_id_type": "",
"clearing_system_transaction_id": "PRTYAU31XXXN2080100301673435643499",
"end_to_end_id": "test_Happy",
"cdtr_ref_inf": "test_Happy",
"ultm_cdtr_id": "",
"ultm_cdtr_scheme_nm": "",
"ultm_cdtr_nm": "",
"ctgy_purp": "",
"debtor_legal_name": "Test Assembly",
"instruction_id": "PRTYAU31XXXI20230111000000000000380",
"agreement_id": "070e190091a111edbf0ffdda16d3c1ca",
"agreement_uuid": "a4298099-d04b-4a52-b1b4-54038688eb2d"
},
"links": {
"self": "/payment_details/failed/PRTYAU31XXXI20230111000000000000380",
"agreements": "/payto/agreements/a4298099-d04b-4a52-b1b4-54038688eb2d"
}
}
Updated 7 months ago