# Payments Report The Payments Report provides a comprehensive history of your payments' transition through the payment lifecycle, including: - Successful authorizations - Voids - Captures You can use the report to reconcile your payments against your internal records. --- ## Report availability The report data is refreshed daily at 08:00:00 UTC. You can set the report time zone to UTC, or the time zone configured on your Dashboard. You can generate the report: - On demand, for a specific time period - On a daily, weekly, or monthly schedule The report covers updates from the start of the first day of the reporting period at 00:00:00, to the end of the final day of the reporting period at 23:59:59. 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_using_the_API) - [Via Secure File Transfer Protocol](https://www.checkout.com/docs/business-operations/retrieve-reports.md#Access_reports_using_SFTP) (SFTP) ### Pre-filter by field via SFTP For targeted insight and efficient processing, you can pre-filter your scheduled SFTP report by one of the following fields and send them to specific recipients. For example, pre-filter by processing channel and send each channel's data to the relevant owner. - Is 3DS - AFT - CC BIN - CC Issuing Bank - CC Issuing Country - CKO Network Token - Payment Method Name - Payment Type - Processing Channel Name - Wallet --- ## Report format The report is provided as a CSV file. By default, the file name uses the following formats: - API and SFTP – `payments_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv` - Dashboard scheduled reports – `payments_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}.csv` For SFTP, the report is uploaded in the following folder structure:
`{Entity_name} > reports-{Entity_name} > payments` --- ## Sample report [Download a sample report](https://www.checkout.com/docs/files/Sample_Payments_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 the following fields in this order: | Field name | Description | | --- | --- | | Action ID

`string` | The unique identifier for the payment.
Example – `act_abcdef1ghijklmn23opq45r6st` | | Action Date UTC

`date-time` | The date and time when the payment was performed.
Format – ISO 8601
Example – `2024-01-31T10:20:30.456` | | Client Name

`string` | Your name as a Checkout.com client. | | Entity Name

`string` | The name of your Checkout.com entity. | | Sub Entity Name

`string` | The name of your Checkout.com sub-entity. | | Processing Channel Name

`string` | The name of the processing channel used for the payment. | | Processing Channel ID

`string` | The unique identifier for the processing channel used for the payment.
Example – `pc_abcdef1ghijklmn23opq45r6st` | | Merchant Category Code

