Add Whitelist Account

Whitelist a bank account for an existing customer under UPI Collections.

Last updated: 2026-08-03

Endpoint (Requires Authentication)

POST /api/v1/connected-banking/public/upi-collection/whitelist

This API endpoint is used to whitelist a bank account for an existing customer under UPI Collections.

Note: A maximum of 5 accounts can be whitelisted per customer.

Request Headers

Content-Type: application/json
Authorization: Bearer <jwt_token>

Required Fields

The following fields must be encrypted before being sent to the server:

Field	Required	Type	Description
custId	Yes	String	Unique ID of the customer the account belongs to.
accountNumber	Yes	String	Bank account number to whitelist.
ifsc	Yes	String	IFSC code of the bank account. Must be 11 characters long.
accountHolderName	Yes	String	Name of the account holder as per bank records.
enableUpi	Yes	Boolean	Whether UPI collection is enabled for this account.
enableVam	Yes	Boolean	Whether VAM (Virtual Account) collection is enabled for this account.

Decrypted Payload Structure

{
  "custId": "CUST00123",
  "accountNumber": "9651269595",
  "ifsc": "HDFC0001271",
  "accountHolderName": "john doe",
  "enableUpi": false,
  "enableVam": true
}

Success Response (Encrypted) (200 OK)

{
  "respCode": 2005,
  "respMessage": "Account whitelisted successfully",
  "data": "SyivrIAOJMsJH/KfUSnkXZPxHu0tmM+0ww2f18MSYY...encrypted_data_here"
}

Decrypted Response

{
  "id": "05d21bc2-65dd-44b2-9ea1-faca32c7c975",
  "custId": "828668227300001",
  "accountHolderName": "John Doe",
  "accountNumber": "XXXXXXX9595",
  "ifsc": "HDFCXXXXX71",
  "upiEnabled": true,
  "vamEnabled": false,
  "status": 1
}

All Response Codes

Code	Message
2005	Account whitelisted successfully
4172	Invalid IFSC format
4173	accountNumber must be numeric and between 9 and 18 digits long
4179	accountHolderName may only contain letters, spaces, and the characters.
4175	Account is already whitelisted for this customer
4176	Whitelisted account limit reached for this customer
4177	No master VAM configured for this merchant
4001	Unauthorized access
5000	Internal server error

PreviousUpdate Customer

NextUpdate Whitelisted Account

Required Fields

The following fields must be encrypted before being sent to the server:

Field	Required	Type	Description
custId	Yes	String	Unique ID of the customer the account belongs to.
accountNumber	Yes	String	Bank account number to whitelist.
ifsc	Yes	String	IFSC code of the bank account. Must be 11 characters long.
accountHolderName	Yes	String	Name of the account holder as per bank records.
enableUpi	Yes	Boolean	Whether UPI collection is enabled for this account.
enableVam	Yes	Boolean	Whether VAM (Virtual Account) collection is enabled for this account.

{ "id": "05d21bc2-65dd-44b2-9ea1-faca32c7c975", "custId": "828668227300001", "accountHolderName": "John Doe", "accountNumber": "XXXXXXX9595", "ifsc": "HDFCXXXXX71", "upiEnabled": true, "vamEnabled": false, "status": 1 }

All Response Codes

Code	Message
2005	Account whitelisted successfully
4172	Invalid IFSC format
4173	accountNumber must be numeric and between 9 and 18 digits long
4179	accountHolderName may only contain letters, spaces, and the characters.
4175	Account is already whitelisted for this customer
4176	Whitelisted account limit reached for this customer
4177	No master VAM configured for this merchant
4001	Unauthorized access
5000	Internal server error