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

Authorizations

Query parameters

searchstringOptional

pageinteger · int32Optional

page_sizeinteger · int32Optional

show_shadow_deletedbooleanOptional

Responses

get

HTTPcURLJavaScriptPython

GET /v1/beneficiaries/list-bank-beneficiaries 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-04-25T23:27:05.608Z",
      "edited_at": "2025-04-25T23:27:05.608Z"
    }
  ],
  "meta": {
    "page_meta": {
      "page_count": 1,
      "item_count": 1,
      "search": "text",
      "page": 1,
      "page_size": 1
    }
  },
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}

List inter-merchant disbursement beneficiaries

List gateway beneficiaries

get

Authorizations

Query parameters

searchstringOptional

pageinteger · int32Optional

page_sizeinteger · int32Optional

show_shadow_deletedbooleanOptional

Responses

get

HTTPcURLJavaScriptPython

GET /v1/beneficiaries/list-gateway-beneficiaries 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",
      "merchant_id_or_code": "text",
      "merchant_name": "text",
      "gateway_name": "text",
      "recipient_gateway_code": "text",
      "created_at": "2025-04-25T23:27:05.608Z",
      "edited_at": "2025-04-25T23:27:05.608Z"
    }
  ],
  "meta": {
    "page_meta": {
      "page_count": 1,
      "item_count": 1,
      "search": "text",
      "page": 1,
      "page_size": 1
    }
  },
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}