Skip to main content
GET
Get wallet

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Response

Wallet details

Wallet balance, auto-reload, per-product rates, and any in-flight top-up.

available_balance
string
required

Current spendable balance, denominated in currency. A negative value means the wallet is overdrawn.

Pattern: ^-?(?:0|[1-9]\d{0,11})(?:\.\d{1,6})?$
Example:

"21.44"

currency
enum<string>
required
Available options:
USD
Example:

"USD"

as_of
string<date-time>
required
Example:

"2026-08-10T18:04:11.220Z"

auto_reload
required

null means the auto-reload contract read failed, not that it is unconfigured.

pending_top_up
object | null
required

null means no in-flight top-up, or the ledger read failed.

rates
object | null
required

null means the rates read failed, or the wallet has no Metronome contract yet.