Skip to main content
GET
Get wallet balance
Returns a real-time balance snapshot for the wallet — total, locked, and immediately available amounts, plus an asset descriptor. The snapshot is read live from the underlying provider on every call; values are not cached. The three balances:
Before creating an outbound payment order, check available, not amount. An outbound order against insufficient available will finalize as FAILED with errorCode: INSUFFICIENT_FUNDS.
All values are integers in minor units (cents for BRL). See Amounts & currency.

Authorizations

X-Access-Key
string
header
required

Opaque credential identifier provisioned during onboarding. See the Integration Guide for the request-signing protocol.

X-Access-Timestamp
string
header
required

Unix epoch timestamp in UTC milliseconds. See the Integration Guide for skew tolerance.

X-Access-Request-Id
string
header
required

Unique identifier per request (UUID v4 recommended). The (accessKey, requestId) tuple must be unique within the replay window defined by the Integration Guide.

X-Access-Signature
string
header
required

Base64-encoded ECDSA signature of the canonical request, computed with the private key paired to X-Access-Key. See the Integration Guide for canonicalization rules and reference implementations.

Path Parameters

wallet
string
required

Wallet name (RFC 1035 DNS label).

Required string length: 1 - 63
Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Response

The current balance snapshot.

Real-time balance snapshot of a wallet — total, locked, and immediately available amounts, plus the asset descriptor.

amount
object
required

A monetary amount expressed in integer minor units together with its currency and decimal precision.

locked
object
required

A monetary amount expressed in integer minor units together with its currency and decimal precision.

available
object
required

A monetary amount expressed in integer minor units together with its currency and decimal precision.

asset
object
required

Descriptor of a fiat currency or crypto asset, including its display symbol and decimal precision.