v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

GET Bank Account

The GET Bank Account API allows the API user to retrieve the details of the Bank Account registered against a Remitter or a Beneficiary

get/v1/client/bank

Query parameters

userAccountIdstring required

This field allows the API user to specify the Account ID for the Entity being queried

bankAccountIdstring

This field allows the API user to specify the Bank ID for the Bank Account being queried

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.

Response

200

statusinteger

messagestring

Example response

{
  "status": 200,
  "message": "Success",
  "data": [
    {
      "accountNumber": "50100117181231",
      "accountMasked": "XXXXXXXXXX1231",
      "accountHolderName": "Veronica Mars",
      "bankName": "HDFC Bank",
      "bankAddress": "HDFC Bangalore",
      "ifscCode": "HDFC0000000"
    }
  ]
}