Financial actions reports

Last updated: September 12, 2023

Financial actions reports provide an accurate representation of all actions during a payment’s lifecycle that impact your currency account's available balance. Together with the payouts reports, you can reconcile payments and any associated fees against payouts paid out to you.

Understanding the financial impact of each action and any foreign exchange (FX) rates applied also allows you to accurately assess your cost of sale.

The reports come in two forms:

Financial actions by date range: contains financial actions across a specified time period.
Financial actions by payout ID: contains financial actions related to a specific payout ID—useful when reconciling financial actions with a payout paid out to your bank account.

Every row features a unique financial action ID that can be linked to a specific payment, using the payment ID, or a settled payout, using the payout ID.

Both reports feature identical field names and list records chronologically.

Financial actions reports come in CSV format with the file name following these templates:

Financial actions by date range:

financial-actions_{Your Entity-ID}_{Start Date Range:YYYYMMDD}_{End Date Range:YYYYMMDD}_1.csv

Financial actions by payout ID:

financial-actions_{Your Entity-ID}_{Payout date: YYYYMMDD}_{PayoutID}_1.csv

The availability of your reports depends on the type of financial action report available to you.

These reports are made available by 12:00:00 UTC and include any financial actions that impacted your available balance between 00:00:00 UTC and 23:59:59 UTC the previous day.

For example, all financial actions that occur on August 3, 2020 (from 00:00:00 UTC to 23:59:59 UTC) will be included in the daily financial actions by date range report generated and available from August 4, 2020 at 12:00:00 UTC.

Financial actions by date range can be made available on a daily, weekly or monthly basis.

These reports are made available by 15:00:00 UTC. The data includes any financial actions that have impacted your available balance and are linked to any settlements created between 12:00:00 UTC the previous day and 12:00:00 UTC on the same working day.

For example, for a settlement created on August 3, 2020 at 07:00:00 UTC, any financial actions associated to the settlement will be included in the financial actions by payout ID report available on August 3, 2020 at 15:00:00 UTC.

Decimal fields with monetary amounts are expressed in their major currency unit, with up to 8 decimal places. For example, an authorization fee of $0.10 will be expressed as 0.1

Information

To enable one or more additional fields for your reports, contact your Account Manager.

The optional fields you choose are added to the report in the same order they appear in the table.

Field name Description

Field name	Description
Client Entity ID string	The unique ID of the entity for which the payment was processed.
Client Entity Name string	The 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.
Processing Channel ID string	The unique ID for processing channel configurations.
Merchant Category Code string	The four-digit code for retail financial services expressed in ISO 18245 format to classify the types of goods or services provided by you. Learn more about MCCs.
Currency Account ID string	The unique ID of the currency account to which the financial action amount was charged.
Currency Account Name string	The name of the currency account to which the financial action amount was charged.
Currency Account Custom ID string	The custom ID of the currency account to which the financial action amount was charged.
Action Type string	The type of action processed. For example, authorization, capture, refund, chargeback, pay to card.
Action ID string	The unique ID for a given financial action impacting your balances. For example, `Authorization`.
Payment ID string	The unique ID for the payment to which a financial action is associated.
Requested On datetime	The timestamp of when a gateway request was made for an action expressed in ISO format in UTC (`YYYY-MM-DDTHH:mm:SS:sss`).
Processed On datetime	The timestamp of when the action was processed and had impacted your balances in ISO format in UTC (`YYYY-MM-DDTHH:mm:SS:sss`).
Processing Currency string	The three-digit ISO currency code of a financial action when processed. For example, USD for dollars. Learn more about ISO currency codes.
FX Rate Applied decimal	The foreign exchange rate applied to a processed financial action.
Holding Currency string	The three-digit ISO currency code of the currency a financial action is held and paid out in. For example, USD for dollars. Learn more about ISO currency codes.
FX Trade ID string	The unique ID of the foreign exchange trade executed in fulfilment of a financial action.
Payout ID string	The unique ID of the payout in which the financial action was included.
Reference string	An optional ID used to track financial actions.
Payment Method string	The payment method associated with the financial action.
Card Type string	The card type used to make the payment. For example, credit or debit card.
Card Category string	The card category used to make the payment. For example, consumer or commercial.
Issuer Country string	The two-digit ISO country code of the country where the card was issued. For example, US. Learn more about ISO currency codes.
Entity Country string	The two-digit ISO country code of a client entity. For example, US. Learn more about ISO currency codes.
Region string	The region where this payment occurred. This could be Domestic, International, Intra, IntraEEA, or IntraEuropean_SEPA.
MID string	An optional merchant ID used to segment your payments traffic with card schemes.
Response Code string	The response code of the payment request. Learn more about API response codes.
Response Description string	A description of the response code of the payment request.
Breakdown Type string	A description of the type of fee or amount. For example, authorization fee.
Processing Currency Amount decimal	The associated amount of the financial action in the processed currency.
Holding Currency Amount decimal	The associated amount of the financial action in the held 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 at the point 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 columns to account for foreign exchange rates from multiple rate ticks.
Fee Detail string optional	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 the reserve was deducted from the payment.
Reserve Release Date date optional	The date the reserve is either: Scheduled to be released for a Rolling Reserve Deducted financial action Released for a Rolling Reserve Released financial action
Processing Channel Name string optional	The name for the processing channel configurations that determine how payments are routed and processed.
Acquirer Reference Number string optional	The unique number assigned to a transaction when it moves through the payment flow between the merchant bank and the cardholder’s bank.
Account Funding Transaction string optional	A flag to mark if a transaction debited funds from an account to fund a non-merchant account. For example, to load a prepaid card or top up 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 value can be one of: `Regular` `Recurring` `MOTO` `Installment` `Unscheduled`

