Skip to main content

Report API

The Report API allows merchants and accounting partners to retrieve transactions for accounting and financial reporting purposes.

Who can use this API​

This API is available to merchants using the Payment Integration, Recurring Payments, or Donations products, and to accounting partners using accounting keys.

See API access for full details, including VM number merchants and how to grant an accounting partner access to your sales unit data.

Report API documentation​

  • Quick start: Run the basic examples in curl and Postman.
  • 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.