Partner Balances

Retrieve partner account balances

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieve the current balances for the partner's accounts, one entry per currency.

Request

GET /partner/balances

Example Response

{
  "balances": [
    {
      "currency": "BTC",
      "amount": "1.50000000",
      "available_amount": "1.50000000"
    },
    {
      "currency": "USD",
      "amount": "100000.00",
      "available_amount": "100500.00"
    }
  ]
}

Response Fields

FieldTypeDescription
currencystringCurrency code
amountstringCurrent balance for the currency
available_amountstringAmount available to spend, computed as amount plus any configured overdraft for the account. Equals amount when no overdraft is configured.

Notes

  • All amounts are returned as strings to preserve decimal precision.
  • Use the decimal_places from Partner Details for proper formatting.
  • available_amount may exceed amount when an overdraft is configured for the account, and may differ from amount even when the balance is negative.
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json