Authorization report
This report provides you a summary of the successful and unsuccessful authorizations, and associated details for each authorization.
Use cases
- Track all the payment transactions that have been authorized during a specific period.
- Verify that transactions have been properly authorized by the card issuer or payment network.
- Reconcile by comparing this report with sales records to ensure that all authorized transactions are accounted for.
Granularity
- Summary Section: Combination of Presentment Currency Code, Settlement Currency Code, Method of Payment (MOP) type, and Response Code.
- Details section: Combination of Merchant Order Number, Merchant Action code Text, Authorization Amount, Authorization Code, and Payment Brand Auth Response.
Fields
The following table shows the summary section field details.
| Field name | Description |
|---|---|
| Record Type | Identifies the section title. |
| Presentment currency Code | The three-character abbreviation for the currency in which the cardholder transaction occurred. |
| Settlement Currency Code | The three-character abbreviation for the currency in which the merchant is being funded. |
| MOP Type | Method of payment (Visa, Mastercard, International Maestro, etc.) |
| Response Code | Authorization response code indicating Approval, Decline or Rejection. |
| Response Description | Text description of the authorization response code Authorization response indicating Approval, Decline or Rejection. |
| Firm Authorization Approval Code | A high-level summarization of the Firm's representation of the authorization response code being sent back to the merchant during credit card authorization. Valid values are:
|
| Total Transaction Count | Count of transactions for the summarized record. |
| Amount | Authorization amount. |
| Count of Declined Transactions | Number of declined transactions for the summarized record |
| Authorization Total Count % | Percentage of authorization count for the specific payment method compared to the total count. |
| Authorization Status % | Percentage of authorization count for the specific reason code compared to the total count. |
| Transaction Decline % | Percentage of decline count for the specific decline reason code compared to the total decline count. |
The following table shows the data section field details.
Field name |
Description |
|---|---|
Presentment Currency Code |
The three-character abbreviation for the currency in which the cardholder transaction occurred. |
Settlement Currency Code |
The three-character abbreviation for the currency in which the merchant is being funded. |
Payment Method Code |
Code that identifies the (MOP) method of payment for the transaction. |
Merchant Order Number |
The order number submitted by the merchant with the original sale. |
Merchant Action Code Text |
Type of transaction action conducted. Valid Values:
|
Authorization Amount |
Authorization amount |
Account Number |
Cardholders account number. |
Credit Card Expiration Year Month Number |
The credit card account expiration date (month and year) as submitted by the merchant with this transaction. *Note: If the values in this column, do not render correctly, open the report file in Notepad to get the correct values for this field. |
Transaction Type Text |
Textual description of type of the transaction |
Authorization Timestamp |
The date and time in UTC time zone on which the authorization was performed for the transaction. |
Authorization Code |
Six-character code related to a positive response from the endpoint. |
Payment Brand Auth Response |
The actual auth response received from the Network. |
Payment Brand Response Code Category |
The Payment Brand Response Code Category is derived based on the authorization response codes received from payment brand systems. Valid values:
|
PTI Authorization Response Code |
Response code describing the result of an authorization attempted that was either received from an endpoint or Merchant Supplied. |
Authorization Initiator |
Who initiated the authorization, ECP Verification/Validation and Pre-Notes attempt. |
Authorization Source Code |
Provider of the response (i.e., merchant or endpoint). |
POS Authentication Source |
Point of Sale Authentication source. |
Merchant Category Code |
Indicator used to classify a merchant's product or service. |
Country of Issuance |
Standard alpha ISO country code that identifies the card's issuing country. May be space-filled for transactions on unsupported methods of payment. |
Digital Token Method Text |
Text description which indicates whether the transaction is related to a Digital Payment Token. |
Prepaid Card Type Code |
Card Type Indicator (CTI), Indicates whether the card is a prepaid card. |
Commercial Card Code |
Card Type Indicator (CTI), Indicates whether the card is a commercial card and is capable of processing Level 2 or Level 3 transactions. |
Card Usage Type |
Codifies whether the transaction is a Signature Debit transaction (1), PIN Debit transaction (2), or a Credit Card transaction (3). |
Payment Transaction Identifier |
Identifies a unique occurrence of a payment processing request for a sale that is associated with a purchase of goods and/or services. A payment request can consist of authorizations, captures and refunds. This identifier connects all of the requests related to the original sale. |
Terminal Identifier |
Number identifying the POS terminal or similar device through which the transaction was processed |
Sample report configuration
The following request code block shows how to configure an authorization report for entityType = CO/BU/TD.
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"
}
}