v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Get Beneficiary by ID

Use this API to get details of the specified beneficiary.

get/v1/accounts/beneficiaries/{beneficiary_id}

Path parameters

beneficiary_idstring required

Unique identifier of the beneficiary for which details should be returned.<br><br>Example: vab_EFQeD9s8dPOqsPEUZPELmpgwm

Response

200

idstring

objectstring

typestring

name_of_account_holderstring

emailstring

phonestring

bank_account_numberstring

bank_ifsc_codestring

{"stackTrail":"paths:/v1/accounts/beneficiaries/{beneficiary_id}:get:responses:200:content:application/json:schema:properties:bank_name","oasType":"schema","type":"unknown"}

created_atinteger

statusstring

is_sandboxboolean

account_idstring

Example response

{
  "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"
}