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 must test the client credentials you received from the implementations team to conduct a test transaction. For more about getting your test client credentials, refer to Getting started.
Set up how and when you want to receive your reports
Create a new report configuration by performing a POST /reports using the report configurations of the report type you want.
Preset report configurations
You can use the following example report configurations for each preset report type.
Authorization report configuration
The following request code block shows how to configure an authorization report for entityType = CO/BU/TD. Download the sample Authorization report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionTitle": "Authorization Summary",
"sectionReportTypeName": "Transaction Details",
"sectionReportTypeId": "3001",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Authorization Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "MOP Type"
},
{
"reportAttributeName": "PTI Authorization Response Code",
"alias": "Response Code"
},
{
"reportAttributeName": "PTI Authorization Response Code Description",
"alias": "Response Description"
},
{
"reportAttributeName": "Firm Authorization Approval Code"
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Total Transaction Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": false
},
{
"reportAttributeName": "Authorization Amount",
"alias": "Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": false
},
{
"reportAttributeName": "Transaction Decline Count",
"alias": "Count of Declined Transactions",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": false
},
{
"alias": "Authorization Total Count %",
"customCalculationText": "% of",
"customCalculationOn": "Total Transaction Count",
"groupBy": [
"MOP Type"
]
},
{
"alias": "Authorization Status %",
"customCalculationText": "% of",
"customCalculationOn": "Total Transaction Count",
"groupBy": [
"MOP Type",
"PTI Authorization Response Code"
]
},
{
"alias": "Transaction Decline %",
"customCalculationText": "% of",
"customCalculationOn": "Count of Declined Transactions",
"groupBy": [
"MOP Type",
"PTI Authorization Response Code"
]
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Transaction Type Text",
"filterAttributeCode": "NOT IN (\"REJECTS\")"
},
{
"reportAttributeName": "Merchant Action Code Text",
"filterAttributeCode": "IN (\"DEPOSITS\",\"AUTHORIZATIONS\")"
},
{
"reportAttributeName": "Authorization Amount",
"filterAttributeCode": "IS NOT NULL"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "MOP Type",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "PTI Authorization Response Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Authorization Details",
"sectionReportTypeName": "Transaction Details",
"sectionReportTypeId": "3001",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Authorization Details"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Merchant Action Code Text"
},
{
"reportAttributeName": "Authorization Amount"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Credit Card Expiration Year Month Number"
},
{
"reportAttributeName": "Transaction Type Text"
},
{
"reportAttributeName": "Authorization Timestamp"
},
{
"reportAttributeName": "Authorization Code"
},
{
"reportAttributeName": "Payment Brand Auth Response"
},
{
"reportAttributeName": "Payment Brand Response Code Category"
},
{
"reportAttributeName": "PTI Authorization Response Code"
},
{
"reportAttributeName": "Authorization Initiator"
},
{
"reportAttributeName": "Authorization Source Code"
},
{
"reportAttributeName": "POS Authentication Source"
},
{
"reportAttributeName": "Merchant Category Code"
},
{
"reportAttributeName": "Country Of Issuance"
},
{
"reportAttributeName": "Digital Token Method Text"
},
{
"reportAttributeName": "Prepaid Card Type Code"
},
{
"reportAttributeName": "Commercial Card Code"
},
{
"reportAttributeName": "Card Usage Type"
},
{
"reportAttributeName": "Payment Transaction Identifier"
},
{
"reportAttributeName": "Terminal Identifier"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Merchant Action Code Text",
"filterAttributeCode": "IN (\"DEPOSITS\",\"AUTHORIZATIONS\")"
},
{
"reportAttributeName": "Authorization Amount",
"filterAttributeCode": "IS NOT NULL"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Merchant Order Number",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Authorization Report",
"reportFileName": "Authorization Report,<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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>",
"reportConfigStatus": "active",
"reportName": "Authorization Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-02-21 04:00:00",
"reportingPeriodEndTimestamp": "2023-02-22 03:59:59"
}
}The following request code block shows how to configure an authorization report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionTitle": "Authorization Summary",
"sectionReportTypeName": "Transaction Details",
"sectionReportTypeId": "3001",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Authorization Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "MOP Type"
},
{
"reportAttributeName": "PTI Authorization Response Code",
"alias": "Response Code"
},
{
"reportAttributeName": "PTI Authorization Response Code Description",
"alias": "Response Description"
},
{
"reportAttributeName": "Firm Authorization Approval Code"
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Total Transaction Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": false
},
{
"reportAttributeName": "Authorization Amount",
"alias": "Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": false
},
{
"reportAttributeName": "Transaction Decline Count",
"alias": "Count of Declined Transactions",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": false
},
{
"alias": "Authorization Total Count %",
"customCalculationText": "% of",
"customCalculationOn": "Total Transaction Count",
"groupBy": [
"MOP Type"
]
},
{
"alias": "Authorization Status %",
"customCalculationText": "% of",
"customCalculationOn": "Total Transaction Count",
"groupBy": [
"MOP Type",
"PTI Authorization Response Code"
]
},
{
"alias": "Transaction Decline %",
"customCalculationText": "% of",
"customCalculationOn": "Count of Declined Transactions",
"groupBy": [
"MOP Type",
"PTI Authorization Response Code"
]
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Transaction Type Text",
"filterAttributeCode": "NOT IN (\"REJECTS\")"
},
{
"reportAttributeName": "Merchant Action Code Text",
"filterAttributeCode": "IN (\"DEPOSITS\",\"AUTHORIZATIONS\")"
},
{
"reportAttributeName": "Authorization Amount",
"filterAttributeCode": "IS NOT NULL"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "MOP Type",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "PTI Authorization Response Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Authorization Details",
"sectionReportTypeName": "Transaction Details",
"sectionReportTypeId": "3001",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Authorization Details"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Merchant Action Code Text"
},
{
"reportAttributeName": "Authorization Amount"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Credit Card Expiration Year Month Number"
},
{
"reportAttributeName": "Transaction Type Text"
},
{
"reportAttributeName": "Authorization Timestamp"
},
{
"reportAttributeName": "Authorization Code"
},
{
"reportAttributeName": "Payment Brand Auth Response"
},
{
"reportAttributeName": "Payment Brand Response Code Category"
},
{
"reportAttributeName": "PTI Authorization Response Code"
},
{
"reportAttributeName": "Authorization Initiator"
},
{
"reportAttributeName": "Authorization Source Code"
},
{
"reportAttributeName": "POS Authentication Source"
},
{
"reportAttributeName": "Merchant Category Code"
},
{
"reportAttributeName": "Country Of Issuance"
},
{
"reportAttributeName": "Digital Token Method Text"
},
{
"reportAttributeName": "Prepaid Card Type Code"
},
{
"reportAttributeName": "Commercial Card Code"
},
{
"reportAttributeName": "Card Usage Type"
},
{
"reportAttributeName": "Payment Transaction Identifier"
},
{
"reportAttributeName": "Terminal Identifier"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Merchant Action Code Text",
"filterAttributeCode": "IN (\"DEPOSITS\",\"AUTHORIZATIONS\")"
},
{
"reportAttributeName": "Authorization Amount",
"filterAttributeCode": "IS NOT NULL"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Merchant Order Number",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Authorization Report",
"reportFileName": "Authorization Report,<Processing Entity ID>.<Report Type>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Authorization Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-02-21 04:00:00",
"reportingPeriodEndTimestamp": "2023-02-22 03:59:59"
}
}Charge summary report configuration
The following request code block shows how to configure a charge summary report for entityType = CO/BU/TD. Download the sample Charge summary report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"constantValueText": "Charge Summary",
"alias": "Record Type"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Charge Category Text"
},
{
"reportAttributeName": "Charge Subcategory Text"
},
{
"reportAttributeName": "Action Type Code Text"
},
{
"reportAttributeName": "Merchant Service Fee Schedule Identifier"
},
{
"reportAttributeName": "Fee Text"
},
{
"reportAttributeName": "Interchange Qualification Code"
},
{
"reportAttributeName": "Unit Quantity Number",
"aggregateOperationText": "sum",
"alias": "Unit Quantity"
},
{
"reportAttributeName": "Unit Fee Amount"
},
{
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "sum",
"alias": "Transaction Amount"
},
{
"reportAttributeName": "Fee Rate"
},
{
"reportAttributeName": "Settled Total Fee Amount",
"aggregateOperationText": "sum",
"alias": "Total Charge"
},
{
"reportAttributeName": "Sales Tax",
"aggregateOperationText": "sum",
"alias": "Sales Tax"
},
{
"reportAttributeName": "Federal Tax",
"aggregateOperationText": "sum",
"alias": "Federal Tax"
},
{
"reportAttributeName": "Provincial Tax",
"aggregateOperationText": "sum",
"alias": "Provincial Tax"
},
{
"reportAttributeName": "Total Charge after Tax",
"aggregateOperationText": "sum",
"alias": "Total Charge after Tax"
}
]
},
],
"sectionSortOrderList": [
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}, {
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Charge Category Text",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Charge Subcategory Text",
"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\",\"Monthly Non-Transaction Fees\")"
}
]
},
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"distinctSelectIndicator": true,
"sectionSelectedFields": [
{
"constantValueText": "Tax Information",
"alias": "Record Type"
},
{
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Acquirer Codice Fiscale"
},
{
"reportAttributeName": "Acquirer Legal Entity"
},
{
"reportAttributeName": "CPSI GST Registration Number"
},
{
"reportAttributeName": "CPSI QST Registration Number"
},
{
"reportAttributeName": "Merchant Codice Fiscale"
},
{
"reportAttributeName": "Recipient Address"
},
{
"reportAttributeName": "Recipient Legal Entity"
}
],
"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\",\"Monthly Non-Transaction Fees\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Charge Summary Report",
"reportFileName": "Charge Summary Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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,
"totalRowCountDisplayIndicator": false,
"reportName": "Charge Summary Report",
"sectionRowCountDisplayIndicator": false,
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-08-27 11:30:00",
"reportingPeriodEndTimestamp": "2023-08-28 02:00:00"
}
}The following request code block shows how to configure a charge summary report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"constantValueText": "Charge Summary",
"alias": "Record Type"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Charge Category Text"
},
{
"reportAttributeName": "Charge Subcategory Text"
},
{
"reportAttributeName": "Action Type Code Text"
},
{
"reportAttributeName": "Merchant Service Fee Schedule Identifier"
},
{
"reportAttributeName": "Fee Text"
},
{
"reportAttributeName": "Interchange Qualification Code"
},
{
"reportAttributeName": "Unit Quantity Number",
"aggregateOperationText": "sum",
"alias": "Unit Quantity"
},
{
"reportAttributeName": "Unit Fee Amount"
},
{
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "sum",
"alias": "Transaction Amount"
},
{
"reportAttributeName": "Fee Rate"
},
{
"reportAttributeName": "Settled Total Fee Amount",
"aggregateOperationText": "sum",
"alias": "Total Charge"
},
{
"reportAttributeName": "Sales Tax",
"aggregateOperationText": "sum",
"alias": "Sales Tax"
},
{
"reportAttributeName": "Federal Tax",
"aggregateOperationText": "sum",
"alias": "Federal Tax"
},
{
"reportAttributeName": "Provincial Tax",
"aggregateOperationText": "sum",
"alias": "Provincial Tax"
},
{
"reportAttributeName": "Total Charge after Tax",
"aggregateOperationText": "sum",
"alias": "Total Charge after Tax"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Charge Category Text",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Charge Subcategory Text",
"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\",\"Monthly Non-Transaction Fees\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Charge Summary Report",
"reportFileName": "Charge Summary Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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,
"totalRowCountDisplayIndicator": false,
"reportName": "Charge Summary Report",
"sectionRowCountDisplayIndicator": false,
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-08-27 11:30:00",
"reportingPeriodEndTimestamp": "2023-08-28 02:00:00"
}
}Deposit details report configuration
The following request code block shows how to configure a deposit details report for entityType = CO/BU/TD. Download the sample Deposit details report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"reportAttributeName": "Submission Date"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Credit Card Expiration Year Month Number"
},
{
"alias": "Transaction Amount in Presentment Currency",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"SALE\",\"REF\")"
}
]
},
{
"reportAttributeName": "Merchant Action Code"
},
{
"reportAttributeName": "Action Type Code Text"
},
{
"reportAttributeName": "Authorization Date"
},
{
"reportAttributeName": "Country of Issuance"
},
{
"reportAttributeName": "Transaction Type Code"
},
{
"reportAttributeName": "Transaction Type Text"
},
{
"reportAttributeName": "Merchant Category Code"
},
{
"reportAttributeName": "Digital Token Method Code"
},
{
"reportAttributeName": "Digital Wallet Brand"
},
{
"alias": "Interchange Qualification Code",
"reportAttributeName": "Interchange Qualification Code",
"aggregateOperationText": "max",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Fee Text",
"aggregateConditionText": "IN(\"Interchange\")"
}
]
},
{
"alias": "Interchange Unit Fee",
"reportAttributeName": "Unit Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Fee Text",
"aggregateConditionText": "IN(\"Interchange\")"
}
]
},
{
"alias": "Fee Rate",
"reportAttributeName": "Fee Rate",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Fee Text",
"aggregateConditionText": "IN(\"Interchange\")"
}
]
},
{
"alias": "Total Interchange Amount",
"reportAttributeName": "Raw Settled Total Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"IA\")"
},
{
"aggregateConditionAttributeName": "Charge Subcategory Text",
"aggregateConditionText": "IN(\"Interchange Fees\")"
}
]
},
{
"alias": "Total Assessment Amount",
"reportAttributeName": "Raw Settled Total Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"IA\")"
},
{
"aggregateConditionAttributeName": "Charge Subcategory Text",
"aggregateConditionText": "IN (\"Assessment Fees\")"
}
]
},
{
"alias": "Other Debit Passthrough Fees",
"reportAttributeName": "Raw Settled Total Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"PFEE\")"
},
{
"aggregateConditionAttributeName": "Charge Subcategory Text",
"aggregateConditionText": "IN(\"Debit Pass Thru Fees\")"
}
]
},
{
"reportAttributeName": "Merchant Information Description"
},
{
"reportAttributeName": "Surcharge Amount"
},
{
"reportAttributeName": "Bank Sort Code"
},
{
"reportAttributeName": "Card Usage Type"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Submission Date",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Transaction Division External Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Online Submission Indicator",
"filterAttributeCode": "=\"N\""
},
{
"reportAttributeName": "Merchant Action Text",
"filterAttributeCode": "=\"DEPOSITS\""
},
{
"reportAttributeName": "Transaction Type Text",
"filterAttributeCode": "!=\"Rejects\""
},
{
"reportAttributeName": "Transaction Deposit Indicator",
"filterAttributeCode": "=\"Y\""
},
{
"reportAttributeName": "Merchant Order Number",
"filterAttributeCode": "!=\"NULL\""
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Deposit Detail Report",
"reportFileName": "Deposit Detail Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Deposit Detail Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-05-06 11:30:00",
"reportingPeriodEndTimestamp": "2024-05-07 02:00:00"
}
}The following request code block shows how to configure a deposit details report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"reportAttributeName": "Submission Date"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Credit Card Expiration Year Month Number"
},
{
"alias": "Transaction Amount in Presentment Currency",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"SALE\",\"REF\")"
}
]
},
{
"reportAttributeName": "Merchant Action Code"
},
{
"reportAttributeName": "Action Type Code Text"
},
{
"reportAttributeName": "Authorization Date"
},
{
"reportAttributeName": "Country of Issuance"
},
{
"reportAttributeName": "Transaction Type Code"
},
{
"reportAttributeName": "Transaction Type Text"
},
{
"reportAttributeName": "Merchant Category Code"
},
{
"reportAttributeName": "Digital Token Method Code"
},
{
"reportAttributeName": "Digital Wallet Brand"
},
{
"alias": "Interchange Qualification Code",
"reportAttributeName": "Interchange Qualification Code",
"aggregateOperationText": "max",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Fee Text",
"aggregateConditionText": "IN(\"Interchange\")"
}
]
},
{
"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": "Raw Settled Total Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"IA\")"
},
{
"aggregateConditionAttributeName": "Charge Subcategory Text",
"aggregateConditionText": "IN(\"Interchange Fees\")"
}
]
},
{
"alias": "Total Assessment Amount",
"reportAttributeName": "Raw Settled Total Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"IA\")"
},
{
"aggregateConditionAttributeName": "Charge Subcategory Text",
"aggregateConditionText": "IN (\"Assessment Fees\")"
}
]
},
{
"alias": "Other Debit Passthrough Fees",
"reportAttributeName": "Raw Settled Total Fee Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"PFEE\")"
},
{
"aggregateConditionAttributeName": "Charge Subcategory Text",
"aggregateConditionText": "IN(\"Debit Pass Thru Fees\")"
}
]
},
{
"reportAttributeName": "Merchant Information Description"
},
{
"reportAttributeName": "Surcharge Amount"
},
{
"reportAttributeName": "Bank Sort Code"
},
{
"reportAttributeName": "Card Usage Type"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Submission Date",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Online Submission Indicator",
"filterAttributeCode": "=\"N\""
},
{
"reportAttributeName": "Merchant Action Text",
"filterAttributeCode": "=\"DEPOSITS\""
},
{
"reportAttributeName": "Transaction Type Text",
"filterAttributeCode": "!=\"Rejects\""
},
{
"reportAttributeName": "Transaction Deposit Indicator",
"filterAttributeCode": "=\"Y\""
},
{
"reportAttributeName": "Merchant Order Number",
"filterAttributeCode": "!=\"NULL\""
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Deposit Detail Report",
"reportFileName": "Deposit Detail Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Deposit Detail Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-05-06 11:30:00",
"reportingPeriodEndTimestamp": "2024-05-07 02:00:00"
}
}Deposit activity summary report configuration
The following request code block shows how to configure a deposit activity summary report for entityType = CO/BU/TD. Download the sample Deposit activity summary report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionTitle": "Conveyed Deposit Summary",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Conveyed Deposit Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"alias": "Conveyed Sales Count",
"reportAttributeName": "Transaction Count",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Conveyed Sales\")"
}
]
},
{
"alias": "Conveyed Sales Amount",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Conveyed Sales\")"
}
]
},
{
"alias": "Conveyed Refund Count",
"reportAttributeName": "Transaction Count",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Conveyed Refunds\")"
}
]
},
{
"alias": "Conveyed Refund Amount",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Conveyed Refunds\")"
}
]
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Charge Category Text",
"filterAttributeCode": "IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Settled Deposit Summary",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Settled Deposit Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"alias": "Settled Sales Count",
"reportAttributeName": "Transaction Count",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Settled Sales\")"
}
]
},
{
"alias": "Settled Sales Amount in Presentment Currency",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"SALE\")"
}
]
},
{
"alias": "Settled Sales Amount in Settlement Currency",
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"SALE\")"
}
]
},
{
"alias": "Settled Refund Count",
"reportAttributeName": "Transaction Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"REF\")"
}
]
},
{
"alias": "Settled Refund Amount in Presentment Currency",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"REF\")"
}
]
},
{
"alias": "Settled Refund Amount in Settlement Currency",
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"REF\")"
}
]
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Charge Category Text",
"filterAttributeCode": "IN (\"Settled Sales\",\"Settled Refunds\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Fees & Adjustments Summary",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Fees & Adjustments Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Settlement Amount",
"alias": "Net Settled Deposits Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN (\"SALE\",\"REF\")"
},
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN (\"S\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Interchange & Assessment Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Interchange & Assessment Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Processing Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Chargeback Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Chargeback Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Other Fees & Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Settled Sales\",\"Settled Refunds\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Interchange & Assessment Fees\",\"Chargeback Adjustments\",\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Net Financial Activity",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
]
},
{
"reportAttributeName": "Foreign Exchange Rate"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Charge Category Text",
"filterAttributeCode": "Not IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Deposit Transfer Summary",
"sectionReportTypeName": "Settlement Summary",
"sectionReportTypeId": "3005",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Deposit Transfer Summary"
},
{
"reportAttributeName": "Activity Date"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Funds Transfer Category Description"
},
{
"reportAttributeName": "Fund Transfer Instruction Number"
},
{
"reportAttributeName": "Fund Transfer Identifier"
},
{
"reportAttributeName": "Merchant Activity Date Range"
},
{
"reportAttributeName": "Fund Transfer Effective Date"
},
{
"alias": "Funds Transfer Amount",
"reportAttributeName": "Funds Transfer Category Amount",
"aggregateOperationText": "sum"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Activity Date",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Funds Transfer Category Description",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Fund Transfer Effective Date",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Fund Transfer Identifier",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Category Code",
"filterAttributeCode": "NOT IN (\"OTHER\")"
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"filterAttributeCode": "!=0.0"
},
{
"reportAttributeName": "Settled Conveyed Code",
"filterAttributeCode": "IN (\"S\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Deposit Activity Summary Report",
"reportFileName": "Deposit ACtivity Summary Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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>",
"reportName": "Deposit Activity Summary Report",
"csvColumnNameDisplayIndicator": true,
"reportConfigStatus": "active",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-07-24 02:00:00",
"reportingPeriodEndTimestamp": "2024-07-25 01:59:59"
}
}The following request code block shows how to configure a deposit activity summary report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionTitle": "Conveyed Deposit Summary",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Conveyed Deposit Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"alias": "Conveyed Sales Count",
"reportAttributeName": "Transaction Count",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Conveyed Sales\")"
}
]
},
{
"alias": "Conveyed Sales Amount",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Conveyed Sales\")"
}
]
},
{
"alias": "Conveyed Refund Count",
"reportAttributeName": "Transaction Count",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Conveyed Refunds\")"
}
]
},
{
"alias": "Conveyed Refund Amount",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Conveyed Refunds\")"
}
]
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Charge Category Text",
"filterAttributeCode": "IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Settled Deposit Summary",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Settled Deposit Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"alias": "Settled Sales Count",
"reportAttributeName": "Transaction Count",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN(\"Settled Sales\")"
}
]
},
{
"alias": "Settled Sales Amount in Presentment Currency",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"SALE\")"
}
]
},
{
"alias": "Settled Sales Amount in Settlement Currency",
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"SALE\")"
}
]
},
{
"alias": "Settled Refund Count",
"reportAttributeName": "Transaction Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"REF\")"
}
]
},
{
"alias": "Settled Refund Amount in Presentment Currency",
"reportAttributeName": "Presentment Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"REF\")"
}
]
},
{
"alias": "Settled Refund Amount in Settlement Currency",
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN(\"S\")"
},
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN(\"REF\")"
}
]
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Charge Category Text",
"filterAttributeCode": "IN (\"Settled Sales\",\"Settled Refunds\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Fees & Adjustments Summary",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Fees & Adjustments Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Settlement Amount",
"alias": "Net Settled Deposits Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Code",
"aggregateConditionText": "IN (\"SALE\",\"REF\")"
},
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "IN (\"S\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Interchange & Assessment Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Interchange & Assessment Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Processing Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Chargeback Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Chargeback Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Other Fees & Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Settled Sales\",\"Settled Refunds\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Interchange & Assessment Fees\",\"Chargeback Adjustments\",\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Net Financial Activity",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
]
},
{
"reportAttributeName": "Foreign Exchange Rate"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Charge Category Text",
"filterAttributeCode": "Not IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Deposit Transfer Summary",
"sectionReportTypeName": "Settlement Summary",
"sectionReportTypeId": "3005",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Deposit Transfer Summary"
},
{
"reportAttributeName": "Activity Date"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Funds Transfer Category Description"
},
{
"reportAttributeName": "Fund Transfer Instruction Number"
},
{
"reportAttributeName": "Fund Transfer Identifier"
},
{
"reportAttributeName": "Merchant Activity Date Range"
},
{
"reportAttributeName": "Fund Transfer Effective Date"
},
{
"alias": "Fund Transfer Amount",
"reportAttributeName": "Funds Transfer Category Amount",
"aggregateOperationText": "sum"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Activity Date",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Funds Transfer Category Description",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Fund Transfer Effective Date",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Fund Transfer Identifier",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Category Code",
"filterAttributeCode": "NOT IN (\"OTHER\")"
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"filterAttributeCode": "!=0.0"
},
{
"reportAttributeName": "Settled Conveyed Code",
"filterAttributeCode": "IN (\"S\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Deposit Activity Summary Report",
"reportFileName": "Deposit ACtivity Summary Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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>",
"reportName": "Deposit Activity Summary Report",
"csvColumnNameDisplayIndicator": true,
"reportConfigStatus": "active",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-07-24 02:00:00",
"reportingPeriodEndTimestamp": "2024-07-25 01:59:59"
}
}Dispute details report configuration
The following request code block shows how to configure a dispute details report for entityType = CO/BU/TD. Download the sample Dispute details report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Dispute Details v2",
"sectionReportTypeId": "3017",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "DisputeSummary"
},
{
"reportAttributeName": "Transaction Division External Identifier"
},
{
"alias": "Dispute Type Code",
"reportAttributeName": "Post Deposit Event Dispute Type Code"
},
{
"alias": "Category",
"reportAttributeName": "Dispute Category Code"
},
{
"reportAttributeName": "Financial Non-Financial Code"
},
{
"alias": "Count",
"reportAttributeName": "Record Count",
"aggregateOperationText": "sum"
},
{
"alias": "Presentment Currency Amount",
"reportAttributeName": "Post Deposit Event Action Presentment Currency Amount",
"aggregateOperationText": "sum"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"alias": "Settlement Currency Amount",
"reportAttributeName": "Post Deposit Event Action Settlement Currency Amount",
"aggregateOperationText": "sum"
},
{
"reportAttributeName": "Settlement Currency Code"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Post Deposit Event Dispute Type Code",
"filterAttributeCode": "IN (\"CB\",\"ECP\",\"AJ\")" },
{
"reportAttributeName": "Dispute Category Code",
"filterAttributeCode": "IN (\"BEGINV\",\"RECD\",\"REPR\",\"PARREP\",\"OPAACCEPT\",\"RECRS\",\"RTM\",\"PARRTM\",\"OPAREQ\",\"OPADENY\",\"ADJPDE\",\"ADJPAR\",\"ENDINV\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Division External Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Dispute Category Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionReportTypeName": "Dispute Details v2",
"sectionReportTypeId": "3017",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "DisputeDetails"
},
{
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Dispute Transaction Sequence Number"
},
{
"alias": "Dispute Type Code",
"reportAttributeName": "Post Deposit Event Dispute Type Code"
},
{
"alias": "Category",
"reportAttributeName": "Dispute Category Code"
},
{
"reportAttributeName": "Issuer Dispute Presentment Currency Amount"
},
{
"alias": "Current Action Presentment Currency Amount",
"reportAttributeName": "Post Deposit Event Action Presentment Currency Amount"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Consumer Name"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Payment Brand Dispute Reason Code"
},
{
"reportAttributeName": "Payment Brand Dispute Reason Text"
},
{
"reportAttributeName": "ECP Reason Category Classification"
},
{
"reportAttributeName": "ECP Reason Category Classification Text"
},
{
"reportAttributeName": "Transaction Date"
},
{
"reportAttributeName": "Dispute Initiate Date"
},
{
"alias": "Activity Date",
"reportAttributeName": "Dispute Activity Date"
},
{
"reportAttributeName": "Dispute Due Date"
},
{
"reportAttributeName": "Dispute Usage Code"
},
{
"reportAttributeName": "Accountholder Authorization Method"
},
{
"reportAttributeName": "Accountholder Authorization Method Text"
},
{
"reportAttributeName": "Acquirer Reference Number"
},
{
"reportAttributeName": "Issuer Dispute Settlement Currency Amount"
},
{
"alias": "Current Action Settlement Currency Amount",
"reportAttributeName": "Post Deposit Event Action Settlement Currency Amount"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Authorization Date"
},
{
"reportAttributeName": "Action Code"
},
{
"reportAttributeName": "Cardholder Debit Credit Indicator"
},
{
"reportAttributeName": "Adjustment Number"
},
{
"reportAttributeName": "Ticket Number"
},
{
"reportAttributeName": "Status Flag Code"
},
{
"reportAttributeName": "Digital Token Method Code"
},
{
"reportAttributeName": "Potential Bundled Chargebacks Indicator"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Post Deposit Event Dispute Type Code",
"filterAttributeCode": "IN (\"CB\",\"ECP\",\"AJ\")"
},
{
"reportAttributeName": "Dispute Category Code",
"filterAttributeCode": "IN (\"RECD\",\"REPR\",\"PARREP\",\"OPAACCEPT\",\"RECRS\",\"RTM\",\"PARRTM\",\"OPAREQ\",\"OPADENY\",\"ADJPDE\",\"ENDINV\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Division External Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Dispute Category Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Dispute Transaction Sequence Number",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Dispute Details Report",
"reportFileName": "Dispute Details.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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,
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-06-03 00:00:00",
"reportingPeriodEndTimestamp": "2024-06-04 00:00:00"
}
}The following request code block shows how to configure a dispute details report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Dispute Details v2",
"sectionReportTypeId": "3017",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "DisputeSummary"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"alias": "Dispute Type Code",
"reportAttributeName": "Post Deposit Event Dispute Type Code"
},
{
"alias": "Category",
"reportAttributeName": "Dispute Category Code"
},
{
"reportAttributeName": "Financial Non-Financial Code"
},
{
"alias": "Count",
"reportAttributeName": "Record Count",
"aggregateOperationText": "sum"
},
{
"alias": "Presentment Currency Amount",
"reportAttributeName": "Post Deposit Event Action Presentment Currency Amount",
"aggregateOperationText": "sum"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"alias": "Settlement Currency Amount",
"reportAttributeName": "Post Deposit Event Action Settlement Currency Amount",
"aggregateOperationText": "sum"
},
{
"reportAttributeName": "Settlement Currency Code"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Post Deposit Event Dispute Type Code",
"filterAttributeCode": "IN (\"CB\",\"ECP\",\"AJ\")" },
{
"reportAttributeName": "Dispute Category Code",
"filterAttributeCode": "IN (\"BEGINV\",\"RECD\",\"REPR\",\"PARREP\",\"OPAACCEPT\",\"RECRS\",\"RTM\",\"PARRTM\",\"OPAREQ\",\"OPADENY\",\"ADJPDE\",\"ADJPAR\",\"ENDINV\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Processing Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Dispute Category Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionReportTypeName": "Dispute Details v2",
"sectionReportTypeId": "3017",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "DisputeDetails"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"reportAttributeName": "Dispute Transaction Sequence Number"
},
{
"alias": "Dispute Type Code",
"reportAttributeName": "Post Deposit Event Dispute Type Code"
},
{
"alias": "Category",
"reportAttributeName": "Dispute Category Code"
},
{
"reportAttributeName": "Issuer Dispute Presentment Currency Amount"
},
{
"alias": "Current Action Presentment Currency Amount",
"reportAttributeName": "Post Deposit Event Action Presentment Currency Amount"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Consumer Name"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Payment Brand Dispute Reason Code"
},
{
"reportAttributeName": "Payment Brand Dispute Reason Text"
},
{
"reportAttributeName": "ECP Reason Category Classification"
},
{
"reportAttributeName": "ECP Reason Category Classification Text"
},
{
"reportAttributeName": "Transaction Date"
},
{
"reportAttributeName": "Dispute Initiate Date"
},
{
"alias": "Activity Date",
"reportAttributeName": "Dispute Activity Date"
},
{
"reportAttributeName": "Dispute Due Date"
},
{
"reportAttributeName": "Dispute Usage Code"
},
{
"reportAttributeName": "Accountholder Authorization Method"
},
{
"reportAttributeName": "Accountholder Authorization Method Text"
},
{
"reportAttributeName": "Acquirer Reference Number"
},
{
"reportAttributeName": "Issuer Dispute Settlement Currency Amount"
},
{
"alias": "Current Action Settlement Currency Amount",
"reportAttributeName": "Post Deposit Event Action Settlement Currency Amount"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Authorization Date"
},
{
"reportAttributeName": "Action Code"
},
{
"reportAttributeName": "Cardholder Debit Credit Indicator"
},
{
"reportAttributeName": "Adjustment Number"
},
{
"reportAttributeName": "Ticket Number"
},
{
"reportAttributeName": "Status Flag Code"
},
{
"reportAttributeName": "Digital Token Method Code"
},
{
"reportAttributeName": "Potential Bundled Chargebacks Indicator"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Post Deposit Event Dispute Type Code",
"filterAttributeCode": "IN (\"CB\",\"ECP\",\"AJ\")"
},
{
"reportAttributeName": "Dispute Category Code",
"filterAttributeCode": "IN (\"RECD\",\"REPR\",\"PARREP\",\"OPAACCEPT\",\"RECRS\",\"RTM\",\"PARRTM\",\"OPAREQ\",\"OPADENY\",\"ADJPDE\",\"ENDINV\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Processing Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Dispute Category Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Dispute Transaction Sequence Number",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Dispute Details Report",
"reportFileName": "Dispute Details.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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,
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-06-03 00:00:00",
"reportingPeriodEndTimestamp": "2024-06-04 00:00:00"
}
}Exception report configuration
The following request code block shows how to configure an exception report for entityType = CO/BU/TD. Download the sample Exception report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Transaction Details",
"sectionReportTypeId": "3001",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Transaction Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Merchant Presenter Identifier"
},
{
"reportAttributeName": "Merchant Presenter Short Name"
},
{
"reportAttributeName": "Submission Identifier"
},
{
"reportAttributeName": "Submission Status"
},
{
"reportAttributeName": "Submission Date"
},
{
"alias": "Transaction Count",
"reportAttributeName": "Merchant Order Number",
"aggregateOperationText": "count"
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Authorization Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Merchant Action Code Text",
"aggregateConditionText": "= 'AUTHORIZATIONS'"
},
{
"aggregateConditionAttributeName": "Submission File Status",
"aggregateConditionText": "= 'RD'"
}
]
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Declined Deposit Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Declined Deposit'"
}
]
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Declined Deposit Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Declined Deposit'"
}
]
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Rejected Transaction Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Rejected Transaction'"
}
]
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Rejected Transaction Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Rejected Transaction'"
}
]
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Cancelled/On-Hold Deposit Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Cancels/OnHold'"
}
]
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Cancelled/On-Hold Net Deposit Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Cancels/OnHold'"
}
]
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Successful Deposit Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Transaction Deposit Indicator",
"aggregateConditionText": "= 'Y'"
},
{
"aggregateConditionAttributeName": "Submission File Status",
"aggregateConditionText": "= 'RD'"
}
]
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Successful Net Deposit Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Transaction Deposit Indicator",
"aggregateConditionText": "= 'Y'"
},
{
"aggregateConditionAttributeName": "Submission File Status",
"aggregateConditionText": "= 'RD'"
}
]
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Merchant Presenter Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Submission Identifier",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Merchant Action Code Text",
"filterAttributeCode": "NOT IN (\"EXCLUDE FROM REPORTING\")"
},
{
"reportAttributeName": "Online Submission Indicator",
"filterAttributeCode": "IN (\"N\")"
},
{
"reportAttributeName": "Latest Authorization Indicator",
"filterAttributeCode": "=\"TRUE\""
}
]
},
{
"sectionReportTypeName": "Transaction Details",
"sectionReportTypeId": "3001",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Exception Details"
},
{
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Submission Identifier"
},
{
"reportAttributeName": "Record Number"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Exception Description"
},
{
"alias": "Amount",
"reportAttributeName": "Presentment Amount"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Credit Card Expiration Year Month Number"
},
{
"reportAttributeName": "Merchant Action Code Text"
},
{
"reportAttributeName": "Authorization Date"
},
{
"reportAttributeName": "Authorization Code"
},
{
"alias": "Auth Response Code",
"reportAttributeName": "PTI Authorization Response Code"
},
{
"reportAttributeName": "Country Of Issuance"
},
{
"reportAttributeName": "Merchant Category Code"
},
{
"reportAttributeName": "Reject Code"
},
{
"reportAttributeName": "Card Usage Type"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Division External Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Submission Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Merchant Order Number",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Exception Description",
"filterAttributeCode": "IN(\"rejected transaction\",\"declined deposit\",\"cancels/onhold\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Transaction Summary & Exception Report",
"reportFileName": "Transaction Summary & Exception Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Transaction Summary & Exception Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-05-06 11:30:00",
"reportingPeriodEndTimestamp": "2024-05-07 02:00:00"
}
}The following request code block shows how to configure an exception report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Transaction Details",
"sectionReportTypeId": "3001",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Transaction Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Merchant Presenter Identifier"
},
{
"reportAttributeName": "Merchant Presenter Short Name"
},
{
"reportAttributeName": "Submission Identifier"
},
{
"reportAttributeName": "Submission Status"
},
{
"reportAttributeName": "Submission Date"
},
{
"alias": "Transaction Count",
"reportAttributeName": "Merchant Order Number",
"aggregateOperationText": "count"
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Authorization Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Merchant Action Code Text",
"aggregateConditionText": "= 'AUTHORIZATIONS'"
},
{
"aggregateConditionAttributeName": "Submission File Status",
"aggregateConditionText": "= 'RD'"
}
]
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Declined Deposit Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Declined Deposit'"
}
]
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Declined Deposit Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Declined Deposit'"
}
]
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Rejected Transaction Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Rejected Transaction'"
}
]
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Rejected Transaction Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Rejected Transaction'"
}
]
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Cancelled/On-Hold Deposit Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Cancels/OnHold'"
}
]
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Cancelled/On-Hold Net Deposit Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Exception Description",
"aggregateConditionText": "= 'Cancels/OnHold'"
}
]
},
{
"reportAttributeName": "Merchant Order Number",
"alias": "Successful Deposit Count",
"aggregateOperationText": "count",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Transaction Deposit Indicator",
"aggregateConditionText": "= 'Y'"
},
{
"aggregateConditionAttributeName": "Submission File Status",
"aggregateConditionText": "= 'RD'"
}
]
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Successful Net Deposit Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Transaction Deposit Indicator",
"aggregateConditionText": "= 'Y'"
},
{
"aggregateConditionAttributeName": "Submission File Status",
"aggregateConditionText": "= 'RD'"
}
]
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Merchant Presenter Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Submission Identifier",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Merchant Action Code Text",
"filterAttributeCode": "NOT IN (\"EXCLUDE FROM REPORTING\")"
},
{
"reportAttributeName": "Online Submission Indicator",
"filterAttributeCode": "IN (\"N\")"
},
{
"reportAttributeName": "Latest Authorization Indicator",
"filterAttributeCode": "=\"TRUE\""
}
]
},
{
"sectionReportTypeName": "Transaction Details",
"sectionReportTypeId": "3001",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Exception Details"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Submission Identifier"
},
{
"reportAttributeName": "Record Number"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Exception Description"
},
{
"alias": "Amount",
"reportAttributeName": "Presentment Amount"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Credit Card Expiration Year Month Number"
},
{
"reportAttributeName": "Merchant Action Code Text"
},
{
"reportAttributeName": "Authorization Date"
},
{
"reportAttributeName": "Authorization Code"
},
{
"alias": "Auth Response Code",
"reportAttributeName": "PTI Authorization Response Code"
},
{
"reportAttributeName": "Country Of Issuance"
},
{
"reportAttributeName": "Merchant Category Code"
},
{
"reportAttributeName": "Reject Code"
},
{
"reportAttributeName": "Card Usage Type"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Processing Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Submission Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Merchant Order Number",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Exception Description",
"filterAttributeCode": "IN(\"rejected transaction\",\"declined deposit\",\"cancels/onhold\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Transaction Summary & Exception Report",
"reportFileName": "Transaction Summary & Exception Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Transaction Summary & Exception Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-05-06 11:30:00",
"reportingPeriodEndTimestamp": "2024-05-07 02:00:00"
}
}Financial activity summary report configuration
The following request code block shows how to configure a financial activity summary report for entityType = CO/BU/TD. Download the sample Financial activity summary report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Settlement Summary",
"sectionReportTypeId": "3005",
"sectionSelectedFields": [
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Activity EDT Date",
"alias": "Reporting Date"
},
{
"reportAttributeName": "Category Amount",
"alias": "Net Conveyed Deposits",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "IN(\"SALE\",\"REF\")"
},
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"C\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Category Amount",
"alias": "Net Settled Deposits",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "IN(\"SALE\",\"REF\")"
},
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"alias": "Foreign Exchange Rate",
"reportAttributeName": "Foreign Exchange Rate",
"aggregateOperationText": "max",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Net Settled Deposits in Settlement Currency",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "IN(\"SALE\",\"REF\")"
},
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Chargeback/ECPReturns/Debit Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "IN(\"CB\",\"ERET\",\"DBADJ\")"
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Interchange & Assessment Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"IA\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Processing Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"PFEE\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Other Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"OTH\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Backup With Holding Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"BUW\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Reserve Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"RES\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Net Financial Activity",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Rejected Transfers",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Funds Transfer Category Code",
"aggregateConditionText": "= \"REJFT\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Pending Transfers",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Funds Transfer Category Code",
"aggregateConditionText": "= \"PENDFT\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Effective Transfers",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Funds Transfer Category Code",
"aggregateConditionText": "= \"EFEFT\""
}
]
},
{
"reportAttributeName": "Daily Ending Balance"
},
{
"reportAttributeName": "Reserve Balance"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Activity EDT Date",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Category Code",
"filterAttributeCode": "NOT IN (\"OTHER\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Financial Activity Summary Report",
"reportFileName": "Financial Activity Summary Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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>",
"reportName": "Financial Activity Summary Report",
"csvColumnNameDisplayIndicator": true,
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-02-03 04:00:00",
"reportingPeriodEndTimestamp": "2023-02-05 03:59:59"
}
}The following request code block shows how to configure a financial activity summary report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Settlement Summary",
"sectionReportTypeId": "3005",
"sectionSelectedFields": [
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Activity EDT Date",
"alias": "Reporting Date"
},
{
"reportAttributeName": "Category Amount",
"alias": "Net Conveyed Deposits",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "IN(\"SALE\",\"REF\")"
},
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"C\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Category Amount",
"alias": "Net Settled Deposits",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "IN(\"SALE\",\"REF\")"
},
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"alias": "Foreign Exchange Rate",
"reportAttributeName": "Foreign Exchange Rate",
"aggregateOperationText": "max",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Net Settled Deposits in Settlement Currency",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "IN(\"SALE\",\"REF\")"
},
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Chargeback/ECPReturns/Debit Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "IN(\"CB\",\"ERET\",\"DBADJ\")"
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Interchange & Assessment Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"IA\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Processing Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"PFEE\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Other Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"OTH\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Backup With Holding Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"BUW\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Reserve Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Category Code",
"aggregateConditionText": "=\"RES\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Net Financial Activity",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Current Merchant Activity Indicator",
"aggregateConditionText": "=\"TRUE\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Rejected Transfers",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Funds Transfer Category Code",
"aggregateConditionText": "= \"REJFT\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Pending Transfers",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Funds Transfer Category Code",
"aggregateConditionText": "= \"PENDFT\""
}
]
},
{
"reportAttributeName": "Funds Transfer Category Amount",
"alias": "Effective Transfers",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Settled Conveyed Code",
"aggregateConditionText": "=\"S\""
},
{
"aggregateConditionAttributeName": "Funds Transfer Category Code",
"aggregateConditionText": "= \"EFEFT\""
}
]
},
{
"reportAttributeName": "Daily Ending Balance"
},
{
"reportAttributeName": "Reserve Balance"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Activity EDT Date",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Category Code",
"filterAttributeCode": "NOT IN (\"OTHER\")"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Financial Activity Summary Report",
"reportFileName": "Financial Activity Summary Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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>",
"reportName": "Financial Activity Summary Report",
"csvColumnNameDisplayIndicator": true,
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-02-03 04:00:00",
"reportingPeriodEndTimestamp": "2023-02-05 03:59:59"
}
}Funded transaction fee details report configuration
The following request code block shows how to configure a funded transaction fee details report for entityType = CO/BU/TD. Download the sample Funded transaction fee details report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Fee Details",
"sectionReportTypeId": "3006",
"sectionTitle": "Funded Transaction Fee Detail",
"sectionSelectedFields": [
{
"reportAttributeName": "Activity Date"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Foreign Exchange Rate"
},
{
"reportAttributeName": "Funds Transfer Category Text"
},
{
"reportAttributeName": "Fund Transfer Identifier"
},
{
"reportAttributeName": "Fund Transfer Instruction Number"
},
{
"reportAttributeName": "Fund Transfer Effective Date"
},
{
"reportAttributeName": "Acquirer Reference Number"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Sale/Refund Code"
},
{
"reportAttributeName": "Action Type Code"
},
{
"reportAttributeName": "Secure Bank Account Number"
},
{
"reportAttributeName": "Presentment Amount"
},
{
"alias": "Presentment Amount in Settlement Currency",
"reportAttributeName": "Transaction Amount"
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Net Settled Sales Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Settled Sales\",\"Settled Refunds\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Interchange & Assessment Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Interchange & Assessment Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Back Up Withholding Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Back Up Withholding Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Chargeback Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Chargeback Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Discount Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Discount Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "ECP Return Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"ECP Return Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Other Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Other Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Processing Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Reserve Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Reserve Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Other Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Reserve Adjustments\",\"Interchange & Assessment Fees\",\"Back Up Withholding Adjustments\",\"Chargeback Adjustments\",\"Discount Fees\",\"ECP Return Adjustments\",\"Settled Sales\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Settled Refunds\", \"Other Adjustments\",\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Net Financial Activity",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
]
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Settled Total Fee Amount",
"filterAttributeCode": "!=0.0"
},
{
"reportAttributeName": "Settled Conveyed Code",
"filterAttributeCode": "='S'"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Funded Transaction Fee Detail Report",
"reportFileName": "Funded Transaction Fee Detail Report,<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Funded Transaction Fee Detail Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-02-21 04:00:00",
"reportingPeriodEndTimestamp": "2023-02-22 03:59:59"
}
}The following request code block shows how to configure a funded transaction fee details report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Fee Details",
"sectionReportTypeId": "3006",
"sectionTitle": "Funded Transaction Fee Detail",
"sectionSelectedFields": [
{
"reportAttributeName": "Activity Date"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Foreign Exchange Rate"
},
{
"reportAttributeName": "Funds Transfer Category Text"
},
{
"reportAttributeName": "Fund Transfer Identifier"
},
{
"reportAttributeName": "Fund Transfer Instruction Number"
},
{
"reportAttributeName": "Fund Transfer Effective Date"
},
{
"reportAttributeName": "Acquirer Reference Number"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Sale/Refund Code"
},
{
"reportAttributeName": "Action Type Code"
},
{
"reportAttributeName": "Secure Bank Account Number"
},
{
"reportAttributeName": "Presentment Amount"
},
{
"alias": "Presentment Amount in Settlement Currency",
"reportAttributeName": "Transaction Amount"
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Net Settled Sales Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Settled Sales\",\"Settled Refunds\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Interchange & Assessment Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Interchange & Assessment Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Back Up Withholding Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Back Up Withholding Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Chargeback Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Chargeback Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Discount Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Discount Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "ECP Return Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"ECP Return Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Other Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Other Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Processing Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Reserve Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Reserve Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Othe Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Reserve Adjustments\",\"Interchange & Assessment Fees\",\"Back Up Withholding Adjustments\",\"Chargeback Adjustments\",\"Discount Fees\",\"ECP Return Adjustments\",\"Settled Sales\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Settled Refunds\", \"Other Adjustments\",\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Net Financial Activity",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
]
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Processing Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Settled Total Fee Amount",
"filterAttributeCode": "!=0.0"
},
{
"reportAttributeName": "Settled Conveyed Code",
"filterAttributeCode": "='S'"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Funded Transaction Fee Detail Report",
"reportFileName": "Funded Transaction Fee Detail Report,<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Funded Transaction Fee Detail Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-02-21 04:00:00",
"reportingPeriodEndTimestamp": "2023-02-22 03:59:59"
}
}Interchange qualification report configuration
The following request code block shows how to configure an interchange report for entityType = CO/BU/TD. Download the sample Interchange qualification report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionTitle": "Interchange Qualification Summary",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Interchange Qualification Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Interchange Qualification Code"
},
{
"reportAttributeName": "Interchange Qualification Text"
},
{
"reportAttributeName": "Fee Rate"
},
{
"reportAttributeName": "Unit Fee Amount"
},
{
"alias": "Sales Count",
"reportAttributeName": "Merchant Order Number",
"aggregateOperationText": "count"
},
{
"alias": "Count %",
"customCalculationText": "% of",
"customCalculationOn": "Sales Count",
"groupBy": [
"Payment Method Code",
"Settlement Currency Code"
]
},
{
"alias": "Sales Amount",
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "sum"
},
{
"alias": "Amount %",
"customCalculationText": "% of",
"customCalculationOn": "Sales Amount",
"groupBy": [
"Payment Method Code",
"Settlement Currency Code"
]
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Conveyed Settled Code",
"filterAttributeCode": "=\"S\""
},
{
"reportAttributeName": "Deposit Category Code",
"filterAttributeCode": "=\"S\""
},
{
"reportAttributeName": "Fee Text",
"filterAttributeCode": "=\"Interchange\""
},
{
"reportAttributeName": "Entity Type Code",
"filterAttributeCode": "=\"TD\""
},
{
"reportAttributeName": "Payment Method Code",
"filterAttributeCode": "IN(\"MC\",\"VI\",\"DI\",\"MD\",\"SW\",\"IM\",\"DD\",\"VR\",\"MR\",\"AX\",\"JC\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Interchange Qualification Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Interchange Qualification Details",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Interchange Qualification Details"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Interchange Qualification Code"
},
{
"reportAttributeName": "Downgrade Reason Code"
},
{
"reportAttributeName": "Downgrade Reason Text"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Deposit Date"
},
{
"alias": "Amount",
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "max"
},
{
"reportAttributeName": "Acquirer Reference Number"
},
{
"reportAttributeName": "Card Usage Type"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Conveyed Settled Code",
"filterAttributeCode": "=\"S\""
},
{
"reportAttributeName": "Deposit Category Code",
"filterAttributeCode": "=\"S\""
},
{
"reportAttributeName": "Fee Text",
"filterAttributeCode": "=\"Interchange\""
},
{
"reportAttributeName": "Entity Type Code",
"filterAttributeCode": "=\"TD\""
},
{
"reportAttributeName": "Payment Method Code",
"filterAttributeCode": "IN(\"MC\",\"VI\",\"DI\",\"MD\",\"SW\",\"IM\",\"DD\",\"VR\",\"MR\",\"AX\",\"JC\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Interchange Qualification Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Interchange Qualification Report",
"reportFileName": "Interchange Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Interchange Qualification Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-05-06 11:30:00",
"reportingPeriodEndTimestamp": "2024-05-07 02:00:00"
}
}The following request code block shows how to configure an interchange report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionTitle": "Interchange Qualification Summary",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Interchange Qualification Summary"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Interchange Qualification Code"
},
{
"reportAttributeName": "Interchange Qualification Text"
},
{
"reportAttributeName": "Fee Rate"
},
{
"reportAttributeName": "Unit Fee Amount"
},
{
"alias": "Sales Count",
"reportAttributeName": "Merchant Order Number",
"aggregateOperationText": "count"
},
{
"alias": "Count %",
"customCalculationText": "% of",
"customCalculationOn": "Sales Count",
"groupBy": [
"Payment Method Code",
"Settlement Currency Code"
]
},
{
"alias": "Sales Amount",
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "sum"
},
{
"alias": "Amount %",
"customCalculationText": "% of",
"customCalculationOn": "Sales Amount",
"groupBy": [
"Payment Method Code",
"Settlement Currency Code"
]
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Conveyed Settled Code",
"filterAttributeCode": "=\"S\""
},
{
"reportAttributeName": "Deposit Category Code",
"filterAttributeCode": "=\"S\""
},
{
"reportAttributeName": "Fee Text",
"filterAttributeCode": "=\"Interchange\""
},
{
"reportAttributeName": "Payment Method Code",
"filterAttributeCode": "IN(\"MC\",\"VI\",\"DI\",\"MD\",\"SW\",\"IM\",\"DD\",\"VR\",\"MR\",\"AX\",\"JC\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Interchange Qualification Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionTitle": "Interchange Qualification Details",
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "Interchange Qualification Details"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Interchange Qualification Code"
},
{
"reportAttributeName": "Downgrade Reason Code"
},
{
"reportAttributeName": "Downgrade Reason Text"
},
{
"reportAttributeName": "Account Number"
},
{
"reportAttributeName": "Deposit Date"
},
{
"alias": "Amount",
"reportAttributeName": "Settlement Amount",
"aggregateOperationText": "max"
},
{
"reportAttributeName": "Acquirer Reference Number"
},
{
"reportAttributeName": "Card Usage Type"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Conveyed Settled Code",
"filterAttributeCode": "=\"S\""
},
{
"reportAttributeName": "Deposit Category Code",
"filterAttributeCode": "=\"S\""
},
{
"reportAttributeName": "Fee Text",
"filterAttributeCode": "=\"Interchange\""
},
{
"reportAttributeName": "Payment Method Code",
"filterAttributeCode": "IN(\"MC\",\"VI\",\"DI\",\"MD\",\"SW\",\"IM\",\"DD\",\"VR\",\"MR\",\"AX\",\"JC\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Processing Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Interchange Qualification Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Interchange Qualification Report",
"reportFileName": "Interchange Report.<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Interchange Qualification Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2024-05-06 11:30:00",
"reportingPeriodEndTimestamp": "2024-05-07 02:00:00"
}
}Transaction fee details report configuration
The following request code block shows how to configure a transaction fee details report for entityType = CO/BU/TD. Download the sample Transaction fee details report.
Json
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"reportAttributeName": "Activity Date"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Foreign Exchange Rate"
},
{
"reportAttributeName": "Fund Transfer Instruction Number"
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Transaction Amount in Presentment Currency",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Settled Sales\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Settled Refunds\")"
}
]
},
{
"reportAttributeName": "Settlement Amount",
"alias": "Transaction Amount in Settlement Currency",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Settled Sales\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Settled Refunds\")"
}
]
},
{
"reportAttributeName": "Settlement Amount",
"alias": "Settled Deposit Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Settled Sales\",\"Settled Refunds\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Interchange & Assessment Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Interchange & Assessment Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Back Up Withholding Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Back Up Withholding Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Chargeback Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Chargeback Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Discount Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Discount Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "ECP Return Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"ECP Return Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Other Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Other Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Processing Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Reserve Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Reserve Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Others",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Reserve Adjustments\",\"Interchange & Assessment Fees\",\"Back Up Withholding Adjustments\",\"Chargeback Adjustments\",\"Discount Fees\",\"ECP Return Adjustments\",\"Settled Sales\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Settled Refunds\", \"Other Adjustments\",\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Net Financial Activity",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
]
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Transaction Fee Detail Report",
"reportFileName": "Transaction Fee Detail Report,<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Transaction Fee Detail Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-02-21 04:00:00",
"reportingPeriodEndTimestamp": "2023-02-22 03:59:59"
}
}The following request code block shows how to configure a transaction fee details report for entityType = PE.
Json
{
"entityType": "PE",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"reportAttributeName": "Activity Date"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"reportAttributeName": "Presentment Currency Code"
},
{
"reportAttributeName": "Settlement Currency Code"
},
{
"reportAttributeName": "Foreign Exchange Rate"
},
{
"reportAttributeName": "Fund Transfer Instruction Number"
},
{
"reportAttributeName": "Presentment Amount",
"alias": "Transaction Amount in Presentment Currency",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Settled Sales\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Settled Refunds\")"
}
]
},
{
"reportAttributeName": "Settlement Amount",
"alias": "Transaction Amount in Settlement Currency",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Settled Sales\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Settled Refunds\")"
}
]
},
{
"reportAttributeName": "Settlement Amount",
"alias": "Settled Deposit Amount",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Settled Sales\",\"Settled Refunds\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Interchange & Assessment Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Interchange & Assessment Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Back Up Withholding Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Back Up Withholding Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Chargeback Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Chargeback Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Discount Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Discount Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "ECP Return Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"ECP Return Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Other Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Other Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Processing Fees",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Reserve Adjustments",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "IN (\"Reserve Adjustments\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Others",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Reserve Adjustments\",\"Interchange & Assessment Fees\",\"Back Up Withholding Adjustments\",\"Chargeback Adjustments\",\"Discount Fees\",\"ECP Return Adjustments\",\"Settled Sales\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Settled Refunds\", \"Other Adjustments\",\"Processing Fees\")"
}
]
},
{
"reportAttributeName": "Settled Total Fee Amount",
"alias": "Net Financial Activity",
"aggregateOperationText": "sum",
"conditionalAggregateIndicator": true,
"conditionalAggregateFilterList": [
{
"aggregateConditionAttributeName": "Charge Category Text",
"aggregateConditionText": "NOT IN (\"Conveyed Sales\",\"Conveyed Refunds\")"
}
]
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Transaction Processing Entity Identifier",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Payment Method Code",
"sortOrderCode": "desc"
},
{
"reportAttributeName": "Presentment Currency Code",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Settlement Currency Code",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Transaction Fee Detail Report",
"reportFileName": "Transaction Fee Detail Report,<Processing Entity ID>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "EntityId=<Processing Entity ID>,ReportTypeName=<Report Type>,Frequency=<frequency>,FromDate=<From Date YYYY-MM-DD>,ToDate=<To Date YYYY-MM-DD>,GenerationDate=<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",
"reportName": "Transaction Fee Detail Report",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-02-21 04:00:00",
"reportingPeriodEndTimestamp": "2023-02-22 03:59:59"
}
}Pre-funded report configurations
You can use the following example report configurations for each pre-funded report type.
Transaction details report type configuration
The following request code block shows how to configure an ad hoc transaction details report:
Json
{
"entityType": "PE",
"entityIds": [
"123456"
],
"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
The following request code block shows how to configure an ad hoc submission details report:
Json
{
"entityType": "PE",
"entityIds": [
"123456"
],
"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.
Dispute details report type configuration
The following request code block shows how to configure an ad hoc dispute details report:
Json
{
"entityType": "PE",
"entityIds": [
"123456"
],
"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.
Dispute details v2 report type configuration
The following request code block shows how to configure an ad hoc dispute details v2 report:
Json
{
"entityType": "PE",
"entityIds": [
"123456"
],
"reportSections": [
{
"sectionReportTypeId": "3017",
"sectionReportTypeName": "Dispute Details v2"
}
],
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2023-07-01 02:00:00",
"reportingPeriodEndTimestamp": "2023-07-02 01:59:59"
}
}Download the sample Dispute details v2 report.
Post-funded report configurations
You can use the following example report configurations for each post-funded report type.
Settlement details report type configuration
The following request code block shows how to configure an ad hoc settlement details report:
Json
{
"entityType": "PE",
"entityIds": [
"123456"
],
"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
The following request code block shows how to configure an ad hoc settlement summary report:
Json
{
"entityType": "PE",
"entityIds": [
"123456"
],
"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
The following request code block shows how to configure an ad hoc fee details report:
Json
{
"entityType": "PE",
"entityIds": [
"123456"
],
"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.
Standard report configurations
You can use the following example report configurations for each standard report type.
Deposit details report configuration
The following request code block shows how to configure a deposit details report. Download the sample Deposit detail report.
Json
{
"entityIds": [
"123456"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"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": "Transaction Processing Entity 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": "DepositDetails.<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"
}
}Deposit summary report configuration
The following request code block shows how to configure a deposit summary report. Download the sample Deposit summary report.
Json
{
"entityIds": [
"123456"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"reportAttributeName": "Entity Type Code"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Transaction Processing 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": "DepositActivitySummaryFinancials.<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"
}
}Charge summary report configuration
The following request code block shows how to configure a charge summary report. Download the sample Charge summary report.
Json
{
"entityIds": [
"123456"
],
"reportSections": [
{
"sectionReportTypeName": "Submission Details",
"sectionReportTypeId": "3003",
"sectionSelectedFields": [
{
"reportAttributeName": "Charge Category Code"
},
{
"reportAttributeName": "Charge Subcategory Code"
},
{
"reportAttributeName": "Entity Type Code"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Transaction Processing 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": "ChargeSummary.<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"
}
}Deposit transfer summary report configuration
The following request code block shows how to configure a deposit transfer summary report. Download the sample Deposit transfer summary report.
Json
{
"entityIds": [
"123456"
],
"reportSections": [
{
"sectionReportTypeName": "Settlement Summary",
"sectionReportTypeId": "3005",
"sectionSelectedFields": [
{
"reportAttributeName": "Entity Type Code"
},
{
"reportAttributeName": "Entity Identifier"
},
{
"reportAttributeName": "Transaction Processing 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": "DepositActivityTransferSummaryFinancials.<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"
}
}Dispute details report configuration
The following request code block shows how to configure a dispute details report. Download the sample Dispute detail report.
Json
{
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Dispute Details",
"sectionReportTypeId": "3004",
"sectionSelectedFields": [
{
"reportAttributeName": "Entity Type Code"
},
{
"alias": "Entity Identifier",
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Transaction Processing Entity 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": [
{
"reportAttributeName": "Entity Type Code"
},
{
"alias": "Entity Identifier",
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Transaction Processing Entity 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": [
{
"reportAttributeName": "Entity Type Code"
},
{
"alias": "Entity Identifier",
"reportAttributeName": "Transaction Division External Identifier"
},
{
"reportAttributeName": "Transaction Processing Entity 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": "ChargebackActivityExceptionDetails.<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"
}
}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 the 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 the 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 the report configuration createTimestamp is returned in the response. | Create a new report configuration |
| Update an existing configuration to change status to Inactive | The 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 | The 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 is returned in the response. | Get a list of available report types |
| Create a reporting group | A reporting group with the entity type and entities you provided is created. | Create a reporting group |
| Get all reporting groups | An array of reporting groups with their details is returned based on the query parameters. | Get all reporting groups |
| Update a reporting group to change the reportingGroupName | The reporting group details with the updated reportingGroupName is returned. | Update a reporting group |
| Deactivate/activate a reporting group | The reporting group details with reportingGroupdStatus you chose is returned. | Update a reporting group |