Fetch a beneficiary

Fetch a beneficiary using their ID. The response includes the beneficiary's resolved account/merchant details.

Bank and inter-merchant beneficiaries are retrieved separately.

Retrieve a bank beneficiary by id.

get

Authorizations

Bearer

AuthorizationstringRequired

API Key as Bearer Token

Path parameters

idstringRequired

Responses

200

Success

application/json

statusstring · enumOptionalPossible values:

messagestring · nullableOptional

metaobjectOptional

is_errorbooleanRead-onlyOptional

get

/v1/beneficiaries/bank-beneficiary/{id}

HTTPcURLJavaScriptPython

GET /v1/beneficiaries/bank-beneficiary/{id} HTTP/1.1
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": "2026-02-19T21:39:09.542Z",
    "edited_at": "2026-02-19T21:39:09.542Z"
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}

Retrieve a gateway beneficiary by id.

get

Authorizations

Bearer

AuthorizationstringRequired

API Key as Bearer Token

Path parameters

idstringRequired

Responses

200

Success

application/json

statusstring · enumOptionalPossible values:

messagestring · nullableOptional

metaobjectOptional

is_errorbooleanRead-onlyOptional

get

/v1/beneficiaries/gateway-beneficiary/{id}

HTTPcURLJavaScriptPython

GET /v1/beneficiaries/gateway-beneficiary/{id} HTTP/1.1
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": "2026-02-19T21:39:09.542Z",
    "edited_at": "2026-02-19T21:39:09.542Z"
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}