Query for account disbursements
You can GET the disbursements on an account using the following endpoint:
- GET
/billing/v1/accounts/{accountId}/disbursements
To query for individual disbursements, use the GET
/billing/v1/disbursements endpoint as described in Querying for disbursements.
GETing account disbursements looks like the following.
Command
GET /billing/v1/accounts/bc:9918/disbursements{
"count": 2,
"data": [
{
"attributes": {
"account": {
"displayName": "1000000000",
"id": "bc:9918",
"type": "Account",
"uri": "/billing/v1/accounts/bc:S1_1gxtPJZcvqAD1iAXCm"
},
"address": "test",
"amount": {
"amount": "50.00",
"currency": "usd"
},
"disbursementNumber": "1000000049",
"dueDate": "2027-01-29",
"id": "bc:STXQLsf8N4nuG34HMZMTL",
"mailTo": "customer Mail",
"payTo": "Customer name",
"paymentInstrument": {
"displayName": "Check",
"id": "bc:SllytDopRPwq1H16gYOrt",
"type": "UniversalPaymentInstrument",
"uri": "/billing/v1/universal-payment-instruments/bc:SllytDopRPwq1H16gYOrt"
},
"reason": {
"code": "Cancellation",
"name": "Cancellation"
},
"status": {
"code": "Approved",
"name": "Approved"
},
"unappliedFund": {
"displayName": "Default",
"id": "bc:S1YoNuXkVRnbVNMJVg9Yp",
"type": "UnappliedFund",
"uri": "/billing/v1/accounts/bc:S1_1gxtPJZcvqAD1iAXCm/unapplied-funds/bc:S1YoNuXkVRnbVNMJVg9Yp"
}
},
"checksum": "0",
"links": {
"approve": {
"href": "/billing/v1/disbursements/bc:STXQLsf8N4nuG34HMZMTL/approve",
"methods": [
"post"
]
},
"reject": {
"href": "/billing/v1/disbursements/bc:STXQLsf8N4nuG34HMZMTL/reject",
"methods": [
"post"
]
},
"reject-and-hold": {
"href": "/billing/v1/disbursements/bc:STXQLsf8N4nuG34HMZMTL/reject-and-hold",
"methods": [
"post"
]
},
"self": {
"href": "/billing/v1/disbursements/bc:STXQLsf8N4nuG34HMZMTL",
"methods": [
"get",
"patch"
]
},
"void": {
"href": "/billing/v1/disbursements/bc:STXQLsf8N4nuG34HMZMTL/void",
"methods": [
"post"
]
}
}
},
...
}
}