--- title: "Get financial actions" method: GET path: "/financial-actions" tags: ["Financial actions"] --- # Get financial actions `GET /financial-actions` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/financial-actions` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `string` scopes: `financial-actions`, `financial-actions:view` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the list of financial actions and their details. ## Query parameters - `payment_id` string - `action_id` string - `limit` integer - `pagination_token` string ## Response `200` Financial actions retrieved successfully - FinancialActionListResponse: The list of financial actions in the response. - `count` integer: The total number of financial actions on the current page. - `limit` integer: The maximum number of results included per page. - `data` FinancialAction[] - `payment_id` string, required: The unique ID of the payment to which a financial action is associated. - `action_id` string, required: The unique ID of a given financial action impacting your balances. - `action_type` string, required: The type of action processed. For example, authorization, capture, refund, chargeback, pay to card. - `entity_id` string, required: The unique ID 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. - `currency_account_id` string, required: The unique ID of the currency account to which the financial action amount was charged. - `payment_method` string: The payment method associated with the financial action. - `processing_channel_id` string: The unique ID for processing channel configurations. - `mid` string: An optional merchant ID used to segment your payments traffic with card schemes. - `response_code` string: The payment request response code. - `response_description` string: A description of the payment request response code. - `region` 'Domestic' | 'International' | 'Intra' | 'IntraEEA' | 'IntraEuropean_SEPA': The region where this payment occurred. - `card_type` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'CHARGE': The card type used to make the payment - `card_category` 'CONSUMER' | 'COMMERCIAL': The card category used to make the payment. For example, consumer or commercial. - `issuer_country` string: Two-digit ISO country code of the country where the payment is processed. - `merchant_category_code` string: Four-digit code for retail financial services expressed in ISO 18245 format, classifying the types of goods or services you provide. - `fx_trade_id` string: The unique ID of the foreign exchange trade executed in fulfillment of a financial action. - `acquirer_reference_number` string: 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` boolean: 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. - `scheme_fx_adjustment_eligible` boolean: A flag to mark if the transaction honors the scheme exchange rate applicable at the time of authorization for both authorization and settlement movements. - `processed_on` string, date-time, required: An ISO 8601 timestamp of when the action was processed and impacted your balances, in UTC. - `requested_on` string, date-time, required: An ISO 8601 timestamp of when a gateway request was made for an action, in UTC. - `breakdown` FinancialActionBreakdown[]: The breakdown of amounts within this financial action. - `breakdown_type` string, required: A description of the type of fee or amount. For example, authorization fee. - `fx_rate_applied` number, required: The foreign exchange rate applied to a processed financial action. - `holding_currency` string, required: Three-digit ISO currency code of the currency a financial action is held and paid out in. - `holding_currency_amount` number, required: The associated amount of the financial action in the holding currency. - `processing_currency` string, required: Three-digit ISO currency code of a financial action when processed. - `processing_currency_amount` number, required: The associated amount of the financial action in the processing currency. - `transaction_currency` string: The currency of the transaction. - `transaction_currency_amount` number: The transaction amount, expressed in the transaction currency. - `processing_to_transaction_currency_fx_rate` number: The foreign exchange rate between the processing currency and the transaction currency. - `transaction_to_holding_currency_fx_rate` number: 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: The additional level of granularity for predicted scheme fees applied. - `reserve_rate` string: The percentage amount reserved from the payment. - `reserve_release_date` string, date-time: The date that the reserve is scheduled to be released for a Rolling Reserve Deducted, or the date that the reserve is released for a Rolling Reserve Released financial action. - `reserve_deducted_date` string, date-time: The date the reserve was deducted from the payment. - `tax_fx_rate` number: The foreign exchange rate between the holding currency and the tax currency at the point the financial action was processed. - `scheme_fx_adjustment_processing_currency` string: The processing currency of the transactions covered by the scheme FX adjustment. - `scheme_fx_adjustment_rate_applied` number: The rate applied to calculate the scheme FX adjustment over eligible transactions. - `entity_country_tax_currency` string: The currency of the country your entity resides in for tax purposes, if applicable. - `tax_currency_amount` number: The amount of tax applied, expressed in the tax currency. - `bin` string: Identifier for the financial institution that issued the card. - `issuing_bank` string: The bank that issued the card used to make the payment. - `payment_type` string: Specifies the type of card payment where the cardholder is not present e.g. recurring or mail order. This could be Regular, Recurring, MOTO, Installment, or Unscheduled. - `_links` object: The `links` object. - `self` FinancialActionsSelfLink - `href` string - `next` FinancialActionsNextLink - `href` string ## Other responses - `401`: Unauthorized. Likely cause is that access token is not valid or was not specified. - `422`: Unprocessable entity --- [API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)