Get a beneficiary

GET

/v2/payments/bulk-withdrawals/beneficiaries/{id}

Requires DISBURSEMENTS_READ, granted by PAYMENTS_READ or DISBURSEMENTS_WRITE (bundles)

Returns a beneficiary, active or archived.

Parameters

Path Parameters

id*

Beneficiary ID.

Type

string

Required

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

Format

"uuid"

Responses

OK

Content-Type

application/json

{

"id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",

"bank": "FNB",

"bankDisplayName": "FNB/RMB",

"accountHolder": "Thandi Nkosi",

"accountNumberMasked": "*******0327",

"accountNumber": "62845190327",

"branchCode": "250655",

"accountType": "CHEQUE",

"email": "thandi@example.com",

"type": "INDIVIDUAL",

"tradingName": null,

"reference": "SALARY",

"country": "ZA",

"createdAt": "2026-09-01T10:12:30.004Z",

"updatedAt": "2026-10-23T08:15:02.010Z",

"lastPaidAt": "2026-10-23T08:15:03.204Z",

"deletedAt": null,

"deletedBy": null

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
400	-11INVALID_REQUEST	The beneficiary 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 beneficiary 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.