API Reference
Start typing to search…

Get balance report

get
https://api.mollie.com/v2/balances//report

Retrieve a summarized report for all transactions on a given balance within a given timeframe.

The API also provides a detailed report on all 'prepayments' for Mollie fees that were deducted from your balance during the reported period, ahead of your Mollie invoice.

The alias primary can be used instead of the balance ID to refer to the organization's primary balance.

Access with

Organization access token with balance-reports.read

OAuth access with balance-reports.read

Path Params
string
required

Provide the ID of the related balance.

Query Params
string
required

The start date of the report, in YYYY-MM-DD format. The from date is 'inclusive', and in Central European Time. This means a report with for example from=2024-01-01 will include transactions from 2024-01-01 0:00:00 CET and onwards.

string
required

The end date of the report, in YYYY-MM-DD format. The until date is 'exclusive', and in Central European Time. This means a report with for example until=2024-02-01 will include transactions up until 2024-01-31 23:59:59 CET.

string

You can retrieve reports in two different formats. With the status-balances format, transactions are grouped by status (e.g. pending, available), then by transaction type, and then by other sub-groupings where available (e.g. payment method).

With the transaction-categories format, transactions are grouped by transaction type, then by status, and then again by other sub-groupings where available.

Possible values: status-balances transaction-categories (default: status-balances)

boolean

You can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Responses

Updated 8 days ago

Language
Credentials
Request
Response 
 Choose an example:
application/hal+json
Updated 8 days ago