Testing
The test environment generates results based on the details supplied in the request. In this guide, you will learn how to:
- Create new report configurations
- Use samples to create your test scenarios
Before you begin
You need the test client credentials you received from the implementations team to conduct a test transaction. For more about getting your test client credentials, see Getting started.
Identify which report types you need
GET /report-types identifies the report types available.
Set up how and when you want to receive your reports
POST /reports create a new report configuration.
You can use the below example configurations for each report type.
Transaction details report type configuration
Json
{
"entityType": "PE",
"entityIds": [
"999115747121"
],
"reportSections": [
{
"sectionReportTypeId": "3001",
"sectionReportTypeName": "Transaction Details"
}
],
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-07-01 02:00:00",
"reportingPeriodEndTimestamp": "2023-07-02 01:59:59"
}
}Download the sample Transaction details report.
Submission details report type configuration
Json
{
"entityType": "PE",
"entityIds": [
"999115747121"
],
"reportSections": [
{
"sectionReportTypeId": "3003",
"sectionReportTypeName": "Submission Details"
}
],
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-07-01 02:00:00",
"reportingPeriodEndTimestamp": "2023-07-02 01:59:59"
}
}Download the sample Submission details report.
Settlement details report type configuration
Json
{
"entityType": "PE",
"entityIds": [
"999115747121"
],
"reportSections": [
{
"sectionReportTypeId": "3002",
"sectionReportTypeName": "Settlement Details"
}
],
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-07-01 02:00:00",
"reportingPeriodEndTimestamp": "2023-07-02 01:59:59"
}
}Download the sample Settlement details report.
Settlement summary report type configuration
Json
{
"entityType": "PE",
"entityIds": [
"999115747121"
],
"reportSections": [
{
"sectionReportTypeId": "3005",
"sectionReportTypeName": "Settlement Summary"
}
],
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-07-01 02:00:00",
"reportingPeriodEndTimestamp": "2023-07-02 01:59:59"
}
}Download the sample Settlement summary report.
Fee details report type configuration
Json
{
"entityType": "PE",
"entityIds": [
"999115747121"
],
"reportSections": [
{
"sectionReportTypeId": "3006",
"sectionReportTypeName": "Fee Details"
}
],
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-07-01 02:00:00",
"reportingPeriodEndTimestamp": "2023-07-02 01:59:59"
}
}Download the sample Fee details report.
Dispute details report type configuration
Json
{
"entityType": "PE",
"entityIds": [
"999115747121"
],
"reportSections": [
{
"sectionReportTypeId": "3004",
"sectionReportTypeName": "Dispute Details"
}
],
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-07-01 02:00:00",
"reportingPeriodEndTimestamp": "2023-07-02 01:59:59"
}
}Download the sample Dispute details report.
Standard Reports Configuration
Deposit detail report configuration
Json
{
"entityIds": [
"103310853753"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "RACT0010"
},
{
"reportAttributeName": "Submission Date"
},
{
"reportAttributeName": "Merchant Presenter Identifier"
},
{
"reportAttributeName": "Merchant Presenter Short Name"
},
{
"reportAttributeName": "Submission Identifier"
},
{
"reportAttributeName": "Record Number"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Receiving Depository Financial Institution Number"
},
{
"reportAttributeName": "Account Number"
},
{
"alias": "Expiration Date",
"reportAttributeName": "Credit Card Expiration Year Month Number"
},
{
"alias": "Amount",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"SALE\",\"REF\")"
}
]
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Merchant Action Code"
},
{
"reportAttributeName": "Authorization Date"
},
{
"reportAttributeName": "Authorization Code"
},
{
"reportAttributeName": "Merchant Service Authorization Response Code"
},
{
"reportAttributeName": "Trace Number"
},
{
"reportAttributeName": "Consumer Bank Country Code"
},
{
"reportAttributeName": "Transaction Type Code"
},
{
"alias": "MCC",
"reportAttributeName": "Merchant Category Code"
},
{
"reportAttributeName": "Digital Token Method Code"
},
{
"reportAttributeName": "Interchange Qualification Code",
"aggregateOperationText": "max",
"alias": "Interchange Qualification Code"
},
{
"reportAttributeName": "Durbin Amendment Regulator Indicator"
},
{
"alias": "Interchange Unit Fee",
"reportAttributeName": "Unit Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Fee Text",
"aggregateConditionText": "IN(\"Interchange\")"
}
]
},
{
"alias": "Interchange Face Value % Fee",
"reportAttributeName": "Fee Rate",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Fee Text",
"aggregateConditionText": "IN(\"Interchange\")"
}
]
},
{
"alias": "Total Interchange Amount",
"reportAttributeName": "Settled Total Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Fee Text",
"aggregateConditionText": "IN(\"Interchange\")"
}
]
},
{
"alias": "Total Assessment Amount",
"reportAttributeName": "Settled Total Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"IA\")"
},
{
"aggregateConditionAttributeName": "Fee Text",
"aggregateConditionText": "IN (\"Assessment\",\"Cross Border Assessment Fee\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Other Debit Passthrough Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"PFEE\")"
},
{
"aggregateConditionAttributeName": "Charge Subcategory Text",
"aggregateConditionText": "IN(\"Debit Pass Thru Fees\")"
}
]
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Merchant Information Description"
},
{
"reportAttributeName": "Surcharge Amount"
},
{
"reportAttributeName": "Bank Sort Code"
},
{
"reportAttributeName": "International Bank Account Number"
},
{
"reportAttributeName": "Bank Identification Code"
},
{
"reportAttributeName": "Creditor Identifier"
},
{
"reportAttributeName": "Mandate Identifier"
},
{
"reportAttributeName": "Mandate Type Code"
},
{
"reportAttributeName": "Signature Date"
},
{
"reportAttributeName": "Card Usage Type"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Online Submission Indicator",
"filterAttributeCode": "=\"N\""
},
{
"reportAttributeName": "Merchant Order Number",
"filterAttributeCode": "!=\"NULL\""
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Deposit Detail Report",
"reportFileName": "ACT10.<Processing Entity ID>.<Report Type>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "<Processing Entity ID>,<Report Type>,<frequency>,<From Date YYYY-MM-DD>,<To Date YYYY-MM-DD>,<Generation Date YYYY-MM-DD>,GenerationTime=<Generation Time HH:MM:SS>",
"fileHeader": "BEGIN,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"fileTrailer": "END,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"csvColumnNameDisplayIndicator": true,
"reportConfigStatus": "active",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-10-27 02:00:00",
"reportingPeriodEndTimestamp": "2023-10-31 01:59:59"
}
}Download the sample Deposit detail report.
Deposit summary report configuration
Json
{
"entityIds": [
"103310853753"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "RFIN0010"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Fund Transfer Instruction Number"
},
{
"reportAttributeName": "Secure Bank Account Number"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Charge Category Code"
},
{
"reportAttributeName": "Settled Conveyed Code"
},
{
"alias": "Count",
"reportAttributeName": "Transaction Count",
"aggregateOperationText": "sum"
},
{
"alias": "Amount",
"reportAttributeName": "Settled Total Fee Amount",
"aggregateOperationText": "sum"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Foreign Exchange Rate"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Deposit Activity Summary Financial Report",
"reportFileName": "FIN10.<Processing Entity ID>.<Report Type>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "<Processing Entity ID>,<Report Type>,<frequency>,<From Date YYYY-MM-DD>,<To Date YYYY-MM-DD>,<Generation Date YYYY-MM-DD>,<Generation Time HH:MM:SS>",
"fileHeader": "BEGIN,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"fileTrailer": "END,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"csvColumnNameDisplayIndicator": true,
"reportConfigStatus": "active",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-10-27 02:00:00",
"reportingPeriodEndTimestamp": "2023-10-31 01:59:59"
}
}Download the sample Deposit summary report.
Charge summary report configuration
Json
{
"entityIds": [
"103310853753"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"constantValueText": "RFIN0011",
"alias": "Record Type"
},
{
"reportAttributeName": "Charge Category Code"
},
{
"reportAttributeName": "Charge Subcategory Code"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Fund Transfer Instruction Number"
},
{
"reportAttributeName": "Secure Bank Account Number"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Merchant Service Fee Schedule Identifier"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Interchange Qualification Code"
},
{
"reportAttributeName": "Fee Text"
},
{
"reportAttributeName": "Action Type Code"
},
{
"reportAttributeName": "Unit Quantity Number",
"aggregateOperationText": "sum",
"alias": "Unit Quantity"
},
{
"reportAttributeName": "Unit Fee Amount"
},
{
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "sum",
"alias": "Amount"
},
{
"reportAttributeName": "Fee Rate"
},
{
"reportAttributeName": "Settled Total Fee Amount",
"aggregateOperationText": "sum",
"alias": "Total Charge"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "ECP Program Name"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Entity Identifier",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Charge Subcategory Text",
"filterAttributeCode": "IN (\"Authorization Fees\",\"Interchange & Assessment Fees\",\"PDE Fees\",\"Deposit Fees\",\"Equipment Fees\",\"Monthly Fees\",\"Paymentech Non-Transaction Fees\",\"Funds Transfer Fees\",\"Other Fees\",\"Paymentech Fees\",\"Project Expenses\",\"Promotion Fees\", \"Interchange Fees\", \"Assessment Fees\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Charge Summary Report",
"reportFileName": "FIN11.<Processing Entity ID>.<Report Type>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "<Processing Entity ID>,<Report Type>,<frequency>,<From Date YYYY-MM-DD>,<To Date YYYY-MM-DD>,<Generation Date YYYY-MM-DD>,<Generation Time HH:MM:SS>",
"fileHeader": "BEGIN,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"fileTrailer": "END,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"csvColumnNameDisplayIndicator": true,
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-10-27 02:00:00",
"reportingPeriodEndTimestamp": "2023-10-31 01:59:59"
}
}Download the sample Charge summary report.
Deposit transfer summary report configuration
Json
{
"entityIds": [
"103310853753"
],
"reportSections": [
{
"sectionReportTypeName": "Settlement Summary",
"sectionReportTypeId": "3005",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "RFIN0010T"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Fund Transfer Instruction Number"
},
{
"alias": "Secure Bank Account Number",
"reportAttributeName": "Merchant Bank Account Number"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Fund Transfer Identifier"
},
{
"alias": "Category",
"reportAttributeName": "Funds Transfer Category Description"
},
{
"reportAttributeName": "Fund Transfer Effective Date"
},
{
"alias": "Count",
"constantValueText": "0"
},
{
"alias": "Amount",
"reportAttributeName": "Funds Transfer Category Amount",
"aggregateOperationText": "sum"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Foreign Exchange Rate"
}
],
"sectionSortOrderList": [],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Category Code",
"filterAttributeCode": "NOT IN (\"OTHER\")"
},
{
"reportAttributeName": "Settled Conveyed Code",
"filterAttributeCode": "IN (\"S\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Deposit Activity Transfer Summary Financial Report",
"reportFileName": "FIN10T.<Processing Entity ID>.<Report Type>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "<Processing Entity ID>,<Report Type>,<frequency>,<From Date YYYY-MM-DD>,<To Date YYYY-MM-DD>,<Generation Date YYYY-MM-DD>,<Generation Time HH:MM:SS>",
"fileHeader": "BEGIN,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"fileTrailer": "END,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"csvColumnNameDisplayIndicator": true,
"reportConfigStatus": "active",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-10-27 02:00:00",
"reportingPeriodEndTimestamp": "2023-10-31 01:59:59"
}
}Download the sample Deposit transfer summary report.
Dispute detail report configuration
Json
{
"entityIds": [
"103310853753"
],
"reportSections": [
{
"sectionReportTypeName": "Dispute Details",
"sectionReportTypeId": "3004",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "RPDE0017S"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"alias": "Entity Identifier",
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Payment Method Type Code"
},
{
"alias": "Category",
"reportAttributeName": "Dispute Category Code"
},
{
"reportAttributeName": "Financial Non-Financial Code"
},
{
"alias": "Count",
"reportAttributeName": "Post Deposit Event Detail Identifier",
"aggregateOperationText": "distinctCount"
},
{
"alias": "Presentment Currency Amount",
"reportAttributeName": "Post Deposit Event Action Presentment Currency Amount",
"aggregateOperationText": "sum"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"alias": "Settlement Currency Amount",
"reportAttributeName": "Post Deposit Event Action Settlement Currency Amount",
"aggregateOperationText": "sum"
},
{
"alias": "Dispute Type Code",
"reportAttributeName": "Post Deposit Event Dispute Type Code"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Dispute Summary Indicator",
"filterAttributeCode": "= 'TRUE'"
}
]
},
{
"sectionReportTypeName": "Dispute Details",
"sectionReportTypeId": "3004",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "RPDE0017D"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"alias": "Entity Identifier",
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Issuer Dispute Presentment Currency Amount"
},
{
"alias": "Previous Partial Representment",
"constantValueText": ""
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Dispute Category Code"
},
{
"reportAttributeName": "Status Flag Code"
},
{
"reportAttributeName": "Dispute Transaction Sequence Number"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Payment Brand Dispute Reason Code"
},
{
"reportAttributeName": "Transaction Date"
},
{
"reportAttributeName": "Dispute Initiate Date"
},
{
"reportAttributeName": "Activity Date"
},
{
"alias": "Current Action Presentment Currency Amount",
"reportAttributeName": "Post Deposit Event Action Presentment Currency Amount"
},
{
"alias": "Fee Amount",
"reportAttributeName": "Total Fee Assessed Amount",
"aggregateOperationText": "sum"
},
{
"reportAttributeName": "Dispute Usage Code"
},
{
"reportAttributeName": "Acquirer Reference Number"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Issuer Dispute Settlement Currency Amount"
},
{
"alias": "Current Action Settlement Currency Amount",
"reportAttributeName": "Post Deposit Event Action Settlement Currency Amount"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Authorization Date"
},
{
"reportAttributeName": "Dispute Due Date"
},
{
"reportAttributeName": "Ticket Number"
},
{
"reportAttributeName": "Digital Token Method Code"
},
{
"alias": "Dispute Type Code",
"reportAttributeName": "Post Deposit Event Dispute Type Code"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Division External Identifier",
"sortOrderCode": "asc"
}
]
},
{
"sectionReportTypeName": "Dispute Details",
"sectionReportTypeId": "3004",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "RPDE0017D"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"alias": "Entity Identifier",
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Issuer Dispute Presentment Currency Amount"
},
{
"alias": "Previous Partial Representment",
"constantValueText": ""
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Dispute Category Code"
},
{
"reportAttributeName": "Status Flag Code"
},
{
"reportAttributeName": "Dispute Transaction Sequence Number"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Payment Brand Dispute Reason Code"
},
{
"reportAttributeName": "Transaction Date"
},
{
"reportAttributeName": "Dispute Initiate Date"
},
{
"reportAttributeName": "Activity Date"
},
{
"alias": "Current Action Presentment Currency Amount",
"reportAttributeName": "Post Deposit Event Action Presentment Currency Amount"
},
{
"alias": "Fee Amount",
"reportAttributeName": "Total Fee Assessed Amount",
"aggregateOperationText": "sum"
},
{
"reportAttributeName": "Dispute Usage Code"
},
{
"reportAttributeName": "Acquirer Reference Number"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Issuer Dispute Settlement Currency Amount"
},
{
"alias": "Current Action Settlement Currency Amount",
"reportAttributeName": "Post Deposit Event Action Settlement Currency Amount"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Authorization Date"
},
{
"reportAttributeName": "Dispute Due Date"
},
{
"reportAttributeName": "Ticket Number"
},
{
"reportAttributeName": "Digital Token Method Code"
},
{
"alias": "Dispute Type Code",
"reportAttributeName": "Post Deposit Event Dispute Type Code"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Division External Identifier",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Inventory Type",
"filterAttributeCode": "in ('OPENED','CLOSED')"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Chargeback Activity Exception Detail Report",
"reportFileName": "PDE17.<Processing Entity ID>.<Report Type>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "<Processing Entity ID>,<Report Type>,<frequency>,<From Date YYYY-MM-DD>,<To Date YYYY-MM-DD>,<Generation Date YYYY-MM-DD>,<Generation Time HH:MM:SS>",
"fileHeader": "BEGIN,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"fileTrailer": "END,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"csvColumnNameDisplayIndicator": true,
"reportConfigStatus": "active",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-10-27 02:00:00",
"reportingPeriodEndTimestamp": "2023-10-31 01:59:59"
}
}Download the sample Dispute detail report.
Standard Reports Reconciliation
The reconciliation guide shows how to leverage standard reports to reconcile data across payments lifecycle. For detailed information, download the Standard Reports Reconciliation User Guide.
Test Cases
| Test case scenario | Expected output | Request and response reference |
|---|---|---|
| Create a report configuration with adhoc frequency and default attributes | A valid reportIdentifier and reportConfigurationId are generated and report configuration createTimestamp is returned in the response. | Create a new report configuration |
| Create a report configuration with daily frequency and selected attributes | A valid reportIdentifier and reportConfigurationId are generated and report configuration createTimestamp is returned in the response. | Create a new report configuration |
| Create a report configuration with daily frequency and default attributes | A valid reportIdentifier and reportConfigurationId are generated and report configuration createTimestamp is returned in the response. | Create a new report configuration |
| Update an existing configuration to change status to Inactive | A reportConfigStatus changed to inactive and entire report configuration is returned in the response. | Update an existing report configuration |
| Update an existing configuration to change the frequency from adhoc to daily | A scheduleFrequency changed to daily and entire report configuration is returned in the response. | Update an existing report configuration |
| Update an existing config to change the reportName or reportFileName | The reportFileName and reportName are updated and entire report configuration is returned in the response. | Update an existing report configuration |
| Check the status of the report | The reportStatus is returned with a valid value like requested, initiated, completed, or errored. The reportDetails with reportFileName and URL are returned if reportStatus is completed. Other details such as reportIdentifier, reportConfigurationId, reportTypeNames, updateTimestamp, createTimestamp, intervalParam are returned in the response. |
Get details for a specific report |
| Download the report file | The report data are returned in the response. | Get a specific report file |
| Get all the available report configurations | The summarizedReportConfigurations carrying array of all report configurations with their details are returned in the response. | Get a list of available report configuration |
| Get all the available reports | The summarizedReports carrying array of all the reports with their reportDetails are returned in the response. | Get a list of available reports |
| Get all report types | An Array of reportTypes with their details are returned in the response. | Get a list of available report types |