Verify balances
Check your merchants' balances, and their payment and refund totals for a period.
There can be various reasons to keep track of your merchants' balances. For example, to make an internal transfer from a merchant, you need to know how much is available in that merchant's balance.
To check the balance of a merchant, you can:
- View the balance of the merchant now.
- Calculate the totals of the merchant's payments and refunds for a period.
View balances
To view the current balance of a merchant, use one of the following requests:
| API reference | Response |
|---|---|
Get account balance, with your api_key | available: the available balance in major units, rounded to 2 decimal places. pending and on_hold are always 0. The response has no currency. |
Get a merchant's balance, with your API key in the X-API-Key header | available_balance and pending_balance of the merchant's balance account, as strings in major units, and the currency_code. Only partners on the allowlist for this endpoint can use it. |
The following example shows the balance of Example Pizza Ltd. The API Explorer has the full Get account balance request, with examples you can try.
Response - Balance
{
"data": {
"available": 2345.67,
"pending": 0,
"on_hold": 0
}
}Note that the balance includes card and payment takings, internal transfers and funds in transit, minus completed payouts, depending on the merchant's country and payout setup.
Calculate totals
To calculate the totals of a merchant's payments and refunds for a period:
-
Send a Get payment and refund totals for a merchant request with the following parameters:
Parameter Required Description merchantIdRequired The MID of the merchant. fromDateRequired The start date, in YYYY-MM-DD format. toDateRequired The end date, in YYYY-MM-DD format. At most 90 days after fromDate.timezoneThe timezone of the dates, for example Europe/London. We recommend that you send it, because without it the dates are interpreted in UTC. -
The response contains the following totals, in major units:
payment_total: the total of the merchant's successful payments.refund_total: the total of the refunds and chargebacks, as a positive amount.net:payment_totalminusrefund_total.
The following example shows the totals of Example Pizza Ltd for the first two weeks of October. The API Explorer has the full request, with examples you can try.
Response - Totals
{
"data": {
"payment_total": 1250.40,
"refund_total": 35.00,
"net": 1215.40
}
}