List all beneficiaries

Retrieve a paginated list of all the beneficiaries on the merchant's profile.

Bank and inter-merchant beneficiary lists are retrieved separately.

List bank transfer beneficiaries

Retrieve a paginated list of bank transfer beneficiaries.

GET/v1/beneficiaries/list-bank-beneficiaries

Query parameters

Response

200

Success

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

datanullable array of ViewBankBeneficiaryDto (object)

metaPagedMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/beneficiaries/list-bank-beneficiaries', {
    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:52:19.214Z",
      "edited_at": "2024-11-16T16:52:19.214Z"
    }
  ],
  "meta": {
    "page_meta": {
      "search": "text"
    }
  },
  "is_error": false
}

List inter-merchant disbursement beneficiaries

List gateway beneficiaries

GET/v1/beneficiaries/list-gateway-beneficiaries

Query parameters

Response

200

Success

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

datanullable array of ViewGatewayBeneficiaryDto (object)

metaPagedMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/beneficiaries/list-gateway-beneficiaries', {
    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",
      "merchant_id_or_code": "text",
      "merchant_name": "text",
      "gateway_name": "text",
      "recipient_gateway_code": "text",
      "created_at": "2024-11-16T16:52:19.214Z",
      "edited_at": "2024-11-16T16:52:19.214Z"
    }
  ],
  "meta": {
    "page_meta": {
      "search": "text"
    }
  },
  "is_error": false
}