Report API

The Report API provides programmatic access to settlement data, transaction reports, and payment event histories for accounting and financial reporting.

Who can use this API

This API is available to:

• Accounting partners using accounting keys — access covers all merchants who have granted the partner access to their data. Only accounting partners can use this API with partner keys; other partner types do not have access.
• ePayment and Recurring Payments merchants using their standard sales unit API keys.
• Donations organizations using their merchant-level API keys.

VM number merchants cannot use this API directly. They must designate an accounting partner, who can then retrieve the data on their behalf.

See API access for full details and instructions on granting an accounting partner access to your sales unit data.

Need sales context too?

The Sales API gives accounting partners access to order lines, VAT breakdowns, amounts, and categories alongside the money movement data in this API. Join on reference or pspReference to correlate the two.

Report API documentation

• Quick start: Run the basic examples in curl.
• API guide: Learn about the Report API features.
• FAQ: See answers to commonly asked questions.
• Reference spec: Go straight to the endpoint specifications.

If you're new to the platform, see Getting started for information about API keys, product activation, and the test environment.