You're viewing documentation for our latest API. This will not impact your integration, but you will need the documentation relevant to you. If you have an account with Checkout.com you have received an email confirming which version to use.
Payouts reports provide an overview of payouts paid to you along with a breakdown of the associated fees over a specific period of time. This allows you to reconcile payouts with amounts paid out to your bank account and shown on bank statements.
Using the payouts and the financial actions reports together, you can reconcile payouts with the associated payments and fees by using the payout ID on both reports.
Understanding your payouts reports
Payouts reports are available for each entity. Each row on the report shows a payout from a currency account, and for each payout the total amount paid out to you, aggregated fees applied to payments processed (for example, interchange fees), and any account level fees applied to the payout (for example, merchant payout fees) are shown.
Report format
Payouts reports come in CSV format with the file name following this template:
These reports are made available by 15:00:00 UTC. The data includes any settlements created that take place between 12:00:00 UTC the previous day and 12:00:00 UTC on the same day.
For example, a settlement created on August 3, 2020 at 07:00:00 UTC will be included in a daily payout report generated and available by August 3, 2020 at 15:00:00 UTC.
Your payouts reports can be made available on a daily, weekly, or monthly basis.
Information
The payout report reflects settlements that are created and can be expected to be settled to you, not whether they have been successfully settled to your bank accounts.
Report fields
Decimal fields with monetary amounts are expressed in their major currency unit, with up to 8 decimal places. For example, a payout of $50 will be expressed as 50.00
Information
To enable one or more additional fields for your reports, contact your Customer Success Manager.
The optional fields you choose are added to the report in the same order they appear in the table.
Field name
Description
Client Entity ID
string
The unique ID of the entity for which the payment was processed.
Client Entity Name
string
The designated name of the entity for which the payment was processed.
Sub Entity ID
string
The unique ID of the sub entity for which the payment was processed.
Sub Entity Name
string
The name of the sub entity for which the payment was processed.
Currency Account ID
string
The unique ID of the currency account a payout is settled from.
Currency Account Name
string
The custom descriptor of the associated currency account a payout is settled from.
Holding Currency
string
Three-digit ISO currency code of the currency account. For example, USD for dollars.