Skip to main content
GET
Get virtual account balance

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-06-01"

Path Parameters

virtual_account_id
string<uuid>
required

UUID of the account to read the balance of.

Response

Success.

available_balance
number

How much the account has available, in the currency named below. Always returned.

A deposit held by a compliance check (KYT_PENDING or KYT_REJECTED) is left out; the account's deposits list it with that status. A crypto inbound is not in it until it is credited.

In sandbox it comes from a simulated bank.

reserved_balance
number

Money reserved against payouts already submitted that have not settled yet. Still the account's money — it returns to available_balance if such a payout fails or is cancelled — but not available to send again. Always returned; 0 when nothing is reserved.

currency
string

Currency of the balance. Always USD.