Generate Reports

Overview

The Report Generation feature provides partners with downloadable CSV reports for transaction history and transaction state history data. It supports three report types that help users review and export operational data as needed.

Access and Permissions

• Available to Manager, Contributor, and Reader roles only.
• Not available to Ringfencer, Support Officer, or Search Only roles.
• No usage limits or restrictions.
• Reports can be generated as often as needed.

Available Reports

1. Transaction Report

• Provides detailed transaction history with current status.
• Requires a date range selection.
• Future dates are disabled.
• Returns an empty report if no transactions exist within the selected range.

Sample Transaction Report Format

TransactionId,State,Created At,Payment Completed At,State Updated At,Partner Name,SubmerchantId,CartTransactionId,CartTotalAmount,GW Credits Id,GW Credits Amount,Out-of-pocketId,Out-of-pocket Amount,Out-of-pocket Payment Method,CardLast4,CustomerId,Email,Campaign Name,Metadata
TransactionId123,completed,2025-02-05,,2025-02-05,PartnerX,SubmerchantId123,CartTransactionId123,10,,0,Out-of-pocketId123,10,Card,1111,CustomerId123,,CampaignNameX,Metadata123
TransactionId456,completed,2025-02-05,,2025-02-05,PartnerY,SubmerchantId456,CartTransactionId456,50,,0,Out-of-pocketId456,50,Card,2222,CustomerId456,,CampaignNameY,Metadata456
TransactionId789,cancelled,2025-02-05,,2025-02-05,PartnerZ,SubmerchantId789,CartTransactionId789,100,,0,Out-of-pocketId789,100,Card,3333,CustomerId789,,CampaignNameZ,Metadata789Copy to clipboardErrorCopied

2. Transaction State Report

• Provides detailed transaction state history with current status.
• Requires a date range selection.
• Future dates are disabled.
• Returns an empty report if no transactions exist within the selected range.

Sample Transaction Report Format

TransactionId,State,Stated Updated At,Created At,Payment Completed At,State Updated At,Partner Name,SubmerchantId,CartTransactionId,CartTotalAmount,GW Credits Id,GW Credits Amount,Out-of-pocketId,Out-of-pocket Amount,Out-of-pocket Payment Method,CardLast4,CustomerId,Email,Campaign Name,Metadata
TransactionId123,created,2025-02-05,2025-02-05,,2025-02-05,PartnerX,SubmerchantId123,CartTransactionId123,10,,0,Out-of-pocketId123,10,Card,1111,CustomerId123,,CampaignNameX,Metadata123
TransactionId123,completed,2025-02-06,2025-02-05,,2025-02-05,PartnerX,SubmerchantId123,CartTransactionId123,10,,0,Out-of-pocketId123,10,Card,1111,CustomerId123,,CampaignNameX,Metadata123
TransactionId456,created,2025-02-05,2025-02-05,,2025-02-05,PartnerY,SubmerchantId456,CartTransactionId456,50,,0,Out-of-pocketId456,50,Card,2222,CustomerId456,,CampaignNameY,Metadata456
TransactionId456,completed,2025-02-06,2025-02-05,,2025-02-05,PartnerY,SubmerchantId456,CartTransactionId456,50,,0,Out-of-pocketId456,50,Card,2222,CustomerId456,,CampaignNameY,Metadata456
TransactionId456,refunded,2025-02-07,2025-02-05,,2025-02-05,PartnerY,SubmerchantId456,CartTransactionId456,50,,0,Out-of-pocketId456,50,Card,2222,CustomerId456,,CampaignNameY,Metadata456Copy to clipboardErrorCopied

Report Type Summary

Step-by-Step Process

1. Navigate to Reports.
2. Select the report type.
3. Choose a date range.
   • Start date is required.
   • End date is required.
   • Future dates are disabled.
4. Click Generate.
5. The system redirects to the Download tab.

Accessing Reports

Download Tab

• Lists all generated reports, ordered by generation date (newest first).
• Shows report name, generation date, report number, and download link.
• Processing time varies by data volume. Navigate away and return later to download.

File Format

• All reports are downloaded as CSV files, compatible with Microsoft Excel and Google Sheets.

Common Scenarios

Empty Reports

• Normal when no matching data exists, such as no transactions in the selected date range, no ringfenced merchants, or no expiring credits.

Multiple Reports

• Multiple reports can be generated simultaneously with no limit on concurrency. Each report is processed independently.

Best Practices

Before Generating

• Select the correct report type and verify the date range if applicable.
• Consider data volume when estimating processing time.
• Document the reason for report generation outside the system.

After Generating

• Download the report promptly when ready and verify data completeness.
• Store reports securely and follow up on any discrepancies.