v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Create Bank Account Beneficiary

Use this API to add a bank account beneficiary to an account.

post/v1/accounts/{account_id}/beneficiaries

Path parameters

account_idstring required

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

Request body

typestring required

Type of account details linked to the beneficiary. Possible value:<ul><li>account_number</li></ul>

name_of_account_holderstring required

Beneficiary's name. Supported 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

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

phonestring

Beneficiary's phone number. Example: 9876543210

bank_account_numberstring required

Beneficiary's bank account number. Example: 98765432101234

bank_ifsc_codestring required

Beneficiary's bank IFSC. Example: HDFC0000123

bank_namestring

Beneficiary bank name

Response

200

idstring

objectstring

typestring

name_of_account_holderstring

emailstring

phonestring

bank_account_numberstring

bank_ifsc_codestring

bank_namestring

created_atinteger

statusstring

is_sandboxboolean

account_idstring

Example response

{
  "id": "vab_8nz7xTrqvRfuq0jVQz8ulLTnD",
  "object": "beneficiary.account_number",
  "type": "account_number",
  "name_of_account_holder": "Anil Reddy",
  "email": "anil.reddy@example.com",
  "phone": "9000000138",
  "bank_account_number": "59817294880101",
  "bank_ifsc_code": "ICIC0000001",
  "bank_name": "ICICI Bank",
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "created_at": 1742463922,
  "status": "active",
  "is_sandbox": true,
  "account_id": "va_dPDp6bNcs7mIrWPsO0kle5o6T"
}