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}

Path parameters

id*string

Response

200

Success

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

dataViewBankBeneficiaryDto (object)

metaNoMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/beneficiaries/bank-beneficiary/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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": "2024-11-16T16:42:31.937Z",
    "edited_at": "2024-11-16T16:42:31.937Z"
  },
  "is_error": false
}

Retrieve a gateway beneficiary by id.

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

Path parameters

id*string

Response

200

Success

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

dataViewBankBeneficiaryDto (object)

metaNoMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/beneficiaries/gateway-beneficiary/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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": "2024-11-16T16:42:31.937Z",
    "edited_at": "2024-11-16T16:42:31.937Z"
  },
  "is_error": false
}