Checkout.com Financial actions API

openapi: 3.2.0
info:
  title: Checkout.com API Reference Financial actions API
  description: '## Get started

    Checkout.com provides a collection of APIs that enable you to integrate with our various products and services.

    Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using any HTTP or REST library.

    Sign up for a test account to gain access to the sandbox environment, where you can test API calls without affecting live data.

    For more information, see:


    - API endpoints

    - API rate limits

    - API changes

    - Idempotency

    - Private connections


    ## Base URLs

    The base URLs you must use for your API calls to the sandbox and production environments are unique to you.


    - `https://{prefix}.api.sandbox.checkout.com/{path}`

    - `https://{prefix}.api.checkout.com/{path}`

    - `https://{prefix}.access.sandbox.checkout.com/{path}`

    - `https://{prefix}.access.checkout.com/{path}`


    The unique API endpoint host names resolve to Checkout.com''s IP addresses. Do not allowlist these IP addresses.

    The `{prefix}` value in each base URL is a string containing the first eight characters of each of your environments'' unique `client_id`, excluding the `cli_` prefix.

    To find your unique base URL:

    1. Sign in to the Dashboard environment you want to retrieve the base URL for:


    - Sandbox

    - Production


    2. Go to _Developers_ > _Overview_.

    Your unique base URL is displayed on the _Developer overview_ page. For example, `https://vkuhvk4v.api.checkout.com`.


    3. Alternatively, go to _Settings_ > _Account details_.

    Your unique base URL is displayed under _Connection settings_.


    If you are unsure of your client ID or base URL for either environment, contact your account manager or request support.

    For more information, see API endpoints.

    ## Authentication

    When you sign up for an account, you can authenticate with either Access keys (OAuth 2.0), or Secret API keys.

    Unless explicitly stated, all endpoints require authentication using either your Access or Secret API Keys. Public keys should only be used in JavaScript or native applications.


    - **Client-side authentication**. Use your public key for client-side authentication. It only has access to a limited set of our APIs – mostly those called as part of your payment environment.


    - **Server-to-server authentication**. Use your secret key or OAuth for server-to-server communication. Support for API keys depends on the endpoint.


    Never share your OAuth credentials, API keys, or access tokens. Keep them guarded and secure.'
  termsOfService: https://www.checkout.com/legal/terms-and-policies
  contact:
    name: Checkout.com Support
    url: https://dashboard.checkout.com/support
  version: v1.0.0
servers:
- url: https://{prefix}.api.sandbox.checkout.com
  description: Sandbox environment
  variables:
    prefix:
      default: '{prefix}'
      description: Your unique <a href="https://www.checkout.com/docs/developer-resources/api/api-endpoints" target="_blank">base URL</a>. There is no default value.
- url: https://{prefix}.api.checkout.com
  description: Production environment
  variables:
    prefix:
      default: '{prefix}'
      description: Your unique <a href="https://www.checkout.com/docs/developer-resources/api/api-endpoints" target="_blank">base URL</a>. There is no default value.
tags:
- name: Financial actions
  description: Returns all the processed financial actions associated with your given filter. The results are ordered by processing date in descending order (latest first).
