/
API ReferenceBalances

Balances

View available, pending, and reserved balances across currencies.

AuthenticationCollectionsPayoutsCustomersBalancesWebhooksProductsDisputesFX Rates
GET/v1/balances

List all balances across currencies

Response Codes

200Balances retrieved
1{
2  "object": "list",
3  "data": [
4    {
5      "currency": "USD",
6      "available": 1250000,
7      "pending": 75000,
8      "reserved": 25000
9    },
10    {
11      "currency": "NGN",
12      "available": 45000000,
13      "pending": 2500000,
14      "reserved": 0
15    },
16    {
17      "currency": "GBP",
18      "available": 320000,
19      "pending": 0,
20      "reserved": 15000
21    }
22  ]
23}
GET/v1/balances/{currency}

Get balance for a specific currency

Parameters

NameTypeInRequiredDescription
currencystringpathRequiredISO 4217 currency code

Response Codes

200Balance retrieved404No balance for this currency
1{
2  "currency": "USD",
3  "available": 1250000,
4  "pending": 75000,
5  "reserved": 25000
6}