Skip to main content
GET
Get a virtual account

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
string
required
Example:

"cus_1A2b3C4d5E6f7G8h9I0jKl"

virtualAccountId
string
required
Example:

"vac_1A2b3C4d5E6f7G8h9I0jKl"

Response

id
string
required

Id of the virtual account. Each id has the form vac_ followed by 22 alphanumeric characters.

Pattern: ^vac_[0-9A-Za-z]{22}$
status
enum<string>
required

pending_activation: the account was requested and is still being set up, so nobody can pay into it yet. active: the customer can be paid into it. disabled: the account takes no new deposits.

Available options:
pending_activation,
active,
disabled
asset
object
required
balances
object[]
required

What the account holds, in the account's own asset.

depositInstructions
object[]
required

Coordinates to give a payer, grouped by collection method — branch on each block's type, and read the currency off the block's currency rather than off type. Empty until status is active.

Domestic US clearing coordinates: an account number plus one routing number per network (ACH, Fedwire, RTP).

Example:
activatedAt
string<date-time> | null
required

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"

createdAt
string<date-time>
required

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"

updatedAt
string<date-time>
required

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"