API ReferenceCustomersAPI IntegrationBalances

Get a Balance

Get wallet balances for a single currency.

Authentication: Bearer token required

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customer_idstringRequired
Unique Customer Identifier
currency_codestringRequired

Three letter Currency Code (as specified by ISO4217).

Response

Ok. The response body contains balances for a single currency.
currencystring

Three letter Currency Code (ISO4217).

total_balancedouble
Total balance is the amount of cleared funds in your account and includes any pending payments.
available_balancedouble
Available balance is the cleared funds minus any funds which are committed to an outgoing payment.
outstanding_balancedouble
Outstanding balance is the amount which you are expected to pay for pending orders.

Errors