Financial Actions by Payout ID Report
Last updated: May 21, 2025
The Financial Actions by Payout ID Report provides a detailed record of all financial activity associated with a specific settlement. For each payment in the settlement, it chronologically lists all lifecycle actions that impact your sub-account's Available balance. You can link each financial action ID to the payment using the payment ID, and to the settlement using the payout/settlement ID.
Use this report to:
- Reconcile payments and any associated fees for settlements together with the Payouts Report.
- Understand the financial impact of each action and any foreign exchange (FX) rates applied to accurately assess your cost of sale.
Information
For information about the financial actions in this report, see Breakdown types.
This report is created when your settlement is generated, between 02:00am and 12:00am in your entity's settlement time zone. A report is created for every settlement that is paid out, in line with your settlement frequency.
For example, your settlement time zone is America/Los_Angeles Pacific Time (PT) and your settlement frequency is daily.
You receive a USD settlement from Checkout.com on August 4 that has payout/settlement ID 00000000CFJU.
The report is generated at 12:00am PT on August 4, and includes all financial activity held in USD from August 3 at 12:00am to 23:59pm PT.
See instructions on how to download the report on demand or on a schedule:
You can also download this report for a specific settlement in the Dashboard:
- Sign in to the Dashboard.
- Go to Settlements and select the relevant settlement.
- On the Settlement details page, for Transaction breakdown, select Download CSV.
The report is provided as a CSV file. The file name uses the following formats by default:
- API and SFTP –
financial-actions_{EntityID}_{Payout Date: YYYYMMDD}_{PayoutID}_1.csv - Dashboard scheduled reports –
financial-actions_{Your Entity-ID}_{Payout date: YYYYMMDD}_{PayoutID}_1.csv
For SFTP, the report is uploaded in the following folder structure:
{Entity_name} > reports-{Entity_name} > financial-actions > payout-id
Download as a CSV file a sample:
- Financial Actions by Payout ID Report
- Financial Actions by Payout ID Report when the
Carried forwardsettlement status is enabled
Information
If you're using Safari, hold the Option key when you download.
Information
- To enable any optional fields, contact your account manager or [email protected].
- Sub-accounts are referred to as "currency accounts" in the report fields.
- All decimal amounts are expressed in the major currency unit, with fixed-point notation with up to eight decimal places. For example,
500 USDis represented as500.00.
The report can include the following fields in this order:
| Field name | Description |
|---|---|
Client Entity ID string | The unique identifier for the entity the settlement was paid out to. |
Client Entity Name string | The name of the entity. |
Sub Entity ID string | The unique identifier for the sub-entity the settlement was paid out to. |
Sub Entity Name string | The name of the sub-entity. |
Processing Channel ID string | The unique identifier for the processing-channel configuration. |
Merchant Category Code string | The merchant's merchant category code. Merchants can have multiple category codes. |
Currency Account ID string | The unique identifier for the sub-account impacted by the financial action. |
Currency Account Name string | The name of the sub-account. |
Currency Account Custom ID string | Your identifier for the sub-account. |
Action Type string | The type of financial action. See Breakdown types. |
Action ID string | The unique identifier for the financial action. |
Payment ID string | The unique identifier for the payment the financial action is associated with. |
Requested On datetime | The date and time when the gateway request was made for the financial action, in UTC. |
Processed On datetime | The date and time when the financial action was processed, in UTC. |
Processing Currency string | The currency the financial action was processed in. |
FX Rate Applied decimal | The foreign exchange rate applied to the financial action. If the processing currency and holding currency are the same, this value is |
Holding Currency string | The currency the financial action is held and paid out in. |
FX Trade ID string | The unique identifier for the foreign exchange trade executed for the financial action. |
Payout ID string | The unique identifier for the settlement the financial action was included in. This is the same value as the settlement ID. |
Reference string optional | Your identifier used to track the financial action. |
Payment Method string | The payment method used for the financial action. |
Card Type string | The type of card type used to make the payment. This can be one of:
|
Card Category string | The category of card used to make the payment. This can be one of:
|
Issuer Country string | The country where the card was issued. |
Entity Country string | The country where the entity is registered. |
Region string | The region where the payment was made. This can be one of:
|
MID string | The merchant identifier used to segment your payments traffic with card schemes. |
Response Code string | The response code for the payment request. |
Response Description string | The description of the response code for the payment request. |
Breakdown Type string | The breakdown type of the fee or amount. |
Processing Currency Amount decimal | The amount of the financial action in the processing currency. |
Holding Currency Amount decimal | The amount of the financial action in the holding currency. |
Entity Country Tax Currency string | The currency of the country your entity resides in for tax purposes, if applicable. |
Tax FX Rate decimal | The foreign exchange rate between the holding currency and the tax currency when the financial action was processed. |
Tax Currency Amount decimal | The amount of tax applied, expressed in the tax currency. |
Transaction Currency string optional | The currency of the transaction. |
Transaction Currency Amount decimal optional | The transaction amount, expressed in the transaction currency. |
Processing to Transaction Currency FX Rate decimal optional | The foreign exchange rate between the processing currency and the transaction currency. |
Transaction to Holding Currency FX Rate decimal optional | The foreign exchange rate between the transaction currency and the holding currency. This rate is inferred from both the FX Rate and Processing to Transaction Currency FX Rate fields to account for foreign exchange rates from multiple rate ticks. |
Fee Detail string | The additional level of granularity for predicted scheme fees applied. |
Reserve Rate percentage optional | The percentage amount reserved from the payment. |
Reserve Deducted Date date optional | The date and time when the reserve was deducted from the payment. |
Reserve Release Date date optional | The date and time when the reserve:
Format – ISO 8601 |
Processing Channel Name string optional | The name of the processing channel configuration. |
Acquirer Reference Number string optional | The unique 23-digit identifier for the payment as it moves through the payment flow between your bank and the cardholder’s bank. |
Account Funding Transaction string optional | A flag that the transaction debited funds from an account to fund a non-merchant account. For example, to load a prepaid card or add funds to a wallet. |
Entity Segment string optional | The name of the entity segment the payment is tagged to. |
Issuing Bank string optional | The bank that issued the card used to make the payment. |
BIN string optional | The identifier for the financial institution that issued the card. |
Payment Type string optional | The type of card payment used for the card-not-present (CNP) payment. For example, for a recurring payment or mail order. This can be one of:
|
Requested On UTC Datetime optional | The date and time when the financial action was requested, in UTC. |
Processed On UTC Datetime optional | The date and time when the financial action was processed, in UTC. Format – ISO 8601 code |