Bank details

A bank account belongs to one of your end-users. Register it once, then reference its owner from a payment request via bankOwnerId. Each end-user can hold one bank account.

The bank detail object

Field	Type	Description
id	string	Unique identifier for the bank account.
ownerId	string	The end-user who owns this account. Must be one of your end-users.
ownerEmail	string	Email of the owning end-user, for convenience.
accountHolderName	string	Name as it appears on the bank account.
accountNumber	string	9–18 digits. Masked in responses — only the last 4 digits are returned.
ifscCode	string	11-character IFSC, e.g. HDFC0001234. Pattern: 4 letters, a 0, then 6 alphanumerics.
bankName	string	Name of the bank.
branchName	string (optional)	Branch name. Optional.
accountType	enum	SAVINGS or CURRENT.
createdAt	string (ISO 8601)	When the account was added.

GET/api/v1/bank-details

List bank details

Returns up to 100 bank accounts owned by your end-users, newest first.

200 Response

{
  "data": [
    {
      "id": "cmpqz8wf40001rzdot0kxuio0",
      "ownerId": "clx9p2k3a0000abc",
      "ownerEmail": "[email protected]",
      "accountHolderName": "Ada Lovelace",
      "accountNumber": "XXXXXXXX9012",
      "ifscCode": "HDFC0001234",
      "bankName": "HDFC Bank",
      "branchName": "MG Road",
      "accountType": "SAVINGS",
      "createdAt": "2026-05-29T13:48:10.912Z"
    }
  ]
}

POST/api/v1/bank-details

Add a bank account for an end-user

Required: ownerId (an end-user id), accountHolderName, accountNumber, ifscCode, bankName, accountType. Optional: branchName.

Request body

{
  "ownerId": "clx9p2k3a0000abc",
  "accountHolderName": "Ada Lovelace",
  "accountNumber": "123456789012",
  "ifscCode": "HDFC0001234",
  "bankName": "HDFC Bank",
  "branchName": "MG Road",
  "accountType": "SAVINGS"
}

Status	Meaning
400	Invalid body. `details` lists offending fields.
404	No end-user with that `ownerId` exists under your account.
409	This end-user already has a bank account on file.

PATCH/api/v1/bank-details/{id}

Update a bank account

Send any subset of the bank fields — at least one. The owner (ownerId) cannot be changed. Returns the updated account.

Request body

{
  "bankName": "ICICI Bank",
  "branchName": "Indiranagar"
}

Status	Meaning
400	Invalid body, or no fields provided.
404	No bank account with that id exists under your account.