Sign in
Virtual Accounts

Close a Virtual Account

Manually close an active virtual account so it no longer accepts payments.

post/virtual_accounts/{id}/close

Path parameters

idstring required

Virtual Account ID (va_*).

Request body

status'closed' required

Must be 'closed' to close the account.

Response

Virtual Account closed.

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.