Optimization Protection

Closed Batch Summary report

This report provides both summary and detailed views of closed batch (submission) activity, including batch identifiers, merchant identifiers, payment methods, response outcomes, and key timestamps.

Closed batch report details
Report type	Supported entity types	Supported file formats
Submission Details	PE - Processing Entity TD - Transaction Division BU - Business Unit CO - Company	Comma Separated Values (csv) Portable Document Format (pdf)

Note

You must be a legacy reporting client to access this report.

Use cases

Track closed batches (submissions) over a specific period for an entity (CO/TD/BU/PE).
Reconcile batch-level totals and counts (by batch ID, card type, action type, currency).

Granularity

Summary section: Combination of Submission Identifier (Batch ID), Payment Method Code (Card Type), Action Type Code Text (Transaction Type), Presentment Currency Code (Currency), and Merchant identifiers.
Details section: Transaction-level rows including Account Number, Merchant Order Number, authorization response/reject codes, and timestamps.

Fields

Summary

The following table shows the summary section field details.

Summary section fields
Field name	Description
Record Type	The section of the report. For the summary section, record type value is CBR0010.
Merchant ID	The transaction division external identifier.
Merchant Name	The name associated with the Merchant Services assigned TD number.
Batch ID	Unique identification number for the submission, assigned by Merchant Services. Submit Identifier.
Card Type	Code that identifies the (MOP) method of payment for the transaction.
Transaction Type	Action type code description.
Transaction Description	Text label/description of the fee type for this fee data record.
Transaction Count	The number of items included in a data record. Space-filled for data records with a Category other than SALE or REF.
Currency	Three character abbreviation for the currency in which the cardholder transaction occurred. This field is suppressed unless cross-currency is selected.
Net Amount	The monetary value of the transaction in presentment currency.

Details

The following table shows the details section field details.

Details section fields
Field name	Description
Record Type	The section of the report. For the detail section, report type value is CBR0010.
Merchant ID	The transaction division external identifier.
Merchant Name	The name associated with the Merchant Services assigned TD number.
Batch ID	Unique identification number for the submission, assigned by Merchant Services. Submit Identifier.
Card Type	Code that identifies the (MOP) method of payment for the transaction.
Transaction Type	The action type code description.
Card Number	The cardholder's account number.
Order #	The order number submitted by the merchant with the original sale.
Resp Code	Three digit authorization response indicating Approval, Decline or Rejection.
Resp Code Description	Merchant Services response code text description of the result of an authorization attempted that was either received from an endpoint or merchant Supplied.
Rejection Code	Three-character code used to identify the reason that a transaction fails a Merchant Services Solutions front-end edit. Space-filled for any transactions with an Exception Type other than REJECT.
Transaction Description	The text label/description of the fee type for this fee data record.
Transaction Date Time	The date and time in UTC time zone on which the authorization was performed for the transaction.
Settlement Date Time	The timestamp on which the submission was fully received at Merchant Services in UTC time zone.
Customer Profile	Identifier for the consumer profile which contains information relevant to processing transactions such as name, address, account, and payment methods information.
Currency	Three character abbreviation for the currency in which the cardholder transaction occurred. This field is suppressed unless cross-currency is selected.
Amount	The monetary value of the transaction in presentment currency.
Merchant Order Description (O)	Additional metadata information for order number submitted by the merchant with the original sale.
Terminal Identifier (O)	The number identifying the POS terminal or similar device through which the transaction was processed
Surcharge Amount (O)	Total surcharge amount submitted by the merchant for this transaction.
Commercial Card Code (O)	Card Type Indicator (CTI) that indicates whether the card is a commercial card and is capable of processing Level 2 or Level 3 transactions.
Level 3 Card Type Code (O)	Card Type Indicator (CTI) that indicates whether a Commercial card is Level III interchange qualification capable.
PINless Debit Card Type Code (O)	Card Type Indicator (CTI) that indicates whether the card is PINless debit capable.
Prepaid Card Type Code (O)	Card Type Indicator (CTI) that indicates whether the card is a prepaid card.
Signature Debit Card Type Code (O)	Card Type Indicator (CTI) that indicates whether the card is a signature debit card.
Affluent Card Type Code (O)	Card Type Indicator (CTI) that indicates whether the card supports account holders with higher credit limits.
Health Care Card Type Code (O)	Card Type Indicator (CTI) that indicates whether the card is a Healthcare card.
Payroll Card Type Code (O)	Card Type Indicator (CTI) that indicates whether the card is a payroll card.
Card Product Type (O)	Product associated with the card as defined by the association.
Country of Issuance (O)	Standard alpha ISO country code that identifies the card's issuing country. May be space-filled. For transactions on unsupported methods of payment.
Enhance Address Verification Service Response Code (O)	Responses for Postal Code, Street, Name, Phone, and Email. Valid values are: N - Data does not match R - Retry S - Service not allowed U - Data unchecked Y - Data matches Space-filled - Data not sent.
Card Security Value Response Code (O)	The value returned by the endpoint in response to CVV2, CVC or CID validation request from the merchant.

Sample report configurations

The following samples help you get an idea of how to configure closed batch summary reports.

CO/BU/TD/PE

The following request code block shows how to configure an account updated report for entityType = CO/BU/TD/PE.

Json

