Create Virtual Account/VPA Version 1.1

Use this API to create a virtual account or a virtual UPI address.

ℹ️

URLs

Click to view the response codes.

Response Codes

Sub CodeStatusDescription
200SUCCESSVirtual account created successfully
409ERRORVirtual account Id already exists.
400ERRORInvalid proportion scale precision provided for the given vendorId: {vendorId}
400ERRORSplit Settlement preference is not enabled for profile, you cannot provide Split Config Details for virtual account.
400ERRORSpecified Split Proportions greater than 100
400ERRORInvalid Proportion provided for the given vendorId : {vendorId}
400ERRORSpecified VendorId: {vendorid}, is not registered with merchant
400ERRORPlease provide valid virtual account ID. Only digits and alphabets are allowed
400ERRORvAccountId can be minimum of 3 characters.
400ERRORvAccountId can be maximum of 12 characters for IDFC Bank VBA.
400ERRORvAccountId can be maximum of 8 characters for Yes Bank VBA
400ERRORvAccountId can be maximum of 15 numeric characters for ICICI Bank VPA.
400ERRORvAccountId can be maximum of 26 alpha-numeric characters for ICICI Bank VPA.
400ERRORvAccountId can be maximum of 20 characters for Yes Bank VPA.
400ERRORvAccountId can be maximum of 8 characters for multiple VBAs.
400ERRORvAccountId can be maximum of 10 characters for multiple VPAs.
409ERRORCreate Multiple Accounts feature not enabled for your account. Please contact [email protected]
409ERRORVirtual VPA not enabled for your account. Please check with your account manager or mail [email protected]
400ERRORPlease provide the name.
400ERRORPlease provide valid name. Only alphabets and spaces are allowed.
400ERRORName can be minimum of 5 and maximum of 30 characters.
400ERRORPlease provide the phone number.
400ERRORPlease provide valid phone number.
400ERRORPlease provide the email.
400ERRORPlease provide valid email
400ERRORRemitter account and remitter IFSC should be provided together
400ERRORRemitter Account number should contain 9 to 30 alphanumeric characters.
400ERROREnter valid IFSC.
422ERRORAmount Lock with VPA not supported.
422ERRORRemitter Lock with VPA not supported.
400ERRORInvalid minAmount and/or maxAmount Parameter. Maximum 2 digit precision allowed and minAmount should be less than or equal to maxAmount.
400ERRORPlease check the notification group provided.
500ERRORVirtual account(s) created but split config could not be created.
400ERRORAny of the parameter(s) is not compatible with required data type. Please pass correct data type for all parameters.

📘

minAmount and maxAmount

  • You can specify either minAmount, maxAmount, or both for virtual accounts. These parameters are not applicable for virtual VPAs.
  • minAmount should always be lesser than or equal to maxAmount.

Language
Click Try It! to start a request and see the response here!

Experience the all-new Cashfree Payments Docs! Faster, smarter, and easier to navigate. Check it out here!🎉