Get Started with Reporting
Choose a reporting method
Use this guide to take your first steps with either reporting method. If you are not sure which to use, see the Reporting Overview.
Get Started with the Reporting API
The Reporting API is the right choice if you need to pull report data into an external system, automate recurring downloads, or build a custom reporting pipeline.
Prerequisites
Before making API requests, you need:
- API credentials: Your merchant ID and either an HTTP Signature key pair or a JSON Web Token (JWT) certificate.
See Getting Started with REST for credential setup instructions.
- A client application that supports HTTPS with TLS 1.2 and HTTP/1.1. HTTPS libraries are available for Java, C/C++, Perl, Visual Basic, and other languages.
Review available report types
Send a GET /reporting/v3/report-definitions request to see all supported report types and their field definitions. See Report Definitions.
Create a subscription or one-time report
- For recurring reports (daily, weekly, or monthly): call
PUT/reporting/v3/report-subscriptionswith your chosen report type, fields, frequency, and time zone. See Report Subscriptions. - For a one-time report: call
PUT/reporting/v3/reports. See On-Demand Reports.
Download the generated report
Reports are built asynchronously. Daily recurring reports are typically ready within six hours of their scheduled start time. To check whether a report is ready, poll GET /reporting/v3/available-reports until the report appears with status COMPLETED. When ready, download by name and date or by report ID. See Download Reports.
Get Started with Reporting
Reporting is the right choice if you manage reports through the web portal and do not need to integrate report data into external systems.
Prerequisites
- A account with reporting permissions.
- Access to the for your environment:
Check what reports are available to you
Review the complete list of reports at Reports Available in to understand which reports apply to your account and what data they contain.
Check your Available Reports
In the left navigation pane, click the Reporting icon, then under Downloadable Reports click Available Reports. Several standard reports are enabled automatically during onboarding, so you might already have reports ready to download.
Set up or customize report subscriptions
To modify standard reports or create custom subscriptions, go to Reporting > Downloadable Reports > Report Subscription Management. See Manage Downloadable Reports.
Download a report
On the Available Reports page, click a file format link in the Download column for any completed report. Only reports that have finished generating and contain data show download links.
View on-demand reports
For reports you can view directly in the browser without downloading, choose from the reports under Reporting > Transaction Reports or Reporting > Financial Reports in the left navigation pane. See On-Demand Reports.
Thanks for your feedback!
Last published: October 28, 2026