finances

Wallet breakdowns

Changed on

Get the opening balance, the total of each category and the closing balance of every wallet on your account, from startDate to endDate in UTC, both days included. These are the same figures as in the wallet breakdown on the Dashboard.

Categories with no movement are left out. Treat a missing category as 0.

get/v2/wallet-breakdowns

Request

  • Base URL
    https://api.sandbox.pawapay.io
  • URL
    https://api.sandbox.pawapay.io/v2/wallet-breakdowns
  • Auth
    HTTP bearer

Query parameters

startDatestring date required
Example:2026-06-01

First UTC calendar day of the period, inclusive.

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

endDatestring date required
Example:2026-06-30

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, can be up to 31 days, for example 2026-07-01 to 2026-07-31.

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

countrystring
Example:ZMB

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.

Response

Request has been succesfully processed.

startDatestring date required

The startDate of the request.

endDatestring date required

The endDate of the request.

countrystring

The country of the request, in upper case. Only included if you sent country.

Example response

{
  "startDate": "2026-06-01",
  "endDate": "2026-06-30",
  "country": "UGA",
  "wallets": [
    {
      "country": "ZMB",
      "currency": "ZMW",
      "provider": "MTN_MOMO_BEN",
      "breakdown": {
        "openingBalance": "148734.21",
        "deposits": "512400",
        "splitDeposits": "1500",
        "payouts": "-301200.5",
        "splitPayouts": "-900",
        "remittances": "-12000",
        "refunds": "-1200",
        "fees": "-8123.4",
        "topUps": "50000",
        "withdrawals": "-250000",
        "adjustments": "310.5",
        "compensations": "25",
        "uncategorized": "0",
        "closingBalance": "150920.81"
      }
    }
  ]
}

Changes