v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Get All Beneficiaries

Use this API to get all beneficiaries for an account.

get/v1/accounts/{account_id}/beneficiaries

Path parameters

account_idstring required

Unique identifier of the account to which the beneficiary is linked. Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI

Query parameters

start_afterstring

The beneficiary_id after which details should be returned. Use this with the results_per_page for pagination. Example: vab_EFQeD9s8dPOqsPEUZPELmpgwm

start_beforestring

The beneficiary_id before which details should be returned. Use this with the results_per_page for pagination. Example: vab_EFQeD9s8dPOqsPEUZPELmpgwm

results_per_pagestring

The number of results you want to get per API call. Use this with the start_before or start_after parameters for pagination. <ul><li>Default value 10.</li><li>Maximum value 100.</li></ul>Example: 15

from_datestring

Has to be used with to_date. The UNIX timestamp after which details should be returned. Use this with the results_per_page, start_after, and start_before for pagination. Example: 1651052818

to_datestring

Has to be used with from_date. The UNIX timestamp before which details should be returned. Use this with the results_per_page, start_after, and start_before for pagination. Example: 1651052818

Response

200

objectstring

has_moreboolean

Example response

{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "vab_ZfDkRA2ioO665Voe3WY3q9GOc",
      "object": "beneficiary.account_number",
      "type": "account_number",
      "name_of_account_holder": "Ganga Reddy",
      "email": "ganga.reddy@example.com",
      "phone": "9000000126",
      "bank_account_number": "10000000000126",
      "bank_ifsc_code": "ABCD0000123",
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "created_at": 1645522073,
      "status": "active",
      "is_sandbox": true,
      "account_id": "va_gwWeSHZ48QK1gmiVebZWV3YdA"
    }
  ]
}