paths:
  /financial-actions:
    get:
      tags:
      - Financial actions
      summary: Get financial actions
      description: Returns the list of financial actions and their details.
      operationId: getFinancialActions
      parameters:
      - name: payment_id
        in: query
        description: The ID of the payment you want to retrieve financial actions for. Required if `action_id` is not used.
        schema:
          type: string
          example: pay_qqufsd3rfnqufngwklghlxrzpm
      - name: action_id
        in: query
        description: The ID of the action you want to retrieve financial actions for. Required if `payment_id` is not used.
        schema:
          type: string
          example: act_wsnyzbzmr2huxcekoj7qqhxwuy
      - name: limit
        in: query
        description: The number of results to retrieve per page. </br> For example, if the total result count is 50, and you use `limit=10`, you will need to iterate over 5 pages containing 10 results each to retrieve all of the reports that match your query.
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
          default: 100
          example: 5
      - name: pagination_token
        in: query
        description: A token used for pagination when a response contains results across multiple pages.
        schema:
          type: string
      responses:
        '200':
          description: Financial actions retrieved successfully
          headers:
            Cko-Version:
              $ref: '#/components/headers/Cko-Version'
            Cko-Request-Id:
              $ref: '#/components/headers/Cko-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialActionListResponse'
        '401':
          description: Unauthorized. Likely cause is that access token is not valid or was not specified.
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialActionErrorResponse'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/FinancialActionErrorResponse'
      security:
      - OAuth:
        - financial-actions
        - financial-actions:view
      - ApiSecretKey: []
      x-codeSamples:
      - lang: cURL
        label: curl
        source: 'curl -i -X GET \

          ''https://{prefix}.api.sandbox.checkout.com/financial-actions?payment_id=pay_qqufsd3rfnqufngwklghlxrzpm&limit=5'' \

          -H ''Authorization: Bearer <YOUR_TOKEN_HERE>''

          '
      - lang: Java
        label: Java
        source: "import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\nimport java.nio.charset.StandardCharsets;\nimport java.util.stream.Collectors;\n\npublic class App {\n  public static void main(String[] args) throws Exception {\n    var httpClient = HttpClient.newBuilder().build();\n\n    HashMap<String, String> params = new HashMap<>();\n    params.put(\"payment_id\", \"pay_qqufsd3rfnqufngwklghlxrzpm\");\n    params.put(\"limit\", \"5\");\n\n    var query = params.keySet().stream()\n      .map(key -> key + \"=\" + URLEncoder.encode(params.get(key), StandardCharsets.UTF_8))\n      .collect(Collectors.joining(\"&\"));\n\n    var host = \"https://{prefix}.api.sandbox.checkout.com\";\n    var pathname = \"/financial-actions\";\n    var request = HttpRequest.newBuilder()\n      .GET()\n      .uri(URI.create(host + pathname + '?' + query))\n      .header(\"Authorization\", \"Bearer <YOUR_TOKEN_HERE>\")\n      .build();\n\n    var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n    System.out.println(response.body());\n  }\n}\n"
      - lang: C#
        label: C#
        source: "using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\n\npublic class Program\n{\n  private readonly IHttpClientFactory _httpClientFactory;\n  public static async Task Main(string[] args)\n  {\n    var client = _httpClientFactory.CreateClient();\n    client.DefaultRequestHeaders.Add(\"Authorization\", \"Bearer <YOUR_TOKEN_HERE>\");\n    var request = await client.GetAsync(\"https://{prefix}.api.sandbox.checkout.com/financial-actions?payment_id=pay_qqufsd3rfnqufngwklghlxrzpm&limit=5\");\n    var response = await request.Content.ReadAsStringAsync();\n\n    Console.WriteLine(response);\n  }\n}\n"
      - lang: Python
        label: Python
        source: "import requests\n\nurl = \"https://{prefix}.api.sandbox.checkout.com/financial-actions\"\n\nquery = {\n  \"payment_id\": \"pay_qqufsd3rfnqufngwklghlxrzpm\",\n  \"limit\": \"5\"\n}\n\nheaders = {\"Authorization\": \"Bearer <YOUR_TOKEN_HERE>\"}\n\nresponse = requests.get(url, headers=headers, params=query)\n\ndata = response.json()\nprint(data)\n"
      x-code-samples:
      - lang: Go
        source: "// For more information please refer to https://github.com/checkout/checkout-sdk-go\nimport (\n\t\"github.com/checkout/checkout-sdk-go\"\n\t\"github.com/checkout/checkout-sdk-go/configuration\"\n\t\"github.com/checkout/checkout-sdk-go/financial\"\n)\n\n// API Keys\napi, err := checkout.\n\t\t\tBuilder().\n\t\t\tStaticKeys().\n\t\t\tWithSecretKey(\"secret_key\").\n\t\t\tWithEnvironment(configuration.Sandbox()). // or Environment.PRODUCTION\n                        WithEnvironmentSubdomain(\"{prefix}\"). // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints.\n\t\t\tBuild()\nif err != nil {\n\treturn nil, err\n}\n\n// OAuth\napi, err := checkout.\n\t\t\tBuilder().\n\t\t\tOAuth().\n\t\t\tWithClientCredentials(\"client_id\", \"client_secret\").\n\t\t\tWithScopes([]string{configuration.FinancialActions}).\n\t\t\tWithEnvironment(configuration.Sandbox()). // or Environment.PRODUCTION\n                        WithEnvironmentSubdomain(\"{prefix}\"). // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints.\n\t\t\tBuild()\nif err != nil {\n\treturn nil, err\n}\n\nquery := financial.QueryFilter{\n\tPaymentId: \"payment_id\",\n\tActionId:  \"action_id\",\n\tLimit:     20,\n}\n\nresponse, err := api.Financial.GetFinancialActions(query)\nif err != nil {\n\treturn nil, err\n}\n\nreturn response, nil"
