Create 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 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.

Body Params
string
required

Account type; can be physical / savings / virtual, only virtual allowed as of now. Other supported types to be added in the subsequent iterations

string
required

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

string
required

PAN number of the entity

string
required

Email address of the entity

string
required

Mobile of the entity

string

Physical address of the entity

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

float

Maximum transaction amount limit

string
required

A valid currency code e.g.INR

string
required

Unique customer ID to be saved against the customer

string

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)

int32

1 if sub - merchant onboarding is required

int32

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

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 entity. Mandatory when upi_onboarding is set to 1

int32

Pincode of the entity. Mandatory when upi_onboarding is set to 1

upi_onboarding_details
object

Mandatory when upi_onboarding is set to 1

Headers
string
required
string
required
string
required
string
required
Responses

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