Retrieve reports

Last updated: November 28, 2024

Checkout.com provides a range of reports to support and help you gain insight into your business operations.

You can access reports in the following ways:

Generate and download reports in the Dashboard on demand or on schedule.
Retrieve reports programmatically via the Reports API.
Access reports via Secure File Transfer Protocol (SFTP).
Receive webhook notifications when scheduled reports are generated to retrieve them via the API or SFTP.

For detailed information about the purpose and contents of a report, select it in the Report name column.

The following reports are available:

Report name	Description
Authentication Report	All authentications during the selected timeframe
Balance Breakdown Report	All financial activity impacting your available balance over a specific date range, which you can use for balance management and reconciliation
Balance Report	All your balances during the selected timeframe, which you can use for balance management and reconciliation
Bank Payouts Report	All successful and declined bank payouts during the selected timeframe
Card Payouts Report	All successful and declined card payouts during the selected timeframe
Disputes Report	All disputes raised with you during the selected timeframe
Financial Actions by Date Range Report	All financial actions within a specific date range that impacted your currency account's available balance, which you can use for balance management and reconciliation
Financial Actions by Payout ID Report	All financial actions for a specific payout, which you can use for reconciliation and settlements
Fraud Detection Report	A transaction-by-transaction summary of data points, rules triggered, outcomes at each stage, and any fraudulent transactions to help improve the performance of risk rules
Invoices	A monthly summary of Checkout.com fees for each of your active entities per currency, which you can submit as a tax document in applicable regions
Issuing: Authorizations Report	All authorization, reversal, and advice messages during the selected timeframe
Issuing: Cards Report	Information about all your issued cards during the selected timeframe
Issuing: Chargebacks Report	All chargebacks raised after a dispute during the selected timeframe
Issuing: Presentments Report	All presentments raised after a dispute during the selected timeframe
Issuing: Quarterly Mastercard Report (QMR) Available in the Dashboard only	Operational metrics that processing-only clients must send to Mastercard every quarter
Issuing: Settlement Activity Report	All transactional messages generated during the selected timeframe
Issuing: Settlement Summary Report	Aggregated settlement amounts for all transactions during the selected timeframe
Payments Report	All payment actions during the selected timeframe
Payouts Report	All payouts and related fees during the selected timeframe, which you can use for reconciliation and settlements
Reported Fraudulent Transactions Report	All reported fraudulent transactions during the selected timeframe
Retrievals Report	All retrieval requests during the selected timeframe, which you can use to manage disputes
Settlement Breakdown Report	All financial activity that makes up your settlement, which you can use for reconciliation and settlements
Settlement Statement	An overview of your settlement, summarizing related financial activity (for example, payments, refunds, chargebacks, and fees), which you can use for reconciliation and settlements

Reports can contain a maximum of 1 million rows per CSV file. If the volume of data is greater than that, the report is split into multiple files of up to 1 million rows each.

Split files include a number at the end of the filename. For example, if a Financial Actions by Date Range Report contains 2.4 million rows, the following files are created:

financial-actions_{Entity ID}_{Start Date:YYYYMMDD}_{End Date:YYYYMMDD}_1.csv
financial-actions_{Entity ID}_{Start Date:YYYYMMDD}_{End Date:YYYYMMDD}_2.csv
financial-actions_{Entity ID}_{Start Date:YYYYMMDD}_{End Date:YYYYMMDD}_3.csv

All Checkout.com reports are available on demand or on schedule in the Dashboard.

To generate and download reports:

Go to Reports > All reports.
- If this is your first report, select Generate reports.
- If you have already generated reports, select New report.
On the New report page under:
- Create your report – From the Select type dropdown, select the relevant report.
- Time zone – Select either UTC or the Dashboard time zone (your local time).
To generate the report now and/or on a schedule, select the relevant heading:
- Now – From the Covered period calendar, select the date range for the report to cover.
  If you want to edit the file name, enter your changes in the File name box. This may help you find the report later.
- Scheduled – Under Frequency, select to generate the report Daily, Weekly, or Monthly.
  If you want to edit the schedule name, enter your changes in the Schedule name box.
