Disbursement APIDisbursement

Get Transactions

View as Markdown
### Get Transactions The **Get Transactions** endpoint retrieves a list of all disbursement transactions associated with your account. You can use this to check the status of a specific payout. **Possible Statuses:** - `pending` - `completed` - `cancelled` > A payout is marked as `cancelled` if it failed or was cancelled — there is no separate `failed` status. No funds are transferred for a `cancelled` payout. #### Usage Tips Always filter by `reference_no` to look up the one payout you care about — unfiltered or broadly-filtered listing is discouraged and being phased out. Prefer webhooks (`callback_webhook_url`) over polling for routine status tracking.

Authentication

AuthorizationBearer

Bearer token obtained from the Create Access Token endpoint. Tokens are valid for ~60 minutes — cache and reuse a token for its full lifetime instead of re-authenticating per request.

Query parameters

reference_nostringOptional

Recommended. Look up a single transaction by the reference_no you supplied when creating it. This is the intended way to check a transaction’s status — avoid unfiltered listing.

provider_reference_nostringOptional
Filter by the upstream provider's reference number, when you have it.
channelstringOptional

Filter by channel code (see Get Channels).

statusenumOptional
Filter by transaction status.
Allowed values:
date_fromstringOptional

Start of a date-range filter. Use sparingly — avoid combining date ranges with unbounded pagination for routine polling.

date_tostringOptional

End of a date-range filter. Use sparingly — see date_from.

pageintegerOptional

Legacy pagination. Works today, but don’t build new integration logic around browsing pages of results — look up by reference_no instead.

per_pageintegerOptional<=100

Legacy pagination page size (max 100). See page.

Response

OK
messagestring
dataobject

Errors

401
Unauthorized Error