Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Create a Virtual Account

This API is an updated version of creating a virtual account

post/v2/banking/account/virtual

Headers

client_idstring required
client_secretstring required
module_secretstring required

Request body

bank_codesstring[] 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)

namestring required

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

panstring required

PAN number of the virtual account holder.

emailstring

Email address of the virtual account holder

mobilestring required

Mobile of the virtual account holder

addressstring

Address of the virtual account holder

kyc_verifiedinteger required

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

kyc_check_decentrointeger required

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

minimum_balancestring

Minimum balance to be maintained

transaction_limitnumber float

Maximum transaction amount limit

customer_idstring required

Unique customer ID to be saved against the customer

virtual_account_balance_settlementstring

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_aliasstring

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

upi_onboardingboolean

1 if sub - merchant onboarding is required

state_codeinteger

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

citystring

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

pincodeinteger

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

custom_vpastring

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

generate_static_qrinteger

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

upi_sub_merchant_idstring

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

Response

200

OR
OR
OR
OR

Example response

{
  "decentroTxnId": "62E67XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Virtual accounts created successfully",
  "data": [
    {
      "bank": "YES BANK LTD",
      "status": "success",
      "message": "YES BANK account created successfully.",
      "accountNumber": "462515000000000001",
      "ifsc": "YESB0CMSNOC",
      "allowedMethods": [
        "IMPS"
      ],
      "currency": "INR",
      "transactionLimit": 10000,
      "minimumBalance": 7500,
      "upiId": "462515000000000001@yesbankltd",
      "upiQrCode": "<base-64 string>",
      "virtualAccountBalanceSettlement": "DISABLED"
    }
  ]
}