Select Generate report.
Reports that contain a lot of data may take a while to generate.
The All reports page opens listing all generated reports, which you can filter by Name, Status, or Type and search by keyword.
To download the relevant CSV file, select the Download icon on that row.

You can use the Reports API to retrieve your reports programmatically at your chosen interval. For example, daily, weekly, or monthly. You can also automate reconciliation.

The following endpoints are available:

Endpoint name	Description
Get all reports	Returns a list of all your reports and their details
Get report details	Returns a specific report by passing its `id`
Get report file	Returns a specific file from a paginated report by passing the report `id` and the `fileId`

Reports are available in CSV format via Secure File Transfer Protocol (SFTP).

To set up access to your reports:

Contact your Account Manager or [email protected].
You must:
- Provide Checkout.com with an OpenSSH RSA public key.
- Create and securely store a private key.
We then give you:
- An SFTP server
- A port
- A username
- Access to your private key

In your command line, run the following command to create the key pair:
ssh-keygen -t rsa -b 4096 -f "checkout-sftp"
This generates two files:
- checkout-sftp.pub – The public key you need to share with Checkout.com
- checkout-sftp – Your private key for accessing your SFTP client
To retrieve the public key using the command line:
- For macOS or Linux, run cat.
- For Windows, run more.
  Alternatively, use your system's file explorer.
Send the public key to your Account Manager or [email protected].
Use the private key as a credential to sign in to your SFTP client.

Information

We recommend that you encrypt your secret key using the AES-256 cipher.

Reports are uploaded in the following folder structure:

Directory – {entity name} > reports-{entity name} > sessions_authentication
File name format – sessions_authentication_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > balance
File name format – statement_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}.csv

Directory – {entity name} > reports-{entity name} > balance-breakdown
File name format – balance-breakdown_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > paytobank
File name format – paytobank_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > paytocard
File name format – paytocard_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > disputes
File name format – disputes_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > financial-actions > date-range
File name format – financial-actions_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > financial-actions > payout-id
File name format – financial-actions_{EntityID}_{Payout Date: YYYYMMDD}_{PayoutID}_1.csv

Directory – {entity name} > reports-{entity name} > fraud_detection
File name format – fraud_detection_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > issuing_authorizations
File name format – issuing_authorizations_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > issuing_cards
File name format – issuing_cards_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > issuing_chargebacks
File name format – issuing_chargebacks_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > issuing_presentments
File name format – issuing_presentments_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > issuing_settlement_activity
File name format – issuing_settlement_activity_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > issuing_settlement_summary
File name format – issuing_settlement_summary_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > payments
File name format – payments_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > payouts
File name format – payouts_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > reported_fraudulent_transactions
File name format – reported_fraudulent_transactions_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > retrievals
File name format – retrievals_{EntityID}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}_1.csv

Directory – {entity name} > reports-{entity name} > settlement-statements
File name format – settlement-statement_{EntityID}_{Payout Date: YYYYMMDD}_{Payout ID}.pdf

Directory – {entity name} > reports-{entity name} > settlement-breakdown
File name format – settlement-breakdown_{EntityID}_{Payout Date: YYYYMMDD}_{PayoutID}_1.csv

You can set up a webhook to receive notifications when scheduled reports are generated and available via the API or SFTP. For guidance, see:

Set up your webhook receiver
The report_generated event reference

Retrieve reports

How it works

Reports overview

Pagination

Generate reports in the Dashboard

Retrieve reports via API

Access reports via SFTP

Create a public and private key pair

Information

SFTP report file naming conventions

Authentication Report

Balance Report

Balance Breakdown Report

Bank Payouts Report

Card Payouts Report

Disputes Report

Financial Actions by Date Range Report

Financial Actions by Payout ID Report

Fraud Detection Report

Issuing: Authorizations Report

Issuing: Cards Report

Issuing: Chargebacks Report

Issuing: Presentments Report

Issuing: Settlement Activity Report

Issuing: Settlement Summary Report

Payments Report

Payouts Report

Reported Fraudulent Transactions Report

Retrievals Report

Settlement Statement

Settlement Breakdown Report

Receive reports webhooks