Skip to content

Balances

What you hold, what you can withdraw, and what is still pending.

Endpoint What it does
GET /v1/balances Retrieve balances

Try any of them in the API tester.

GET /v1/balances

Your balance per currency.

available is what you can be paid out, or can send a payout from. pending is money a partner owes us for your collections and has not yet remitted: settled on your side, not yet funded on ours. reserved is held against disputes or a rolling reserve.

Authentication: a secret key (server-side only) with the scope balance.read.

Field Type What it is
data array
object string
  • 401: the key is missing, wrong or revoked
  • 403: the key lacks the scope, or your account may not do this
  • 429: too many requests; wait for Retry-After
  • 500: Internal Server Error
  • 503: the payment partner is unreachable; safe to retry

Every error is a JSON problem with a stable code. See Errors.