Skip to main content
GET
Get account balance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Snapshot returned successfully.

currency
string
required

Settlement currency configured by the service. The current production default is USD.

Example:

"USD"

wallet_balance
string
required

Wallet balance, with six decimal places.

Example:

"10.000000"

usable_credit
string
required

Available credit: credit limit minus used and frozen credit, with a minimum of zero. Zero when credit is absent, disabled, or restricted.

Example:

"5.000000"

available_total
string
required

Sum of wallet_balance and usable_credit.

Example:

"15.000000"

credit_status
enum<string>
required

Credit account status. none means no credit account; restricted indicates a risk restriction.

Available options:
none,
active,
disabled,
restricted
Example:

"active"

as_of
string<date-time>
required

UTC snapshot time.

Example:

"2026-11-10T10:00:00Z"