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

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

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/beneficiaries/bank-beneficiary/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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-02-20T19:29:50.726Z",
    "edited_at": "2025-02-20T19:29:50.726Z"
  },
  "meta": {},
  "is_error": true,
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Success

Retrieve a gateway beneficiary by id.

get

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

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/beneficiaries/gateway-beneficiary/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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-02-20T19:29:50.726Z",
    "edited_at": "2025-02-20T19:29:50.726Z"
  },
  "meta": {},
  "is_error": true,
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Success