v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Update Beneficiary

Use this API to update the details of a beneficiary.

post/v1/accounts/beneficiaries/{beneficiary_id}

Path parameters

beneficiary_idstring required

Unique identifier of the beneficiary that should be updated. Example: vab_EFQeD9s8dPOqsPEUZPELmpgwm

Request body

name_of_account_holderstring

Account holder's name. Allowed characters: <ul><li>a-z</li><li>A-Z</li><li>0-9</li><li>space</li><li>’</li><li>-</li><li>_</li><li>/</li><li>(</li><li>)</li><li>.</li><li>&</li><li>#</li><li>$</li><li>@</ul></li>Example: Anil Reddy

emailstring

Account holder's email address. Example: anil.reddy@example.com

phonestring

Account holder's phone number. Example: 9876543210

Response

200

idstring

objectstring

typestring

name_of_account_holderstring

emailstring

phonestring

bank_account_numberstring

bank_ifsc_codestring

{"stackTrail":"paths:/v1/accounts/beneficiaries/{beneficiary_id}:post: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": "Gita Reddy",
  "email": "gita.reddy@example.com",
  "phone": "9988776655",
  "bank_account_number": "10000000000126",
  "bank_ifsc_code": "ABCD0000123",
  "metadata": {
    "key_1": "updated_DD",
    "key_2": "updated_XOF",
    "key_3": "MSF"
  },
  "created_at": 1645522073,
  "status": "active",
  "is_sandbox": true,
  "account_id": "va_gwWeSHZ48QK1gmiVebZWV3YdA"
}