Skip to main content
GET
Get the Treasury overview

What this endpoint does

Returns the tenant account’s Treasury summary, including wallet balances, funding setup, and effective capabilities.

When to use it

Use it to initialise a Treasury dashboard or confirm the account is ready before beginning a workflow.

Before you call

Authenticate with treasury:read. The API key is bound to one tenant account and cannot select or read another account.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

Treat balance timestamps and capability flags as point-in-time values. Read the specific resource before acting on changing state.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Treasury overview for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

Response

200 - application/json

Tenant balances, funding instructions, and effective capabilities.

clientId
string
required
Minimum string length: 1
balances
object[]
required
configurations
object[]
required
fundingInstruments
object[]
required
fundingReceipts
object[]
required
cryptoDestinations
object[]
required
recentMovements
object[]
required
runtimeCapabilities
object[]
required