API ReferenceIntegrationsKnowledge Base

Create a Virtual Account

You can create a new virtual bank account with TPV using this API. You can choose to link it to a specific customer.

Note:
Currently, we support creation of virtual UPI IDs in the live mode only. However, virtual bank accounts can be created in the test and live modes.

Request Parameters🔗

receivers mandatory

json object Configuration of desired receivers for the virtual account.

types
array List of desired receiver types. Possible value is bank_account
allowed_payers mandatory

array Details of customer bank accounts which will be allowed to make payments to your virtual account. The Parent parameter under which the customer bank account details must be passed as child parameters.
Note:
You can add account details of 10 allowed payers for a virtual account. For more details, refer to the Third Party Validation section.

type mandatory

string The type of account through which the customer will make the payment. Possible value is bank_account.

bank_account mandatory

object Indicates the bank account details such as ifsc and account_number.

ifsc mandatory
string The IFSC associated with the bank account through which the customer is expected to make the payment.
account_number mandatory
string The bank account number through which the customer is expected to make the payment. Handy Tips!
The SBI account number contains zeros preceding actual numbers. You should enter the complete account number, including these zeros, or else the transaction will fail, and the amount will be refunded automatically.
For Example, if the account number is 00000022234631312, add the complete account number and not just 22234631312.
description optional

string A brief description of the virtual account.

customer_id optional

string Unique identifier of the customer to whom the virtual account must be tagged. Refer to the Customer API documentation to learn how to create a customer.

notes optional

json object Any custom notes you might want to add to the virtual account can be entered here. Refer to the Notes section of the API Reference Guide to learn more.

close_by optional

integer UNIX timestamp at which the virtual account is scheduled to be automatically closed. The time must be at least 15 minutes after current time. The date range can be set till 2147483647 in UNIX timestamp format (equivalent to Tuesday, January 19, 2038 8:44:07 AM GMT+05:30).
Note:
Any request beyond 2147483647 UNIX timestamp will fail.

Note:
While sharing the details of VAs (created using RBL bank) with the customers, ensure that the fifth character in the IFSC is number 0 and not the letter O. For example, valid IFSC is RATN0VAAPIS and not RATNOVAAPIS.

×