`number` | The [merchant category code (MCC)](https://www.checkout.com/docs/developer-resources/testing/codes/merchant-category-codes.md) of the merchant that processed the payment. | | Action Type

`string` | The type of action that occurred in the payment's lifecycle. This can be one of:

- `Authorization`
- `Capture`
- `Card Verification`
- `Deferred Capture`
- `Expiry`
- `Refund`
- `Returned`
- `Void Authorization` | | Payment Method Name

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

- `ach`
- `alipay_cn`
- `alipay_hk`
- `alma`
- `AMEX`
- `bancontact`
- `benefit`
- `cartes_bancaires`
- `dana`
- `DINERSCLUB`
- `DISCOVER`
- `eps`
- `fawry`
- `gcash`
- `giropay`
- `ideal`
- `JCB`
- `kakaopay`
- `klarna`
- `knet`
- `MAESTRO`
- `MASTERCARD`
- `mbway`
- `multibanco`
- `p24`
- `paypal`
- `plaid`
- `postfinance`
- `provider_token`
- `qpay`
- `sepa`
- `sequra`
- `sofort`
- `stcpay`
- `tabby`
- `tamara`
- `tng`
- `truemoney`
- `UNKNOWN`
- `upi`
- `VISA`
- `wechatpay` | | Co-Badged Card

`string` | Indicates if the card used for the payment is co-badged with another network. For example, Cartes Bancaires Visa. | | Card Holder Name

`string` | The name the cardholder provided during the transaction. | | CC Number

`string` | The credit card number used for the payment.

For security purposes, this value is typically masked. | | Card Expiry Year
`number` | The expiry year of the payment card.
Format – `YYYY`
Example – `2030` | | Card Expiry Month
`number` | The expiry month of the payment card.
Format – `M`
Example – `M` | | Reference

`string` | An optional ID used to track financial actions. | | Amount

`number` | The payment amount. | | Currency Symbol

`string` | The [currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes.md) of the transaction currency. For example, EUR, GBP, or USD. | | Response Code

`number` | The [API response code](https://www.checkout.com/docs/developer-resources/codes/api-response-codes.md) of the payment request. | | Response Description

`string` | A description of the response code of the payment request. | | Customer Email

`string` | The email address of the customer. | | Payment Type

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

- `Recurring`
- `Regular`
- `Installment`
- `MOTO`
- `Unscheduled` | | CVV Check

`string` | The result of the card verification value (CVV) check. | | AVS Check

`string` | The result of the Address Verification Service (AVS) check. | | Is 3DS

`boolean` | Indicates whether the transaction was authenticated with [3D Secure](https://www.checkout.com/docs/payments/authenticate-payments/3d-secure.md). | | 3DS Version

`string` | The 3DS protocol version used for authentication. | | Attempt N3D

`boolean` | Indicates whether a non-3DS payment was requested. | | ECI Code

`string` | The Electronic Commerce Indicator (ECI) value. | | Customer IP

`string` | The IP address of the customer. | | Auth Code

`string` | The authorization code provided by the issuing bank. | | Acquirer Reference Number

`string` | The unique number assigned to a transaction when it moves through the payment flow between the merchant bank and the cardholder’s bank. | | Payment ID

`string` | The unique identifier for the payment. | | Shipping Address 1

`string` | The first line of the shipping address. | | Shipping Address 2

`string` | The second line of the shipping address. | | Shipping Zip

`string` | The ZIP code or post code of the shipping address. | | Shipping City

`string` | The city of the shipping address. | | Shipping Country

`string` | The country of the shipping address. | | Billing Address 1

`string` | The first line of the billing address. | | Billing Address 2

`string` | The second line of the billing address. | | Billing Zip

`string` | The ZIP code or post code of the billing address. | | Billing City

`string` | The city of the billing address. | | Billing Country

`string` | The country of the billing address. | | CC BIN

`string` | The identifier for the financial institution that issued the card.

Format – 6 – 8 digit number | | CC Issuing Bank

`string` | The bank that issued the card used to make the payment. | | CC Issuing Country

`string` | The country that the card was issued in.
Format – [ISO alpha-3 country code](https://www.checkout.com/docs/developer-resources/testing/codes/country-codes.md) | | CC Type

`string` | The type of card that was issued. For example, credit or debit. | | CC Category

`string` | The card category used to make the payment. For example, consumer or commercial. | | Billing Descriptor Part 1

`string` | The first part of the [billing descriptor](https://www.checkout.com/docs/payments/manage-payments/manage-billing-descriptors.md) that appears on the customer's bank statement. | | Billing Descriptor Part 2

`string` | The second part of the [billing descriptor](https://www.checkout.com/docs/payments/manage-payments/manage-billing-descriptors.md) that appears on the customer's bank statement. | | UDF 1

`string` | User-defined field for custom data. | | UDF 2

`string` | User-defined field for custom data. | | UDF 3

`string` | User-defined field for custom data. | | UDF 4

`string` | User-defined field for custom data. | | UDF 5

`string` | User-defined field for custom data. | | Wallet

`string` | The digital wallet used for the payment, if applicable. This can be one of:

- `APPLEPAY`
- `GOOGLEPAY`
- `MDES`
- `NONE`
- `VTS` | | Action Date Local

`date-time` | The date and time the payment action occurred, in local time. | | Processing Acquirer Name

`string` | The name of the acquirer that processed the payment. | | Card Fingerprint

`string` | The unique fingerprint of the card used for the payment. | | CKO Network Token

`boolean` | Whether Checkout.com provisioned a network token for the card. | | Pan Type

`string` | The primary account number (PAN) type. For example, a tokenized PAN (DPAN) or non-tokenized PAN (FPAN). | | Description

`string` | A description of the payment. | | Card On File

`boolean` | Indicates whether the card is stored on file for use in future transactions. | | Entity Segment

`string` | The entity segment the transaction is associated with. | | AFT

`boolean` | Indicates whether the transaction was flagged as an account funding transaction (AFT). | | Authentication MID

`string` | The Merchant ID used for authentication. | | Retrieval Reference Number

`string` | The reference number used for retrieving the transaction details. | | Retry Request End After Days

`number` | The number of days after which a retry request will end. | | Retry Request Max Attempts

`number` | The maximum number of retry attempts allowed. | | Retry Request Current Attempt

`number` | The current attempt number for retrying the transaction. | | Retry Request Next Attempt On

`date-time` | The date and time the next scheduled retry will be attempted. | | Preferred Scheme

`string` | The preferred scheme to use for co-badged cards.

If a preferred scheme was not specified, this returns the local scheme instead. | | Is Merchant Initiated

`boolean` | Specifies whether the merchant initiated the payment on behalf of the customer, without the need for additional cardholder authentication. For example, for an installment payment or a recurring subscription payment. | | Has Previous Payment ID

`boolean` | Specifies whether the merchant submitted a valid previous payment ID. | | Authorization Recommendation Code

`string` | Provides additional information on whether you should retry a transaction. This can be one of the following:

- `01` – Updated or additional information required.
- `02` – Try again later.
- `03` – Do not try again. | | Traffic Type

`string` | Specifies the type of traffic, which is determined by the:

- Transaction type – For example, `regular` or `recurring`.
- Merchant-initiated flag – For example, `recurring_cit`, `recurring_mit`, or `unscheduled_cit`. | | Authorization MID

`string` | An identifier generated by the acquirer that identifies the merchant account. |