List payout account transactions

GET

/v2/payments/payout/history

Requires DISBURSEMENTS_READ, granted by PAYMENTS_READ or DISBURSEMENTS_WRITE (bundles)

Returns the transactions on your payout account, newest first: debits for payouts, and credits for funding and reversed payouts. A reversed payout keeps its original debit, marked REVERSED, alongside a credit for the amount returned.

Parameters

Query Parameters

direction

DEBIT for money out (payouts) or CREDIT for money in (funding and reversals). Case-insensitive.

Type

string

Valid values

"DEBIT""CREDIT"

Example"DEBIT"

status

Only transactions with this status. Case-insensitive.

Type

string

Valid values

"COMPLETE""PROCESSING""REVERSED""FAILED"

Example"COMPLETE"

from

Only transactions at or after this time, in Unix milliseconds.

Type

integer

Example1790812800000

Format

"int64"

to

Only transactions before this time, in Unix milliseconds.

Type

integer

Example1793491200000

Format

"int64"

minAmount

Only transactions of at least this amount, before fees.

Type

number

Example1000

maxAmount

Only transactions of at most this amount, before fees.

Type

number

Example50000

exactAmount

Only transactions of exactly this amount, before fees.

Type

number

Example12500.75

query

Text to find in the payment reference or batch label.

Type

string

Example"salaries"

beneficiaryId

Only payouts to this beneficiary.

Type

string

Example"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"

Format

"uuid"

limit

Page size, from 1 to 200; values outside that range are clamped.

Type

integer

Default

50

offset

Number of items to skip.

Type

integer

Default

0

Responses

OK

Content-Type

application/json

{

"items": [

{

"id": "e3f5a7b9-1c2d-4e6f-8a0b-2c4d6e8f0a1b",

"direction": "DEBIT",

"kind": "WITHDRAWAL",

"status": "COMPLETE",

"amount": "12513.25",

"currency": "ZAR",

"date": 1792746164000,

"counterparty": "Thandi Nkosi",

"reference": "OCT SALARY",

"batchId": "5b9a3c1e-2f4d-4a7b-9c8e-1d2f3a4b5c6d",

"batchLabel": "October salaries",

"paymentId": null

},

{

"id": "4a6c8e0b-2d4f-4a1c-9e3b-5d7f9a1c3e5b",

"direction": "CREDIT",

"kind": "FUNDING",

"status": "COMPLETE",

"amount": "50000.00",

"currency": "ZAR",

"date": 1792654200000,

"counterparty": "Payout account",

"reference": "Funding",

"batchId": null,

"batchLabel": null,

"paymentId": "f9a1c3e5-7b2d-4f6a-8c0e-1d3f5a7b9c2e"

}

],

"total": 2,

"limit": 50,

"offset": 0,

"truncated": null

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
403	-16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED	Payments haven't been set up for your business yet.
500	INTERNAL_ERROR	Unexpected error in the payments service.
502	-16097EXCHANGE_API_ERROR	The payments service failed to process the request.
502	EXCHANGE_API_ERROR	The payments service couldn't complete the request. Try again later.
503	-16099PAYMENTS_BACKEND_PROXY_DISABLED	Payments endpoints are temporarily unavailable.

Plus the errors common to all signed endpoints.