Skip to main content

Wallets API

Planned

A standalone wallets resource (/v1/wallets, per-wallet balances, ledger-entry listing, and wallet-to-wallet transfers) is on the roadmap and not yet available in the sandbox API. The endpoints below describe the planned model. Use the supported endpoints in Balances today for now.

Balances today​

Account balances are aggregated per settlement currency, summed across the underlying rails (vIBANs and USDC rails roll into the USD/EUR tiles):

GET /v1/accounts/me/balance
{
  "totals": [
    { "currency": "USD", "amount": "98000.00", "available": "97000.00", "pending": "1000.00" },
    { "currency": "EUR", "amount": "25000.00", "available": "25000.00", "pending": "0.00" }
  ]
}

The caller is derived from the authenticated session, so there is no account id in the path. To list the underlying vIBANs, use GET /v1/accounts/me/vibans.

These /v1/accounts/me/* endpoints are dashboard (session) endpoints and are not callable with a developer API key.

To move funds to a recipient, create a transfer — POST /v1/transfers — rather than a wallet-to-wallet transfer.

Planned: wallet objects​

GET /v1/wallets
GET /v1/wallets/{wallet_id}/balances
GET /v1/wallets/{wallet_id}/ledger-entries
POST /v1/wallet-transfers

These are part of the roadmap toward multiple logical balance containers (operating, treasury, payout, fee, escrow). See Wallets for the business-facing balance model.