insufficient_funds
error.
We offer a number of ways to check your balance and set up alerts to notify you when your balance is low.
- An API endpoint to fetch your current balance, either for all currencies or for a single currency
- Predictive balance emails when your balance is expected to become low based on your previous order volumes
- Custom balance thresholds that notify you when your balance falls below a specific threshold
Checking balances in the API
The balance endpoint can be used to fetch balances for all currencies or for a single currency.Checking all available balances
To retrieve information on all balances associated with your account, initiate a GET request to the/v2/balance
endpoint.
Each object in the array represents the total available balance for a specific currency:
balance
denotes the current available funding for the specified currencycurrency
is represented by the ISO4217 three-letter currency code
Checking the balance for a single currency
To obtain the balance for a specific currency, include the three-letter currency code in the GET request:/v2/balance/?currency=[CURRENCY]
For example, a request to /v2/balance/?currency=GBP
will yield a single object in response. This API responds to other currencies with a value of 0, as long as the currency is supported on our platform.
balance
denotes the current available funding for the specified currencycurrency
is represented by the ISO4217 three-letter currency code