Access your reports and financial data

Last updated: April 19, 2023

Retrieve your reports with a flexible range of options to meet your integration preferences.

You can use our Reports API to retrieve the following reconciliation reports:

Financial actions reports (for example, by date range or payout ID)
Balance reports
Payouts reports

You can access and download your scheduled reports programmatically, collect them at your chosen interval (for example, daily, weekly, or monthly), and automate reconciliation.

For the full API specification, see the API reference.

Financial actions, balance, and payouts reports are provided in CSV format via Secure File Transfer Protocol (SFTP).

To set up access to your reports, contact your Customer Success Manager.

We will then give you:

an SFTP server
a port
a username
access to your private key

You will need to:

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 will generate two files:

checkout-sftp.pub, which is the public key you need to share with Checkout.com
checkout-sftp, which is the private key you'll need to access your SFTP client

To retrieve the public key using the command line, run cat if you're using a macOS or Linux system, or more if you're using a Windows system. Alternatively, use your system's file explorer.
Send the public key to your Customer Success Manager.
Use the private key as a credential to sign in to your SFTP client.

Information

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

Reports will be uploaded in the following folder structure:

Invoices:

Directory: {client name} > {entity name} > reports-{entity name} > invoices
File name format: invoice_{EntityID}_{Currency}_{Start Date: YYYYMMDD}_{End Date:YYYYMMDD}.pdf

Balance reports:

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

Payouts reports:

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

Settlement statements:

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

Financial actions by payout ID:

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

Financial actions by date range:

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

Reports have a maximum of 1,000,000 rows per CSV file. If the volume of data is greater than that, it's split into multiple files, containing up to 1,000,000 rows each.

Split files include a number at the end of their filename. For example, if a financial actions report by date range has 2,400,000 rows, the following files will be 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

Use Checkout.com's Financial actions API to:

Query your financial action data
Perform near real-time reconciliation
Retrieve the full history of a specific payment

With this API, you can retrieve financial actions for a specific payment or action during its lifecycle. This gives you full visibility of the financial impact shortly after a payment is successfully processed, without the need 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 Customer Success Manager or support@checkout.com.

We've made some changes to our API

Access your reports and financial data

Retrieve your reports via API

Set up access to your reconciliation reports with SFTP

Create a public and private key pair

Information

SFTP report file naming conventions

Financial actions API

Information