v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

Virtual Accounts

Create a Virtual Account

Create a virtual bank account (and optionally a VPA) for accepting NEFT/RTGS/IMPS/UPI payments. Set amount_expected=0 to accept any amount. Auto-closes after 90 days of inactivity. Maximum close_by timestamp: 2147483647.

post/virtual_accounts

Request body

descriptionstring required

Purpose of the virtual account.

amountinteger

Expected amount in paise. Set to 0 to accept any amount.

customer_idstring

Link to an existing customer (cust_*).

close_byinteger

Unix timestamp to auto-close the account. Maximum: 2147483647.

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

Response

Virtual Account created.

idstring

Virtual account ID. Prefix: va_

namestring

Display name of the virtual account.

entity'virtual_account'

descriptionstring

Purpose or description of the virtual account.

amount_expectedinteger

Expected payment amount in paise. 0 means any amount is accepted.

amount_paidinteger

Total amount received so far in paise.

status'active' | 'closed'

active = accepting payments; closed = no longer accepting payments.

close_byinteger

Unix timestamp by which the account will auto-close. Maximum value: 2147483647.

closed_atinteger

Unix timestamp when the account was closed.

customer_idstring

Customer ID linked to this virtual account (cust_*).

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

created_atinteger