Read one wallet's balance

get

https://myapi.xegora.com/api/v1/wallet/balance

The available and reserved balance of the workspace's active wallet in one currency. The reserved balance holds the totals of orders being fulfilled and the amounts of withdrawals not yet paid or cancelled. A currency in which the workspace holds no active wallet (none, frozen or closed) is 404. Requires the wallet.read scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

currency

string

required

length between 3 and 3

Three-letter code of a currency the workspace holds a wallet in (e.g. USD), any case.

Headers

X-Correlation-Id

string

length ≤ 128

^[A-Za-z0-9._:-]{1,128}$

Your own correlation id, carried through Xegora's logs and audit records and returned in correlationId. Kept when it is 1–128 characters of ASCII letters, digits, ., _, : and -; anything else is replaced by an id of Xegora's.

X-Language

string

enum

The language an error's message, title and detail are written in; without it, Accept-Language decides, then English. Successful responses are not translated.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Available and reserved balances.

400The request is malformed (code = invalid_request): a bad parameter or header, a missing or malformed Idempotency-Key, or a body member the contract does not have — named, by its path in the body, in errors. Do not retry unchanged.

401No valid API key (code = unauthorized): missing, malformed, unknown, revoked or expired, or a wrong secret. The message is worded for an API key — this surface has no session to sign in to.

404No such resource in this workspace, or no such route (code = not_found).