v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

Virtual Accounts

Add a VPA receiver to a Virtual Account

Add a UPI VPA receiver to an existing virtual account (Smart Collect 2.0). Requires the VPA receiver feature to be enabled on the merchant account.

post/virtual_accounts/{id}/receivers

idstring required

Virtual Account ID (va_*).

typesstring[] required

Must contain 'vpa'.

VPA receiver added. Returns the updated VirtualAccount.

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