Skip to main content
GET
Get virtual account balance
Stable since 2025-01-01 — unchanged in 2026-06-01.

Authorizations

Authorization
string
header
required

Access token from POST /auth (the data.access_token value).

x-api-key
string
header
required

API key issued by Kira. Required on every request, including /auth.

Headers

X-Api-Version
string

Optional. The date-versioned API version to apply for this request (e.g. 2026-04-14). When sent it always wins, even over your pinned account default. When omitted, the API uses your account's pinned version if set, otherwise a baseline default.

Example:

"2026-06-01"

Path Parameters

virtual_account_id
string<uuid>
required

Virtual account UUID.

Response

Success.

Bare balance object — no envelope.

available_balance
number
required

Available balance for the account.

currency
string
required

Balance currency (e.g. USD).