Client Entity ID

string

The unique ID of the entity for which the payment was processed.

Client Entity Name

string

The 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.

Processing Channel ID

string

The unique ID for processing channel configurations.

Merchant Category Code

string

The four-digit code for retail financial services expressed in ISO 18245 format to classify the types of goods or services provided by you.

Learn more about MCCs.

Currency Account ID

string

The unique ID of the currency account to which the financial action amount was charged.

Currency Account Name

string

The name of the currency account to which the financial action amount was charged.

Currency Account Custom ID

string

The custom ID of the currency account to which the financial action amount was charged.

Action Type

string

The type of action processed. For example, authorization, capture, refund, chargeback, pay to card.

Action ID

string

The unique ID for a given financial action impacting your balances. For example, Authorization.

Payment ID

string

The unique ID for the payment to which a financial action is associated.

Requested On

datetime

The timestamp of when a gateway request was made for an action expressed in ISO format in UTC (YYYY-MM-DDTHH:mm:SS:sss).

Processed On

datetime

The timestamp of when the action was processed and had impacted your balances in ISO format in UTC (YYYY-MM-DDTHH:mm:SS:sss).

Processing Currency

string

The three-digit ISO currency code of a financial action when processed. For example, USD for dollars.

Learn more about ISO currency codes.

FX Rate Applied

decimal

The foreign exchange rate applied to a processed financial action.

Holding Currency

string

The three-digit ISO currency code of the currency a financial action is held and paid out in. For example, USD for dollars.

Learn more about ISO currency codes.

FX Trade ID

string

The unique ID of the foreign exchange trade executed in fulfilment of a financial action.

Payout ID

string

The unique ID of the payout in which the financial action was included.

Reference

string

An optional ID used to track financial actions.

Payment Method

string

The payment method associated with the financial action.

Card Type

string

The card type used to make the payment. For example, credit or debit card.

Card Category

string

The card category used to make the payment. For example, consumer or commercial.

Issuer Country

string

The two-digit ISO country code of the country where the card was issued. For example, US.

Learn more about ISO currency codes.

Entity Country

string

The two-digit ISO country code of a client entity. For example, US.

Learn more about ISO currency codes.

Region

string

The region where this payment occurred. This could be Domestic, International, Intra, IntraEEA, or IntraEuropean_SEPA.

MID

string

An optional merchant ID used to segment your payments traffic with card schemes.

Response Code

string

The response code of the payment request.

Learn more about API response codes.

Response Description

string

A description of the response code of the payment request.

Breakdown Type

string

A description of the type of fee or amount. For example, authorization fee.

Processing Currency Amount

decimal

The associated amount of the financial action in the processed currency.

Holding Currency Amount

decimal

The associated amount of the financial action in the held 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 at the point 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 columns to account for foreign exchange rates from multiple rate ticks.

Fee Detail

string

optional

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 the reserve was deducted from the payment.

Reserve Release Date

date

optional

The date the reserve is either:

Scheduled to be released for a Rolling Reserve Deducted financial action
Released for a Rolling Reserve Released financial action

Processing Channel Name

string

optional

The name for the processing channel configurations that determine how payments are routed and processed.

Acquirer Reference Number

string

optional

The unique number assigned to a transaction when it moves through the payment flow between the merchant bank and the cardholder’s bank.

Account Funding Transaction

string

optional

A flag to mark if a transaction debited funds from an account to fund a non-merchant account. For example, to load a prepaid card or top up 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 value can be one of:

Regular
Recurring
MOTO
Installment
Unscheduled

Select the following links to download sample reports:

Financial actions report (CSV file)
Financial actions report by payout ID (CSV file)
Financial actions report for platforms (CSV file)

Information

If you're using Safari, hold the Option key when you download.

We've made some changes to our API

Financial actions reports

Understanding your financial actions reports

Report format

When are my reports available?

Financial actions by date range

Financial actions by payout ID

Report fields

Information

Sample reports

Information