components:
  headers:
    Cko-Request-Id:
      description: The unique identifier of the request
      schema:
        type: string
    Cko-Version:
      description: The version of the API
      schema:
        type: string
  schemas:
    FinancialAction:
      required:
      - payment_id
      - action_id
      - action_type
      - entity_id
      - currency_account_id
      - processed_on
      - requested_on
      type: object
      properties:
        payment_id:
          pattern: ^(pay)_(\w{26})$
          type: string
          description: The unique ID of the payment to which a financial action is associated.
          example: pay_qqufsd3rfnqufngwklghlxrzpm
        action_id:
          pattern: ^(act)_(\w{26})$
          type: string
          description: The unique ID of a given financial action impacting your balances.
          example: act_wsnyzbzmr2huxcekoj7qqhxwuy
        action_type:
          type: string
          description: The type of action processed. For example, authorization, capture, refund, chargeback, pay to card.
          example: Capture
        entity_id:
          pattern: ^(ent)_(\w{26})$
          type: string
          description: The unique ID of the entity for which the payment was processed.
          example: ent_xozz5q2yvxsetbslrvjxugbsyy
        sub_entity_id:
          pattern: ^(ent)_(\w{26})$
          type: string
          description: The unique ID of the sub-entity for which the payment was processed.
          example: ent_6akzb5simnkejihbnw6udjpecq
        currency_account_id:
          pattern: ^(ca)_(\w{26})$
          type: string
          description: The unique ID of the currency account to which the financial action amount was charged.
          example: ca_oo5z564in66ujcsxlbhjsar3p4
        payment_method:
          type: string
          description: The payment method associated with the financial action.
          example: MASTERCARD
        processing_channel_id:
          pattern: ^(pc)_(\w{26})$
          type: string
          description: The unique ID for processing channel configurations.
          example: pc_y7hikmc5flhuvav47blunjsdui
        mid:
          type: string
          description: An optional merchant ID used to segment your payments traffic with card schemes.
          example: mid-12345
        response_code:
          type: string
          description: The payment request response code.
          example: '10000'
        response_description:
          type: string
          description: A description of the payment request response code.
          example: Approved
        region:
          enum:
          - Domestic
          - International
          - Intra
          - IntraEEA
          - IntraEuropean_SEPA
          type: string
          description: The region where this payment occurred.
          example: International
        card_type:
          enum:
          - CREDIT
          - DEBIT
          - PREPAID
          - CHARGE
          type: string
          description: The card type used to make the payment
          example: CREDIT
        card_category:
          enum:
          - CONSUMER
          - COMMERCIAL
          type: string
          description: The card category used to make the payment. For example, consumer or commercial.
          example: CONSUMER
        issuer_country:
          type: string
          description: Two-digit ISO country code of the country where the payment is processed.
          example: US
        merchant_category_code:
          type: string
          description: Four-digit code for retail financial services expressed in ISO 18245 format, classifying the types of goods or services you provide.
          example: '5311'
        fx_trade_id:
          type: string
          description: The unique ID of the foreign exchange trade executed in fulfillment of a financial action.
          example: trd_intsaxljgi6uzkxnv6lex3xayu
        acquirer_reference_number:
          type: string
          description: The unique number assigned to a transaction when it moves through the payment flow between the merchant bank and the cardholder's bank.
          example: 01234567890123456789012
        account_funding_transaction:
          type: boolean
          description: 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.
          example: true
        scheme_fx_adjustment_eligible:
          type: boolean
          description: A flag to mark if the transaction honors the scheme exchange rate applicable at the time of authorization for both authorization and settlement movements.
          example: true
        processed_on:
          type: string
          description: An ISO 8601 timestamp of when the action was processed and impacted your balances, in UTC.
          format: date-time
          example: '2022-02-18T13:00:12.3570000+00:00'
        requested_on:
          type: string
          description: An ISO 8601 timestamp of when a gateway request was made for an action, in UTC.
          format: date-time
          example: '2022-02-18T13:00:11.7240000+00:00'
        breakdown:
          type: array
          items:
            $ref: '#/components/schemas/FinancialActionBreakdown'
          description: The breakdown of amounts within this financial action.
        bin:
          type: string
          description: Identifier for the financial institution that issued the card.
          example: '444444'
        issuing_bank:
          type: string
          description: The bank that issued the card used to make the payment.
          example: Bank Name
        payment_type:
          type: string
          description: 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.
          example: Regular
      additionalProperties: false
      description: Financial actions response details.
    FinancialActionErrorResponse:
      type: object
      properties:
        request_id:
          type: string
          description: Request ID
          example: 0HMJGFVAQ35TL:00000117
        error_type:
          type: string
          description: 'The type of error. <br/> • `invalid_request`: Usually occurs with an HTTP status code `422`. The request payload failed validation. <br/> • `not_found`: Usually occurs with an HTTP status code `404`. The requested resource was not found. <br/>

            '
        error_codes:
          type: array
          items:
            type: string
          description: 'Error response code. Full list of error codes below: <br/> • `invalid_some_field`: Usually occurs with an error type `invalid_request` and HTTP status code `422 Unprocessable entity`. The field `some_field` failed validation. Please consult the API spec. <br/> • `some_resource_not_found`: Usually occurs with an error type `not_found`. The resource you are trying to retrieve does not exist. <br/>

            '
      additionalProperties: false
      description: Error Response
    FinancialActionBreakdown:
      required:
      - breakdown_type
      - fx_rate_applied
      - holding_currency
      - holding_currency_amount
      - processing_currency
      - processing_currency_amount
      type: object
      properties:
        breakdown_type:
          type: string
          description: A description of the type of fee or amount. For example, authorization fee.
          example: Scheme Fixed Fee
        fx_rate_applied:
          type: number
          description: The foreign exchange rate applied to a processed financial action.
          example: 1.24
        holding_currency:
          type: string
          description: Three-digit ISO currency code of the currency a financial action is held and paid out in.
          example: USD
        holding_currency_amount:
          type: number
          description: The associated amount of the financial action in the holding currency.
          example: 0.19526938
        processing_currency:
          type: string
          description: Three-digit ISO currency code of a financial action when processed.
          example: GBP
        processing_currency_amount:
          type: number
          description: The associated amount of the financial action in the processing currency.
          example: 0.1581682
        transaction_currency:
          type: string
          description: The currency of the transaction.
          example: EUR
        transaction_currency_amount:
          type: number
          description: The transaction amount, expressed in the transaction currency.
          example: 0.18031175
        processing_to_transaction_currency_fx_rate:
          type: number
          description: The foreign exchange rate between the processing currency and the transaction currency.
          example: 1.14
        transaction_to_holding_currency_fx_rate:
          type: number
          description: 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.
          example: 1.08
        fee_detail:
          type: string
          description: The additional level of granularity for predicted scheme fees applied.
          example: Visa Fixed Acquirer Network Fee
        reserve_rate:
          type: string
          description: The percentage amount reserved from the payment.
          example: 5%
        reserve_release_date:
          type: string
          description: 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.
          format: date-time
          example: '2023-06-21T09:15:34.7820000+00:00'
        reserve_deducted_date:
          type: string
          description: The date the reserve was deducted from the payment.
          format: date-time
          example: '2022-02-18T13:00:12.3570000+00:00'
        tax_fx_rate:
          type: number
          description: The foreign exchange rate between the holding currency and the tax currency at the point the financial action was processed.
          example: 1.45
        scheme_fx_adjustment_processing_currency:
          type: string
          description: The processing currency of the transactions covered by the scheme FX adjustment.
          example: GBP
        scheme_fx_adjustment_rate_applied:
          type: number
          description: The rate applied to calculate the scheme FX adjustment over eligible transactions.
          example: 1.45
        entity_country_tax_currency:
          type: string
          description: The currency of the country your entity resides in for tax purposes, if applicable.
          example: AUD
        tax_currency_amount:
          type: number
          description: The amount of tax applied, expressed in the tax currency.
          example: 1.1
    FinancialActionsNextLink:
      allOf:
      - $ref: '#/components/schemas/FinancialActionsLink'
    FinancialActionListResponse:
      type: object
      properties:
        count:
          type: integer
          description: The total number of financial actions on the current page.
          format: int32
          example: 1
        limit:
          maximum: 100
          minimum: 1
          type: integer
          description: The maximum number of results included per page.
          format: int32
          default: 100
          example: 5
        data:
          type: array
          items:
            type: object
            allOf:
            - $ref: '#/components/schemas/FinancialAction'
            description: The list of financial actions from the current page.
        _links:
          type: object
          properties:
            self:
              type: object
              allOf:
              - $ref: '#/components/schemas/FinancialActionsSelfLink'
              description: The `self` object.
              example:
                href: https://{prefix}.api.checkout.com/financial-actions?payment_id=pay_qqufsd3rfnqufngwklghlxrzpm&limit=5
            next:
              type: object
              allOf:
              - $ref: '#/components/schemas/FinancialActionsNextLink'
              description: The `next` object.
              example:
                href: https://{prefix}.api.checkout.com/financial-actions?payment_id=pay_qqufsd3rfnqufngwklghlxrzpm&limit=5&pagination_token=string
          description: The `links` object.
      additionalProperties: false
      description: The list of financial actions in the response.
    FinancialActionsSelfLink:
      allOf:
      - $ref: '#/components/schemas/FinancialActionsLink'
    FinancialActionsLink:
      type: object
      properties:
        href:
          type: string
  securitySchemes:
    ApiPublicKey:
      type: apiKey
      description: "Public keys are for client-side authentication and supported only in JavaScript or native applications.\n  \n#### Format\n\n- Sandbox – `pk_sbox_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n\n- Production – `pk_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n\nWhen specifying your public key, use the format `Bearer {{PublicApiKey}}`.\n"
      name: Authorization
      in: header
      x-cko-type: publicKey
    ApiSecretKey:
      type: apiKey
      description: 'You can pass your secret API key in the `Authorization` header of your requests for supported endpoints.


        #### Format


        - Sandbox – `sk_sbox_xxxxxxxxxxxxxxxxxxxxxxxxxx`


        - Production – `sk_xxxxxxxxxxxxxxxxxxxxxxxxxx`


        When specifying your secret key, use the format `Bearer {{SecretApiKey}}`.


        ```

        curl --location --request POST ''https://{prefix}.api.checkout.com/{{path}}'' \

        --header ''Content-Type: application/json'' \

        --header ''Accept: application/json'' \

        --header ''Authorization: Bearer {{SecretApiKey}}'' \

        --data-raw ''{

        "amount": 10000,

        "currency": "USD",

        "reference": "Visa-USD-Test",

        ...

        }''

        ```

        '
      name: Authorization
      in: header
      x-cko-type: secretKey
    OAuth:
      type: oauth2
      description: "Your OAuth credentials include an access key ID and an access key secret. They correspond to an OAuth 2.0 client ID and a client secret respectively. \n\nTo exchange these credentials for an access token, call the [Request an access token](/tag/access/POST/connect/token) endpoint. Authenticate using basic authentication, with your access key ID as the username and your access key secret as the password.\n\n| Environment   |      Authorization server                            |\n|---------------|------------------------------------------------------|\n| Sandbox       |  https://{prefix}.access.sandbox.checkout.com/connect/token   |\n| Production    |  https://{prefix}.access.checkout.com/connect/token           |\n\n```\ncurl --location 'https://{prefix}.access.checkout.com/connect/token' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'grant_type=client_credentials' \\\n--data-urlencode 'client_id=ack_...' \\\n--data-urlencode 'client_secret=...' \n```\n\nThe token server returns a Bearer `access_token` in JSON Web Token (JWT) format. Use this token in the `Authorization` header of your API requests.\n\n```\ncurl --location --request POST 'https://{prefix}.api.checkout.com/{{path}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer {{AccessToken}}' \\\n--data-raw '{\n  \"amount\": 10000,\n  \"currency\": \"USD\",\n  \"reference\": \"Visa-USD-Test\",\n  ...\n}'\n```\n\nThe `expires_in` field in the response indicates the validity period of your access token in seconds. When your token expires, you must request a new one.\n\nDepending on the Environment against which you're making your requests against you'll need to request the token from a different Authorization Server.\n\n| Environment   |      Authorization Server                            |\n|---------------|------------------------------------------------------|\n| Sandbox       |  https://{prefix}.access.sandbox.checkout.com/connect/token   |\n| Production    |  https://{prefix}.access.checkout.com/connect/token           |\n\nYour base URL `{prefix}` is unique. To learn how to retrieve your unique base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints).\n"
      flows:
        clientCredentials:
          tokenUrl: string
          scopes:
            vault: Access to all Vault resources
            vault:apme-enrollment: Manage Apple Pay Domain Enrollment
            vault:customers: Manage customers
            vault:card-metadata: Read card metadata
            vault:instruments: Create instruments
            vault:network-tokens: Manage network tokens
            vault:tokenization: Tokenize payment instruments
            vault:real-time-account-updater: Access to real-time account updater
            gateway: Access to all Gateway resources
            gateway:payment: Request payments
            gateway:payment-details: Get payment details
            gateway:payment-authorizations: Increment authorizations
            gateway:payment-voids: Void payments
            gateway:payment-captures: Capture payments
            gateway:payment-contexts: Manage payment contexts
            gateway:payment-cancellations: Manage payment cancellations
            gateway:payment-refunds: Refund payments
            fx: Foreign exchange services
            payouts:bank-details: Get bank details
            sessions:app: App-based authentication
            sessions:browser: Browser-based authentication
            disputes: Access to all Disputes resources
            disputes:view: View disputes
            disputes:provide-evidence: Provide dispute evidence
            disputes:accept: Accept disputes
            disputes:scheme-files: Read dispute scheme files
            accounts: Manage sub-entities
            flow: Access to all Flow resources
            flow:workflows: Manage workflows
            flow:events: Retrieve events
            flow:reflow: Manage workflows
            files: Access to all Files resources
            files:retrieve: Retrieve files
            files:upload: Upload files
            files:download: Download files
            forward: Access to Forward api
            forward:secrets: Manage secrets in Forward api
            balances: Access to all Balances resources
            balances:view: View balances
            balances:top-up-instructions: Get top-up instructions
            transfers: Access to all Transfers resources
            transfers:view: View transfers
            transfers:create: Create transfers
            middleware: Access to all Middleware resources
            middleware:merchants-secret: Allows merchant identity and Middleware token exchange from a secure execution environment
            middleware:merchants-public: Allows merchant identity and Middleware token exchange from an insecure execution environment
            payment-sessions: Access to all Payment Sessions resources
            payments:search: Search payments
            reports: Access to all Reports resources
            reports:view: View reports
            financial-actions: Access to all Financial actions resources
            financial-actions:view: View financial actions
            card-management: Access to all Card management resources
            issuing:card-management-read: Gives access to card management endpoints with GET operations
            issuing:card-management-write: Gives access to card management endpoints with POST/ PUT / DELETE operations
            issuing:controls-read: Gives access to card control endpoints with GET operations
            issuing:controls-write: Gives access to card control endpoints with POST/ PUT / DELETE operations
            transactions: Access to all transactions resources
            issuing:transactions-read: Gives access to get and search transactions
            issuing:transactions-write: Gives access to simulate transactions for testing purposes
            issuing-disputes: Access to Issuing disputes resources
            issuing:disputes-read: Gives access to get disputes
            issuing:disputes-write: Gives access to create and submit Issuing disputes
            identity-verification: Access to all Identities endpoints
            Payment Context: Read payment context
            agentic:inventory: Manage agentic commerce inventory and reservations
    SessionSecret:
      type: apiKey
      description: 'A base64 encoded value prefixed with `sek_` that gives access to client-side operations for a single authentication within the Sessions API. This value is returned as the `session_secret` when requesting a session.

        '
      name: Authorization
      in: header
