Interchange qualification report
This report provides a summary of different Bankcard Interchange Rates which the transactions have qualified for in a given period, and associated interchange details for each merchant order number.
Use cases
- View interchange qualification and downgrades at a transaction level.
- Research if the transactions are qualifying at the best possible interchange rates.
Granularity
- Summary Section: Combination of Presentment Currency Code, Settlement Currency Code, Payment Method Code, Interchange Qualification Code, Interchange Qualification Text, Fee Rate, Unit Fee Amount.
- Details Section: Merchant Order Number
Fields
The following table shows the summary section field details.
| Field name | Description |
|---|---|
| Record Type | Defines the section of the report. For summary section, record type value is Interchange Qualification Summary. |
| Presentment Currency Code | The three-character abbreviation for the currency in which the cardholder transaction occurred. This field is suppressed unless cross-currency is selected. |
| Settlement Currency Code | The three-character abbreviation for the currency in which the merchant is being funded. |
| Payment Method Code | Code that identifies the method of payment (MOP) for the transaction. |
| Interchange Qualification Code | Code that identifies the rate at which J.P. Morgan qualified the transaction. |
| Interchange Qualification Text | Description of the reason the transaction qualified for a specific Interchange Qualification. |
| Fee Rate | The percentage rate fee applied to the face value of this transaction. For this field, a positive amount indicates a debit % rate to the merchant. A negative amount indicates a credit % rate. |
| Unit Fee Amount | Fee per item as assessed by the card associations. For this field, a positive amount indicates a debit unit fee to the merchant. A negative amount indicates a credit unit fee. |
| Sales Count | Count of Merchant Order Number grouped by Presentment Currency Code, Settlement Currency Code, Payment Method Code, Interchange Qualification Code, Interchange Qualification Text, Fee Rate, Unit Fee Amount. |
| Count | Percentage of Sales Count grouped by Payment Method Code & Settlement Currency Code. |
| Sales Amount | Sum of settlement amount grouped by Presentment Currency Code, Settlement Currency Code, Payment Method Code, Interchange Qualification Code, Interchange Qualification Text, Fee Rate, Unit Fee Amount. |
| Amount | Percentage of Sales Amount grouped by Payment Method Code & Settlement Currency Code |
The following table shows the details section field details.
| Field name | Description |
|---|---|
| Record Type | Defines the section of the report. For details section, record type value is Interchange Qualification Details. |
| Entity Identifier | Specifies the unique entity identifier. |
| Presentment Currency Code | The three-character abbreviation for the currency in which the cardholder transaction occurred. This field is suppressed unless cross-currency is selected. |
| Settlement Currency Code | The three-character abbreviation for the currency in which the merchant is being funded. |
| Payment Method Code | Code that identifies the method of payment (MOP) for the transaction. |
| Merchant Order Number | The order number submitted by the merchant with the original sale. |
| Interchange Qualification Code | Code that identifies the rate at which J.P. Morgan qualified the transaction. |
| Downgrade Reason Code | The value representing the reason the transaction qualified for a specific interchange qualification. |
| Downgrade Reason Text | The description of the value representing the reason the transaction qualified for a specific interchange qualification. |
| Account Number | Cardholders account number. |
| Deposit Date | Day the deposit transaction was received in UTC time zone. |
| Amount | Max of settlement amount grouped by rest of the attributes in the detail section. |
| Acquirer Reference Number | The acquirer's reference number assigned to the transaction at the time of the sale/refund. |
| Card Usage Type | Specifies if the transaction is a signature debit transaction, PIN debit transaction, or a credit card transaction. |
Sample report configuration
The following request code block shows how to configure an interchange report for entityType = CO/BU/TD.
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"
}
}