Create Bank Account Beneficiary

post

https://api.zwitch.io/v1/accounts/{account_id}/beneficiaries

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

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

Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI

Body Params

type

string

required

Defaults to account_number

Type of account details linked to the beneficiary.

Possible value:

account_number

name_of_account_holder

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]

phone

string

Beneficiary's phone number.

Example: 9876543210

bank_account_number

string

required

Beneficiary's bank account number.

Example: 98765432101234

bank_ifsc_code

string

required

Beneficiary's bank IFSC.

Example: HDFC0000123

bank_name

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

200200

401401

422422