API reference

Create report

post
https://api.mollie.com/v2/reports
🚧

Beta feature

This feature is currently in beta testing, and the final specification may still change.

Create a report. Mollie generates it in the background, so you get a pending status back right away.

Poll Get report to check on progress, and grab a download link once it's ready.

This needs an organization access token. A token scoped to a single website profile can't be used, since report data spans the whole organization.

Test mode credentials are rejected, since report data has no live/test distinction.

Creating a report with the exact same parameters while one is already pending or completed doesn't create a new one. You get the existing report back instead, whatever status it currently has.

🔑

Access with

Advanced access token with reports.write
Body Params

Generate a transaction margin report for your organization over a date range.

string
required

The type of report to generate. Determines which other fields the request needs, and which fields show up on the resulting report.

Possible values: transaction_margin

Show Details
transaction_marginA transaction margin report for a whole organization, over a date range.
date
required

The start date of the report period, in YYYY-MM-DD format. Must be strictly before untilDate; a report can't cover a single day. Data is available from 2026-01-01 onwards.

date
required

The end date of the report period, in YYYY-MM-DD format. Must be strictly after fromDate.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/hal+json

Updated about 1 month ago

Did this page help you?