API Reference

Callbacks

Suggest Edits

❗️

Important

We plan to deprecate our callbacks service. Until this is complete, please ensure that you register object types in both callbacks and webhooks within the Pre-live environment. Also note that if you're not getting any callbacks or webhooks, check that the object types are registered and enabled.

Callbacks (the legacy implementation to the improved service, webhooks) notify your platform and users of any state changes, helping complete the information loop when using the Zai service. Callbacks are a useful way of notifying you when statuses or transactions change. For example, 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.

Callbacks allow you to initiate dependent processes or notifications based on updates from Zai.

Types of Callbacks

Only one callback can be enabled for an object type. Each of these callbacks will return the response of the ‘Show’ of that object. For example, a callback for Items will return the GET /items/:id response.

Callback (object_type)TriggersExamples
Items
items		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
Users
users		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 Transactions
batch_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
Accounts
accounts		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
Transactions
transactions		On creation of any Transactions and whenever the state changes.Checking that a transaction has been created for a wallet account payment
Disbursements
disbursements		On creation of any disbursement.Checking that payout has been created for a seller or platform disbursement account.
Companies
companies		On creation or change of a companyChecking if a company's details have changed

Security

There are a few measures that can be taken to ensure callbacks are secure. Only HTTPS URLs are supported and require a valid SSL certificate. Self-signed certificates are not supported.

MethodDescription
IP whitelistingWhitelist the following IPs that callbacks will be sent from, noting the different environments:


Pre-live
13.236.213.54
13.237.52.66
13.237.231.88
54.183.18.207
54.183.142.227


Production
13.238.88.233
13.238.89.179
13.238.80.244
54.183.18.207
54.183.142.227
URL obfuscationWhen creating a callback POST endpoint, use an obfuscated URL to ensure it cannot be easily accessed by an insecure source. Example: https://example.com/callbacks/items/1bb77e2f892ebab9b2
Secondary API callUsing the ID provided within the callback, you can initiate another API call to fetch the resource from Zai once again. This ensures the request and response occur between both backends. Example: A callback of GET /items/:id reaches the endpoint. In the payload there is an ID. Using the ID, make a call to GET /items/:id to ensure the data is coming from the Zai API.

Walkthrough

Create a callback

Use Create Callback to create your callback within Zai. Pass a valid HTTPS URL that will accept a POST request. This URL will receive a POST call when the callback object is triggered. When creating a Callback, 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: 'Assembly Payments callback test'}

Trigger callback

To trigger a callback, update the object you have created a callback for. An example of this would be to Make Payment for an Item, if the callback you created was for an Item.

List callback responses

Use List Callback Responses to view a list of the triggers for the callback you created. Each time the callback is triggered, a response will be added.

Testing

There are a number of ways to start testing callbacks with Zai. We recommend services such as Request Bin and Runscope, both of which can be used to provide a container for all callbacks to be sent to.

Callback by payment

Payment1st Callback2nd Callback3rd Callback
Direct Credit Payoutbatch_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 Payoutbatch_transactions:
-type: disbursement
-type_method: bpay
-state: bank_processing		batch_transactions:
-type: disbursement
-type_method: bpay
-state: successful OR invalid_account_details
Realtime Payoutdisbursements:
-state: successful

OR

-state: cancelled
-npp_payout_state: failed
Card Payintransactions:
-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 Payinbatch_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 Payinbatch_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: successful

AND

transactions:
-type: deposit
-type_method: bpay
-state: successful
NPP Payintransactions:
-type: deposit
-type_method: npp_payin
-state: successful
Direct Credit Payintransactions:
-type: deposit
-type_method: direct_credit
-state: successful
Wallet to Item Transfertransactions:
-type: payment
-type_method: wallet_account_transfer
-state: successful

Examples

Transactions object

NPP Payin via PayID and CRN
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
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
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

{
    "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
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
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
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
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 callback
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
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
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
        }
    }
}

Updated over 1 year ago