Get a payout account transaction

GET

/v2/payments/payout/history/{id}

Requires DISBURSEMENTS_READ, granted by PAYMENTS_READ or DISBURSEMENTS_WRITE (bundles)

Returns one transaction on your payout account.

Parameters

Path Parameters

id*

Transaction ID.

Type

string

Required

Example"e3f5a7b9-1c2d-4e6f-8a0b-2c4d6e8f0a1b"

Format

"uuid"

Responses

OK

Content-Type

application/json

{

"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

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
400	-11INVALID_REQUEST	The transaction ID isn't a valid UUID.
403	-16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED	Payments haven't been set up for your business yet.
404	NOT_FOUND	No payout account transaction with this ID exists on your account.
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.