# Clearing Activity Report The Clearing Activity Report provides an overview of all transactional activities associated with your cards, including: - Presentments - Chargebacks - Representments - Pre-arbitrations - Arbitrations Clearing is when Checkout.com receives instructions to capture funds from the card scheme, but has not yet settled the funds. Settlement is when the funds leave your sub-account and are settled with the scheme. --- ## Report availability The report data is refreshed twice daily at around 12:30 AM and 10:30 AM, in UTC. See instructions on how to download the report on demand or on a schedule: - [In the Dashboard](https://www.checkout.com/docs/business-operations/retrieve-reports.md#Generate_reports_in_the_Dashboard) - [Using the API](https://www.checkout.com/docs/business-operations/retrieve-reports.md#Retrieve_reports_via_API) - [Using Secure File Transfer Protocol](https://www.checkout.com/docs/business-operations/retrieve-reports.md#Access_reports_via_SFTP) (SFTP) - [Using webhooks](https://www.checkout.com/docs/business-operations/retrieve-reports.md#Receive_reports_using_webhooks) --- ## Report format The report is provided as a CSV file. The file name uses the following formats by default: - API and SFTP – `issuing_clearing_activity_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv` - Dashboard scheduled reports – `{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_issuing_clearing_activity` For SFTP, the report is uploaded in the following folder structure:
`{Entity_name} > reports-{Entity_name} > issuing_clearing_activity` --- ## Sample report [Download a sample report](https://www.checkout.com/docs/files/Sample_Clearing_Activity_Report.csv) (CSV file). > **Information** > > If using Safari, hold down the _Option_ key when selecting the link to download the file. --- ## Report fields The report includes all the following fields in this order: | Field name | Description | | --- | --- | | Scheme

`string` | The card scheme used for the payment.
This can be one of:

- `Mastercard`
- `Visa` | | Message ID

`string` | The transaction message's unique identifier, prefixed with `msg_`. | | File ID

`string` | The unique identifier for the card scheme's bulk file that the authorization message was extracted from.
Example – `0123456789012345678801234` | | Transaction ID

`string` | The transaction's unique identifier, which links all related authorization, reversal, and clearing messages. This is prefixed with `trx_`. | | Card ID

`string` | The card's unique identifier, prefixed with `crd_`. | | Cardholder ID

`string` | The cardholder's unique identifier, prefixed with `crh_`. | | Card Product ID

