Report Reference

These reference materials cover reports, common terms, and best practices.

When to Use Each Report Type

This section provides examples of which report type might best fit specific tasks:

• Transaction Request Report:
  • Displays all transaction activity and details.
  • Retrieves details for a specific customer transaction.
• Payment Batch Detail Report:
  • Tracks which transactions were batched for settlement.
  • Used to reconcile transactions with bank deposits.
• Transaction Exception Detail Report:
  • Provides details for investigating failed transactions and errors.
  • Supports diagnosis of processing problems.
• Processor Events Detail Report:
  • Tracks chargebacks, refunds, and processor events.
  • Provides context for unexpected account adjustments.

Report Constraints

These constraints apply to reports:

• Report files: report files are deleted 12 months after the report is created. Reports needed for long-term retention must be downloaded before deletion.
• Active recurring reports: recurring reports are limited to an active maximum of 20 reports simultaneously.
• Custom date range: custom report date ranges cannot exceed 31 days.
• Transaction data: reports cannot include data from dates more than 12 months in the past.
• Processing time: reports can take between 15 minutes and several hours to process.
• Daily recurring reports: daily recurring reports typically require 6 hours from the scheduled time to generate.
• Report name: report names must be unique and cannot be edited.
• Report type: report types cannot be edited.
• Report time zone: reports use system time (UTC). A time zone must be specified when creating a subscription. See Supported Time Zones for valid values.

Glossary

This glossary defines common terms used in reports:

• Batch: a group of transactions submitted together to the payment processor for settlement.
• CSV: Comma-Separated Values: a file format that opens in spreadsheet applications.
• Lookback Period: the period from which a recurring report retrieves data (for example, the previous 24 hours for daily reports).
• One-Time Report: a report generated once for a specific date range.
• Processor Events: notifications from the payment processor about chargebacks, refunds, adjustments, and other post-transaction events.
• Recurring Report: a report that generates automatically on a regular schedule (daily, weekly, or monthly).
• Reconciliation: the process of matching transaction records with bank deposits to ensure accuracy.
• Settlement: the process of transferring funds from the customer's bank to the merchant's bank account.
• XML: Extensible Markup Language: a structured data format used for system integration.