{
    "entityType": "CO",
    "entityIds": [
        "1234567"
    ],
    "reportSections": [
        {
            "sectionTitle": "Closed Batch Summary",
            "sectionReportTypeName": "Submission Details",
            "sectionReportTypeId": "3003",
            "sectionSelectedFields": [
                {
                    "alias": "Record Type",
                    "constantValueText": "CBR0010"
                },
                {
                    "alias": "Merchant ID",
                    "reportAttributeName": "Transaction Division External Identifier"
                },
                {
                    "alias": "Merchant Name",
                    "reportAttributeName": "Transaction Division Name"
                },
                {
                    "alias": "Batch ID",
                    "reportAttributeName": "Submission Identifier"
                },
                {
                    "alias": "Card Type",
                    "reportAttributeName": "Payment Method Code"
                },
                {
                    "alias": "Transaction Type",
                    "reportAttributeName": "Action Type Code Text"
                },
                {
                    "alias": "Transaction Description",
                    "reportAttributeName": "Fee Text"
                },
                {
                    "alias": "Transaction Count",
                    "reportAttributeName": "Action Type Code Text",
                    "aggregateOperationText": "count"
                },
                {
                    "alias": "Currency",
                    "reportAttributeName": "Presentment Currency Code"
                },
                {
                    "alias": "Net Amount",
                    "reportAttributeName": "Presentment Amount",
                    "aggregateOperationText": "sum"
                }
            ],
            "sectionFilterAttributeList": [
                {
                    "reportAttributeName": "Fee Text",
                    "filterAttributeCode": "IN (\"Settled Sales\",\"Settled Refunds\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Rejected Transact\")",
                    "alias": "fee_text"
                },
                {
                    "reportAttributeName": "Charge Category Text",
                    "filterAttributeCode": "IN (\"Settled Sales\",\"Settled Refunds\",\"Conveyed Sales\",\"Conveyed Refunds\")",
                    "alias": "charge_cat_text"
                }
            ],
            "filterExpression": "(fee_text OR charge_cat_text)",
            "sectionSortOrderList": [
                {
                    "reportAttributeName": "Submission Identifier",
                    "sortOrderCode": "asc"
                },
                {
                    "reportAttributeName": "Payment Method Code",
                    "sortOrderCode": "asc"
                }
            ]
        },
        {
            "sectionTitle": "Closed Batch Details",
            "sectionReportTypeName": "Submission Details",
            "sectionReportTypeId": "3003",
            "sectionSelectedFields": [
                {
                    "alias": "Record Type",
                    "constantValueText": "CBR0010"
                },
                {
                    "alias": "Merchant ID",
                    "reportAttributeName": "Transaction Division External Identifier"
                },
                {
                    "alias": "Merchant Name",
                    "reportAttributeName": "Transaction Division Name"
                },
                {
                    "alias": "Batch ID",
                    "reportAttributeName": "Submission Identifier"
                },
                {
                    "alias": "Card Type",
                    "reportAttributeName": "Payment Method Code"
                },
                {
                    "alias": "Transaction Type",
                    "reportAttributeName": "Action Type Code Text"
                },
                {
                    "alias": "Card Number",
                    "reportAttributeName": "Account Number"
                },
                {
                    "alias": "Order #",
                    "reportAttributeName": "Merchant Order Number"
                },
                {
                    "alias": "Resp Code",
                    "reportAttributeName": "Merchant Service Authorization Response Code"
                },
                {
                    "alias": "Resp Code Description",
                    "reportAttributeName": "PTI Authorization Response Code Description"
                },
                {
                    "alias": "Rejection Code",
                    "reportAttributeName": "Reject Code"
                },
                {
                    "alias": "Transaction Description",
                    "reportAttributeName": "Fee Text"
                },
                {
                    "alias": "Transaction DateTime",
                    "reportAttributeName": "Authorization Timestamp"
                },
                {
                    "alias": "Settlement DateTime",
                    "reportAttributeName": "Submission Timestamp"
                },
                {
                    "alias": "Customer Profile",
                    "reportAttributeName": "Consumer Profile ID"
                },
                {
                    "alias": "Currency",
                    "reportAttributeName": "Presentment Currency Code"
                },
                {
                    "alias": "Amount",
                    "reportAttributeName": "Presentment Amount"
                }
            ],
            "sectionFilterAttributeList": [
                {
                    "reportAttributeName": "Fee Text",
                    "filterAttributeCode": "IN (\"Settled Sales\",\"Settled Refunds\",\"Conveyed Sales\",\"Conveyed Refunds\",\"Rejected Transact\")",
                    "alias": "fee_text"
                },
                {
                    "reportAttributeName": "Charge Category Text",
                    "filterAttributeCode": "IN (\"Settled Sales\",\"Settled Refunds\",\"Conveyed Sales\",\"Conveyed Refunds\")",
                    "alias": "charge_cat_text"
                }
            ],
            "filterExpression": "(fee_text OR charge_cat_text)",
            "sectionSortOrderList": [
                {
                    "reportAttributeName": "Submission Identifier",
                    "sortOrderCode": "asc"
                },
                {
                    "reportAttributeName": "Payment Method Code",
                    "sortOrderCode": "asc"
                }
            ]
        }
    ],
    "fileDelimiter": ",",
    "reportConfigurationName": "Closed Batch Report",
    "reportFileName": "Closed Batch Report.<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": "2025-04-03 23:59:59",
        "reportingPeriodEndTimestamp": "2025-04-04 23:59:59"
    }
}

Download sample report

Download the sample Closed Batch Summary report.

Scheduled and ad hoc report configurations