Sign in

v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Create Virtual Account used as Collection Tool

Use this API to create a virtual account used as a collection tool.

post/v1/accounts

Request body

typestring required

Type of account to be created.<br><br>Accepted value: <ul><li>virtual</ul></li>

used_asstring required

Type of virtual account to be created.<br><br>Accepted value: <ul><li>collection_tool</ul></li>

namestring required

Applicant's name.<br><br>Maximum 70 characters.<br><br>Example: Anil Reddy<br><br>Supported characters:<ul><li>A-Z</li><li>a-z</li><li>0-9</li><li>.</li><li>/</li><li>\</li><li>-</li><li>_</li><li>,</li><li>(</li><li>)</li><li>'</li></ul>

mobile_numberstring required

Account holder's mobile number.<br><br>Has to be 10 digits.<br><br>Example: 9876543210<br><br>Supported characters:<ul><li>0-9</ul></li>

emailstring required

Account holder's email address.<br><br>Example: anil.reddy@example.com

bank_namestring

Bank where the virtual account used as a collection tool needs to be created.<br><br>Accepted value: <ul><li>yes_bank</ul></li>

create_vpaboolean

Accepted values: <ul><li>true: Create a VPA and bank account.</li><li>false (default): Create bank account only.</li></ul>

Response

200

idstring
objectstring
typestring
used_asstring
bank_namestring
namestring
mobile_numberstring
emailstring
account_numberstring
ifsc_codestring
vpastring
additional_vpaobject[]
whitelisted_remittersobject[]
whitelisted_beneficiariesobject[]
{"stackTrail":"paths:/v1/accounts:post:responses:200:content:application/json:schema:properties:kyc_url","oasType":"schema","type":"unknown"}
statusstring
created_atinteger
is_sandboxboolean
{"stackTrail":"paths:/v1/accounts:post:responses:200:content:application/json:schema:properties:settlement_account_id","oasType":"schema","type":"unknown"}
verified_beneficiariesobject[]
verified_remittersobject[]

Example response

{
  "id": "va_gsXD5cMqH8XyrfTe3HelnFe43",
  "object": "account.virtual",
  "type": "virtual",
  "used_as": "collection_tool",
  "bank_name": "yes_bank",
  "name": "Lush Adobe",
  "mobile_number": "9876543210",
  "email": "anil.reddy@example.com",
  "account_number": "3636365909131910",
  "ifsc_code": "YESB0CMSNOC",
  "vpa": "zwch1688454450@yesbank",
  "kyc": {
    "city": "Bangalore",
    "postal_code": "560010",
    "state_code": "KA",
    "pan": "XXXXXX905H",
    "business_type": "partnership",
    "business_category": "garage_owners",
    "contact_person": "Rahul Reddy"
  },
  "customer": {
    "id": "cus_LuCej8PYu2A3AXD2VSsRFqNob",
    "mobile_number": "9876543210"
  },
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "status": "active",
  "created_at": 1758100959
}