v1
latestOpenAPI 3.0.02026-07-24126202516.7 KBDisbursements
List Disbursements
Retrieve an ordered and paginated list of existing Disbursements. The list can be filtered by Batch ID.
get/disbursements
Query parameters
limitinteger
Number of records to retrieve. Up to 200.
offsetinteger
Number of records to offset. Required for pagination.
batch_idstring
Batch ID.
Response
OK
Example response
{
"disbursements": [
{
"id": "ad688d54-6791-4f1d-add7-88fbd89b70d1",
"reference_id": "7190770-1-2908",
"amount": 10000,
"currency": "AUD",
"state": "pending",
"to": "Bank Account",
"bank_name": "Bank of Australia",
"bank_account_name": "Samuel Seller",
"bank_account_number": "XXX234",
"bank_routing_number": "XXXXX3",
"npp_payout_state": "trying",
"account_name": "My Water Company",
"biller_name": "ABC Water",
"crn": "0987654321",
"links": {
"transactions": "/disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/transactions",
"wallet_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/wallet_accounts",
"paypal_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/paypal_accounts",
"bank_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/bank_accounts",
"bpay_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/bpay_accounts",
"items": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/items",
"users": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/users"
}
}
]
}