Sign in

v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Add Bank (Remitter/Beneficiary)

The Add Bank API allows the API user to add the details of the bank for both the Remitter and Beneficiary.

put/v1/client/bank

Query parameters

userAccountIdstring required

The account ID for the Remitter or Beneficiary that the Bank Account needs to be added for

Headers

api-keystring required

API Key

auth-keystring required

Auth key generated via the "Generate Auth key API"

userIdstring required

User Id as generated via the "Create Account (sign-Up) API". Identifier of an individual user, you can map this to the User identification at your end.

Request body

accountHolderNamestring required

Bank Account holder name of remitter/beneficiary

bankNamestring required

Name of the Bank of the Remitter/Beneficiary

accountNostring required

Account number of the account holder at the Bank to be added

bankAccountTypestring required

Type of Bank Account to be added. It can be one of the following inputs; ["savings", "checking", "other", "current"]

bankAddressstring required

Bank Address of the recipient bank

swiftCodestring

Swift Code of the non Indian bank (Mandatory for Bene Bank)

shortCodestring

Short Code (alternate:SortCode) is the Transfer Code for UK Banks

routingNostring

Routing Number is the Transfer Code for US Banks

ifscCodestring

IFSC Code is an 11-digit alphanumeric code unique to each bank branch (Mandatory for Remitter Bank) in India

ibanNostring

IBAN Number (International Banking Number) is the international transfer code for the Bank Accounts in for European Banks (Barring UK Banks)

bsbCodestring

BSB Code is the Transfer Code for Australian Banks

branchstring

Branch Name of the recipient Bank

branchCodestring

Branch Code of the recipient bank

bankCodestring

Bank Code of the recipient bank

bankCitystring

City of the recipient bank's address

bankStatestring

State of the recipient bank's address

bankCountrystring

Country of the recipient bank's address (CAPITALs only)

bankPostalCodestring

Postal Code of the recipient bank's address

remarksstring

Optional remarks by the API user

Response

200

statusinteger
messagestring

Example response

{
  "status": 200,
  "message": "Success",
  "data": {
    "bankId": "47964a15-e7be-400e-9504-014af6d99d48",
    "createdAt": "2024-03-01T09:54:12.578Z"
  }
}