Retrieve reports
Checkout.com provides a range of reports to support and help you gain insight into your business operations.
You can generate and download reports in the Dashboard, retrieve them programmatically via the Reports API, or access them via Secure File Transfer Protocol (SFTP).
Information
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 |
---|---|
All authentications during the selected time frame | |
All financial activity impacting your available balance over a specific date range | |
All your balances during the selected time frame | |
All successful and declined bank payouts during the selected time frame | |
All authorization, reversal, and advice messages during the selected period | |
Information about all your issued cards during the selected time frame | |
All chargebacks raised after a dispute during the selected time frame | |
All presentments raised after a dispute during the selected time frame | |
Card Issuing: Quarterly Mastercard Report (QMR) Available in the Dashboard only | Operational metrics that processing-only clients must send to Mastercard every quarter |
All transactional messages generated during the selected time frame | |
Aggregated settlement amounts for all transactions during the selected period | |
All successful and declined card payouts during the selected time frame | |
All disputes raised during the selected time frame | |
All financial actions within a specific date range that impacted your currency account's available balance | |
All financial actions for a specific payout | |
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 | |
All payment actions during the selected time frame | |
All payouts and related fees during the selected time frame | |
All reported fraudulent transactions during the selected time frame | |
All retrieval requests during the selected time frame | |
All financial activity that makes up your settlement | |
An overview of your settlement, summarizing related financial activity – For example, payments, refunds, chargebacks, and fees |
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.
- If this is your first report, select Generate reports.
- 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.
- Now – From the Covered period calendar, select the date range for the report to cover.
- 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 |
---|---|
Returns a list of all your reports and their details | |
Returns a specific report by passing its | |
Returns a specific file from a paginated report by passing the report |
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].
- We then give you:
- An SFTP server
- A port
- A username
- Access to your private key
- You must:
- Provide Checkout.com with an OpenSSH RSA public key.
- Create and securely store a 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.comcheckout-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.
- For macOS or Linux, run
- 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} > 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} > 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} > 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
Reports can contain a maximum of 1,000,000 rows per CSV file. If the volume of data is greater than that, the report is split into multiple files of up to 1,000,000 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,400,000 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
Financial actions are the actions taken during a payment's lifecycle. For example, authorization, risk assessment, capture, or chargebacks.
You can retrieve information about financial actions in reports and using the Financial Actions
API.
Checkout.com offers the following reports:
Use Checkout.com's Financial actions API to:
- Query your financial action data
- Perform near real-time reconciliation
- Programmatically retrieve the history of a given payment
- Programmatically retrieve the fees for a given payment or action during its lifecycle
This gives you full visibility over the financial impact of a payment shortly after it's successfully processed, without needing to wait for CSV reports.
You can query your financial action data by payment ID
, action ID
, or reference
.
For the full API specification, see the API reference.
Information
To learn more, reach out to your Account Manager or [email protected].