Last updated 3 months ago
Retrieve a paginated list of all the beneficiaries on the merchant's profile.
Bank and inter-merchant beneficiary lists are retrieved separately.
/v1/beneficiaries/list-bank-beneficiaries
curl -L \ --url '/v1/beneficiaries/list-bank-beneficiaries' \ --header 'Authorization: YOUR_API_KEY'
{ "status": "success", "message": "text", "meta": { "page_meta": { "page_count": 1, "item_count": 1, "search": "text", "page": 1, "page_size": 1 } }, "is_error": true, "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:22:56.368Z", "edited_at": "2025-02-20T19:22:56.368Z" } ], "errors": { "ANY_ADDITIONAL_PROPERTY": [ "text" ] } }
/v1/beneficiaries/list-gateway-beneficiaries
curl -L \ --url '/v1/beneficiaries/list-gateway-beneficiaries' \ --header 'Authorization: YOUR_API_KEY'
{ "status": "success", "message": "text", "meta": { "page_meta": { "page_count": 1, "item_count": 1, "search": "text", "page": 1, "page_size": 1 } }, "is_error": true, "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-02-20T19:22:56.368Z", "edited_at": "2025-02-20T19:22:56.368Z" } ], "errors": { "ANY_ADDITIONAL_PROPERTY": [ "text" ] } }
