Create Virtual Account / VPA

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

📘

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.

Request and Response Sample Code

Status: 200

{
    "vAccountId":"VATEST", 
    "name":"TestVendor", 
    "phone":"9900111111", 
    "email":"[email protected]", 
    "notifGroup":"TestGroup", 
    "createMultiple": 1
}
{ 
  "status": "SUCCESS", 
  "subCode": "200", 
  "message": "Virtual account added successfully", 
  "data": { 
    "YESB": { 
        "accountNumber": "CASHFREE1234VATEST", 
        "ifsc": "YESB0CMSNOC" 
        },
    "ICIC": { 
        "accountNumber": "PASFR1234VATEST", 
        "ifsc": "ICIC0000106" 
        } 
    } 
}

Status: 200

{
   "vAccountId":"VATEST", 
   "name":"TestVendor", 
   "phone":"9900111111", 
   "email":"[email protected]", 
   "notifGroup":"TestGroup"
}
{ 
  "status": "SUCCESS", 
  "subCode": "200", 
  "message": "Virtual account added successfully", 
  "data": { 
    "accountNumber": "CASHFREE1234VATEST", 
    "ifsc": "YESB0CMSNOC" 
    } 
}

Status: 200

{
   "vAccountId":"A9876543210", 
   "name":"TestVendor", 
   "phone":"9900111111", 
   "email":"[email protected]", 
   "notifGroup":"TestGroup", 
   "createMultiple": 1
}
{ 
  "status": "SUCCESS", 
  "subCode": "200", 
  "message": "Virtual account added successfully", 
  "data": 
  { 
    "YESB": 
    { 
    "accountNumber": "CASHFREE1234A98765432210", 
    "ifsc": "YESB0CMSNOC" 
     } 
   } 
}

Status: 200

{
   "virtualVpaId":"john", 
   "name":"John Doe", 
   "phone":"9900111111", 
   "email":"[email protected]", 
   "notifGroup":"TestGroup"
}
{ 
   "status":"SUCCESS", 
   "subCode":"200", 
   "message":"Virtual account added successfully", 
   "data":
   { 
       "vpa": "[email protected]" 
   } 
}

Status: 409

{
   "vAccountId":"VATEST", 
   "name":"TestVendor", 
   "phone":"9900111111", 
   "email":"[email protected]", 
   "remitterAccount":"007711300000000762", 
   "remitterIfsc":"YESB0000001"
}
{ 
  "status": "ERROR", 
  "subCode": "409", 
  "message": "Virtual account Id already exists" 
}

Status:412

{
   "vAccountId":"VATEST1", 
   "virtualVpaId":"john", 
   "name":"TestVendor", 
   "phone":"9900111111", 
   "email":"[email protected]" 
}
{ 
   "status": "ERROR", 
   "subCode": "412", 
   "message": "Please provide either Virtual Account or VPA" 
}

Response Codes

Sub Code

Status

Description

200

SUCCESS

Virtual account added successfully.

409

ERROR

Virtual account Id already exists.

412

ERROR

Please provide either Virtual Account or VPA.

Language