Reporting

The Reporting guide covers two ways to access your payment transaction data: the Reporting API for developer-driven integration with external systems, and Reporting for managing and downloading reports through the web portal.

How Reporting Works

Both reporting approaches share the same underlying workflow:

1. Define — Choose a report type from the available report definitions and select the fields it should include.
2. Subscribe or request — Set up a recurring subscription (daily, weekly, or monthly) or request a one-time report.
3. Generate — The system builds the report asynchronously. Daily recurring reports are typically available within six hours of their scheduled start time. Use GET /reporting/v3/available-reports to check when a report is ready to download.
4. Retrieve — Download the completed report in Extensible Markup Language (XML) or CSV format using the API, or from the Available Reports page in .

Before You Begin

To use the Reporting API, you need active merchant credentials and an HTTP signature authentication setup. See Get Started with Reporting for credential requirements and environment URLs.

Both sandbox and production environments use the same merchant credentials.

Reporting API

The Reporting API is for developers integrating report data into external systems or automating report workflows programmatically. Using the API, you can:

• View available report types and their field definitions
• Create, update, and delete report subscriptions
• Download reports by name, date criteria, or report ID
• Generate one-time reports without a subscription

Developer workflow:

1. Report Definitions — Explore available report types and their attributes.
2. Report Subscriptions — Set up recurring reports on a daily, weekly, or monthly schedule.
3. Download Reports — Retrieve completed reports by report name, date range, or report ID.
4. On-Demand Reports — Generate one-time reports for ad hoc data needs outside of a subscription.

Reporting

Reporting is for merchants and account users managing reports through the web portal. Several reports are automatically enabled during onboarding, so you can start immediately.

• Standard reports: Pre-configured reports enabled by default. Track and reconcile your payment activity.
• Custom reports: Build reports from available fields to match your specific data needs. You can maintain up to 20 custom report subscriptions.
• Specialized reports: Reports for additional services such as Decision Manager, Account Updater, and Tax Calculation.

workflow:

1. Reports Available in — Review available reports and what data each contains.
2. Manage Downloadable Reports — Subscribe to recurring reports, generate one-time reports, or create custom report subscriptions.
3. On-Demand Reports — View and export transaction reports directly in the browser without setting up a subscription.

These key reports are available by default:

• Transaction Request: Daily transaction-level report logging all payment gateway activity.
• Payment Batch Detail: Daily report showing sales and refunds submitted to your payment processor. Tracks which transactions have been settled.
• Payment Events: Daily report showing payment notifications received from your processor (for selected processors).
• Payment Batch Summary: Summary of sales and refunds by currency and payment method.

Report Generation and Timing

How and When Reports Are Generated

You can choose one or both of these options to create downloadable reports:

• Choose to build your reports on a regular frequency, such as every day or every week. For example, create a subscription for a daily report covering transactions between 5 p.m. and 5 p.m. automatically generates the report daily.
• Create as-needed reports to review your transaction history. For example, configure a one-time (as-needed) report that includes all refund transactions in the month of March 2019. immediately begins building the report.

Downloadable reports are created asynchronously, so they are not available immediately after you create them. As soon as the report is generated, the adds it to the list of Available Reports that you can download.

Report Frequency and Start Time

Report frequency and start time determine the contents of a report. When the report runs, it uses the start time and frequency to determine the ending time for transactions included in the report. The frequency controls how often your report is generated. For example:

• A daily report scheduled to start at 5:00 p.m. Pacific Time runs every day and contains transactions that occurred between 5:00 p.m. the previous day and 4:59 p.m. Pacific Time of the current day, every day. A daily report that runs at 5:00 p.m. on February 2 includes transactions for February 1, 5:00 p.m., through February 2, 4:59 p.m.
• A weekly report scheduled to start at 11:00 a.m. Eastern Time on a Monday contains transactions from the previous 7 days that occurred between 11:00 a.m. on the first day of the time period and 10:59 a.m. on the last day. A weekly report that runs at 11:00 a.m. on February 13 includes transactions for February 6, 11:00 a.m., through February 13, 10:59 a.m.
• A monthly report scheduled to start at 6:00 a.m. Pacific Time on the 1st contains transactions from the previous 28-31 days that occurred between 6:00 a.m. on the first day of the time period and 5:59 a.m. on the last day. A monthly report that runs at 6:00 a.m. on February 1 includes transactions for January 1, 6:00 a.m., through February 1, 5:59 a.m.

Report Generation Date and Time

The generation date and time of a report varies depending on the amount of time it takes to generate the report. Recurring daily reports for merchants are generated and available for download within six hours of the start time. For example:

• A daily report that spans 5:00 p.m. to 4:59 p.m. might have a generate time of 7:00 p.m.
• A daily report that spans 11:00 p.m. to 10:59 p.m. might have a generate time of 1:00 a.m. the following day.

The exact amount of time that is needed to generate a recurring daily report varies based on the size of the report and the load on the system. Weekly, monthly, as-needed reports, or reports for partners, might take longer than six hours to generate.

A report's generate date reflects the actual date the report is created. The report's date range reflects the period of time the report data covers. For example, you can generate a report on:

• May 4, which includes transactions processed between January 1 and January 31.
• February 1, which includes transactions processed between January 1 and January 31.
• May 4, which includes transactions processed only on May 1.

The batch time set in the Production environment is based on your merchant configuration. The batch time set in the Test environment is 12:00 a.m. Pacific Time and cannot be changed.

Service Level Targets for Generating Reports

Recurring daily reports for merchants are expected to generate within six hours of the start time. For example, if a report starts at 1:00 a.m., it should be available for download by 7:00 a.m.

Reports for account-level users and partners, weekly and monthly reports, and as-needed reports might take longer to generate, based on the amount of data in the report.

There is no limit to the size of a generated report. However, large reports take more time to download depending on the file size and your network speed.

File Retention and Lookback Range

File retention period and lookback range vary by report type and contract. Standard file retention is 12 months. Contact your representative for the lookback range and retention details for your account.