Fetch a beneficiary
Fetch a beneficiary using their ID. The response includes the beneficiary's resolved account/merchant details.
Authorizations
Path parameters
idstringRequired
Responses
200
Success
application/json
get
GET /v1/beneficiaries/bank-beneficiary/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
Success
{
"status": "success",
"message": "text",
"data": {
"id": "text",
"beneficiary_type": "bankAccount",
"currency": "text",
"country": "text",
"full_name": "text",
"email": "text",
"phone_number": "text",
"description": "text",
"account_number": "text",
"account_name": "text",
"bank_name": "text",
"bank_code": "text",
"created_at": "2025-07-07T02:32:52.934Z",
"edited_at": "2025-07-07T02:32:52.934Z"
},
"meta": {},
"errors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"is_error": true
}
Authorizations
Path parameters
idstringRequired
Responses
200
Success
application/json
get
GET /v1/beneficiaries/gateway-beneficiary/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
Success
{
"status": "success",
"message": "text",
"data": {
"id": "text",
"beneficiary_type": "bankAccount",
"currency": "text",
"country": "text",
"full_name": "text",
"email": "text",
"phone_number": "text",
"description": "text",
"account_number": "text",
"account_name": "text",
"bank_name": "text",
"bank_code": "text",
"created_at": "2025-07-07T02:32:52.934Z",
"edited_at": "2025-07-07T02:32:52.934Z"
},
"meta": {},
"errors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"is_error": true
}
Last updated