Skip to main content
The Reporting API provides endpoints for accessing transaction history, generating reports, and tracking settlement activity. These endpoints enable reconciliation, financial reporting, and operational analytics for your payment processing.

​
Transaction Data

Query comprehensive transaction data across all payment operations. Transactions represent individual processing steps within payment flows, capturing requests to payment processors and their responses. Transaction access includes:
  • List transactions: Query transaction history with filtering capabilities
  • Retrieve details: Access complete transaction data including processor responses
  • Settlement tracking: Monitor transaction settlement status and timing
Each transaction record includes timestamps, amounts, processor identifiers, and state information necessary for reconciliation and dispute resolution.

​
Report Generation

Create and retrieve reports for specific time periods or criteria. Reports aggregate transaction data for accounting, reconciliation, and business intelligence purposes. Report operations include:
  • Create reports: Generate new reports with specified parameters and date ranges
  • List reports: Query available reports and their generation status
  • Retrieve reports: Access completed report data
  • Get report items: Access detailed line items within a specific report
Reports can be generated on-demand or scheduled for regular intervals, depending on your operational requirements.

​
Settlement Events

Commerce V1 communicates settlement activity through the SettlementEvent. These events provide real-time notification of settlement state changes and fund movements. Settlement tracking enables:
  • Funding reconciliation: Match processor settlements to transactions
  • Cash flow management: Track expected and actual fund transfers
  • Dispute handling: Identify chargebacks and reversals
  • Accounting integration: Sync settlement data with financial systems

​
Data Retention

Transaction and report data is retained according to your account configuration and applicable regulatory requirements. Typical retention periods range from 7 years (PCI DSS requirement) to indefinite for audit purposes. When integrating with the Reporting API:
  • Query transaction data incrementally rather than requesting large date ranges
  • Cache report results to minimize API calls
  • Use pagination for transaction lists to manage response sizes
  • Schedule report generation during off-peak hours for large reports

​
Use Cases

Common reporting and analytics use cases:
  • Financial reconciliation: Match Commerce V1 transactions to processor statements
  • Fraud monitoring: Analyze transaction patterns for suspicious activity
  • Performance metrics: Track authorization rates, settlement times, and processor health
  • Customer analytics: Understand payment method preferences and success rates
  • Compliance reporting: Generate audit trails for regulatory requirements