Manage Beneficiaries (To be deprecated)

🙌

Important Note

Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.

API Endpoints

Add / Update / Disable any beneficiary for sending money from the virtual account (on top of the underlying physical bank account)

Body Params
string
required

Can be ADD/ VERIFY/ UPDATE/ DEACTIVATE/ DELETE

string
required

Beneficiary bank IFSC code

string

Account number against which the beneficiary is to be added. If not passed, beneficiary will be added to company's virtual account

string
required

Beneficiary account number

string
required

Unique code assigned by you to the beneficiary. Mandatory only if action is not ADD

string
required

Can be NEFT/ IMPS/ RTGS/ OTHR (for the beneficiary to support all incoming transfer types). If not specified for the ADD action, defaulted to OTHR. Optional only if action is ADD

string
required

A valid currency code value such as INR

string

Beneficiary name to be added, Alphanumeric characters are allowed but special characters such as “@ # $ % ^ & * ! ; : ~ ` ? = + ) ( apostrophe, double quotes” are not allowed. Minimum length is 5 characters and Maximum length is 255 characters

string

A valid email address for the beneficiary. Mandatory only if action is ADD; Optional in case of all other action types

string

Beneficiary mobile number. Mandatory only if action is ADD; Optional in case of all other action types

int32

If the beneficiary needs to be notified by email for transfers. 0 by default

int32

If the beneficiary needs to be notified by SMS for transfers. 0 by default

Headers
string
required
string
required
string
required

Use the accounts module secret

string
required
Response

Response body
Language