---
title: "Wallet breakdowns"
method: GET
path: "/v2/wallet-breakdowns"
tags: ["finances"]
---

# Wallet breakdowns

`GET /v2/wallet-breakdowns`

## Request

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

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`.

## Query parameters

- `startDate` string, date, required
- `endDate` string, date, required
- `country` string

## Response `200`

Request has been succesfully processed.

- WalletBreakdownsResponse
  - `startDate` string, date, required: The `startDate` of the request.
  - `endDate` string, date, required: The `endDate` of the request.
  - `country` string: The `country` of the request, in upper case. Only included if you sent `country`.
  - `wallets` WalletWithBreakdown[], required: One entry for each wallet on your account, or in `country` if you sent it. Wallets with no movement are included. Sorted by `country`, then `currency`, then `provider`. Identify each wallet by its `country`, `currency` and `provider`. One country can have several wallets.
    - `country` string, text, required: Country of the wallet. Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements).
    - `currency` string, text, required: Currency of the wallet.
    - `provider` string, required: If you are using a wallet that is only used by a single provider, that providers code will be shown here. Empty for country wallets.
    - `breakdown` WalletBreakdown, required: The breakdown of the wallet for the period. Categories with no movement are left out. Treat a missing category as `0`. Money in is positive and money out is negative. Amounts are rounded to 2 decimals, the same as on the Dashboard, without thousands separators or trailing zeros. For example, `-301200.5`. `openingBalance` plus all the categories equals `closingBalance`. Each amount is rounded separately, so your sum can be off by `0.01`.
      - `openingBalance` string, required: Balance at 00:00:00 UTC on `startDate`.
      - `deposits` string: Deposits paid into the wallet, from the API, Payment Page, checkouts and customer-initiated deposits.
      - `splitDeposits` string: The deposit part of split payments.
      - `payouts` string: Payouts. Amounts returned for failed payouts are added back.
      - `splitPayouts` string: The payout part of split payments. Amounts returned for failed ones are added back.
      - `remittances` string: Remittances. Amounts returned for failed remittances are added back.
      - `refunds` string: Refunds. Amounts returned for failed refunds are added back.
      - `fees` string: PawaPay fees and pass-through fees. Fee reimbursements are in `compensations`.
      - `topUps` string: Top ups, wallet-to-wallet transfers into the wallet and float allocations.
      - `withdrawals` string: Settlements, wallet-to-wallet transfers out of the wallet and float reallocations. Amounts returned from cancelled settlements are added back. Because of the transfers and reallocations, this is not always the total of your settlements for the period.
      - `adjustments` string: Manual adjustments, for example taxes, bank charges and corrections.
      - `compensations` string: Manual compensations.
      - `uncategorized` string: Payout reversals, a legacy type, and operations without a known type. The same as Uncategorized on the Dashboard.
      - `closingBalance` string, required: Balance at the end of `endDate`, or now if `endDate` is today.

## Other responses

- `400`: Request was rejected due to incompatibility with PawaPay API specification
- `401`: Authentication failed. Make sure you have added the API token into the header. If using signatures, make sure they are valid.
- `403`: Authorization failure. The API token needs read access to both deposits and payouts.
- `500`: An unknown failure has occurred.

## Changes

- **2026-11-03** `4556d2ec2141`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2/changes/v2/wallet-breakdowns/get.md)

---

[API](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2.md) - [All operations](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2/revisions/4556d2ec2141?raw)