Skip to main content
GET
Wallet breakdowns
The wallet breakdowns endpoint returns, for every wallet on your account, the opening balance, the turnover by category and the closing balance for a period. These are the same figures as on the Dashboard under Wallets → Breakdown, so you can reconcile your wallets without exporting them by hand. Learn more about the wallet breakdown from our Dashboard docs.
  • The period is whole UTC calendar days from startDate to endDate, both inclusive, and at most 31 days.
  • One request returns all your wallets. Use the optional country filter to limit it to one country. Identify each wallet by country, currency and provider, as in Wallet Balances.
  • Wallets with no movement are included, with only their opening and closing balance.
  • Categories with no movement are omitted: treat a missing category as zero.
  • Amounts are signed: credits are positive, debits negative. They are the values shown on the Dashboard, rounded to 2 decimals the same way the Dashboard rounds them, so a value exactly halfway between two cents can round down (for example 2.675 shows as 2.67).
  • openingBalance plus all present categories equals closingBalance. Because each amount is rounded on its own, a sum of the published figures can differ by a cent.
  • Breakdown data starts in 2021. Earlier periods return zero balances and no categories.

What is in withdrawals?

withdrawals holds your settlement withdrawals, outgoing wallet-to-wallet transfers and float reallocations. It is therefore not the same as the sum of your settlements for the period. When a settlement is cancelled, the withdrawn amount returns to your wallet and is netted in withdrawals. For example, 27.00 withdrawn with a 7.00 settlement cancelled shows withdrawals as -20. If the cancellation falls in a later period than the withdrawal, the returned amount is added to withdrawals of that later period, which can make it positive.

Which operations make up each category?

Every operation on your wallet belongs to exactly one category. The mapping below is version 1. A change that moves an operation to another category is announced at least 30 days in advance.

Authorizations

Authorization
string
header
required

Query Parameters

startDate
string<date>
required

First UTC calendar day of the period, inclusive.

Format is YYYY-MM-DD. Date-times are rejected.

Example:

"2026-06-01"

endDate
string<date>
required

Last UTC calendar day of the period, inclusive. Must be on or after startDate and not in the future. The period from startDate to endDate, both days included, is at most 31 days: for example, 2026-06-01 to 2026-07-01.

Format is YYYY-MM-DD. Date-times are rejected.

Example:

"2026-06-30"

country
string

The country you wish to limit the results to.

Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from wikipedia.

Required string length: 3
Example:

"ZMB"

Response

Request has been succesfully processed.

startDate
string<date>
required

The startDate of the request.

Example:

"2026-06-01"

endDate
string<date>
required

The endDate of the request.

Example:

"2026-06-30"

wallets
object[]
required

One entry per wallet on your account (or in country, when filtered), including wallets with no movement. Ordered by country, then currency, then provider.

Identify an entry by country + currency + provider: one country can hold several wallets.

country
string

The country filter of the request, in upper case. Only present when the filter was sent.

Example:

"UGA"