`string` | The identifier for the [card product](https://www.checkout.com/docs/card-issuing/set-up-card-program.md#Card_products), which represents the configuration that your card inherits. This is prefixed with `pro_`. | | Entity ID

`string` | The entity's unique identifier, prefixed with `ent_`. | | Entity Name

`string` | The entity's name. | | Client ID

`string` | Your unique identifier as a Checkout.com client, prefixed with `cli_`. | | Client Name

`string` | Your Checkout.com client name. | | Scheme Settlement Issuer Identifier

`string` | The unique identifier assigned by the scheme to a member financial institution or processing partner.

- For Mastercard, this is your transfer agent ID.
- For Visa, this is your Business Identification Number (BID).

Example – `1234567890` | | Message Type
`string` | The type of clearing message. This can be one of:

- `chargeback` – When you request the merchant to return funds
- `chargeback_reversal` – When you reverse a chargeback
- `pre_arbitration_or_arbitration` – When you and the merchant work to resolve a dispute before or with arbitration from the card scheme
- `presentment` – When the merchant first captures the payment request
- `presentment_reversal` – When the merchant reverses a presentment
- `representment` – When the merchant declines a chargeback and sends a second attempt to recover the amount
- `representment_reversal` – When the merchant reverses a representment | | Transaction Type

`string` | The type of transaction. This can be one of:

- `purchase` – A purchase of goods or services
- `refund` – A credit to the cardholder's account as a full or partial refund for a purchase
- `unique transaction` – A quasi-cash payment using, for example, gaming tokens, cryptocurrency, travelers' cheques
- `withdrawal` – A cash withdrawal from an ATM | | Acquirer Reference Number
`string` | The unique 23-digit identifier for the payment assigned by the acquirer. This is used to track the payment as it moves through the payment flow between the merchant’s bank and the cardholder’s bank. | | Merchant ID

`string` | The merchant's unique identifier.

This may vary per acquirer. | | Merchant Name

`string` | The merchant's company name. | | Merchant Category Code

`integer` | The merchant's [merchant category code (MCC)](https://www.checkout.com/docs/developer-resources/testing/codes/merchant-category-codes.md) for this payment.
Standard – ISO 18245 code
Example – `1731`

Merchants can have multiple MCCs. | | Merchant City

`string` | The city of the merchant's address. | | Merchant State

`string` | For US merchants, the state of the merchant's address.

For other merchants, the value is `null`. | | Merchant Country Code

`string` | The country of the merchant's address.
Standard – [ISO alpha-3 country code](https://www.checkout.com/docs/developer-resources/testing/codes/country-codes.md)
Example – `USA` | | Transaction Currency

`string` | The acquirer's local currency or the local currency where the transaction took place.
Standard – [ISO 4217 code](https://www.checkout.com/docs/developer-resources/testing/codes/currency-codes.md)
Example – `USD` | | Transaction Amount

`decimal` | The full amount of the transaction in the major currency unit.

Format – Fixed-point notation to two or six decimal places

Example – 500 USD is represented as `500.00`

For more information on how to calculate currency units, see [Format the amount value](https://www.checkout.com/docs/payments/accept-payments/format-the-amount-value.md). | | Billing Currency

`string` | The currency in which you bill the cardholder.
Standard – [ISO 4217 code](https://www.checkout.com/docs/developer-resources/testing/codes/currency-codes.md)
Example – `USD` | | Billing Amount

`decimal` | The amount to bill the cardholder in the major currency unit.

Format – Fixed-point notation with up to eight decimal places

**Mastercard only**

For chargebacks, pre-arbitrations, and arbitrations, Mastercard does not provide the billing amount.
Checkout.com therefore calculates the billing amount as follows:

If the billing currency matches:
- The transaction currency – The billing amount equals the transaction amount.
- The reconciliation currency – The billing amount equals the reconciliation amount.

If the billing currency does not match the transaction or reconciliation currency, the transaction amount is converted using Mastercard's daily FX mid-rate. | | Reconciliation Currency

`string` | The currency in which you settle the transaction with the card scheme.
Standard – [ISO 4217 code](https://www.checkout.com/docs/developer-resources/testing/codes/currency-codes.md)
Example – `USD` | | Reconciliation Amount

`decimal` | The amount you settle the card scheme for the transaction in the major currency unit.

Format – Fixed-point notation with up to eight decimal places | | Reconciliation Interchange Amount

`decimal` | The total interchange fee for the transaction in the major currency unit.

Format – Fixed-point notation with:
- Mastercard – Two decimal places
- Visa – Six decimal places | | Created On

`date-time` | The date and time when the transaction was created, in UTC.
Standard – ISO 8601 code
Format – `yyyy-mm-ddThh:mm:ss.sss` | | Settled On

`string` | The date when you expect to settle the card scheme.
Format – `yyyy-mm-dd` | | Reconciled On

`string` | The date when the card scheme processed the clearing transaction.
Format – `yyyy-mm-dd`

When generating this report in the Dashboard, the _Date from/to_ filter is based on this date. | | Metadata

`string` | **Mastercard only**

A field for online travel agencies, where you can get flight booking details.

If no data is available, the value is `null`.

Example – `""passenger_name":"BRET/HANNAH MRS";"ticket_number":"51256069222060";"travel_agency_name":"AIR MAURITIUS""` | | Card Masked PAN

`string` | The card's masked primary account number (PAN).
Example – `1234 56** **** 7890` | | Card Reference

`string` | The reference you provided when creating the card. | | Card UDF 1

`string` | A user-defined field (UDF) you specified during setup. | | Card UDF 2

`string` | A UDF you specified during setup. | | Card UDF 3

`string` | A UDF you specified during setup. | | Card UDF 4

`string` | A UDF you specified during setup. | | Card UDF 5

`string` | A UDF you specified during setup. | | Is Forced Posted

`string`
`optional` | The merchant or acquirer forced the transaction through clearing with no previous authorization.
You can [create a dispute](https://www.checkout.com/docs/card-issuing/manage-issuing-transactions/manage-issuing-disputes.md) to contest the transaction.

This can be one of:
- `not_applicable` – For chargebacks, representments, pre-arbitrations, and arbitrations
- `true` – Indicates that the transaction was forced through clearing
- `false` – Indicates that the transaction was not forced through clearing |