# Retrieve reports Checkout.com provides a range of reports to support your business operations and help you gain insight. You can retrieve reports in the following ways: - Generate and download reports in the Dashboard, on demand or on schedule. - Retrieve reports programmatically using the Reports API. - Access reports using Secure File Transfer Protocol (SFTP). - Receive scheduled reports using webhooks. --- ## Reports overview 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](https://www.checkout.com/docs/payments/retrieve-payment-reports/authentication-report.md) | All authentications within the specified time frame | | [Balance Breakdown Report](https://www.checkout.com/docs/funds-management/retrieve-financial-reports/balance-reports/balance-breakdown-report.md) | All financial activity impacting your available balance within the specified time frame, which you can use for balance management and reconciliation | | [Balance Confirmation Report](https://www.checkout.com/docs/funds-management/retrieve-financial-reports/balance-reports/balance-confirmation-report.md)

Available in the Dashboard only | The closing balance of each currency your entity holds on a specific date, which you can use for audits and month-end or year-end reconciliation | | [Balance Report](https://www.checkout.com/docs/funds-management/retrieve-financial-reports/balance-reports/balance-report.md) | All your balances within the specified time frame, which you can use for balance management and reconciliation | | [Bank Payouts Report](https://www.checkout.com/docs/payments/request-payouts/bank-payouts/bank-payouts-report.md) | All successful and declined bank payouts within the specified time frame | | [Card Payouts Report](https://www.checkout.com/docs/payments/retrieve-payment-reports/card-payouts-report.md) | All successful and declined card payouts within the specified time frame | | [Disputes Report](https://www.checkout.com/docs/business-operations/manage-disputes/retrieve-dispute-reports/disputes-report.md) | All disputes raised with you within the specified time frame | | [Fee Summary Report](https://www.checkout.com/docs/funds-management/retrieve-financial-reports/fee-summary-report.md)

Available in the Dashboard only | All fees and taxes charged to your Checkout.com account within the specified time frame, including card scheme, interchange, and Checkout.com fees | | [Financial Actions by Date Range Report](https://www.checkout.com/docs/funds-management/retrieve-financial-reports/balance-reports/financial-actions-by-date-range-report.md) | All financial actions within the specified time frame that impacted your currency account's available balance, which you can use for balance management and reconciliation | | [Financial Actions by Payout ID Report](https://www.checkout.com/docs/funds-management/retrieve-financial-reports/settlement-reports/financial-actions-by-payout-id-report.md) | All financial actions for a specific payout, which you can use for reconciliation and settlements | | [Fraud Detection Report](https://www.checkout.com/docs/business-operations/prevent-fraud/retrieve-fraud-reports/fraud-detection-report.md) | 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](https://www.checkout.com/docs/business-operations/retrieve-reports/invoices.md) | 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: Authorization Activity Report](https://www.checkout.com/docs/card-issuing/retrieve-issuing-reports/authorization-activity-report.md) | All authorization, reversal, and advice messages within the specified time frame | | [Issuing: Cards Report](https://www.checkout.com/docs/card-issuing/retrieve-issuing-reports/cards-report.md) | Information about all your issued cards within the specified time frame | | [Issuing: Clearing Activity Report](https://www.checkout.com/docs/card-issuing/retrieve-issuing-reports/clearing-activity-report.md) | All transactional activities associated with your cards, including:

- Arbitrations
- Chargebacks
- Pre-arbitrations
- Presentments
- Representments | | [Issuing: Clearing Summary Report](https://www.checkout.com/docs/card-issuing/retrieve-issuing-reports/clearing-summary-report.md) | For [processing-only clients](https://www.checkout.com/docs/card-issuing/set-up-card-program.md#Processing-only_clients), aggregated amounts for all transactional messages received within a specified time frame. | | [Issuing: Dispute Lifecycle Report](https://www.checkout.com/docs/card-issuing/retrieve-issuing-reports/dispute-lifecycle-report.md) | For [processing-only clients](https://www.checkout.com/docs/card-issuing/set-up-card-program.md#Processing-only_clients), lifecycle events for all disputes you raised with merchants on issued cards | | [Issuing: Quarterly Mastercard Report](https://www.checkout.com/docs/card-issuing/retrieve-issuing-reports/quarterly-mastercard-report.md) (QMR)

Available in the Dashboard only | For processing-only clients, operational metrics that you must send to Mastercard every quarter | | [Payments Report](https://www.checkout.com/docs/payments/retrieve-payment-reports/payments-report.md) | All payment actions within the specified time frame, including refunds | | [Payouts Report](https://www.checkout.com/docs/funds-management/retrieve-financial-reports/settlement-reports/payouts-report.md) | All payouts and related fees within the specified time frame, which you can use for reconciliation and settlements | | [Real Time Account Updater Report](https://www.checkout.com/docs/payments/store-and-manage-credentials/retrieve-stored-credentials-reports/real-time-account-updater-report.md) | All updates to cards made by the [Real-Time Account Updater service](https://www.checkout.com/docs/payments/store-and-manage-credentials/update-stored-credentials.md) within the specified time frame | | [Reported Fraudulent Transactions Report](https://www.checkout.com/docs/business-operations/prevent-fraud/retrieve-fraud-reports/reported-fraudulent-transactions-report.md) | All reported fraudulent transactions within the specified time frame | | [Retrievals Report](https://www.checkout.com/docs/business-operations/manage-disputes/retrieve-dispute-reports/retrievals-report.md) | All retrieval requests within the specified time frame, which you can use to manage disputes | | [Settlement Breakdown Report](https://www.checkout.com/docs/funds-management/retrieve-financial-reports/settlement-reports/settlement-breakdown-report.md) | All financial activity that makes up your settlement, which you can use for reconciliation and settlements | | [Settlement Statement](https://www.checkout.com/docs/funds-management/retrieve-financial-reports/settlement-reports/settlement-statement.md) | An overview of your settlement, summarizing related financial activity (for example, payments, refunds, chargebacks, and fees), which you can use for reconciliation and settlements | --- ## Pagination 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` --- ## Generate reports in the Dashboard All Checkout.com reports are available on demand or on schedule in the [Dashboard](https://dashboard.checkout.com/). To generate and download reports, you need one of the following [user roles](https://www.checkout.com/docs/business-operations/use-the-dashboard/manage-users/user-permissions.md): - Admin - Custom role with the `View and generate payment reports` permission - Developer - Disputes manager - Read only - Risk manager - Support manager 1. Go to _Reports_ > _Dashboard reports_. 2. Select _Create report_. 3. On the _Generate report_ page, under: - _Report type_, select the relevant report. - _Entity_, select the required entity. - _Time zone_, select either UTC or the Dashboard time zone (your local time). 4. Under _Report details_, use the _Covered period_ calendar to select the date range to be covered in the report. 5. In the _File name_ box, edit the file name if required. This may help you find the report later. 6. Under _Customize included fields_, select the fields you want to include in the report. Some of the fields are preselected by default. You can choose to select more fields or select all the fields. 7. Select _Create_.
The _Dashboard reports_ page opens listing all generated reports, which you can filter by _Report type, _Generated type_, or _Entity_. You can also search for a report by _Report type_. 8. Select the _Download_ icon next to the report to download it as a CSV file. > **Information** > > Reports that contain a lot of data may take a while to generate. --- ## Retrieve reports using the API You can use the [Reports API](https://api-reference.checkout.com/#tag/Reports) 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](https://api-reference.checkout.com/tag/Reports/#operation/getReports) | Returns a list of all your reports and their details | | [Get report details](https://api-reference.checkout.com/tag/Reports/#operation/getReportDetails) | Returns a specific report by passing its `id` | | [Get report file](https://api-reference.checkout.com/tag/Reports/#operation/getReportFile) | Returns a specific file from a [paginated](#Pagination) report by passing the report `id` and the `fileId` | --- ## Access reports using SFTP Reports are available in CSV format using Secure File Transfer Protocol (SFTP). To set up access to your reports: 1. Contact your account manager or [request support](https://dashboard.checkout.com/support/new?topic=case_account_management_and_access&issue=issue_account_changes). 2. You must: - Provide Checkout.com with an OpenSSH RSA public key. - Create and securely store a private key. - Specify the reports you want to receive, how often, and any filters you want applied. 3. We then give you: - An SFTP server - A port - A username - Access to your private key ### Create a public and private key pair 1. 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 2. 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. 3. Send the public key to your account manager or [request support](https://dashboard.checkout.com/support/new?topic=case_account_management_and_access&issue=issue_account_changes). 4. 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. ### Pre-filter reports For targeted insight and efficient processing, you can pre-filter some scheduled reports by a single field and send them to specific recipients via SFTP. For example, pre-filter by issuing country and send each country's data to the relevant owner. You can pre-filter the following reports: - [Card Payouts Report](https://www.checkout.com/docs/payments/retrieve-payment-reports/card-payouts-report.md#Pre-filter_by_field) - [Disputes Report](https://www.checkout.com/docs/business-operations/manage-disputes/retrieve-dispute-reports/disputes-report.md#Pre-filter_by_field) - [Fraud Detection Report](https://www.checkout.com/docs/business-operations/prevent-fraud/retrieve-fraud-reports/fraud-detection-report.md#Pre-filter_by_field) - [Payments Report](https://www.checkout.com/docs/payments/retrieve-payment-reports/payments-report.md#Pre-filter_by_field) - [Retrievals Report](https://www.checkout.com/docs/business-operations/manage-disputes/retrieve-dispute-reports/retrievals-report.md#Pre-filter_by_field) --- ## Schedule reports You can create a report schedule to automatically generate reports at a specified frequency. You can choose to receive the reports either in the Dashboard, or your SFTP server. If you choose to receive the reports in your SFTP server, you'll also be able to retrieve them using the [Reports API](https://api-reference.checkout.com/#tag/Reports). > **Information** > > To schedule SFTP reports, ensure you configured an SFTP server and created a [public and private key pair](#Create_a_public_and_private_key_pair). To create a report schedule: 1. Sign in to the [Dashboard](https://dashboard.checkout.com). 2. Go to _Reports_. 3. Open the _Schedules_ tab. 4. Select _Create schedule_. 5. On the _New schedule_ page under: - _Delivery type_ – Select if you want to create the report in the Dashboard, or delivered to your SFTP server. - _Time zone_ – Select either UTC or the Dashboard time zone (your local time). - _Report details_ – Under _Frequency_, select to generate the report _Daily_, _Weekly_, or _Monthly_.
Optionally, provide a name for the schedule in _Schedule name_. 6. Under _Customize included fields_, select the fields you want to include in the report. 7. Select _Create_.
The _Reports_ page opens listing all generated scheduled reports, which you can filter by _Name_, _Status_, or _Type_ and search by keyword. --- ## Receive reports using webhooks You can set up a webhook to receive scheduled reports when they are generated. For guidance, see: - [Configure your webhook server](https://www.checkout.com/docs/developer-resources/event-notifications/receive-webhooks/configure-your-webhook-server.md) - [Report generated](https://www.checkout.com/docs/developer-resources/event-notifications/event-types/report_generated.md) webhook