Create a Virtual Account

This API is an updated version of creating a virtual account

🙌

Important Note

Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.

API Endpoints

This API allows you to create a virtual account with single/multi provider feature for a consumer or business in real-time. This functions exactly like a regular bank account with the exception of cash withdrawals.

You can also choose the underlying bank provider if you have a particular preference.

📘

Note: Decentro validates the name by cross-checking it with the PAN details. Please ensure the name passed is as per the name in PAN.

Body Params
bank_codes
array of strings
required

Provider Bank 4 digit code. Acceptable values: YESB (Yes Bank), ICIC (ICICI Bank), UTIB (Axis Bank), DBSS (DBS Bank), IDFB (IDFC Bank) and NSPB (NSDL Bank)

bank_codes*
string
required

Virtual account holder name to be put against the account and linked with UPI - ID

string
required

PAN number of the virtual account holder.

string

Email address of the virtual account holder

string
required

Mobile of the virtual account holder

string

Address of the virtual account holder

int32
required

0 / 1 depending on the status of the customer / merchant at your end. Please note that the onus of KYC lies on you

int32
required

0 / 1 depending on the status of the KYC check requirement from our end(if used). Default value is 0

string

Minimum balance to be maintained

float

Maximum transaction amount limit

string
required

Unique customer ID to be saved against the customer

string
Defaults to enabled

Flag to enable/disable the virtual account for balance settlement.For VA's with disabled flag will not be included in balance settlement API.

master_account
object

Mandatory when company is onboarded more than one business accounts.(Mandatory when 'master_account_alias' is not present)

string

Mandatory when company is onboarded more than one business accounts.(Mandatory when 'master_account' JSON is not present)

boolean

1 if sub - merchant onboarding is required

int32

State of the entity. kindly use /state API to get respective state code. Mandatory when upi_onboarding is set to 1

string

City of the virtual account holder. Mandatory when upi_onboarding is set to 1

int32

Pincode of the virtual account holder. Mandatory when upi_onboarding is set to 1

string

Custom name (lowercase, if not will be converted to lowercase) that is created as a prefix of upi-id handle

upi_onboarding_details
object

Mandatory when upi_onboarding is set to 1

int32
Defaults to 0

Pass 1 - if the static QR need to be generatedPass 0- if the static QR is not required (default value)

string

UPI sub-merchant ID generated by Decentro during sub-merchant on boarding.

Headers
string
required
string
required
string
required
Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json