Create Bank Account Beneficiary

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

Path Params
string
required

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

Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI

Body Params
string
required
Defaults to account_number

Type of account details linked to the beneficiary.

Possible value:

  • account_number

string
required

Beneficiary's name.

Supported characters:

  • a-z
  • A-Z
  • 0-9
  • space
  • -
  • _
  • /
  • (
  • )
  • .
  • &
  • #
  • $
  • @
Example: Anil Reddy

string

Beneficiary's email address.

Example: [email protected]

string

Beneficiary's phone number.

Example: 9876543210

string
required

Beneficiary's bank account number.

Example: 98765432101234

string
required

Beneficiary's bank IFSC.

Example: HDFC0000123

string

Beneficiary bank name

metadata
object

Key-value pair that can be used to store additional information about the entity.

  • Each pair cannot exceed 256 characters.
  • Maximum 5 key-value pairs.
Example: "key_1": "DD”

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json