x-tagGroups:
- name: Set up
  tags:
  - Access
- name: Handle payments and payouts
  tags:
  - Payments
  - Flow
  - Payment Setups
  - Payment Links
  - Hosted Payments Page
  - Forex
  - Apple Pay
  - Bacs Direct Debit
  - Google Pay
  - Transfers
  - Balances
- name: Payment Context
  tags:
  - Payment Context
- name: Payment Methods
  tags:
  - Payment Methods
- name: Store and forward payment credentials
  tags:
  - Tokens
  - Instruments
  - Customers
  - Forward
- name: Authentication
  tags:
  - Standalone
- name: Risk management
  tags:
  - Disputes
- name: Notifications
  tags:
  - Workflows
- name: Platforms
  tags:
  - Platforms
  - Business details
  - Payment instruments
  - Payout schedules
  - Reserve rules
  - Onboarding Simulator
- name: Card issuing
  tags:
  - Cardholders
  - Cards
  - Controls
  - Control profiles
  - Control groups
  - Cardholder access tokens
  - Transactions
  - Issuing disputes
  - Card testing
- name: Identities
  tags:
  - Applicants
  - Identity Verification
  - AML Screening
  - Face Authentication
  - ID Document Verification
  - Address Document Verification


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/checkout-com/openapi/checkout-com-financial-actions-api-openapi.yml