Endpoints: Reporting
These endpoints support viewing report definitions, managing subscriptions, downloading reports, and generating on-demand reports. Requests use HTTP signature authentication. See Get Started with Reporting for credential setup.
Server URLs
Use the base URL for your environment as the URL prefix.
| Environment | Base URL |
|---|---|
| Production | |
| Test |
Report Definitions
| Method | Path | Description | Details | |
|---|---|---|---|---|
GET | /reporting/v3/report-definitions | View all supported report types and their attributes | View All Report Definitions | |
GET | /reporting/v3/report-definitions/{reportDefinitionName} | View the attributes of a single report type | View a Single Report Definition |
Report Subscriptions
| Method | Path | Description | Details | |
|---|---|---|---|---|
GET | /reporting/v3/report-subscriptions | View all report subscriptions | View Report Subscriptions | |
GET | /reporting/v3/report-subscriptions/{reportName} | View a single report subscription | View Report Subscriptions | |
PUT | /reporting/v3/report-subscriptions | Create or update a report subscription | Create or Update a Report Subscription | |
DELETE | /reporting/v3/report-subscriptions/{reportName} | Delete a report subscription | Delete a Report Subscription |
Reports
| Method | Path | Description | Details | |
|---|---|---|---|---|
GET | /reporting/v3/reports | Search available reports | Search Available Reports | |
GET | /reporting/v3/reports/{reportId} | Download a report by report ID | Download a Report by Report ID | |
PUT | /reporting/v3/reports | Create a one-time report | Create a One-Time Report |
Report Downloads
| Method | Path | Description | Details | |
|---|---|---|---|---|
GET | /reporting/v3/report-downloads | Download a completed report by name and date | Download a Report by Criteria |
On-Demand Reports
| Method | Path | Description | Details | |
|---|---|---|---|---|
GET | /reporting/v3/conversion-details | Conversion Detail Report | Conversion Detail Report | |
GET | /reporting/v3/purchase-refund-details | Purchase and Refund Detail Report | Purchase and Refund Detail Report | |
GET | /reporting/v3/net-fundings | Net Funding Report | Net Funding Report | |
GET | /reporting/v3/payment-batch-summaries | Payment Batch Summary Report | Payment Batch Summary Report |
Notification of Change
| Method | Path | Description | Details | |
|---|---|---|---|---|
GET | /reporting/v3/notification-of-changes | Notification of Change Report | Notification of Change Report |
Was this page helpful?
Thanks for your feedback!
Last published: October 28, 2026