openapi: 3.0.2
x-stoplight:
  id: c6861590dda46
info:
  title: Finix API Reference
  description: >+
    ---

    seo:
        title: Finix API Reference
        description: API Reference Documentation for the Finix API. Includes sample API requests and responses.
    ---


    The Finix API is resource oriented, relying heavily on common REST
    principles. Our API uses JSON encoded requests and responses.


    You will receive separate Sandbox and Live accounts, as well as
    corresponding API credentials to access the Finix API.


    ---


    ## Authentication


    To communicate with the Finix API, you must authenticate your requests via
    HTTP Basic Authentication with a `username:password` combination, which you
    can get from your Finix Dashboard. If you do not have a Dashboard yet, you
    can test our APIs with the Sandbox credentials below.


    {% table %}


    -   Parameter

    -   Value


    ---


    -   Sandbox Username

    -   `USsRhsHYZGBPnQw8CByJyEQW`


    ---


    -   Sandbox Password

    -   `8a14c2f9-d94b-4c72-8f5c-a62908e5b30e`


    {% /table %}


    ```shell {% title="Request Format" %}

    curl "https://finix.sandbox-payments-api.com/" \
        -H "Content-Type: application/json" \
        -H "Finix-Version: 2022-02-01" \
        -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
    ```


    ---


    ## Environments


    Finix provides two environments with distinct base URLs to make API
    requests.


    1. A Sandbox environment for developing and testing your integration.

    2. A Live environment for processing payments.


    These environments are entirely separate and do not share API Credentials.


    {% table %}


    -   Environment

    -   Endpoint URL


    ---


    -   Sandbox

    -   `https://finix.sandbox-payments-api.com`


    ---


    -   Live

    -   `https://finix.live-payments-api.com`


    {% /table %}


    {% admonition type="info" name="Live Access" %}

    To get access to the Live environment, please reach out to your Finix
    point-of-contact.

    {% /admonition %}


    ---


    ## HTTP Codes and Errors


    Finix uses HTTP codes to communicate whether requests succeeded or failed.
    Requests to Finix's API return responses within less than one second.


    However, communications between card networks and processors can increase
    response latency. Additionally, response latency for card-present devices
    can be higher depending on how quickly buyers complete the transaction on
    payment terminals.


    Due of this, requests to the Finix API have a maximum timeout of 5 minutes.


    For more details, see [Error
    Codes](/additional-resources/developers/implementation-and-testing/error-codes/).
    Also, you can [test for specific errors and
    responses](/additional-resources/developers/implementation-and-testing/testing-your-integration/).


    {% table %}


    -   Code {% width="10%" %}

    -   Definition {% width="35%" %}

    -   Explanation {% width="55%" %}


    ---


    -   `400`

    -   Bad Request

    -   We could not parse your request. Verify you are providing valid JSON.


    ---


    -   `401`

    -   Unauthorized

    -   We could not authenticate your request. Verify your `username` and
    `password` are correct.


    ---


    -   `402`

    -   Upstream Processor Error

    -   Errors caused by 3rd-party service(s).


    ---


    -   `403`

    -   Forbidden

    -   Your credentials do not have the correct permissions to perform the
    request.


    ---


    -   `404`

    -   Not Found

    -   We could not find the specified resource.


    ---


    -   `405`

    -   Method Not Allowed

    -   The specified resource does not support the HTTP Method used to submit
    the request.


    ---


    -   `406`

    -   Not Acceptable

    -   The server could accept the submitted request. Confirm how the request
    was formatted and submitted.


    ---


    -   `409`

    -   Conflict

    -   The submitted request conflicts with the current state of the server.


    ---


    -   `422`

    -   Unprocessable Entity

    -   The parameters were valid, but the request failed. Usually, the error
    involves misunderstanding of how to perform the request (e.g., creating a
    transfer with a seller that is not-yet-approved).


    ---


    -   `500`

    -   Internal Server Error

    -   We had a problem with our server. Try again later.


    {% /table %}


    ---


    ## Idempotent Requests


    The `Authorization` and `Transfer` resources both have an `idempotency_id`
    field. Use this field to ensure the API Request is performed **_only
    once_**.


    Why is this important? We've all experienced a checkout page that hangs on a
    request or payment, and feared that if we refresh or submit the payment
    again, we'd be charged twice.


    Finix removes this ambiguity with the `idempotency_id`. You or the user can
    generate a unique ID that can be included as an `idempotency_id` with the
    usual request payload. If anyone attempts a request with the same
    `idempotency_id`, the response will raise an exception.


    By passing an `idempotency_id` in the body of your requests, you can be rest
    assured that when you create an `Authorization` or `Transfer`, the user will
    be protected from potential network issues.


    `idempotency_id` is available on the following three endpoints:


    -   `/transfers`

    -   `/authorizations`

    -   `/transfers/{id}/reversals`


    {% admonition type="warning" name="`idempotency_id` scope" %}

    `idempotency_id` checks against previous requests made on the same endpoint.

    {% /admonition %}


    ---


    ## Query Parameters


    Every Finix resource (e.g., `Authorizations`, `Transfers`) can be listed and
    reviewed using `GET` requests. Additionally, every endpoint has query
    parameters available to help you filter the resources that are returned.


    See the following example of how to query the `Transfers` endpoint for
    `Transfer` resources with `type: DEBIT`.


    ```shell {% title="Query Parameter Example" %}

    curl "https://finix.sandbox-payments-api.com/transfers?type=DEBIT" \
        -H "Finix-Version: 2022-02-01" \
        -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
    ```


    ---


    ## Tags


    Many Finix resources (e.g., `Authorization`, `Transfer`) let you include
    `tags` to add key-value metadata to your Finix API resources. For example,
    when creating a Transfer, you might include `customerId: Customer123` to tag
    the Transfer with your internal customer ID. You can update tags as many
    times as needed, as well as filter resources by tags.


    ```json {% title="Tags Example" %}

    {
        ...,
        "tags": {
            "card-type": "business card",
            "order_number": "H-1257",
            "customer_order_reference": "order1234",
            "item_type": "hardware",
            "vendor": "finix"
        }
    }

    ```


    The `tags` object accepts up to 50 `key: value` pairs to annotate resources
    with custom metadata.


    -   Maximum character length for individual `keys` is 40.

    -   Maximum character length for individual `values` is 500.


    {% admonition type="warning" name="Special Characters" %}

    Finix does **_not_** allow special characters on tags (e.g., `\`, `,`, `"`,
    `'`)

    {% /admonition %}


    ---


    ## Versioning


    As Finix improves our products and features, we will make changes to our
    APIs. When breaking changes are made to Finix's API, we may release a new
    dated API version.


    The API version your requests use controls how API responses and webhooks
    behave (for example, the values you see in responses and the parameters you
    can include in requests). For more information, see
    [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).


    <br/>


    ---


    ## Postman Collection


    Finix has a Postman collection to help in your development. You can fork it
    using the button below.


    [<img id="postman-btn" src="https://run.pstmn.io/button.svg" alt="Run In
    Postman" style="width: 128px; height:
    32px;">](https://god.gw.postman.com/run-collection/47694266-26c1778a-64ad-473d-ba6f-440777f2c9c8?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D47694266-26c1778a-64ad-473d-ba6f-440777f2c9c8%26entityType%3Dcollection%26workspaceId%3D72d1f1c9-5637-4a7f-be9b-25fc89a3a2ff)

  contact:
    name: Finix
    url: https://finix.com
    email: support@finix.com
  version: '2022-02-01'
x-ignoredHeaderParameters:
  - Accept
  - finix-apiuser-role
  - date
  - x-request-id
servers:
  - url: https://finix.sandbox-payments-api.com
    description: Sandbox server
  - url: https://finix.live-payments-api.com
    description: Production server
tags:
  - name: Application Profiles
    description: >
      The `application_profile` resource is used to configure the
      `Application`'s `Fee Profile`. The `Application`'s `Fee Profile`
      configures what `Fee` gets applied to transactions processed by the
      `application_profile`.


      **Related Guides:**

      - [Onboarding
      Process](/guides/platform-payments/onboarding-sellers/seller-onboarding-process)

      - [Collecting
      Fees](/guides/platform-payments/monetizing-payments/collecting-seller-fees)
    x-keywords:
      includes:
        - application profile
  - name: Applications
    description: >
      The `Application` resource represents your app. For example, an iOS app,
      website, online marketplace, SaaS platform, etc. – any web service that
      connects buyers (i.e. customers) and sellers (i.e. merchants). In other
      words, an `Application` is a resource that represents the program you're
      integrating with Finix and using to connect with customers (i.e. buyers).


      **Related Guides:**

      - [Getting Started](/guides/getting-started)
    x-keywords:
      excludes:
        - CVV
        - AVS
      includes:
        - application
  - name: Authorizations
    description: >
      An `Authorization` (also known as a card hold) reserves a specific amount
      on a card to be captured (i.e. debited) at a later date, usually within
      seven days. When an `Authorization` is captured it produces a `Transfer`
      resource.


      **Related Guides:**

      - [Auth and
      Captures](/guides/online-payments/payment-features/auth-and-captures)

      - [Level 2 and 3
      Processing](/guides/online-payments/payment-features/level-2-level-3-processing/)

      - [POS
      Integration](/guides/in-person-payments/building-your-integration/pos-integration)

      - [Buyer Charges](/guides/online-payments/payment-features/buyer-charges/)
    x-keywords:
      includes:
        - authorization
  - name: Balance Adjustments
    description: >
      A `Balance Adjustment` modifies the account `Balance` by adding funds (a
      'top-up') or reducing funds for Payouts. Each adjustment is linked to a
      specific payment rail (e.g., ACH, card, wire).


      **Related Guides:**

      - [Adding Funds to your Finix Balance](/guides/payouts/adding-funds)
    keywords:
      includes:
        - account balance
        - add funds
        - add more funds
        - adding funds
        - auto top-up
        - balance
        - balance adjustment
        - Finix balance
        - payouts balance
        - top up
        - top up balance
        - top-up
  - name: Balance Transfers
    description: >
      Our `Balance Transfers` API provides platforms the option to create a
      money movement between their FBO (For the Benefit Of) `Settlement` account
      and their operating account. This is only available for Finix Core
      customers with Litle V12 credentials.


      If you have any questions, please reach out to your Finix point of contact
      or contact [the Finix Support team](mailto:support@finix.com).
    keywords:
      includes:
        - balance transfer
        - FBO
        - for the benefit of
        - settlement account
        - operating account
  - name: Balances
    description: >
      A `Balance` resource represents the current financial state of an
      `Application` identified by the `linked_to` query parameter. 


      It tracks the state of funds processed through the system, including
      amounts that are:
        - `available_amount` for immediate use or disbursement.
        - `pending_amount` due to processing times, holds, or other constraints.
        - `posted_amount`, which reflects the total sum (including both available and pending funds).
    keywords:
      includes:
        - balance
        - available amount
        - pending amount
        - posted amount
        - financial state
  - name: Checkout Forms
    description: >
      `Checkout Forms` are a low-code solution that enables you to create a
      customizable payment page where buyers can easily enter their payment
      details and submit a payment on both desktop and mobile devices.


      With `Checkout Forms`, you can quickly create checkout pages and accept
      payments from buyers with minimal development work.


      **Related Guides:**

      - [Checkout
      Pages](/guides/online-payments/low-code-no-code/checkout-pages)
    x-keywords:
      includes:
        - checkout form
  - name: Compliance Forms
    description: >
      To process payments, your Merchants must validate their compliance with
      PCI DSS requirements annually. To do this, your Merchants must attest to
      PCI Self-Assessment Questionnaire (SAQ) compliance forms.


      **Related Guides:**

      - [Managing PCI
      Compliance](/guides/managing-operations/security-compliance/managing-pci-compliance)

      - [PCI DSS
      Compliance](/guides/managing-operations/security-compliance/pci-dss-compliance)
    x-keywords:
      includes:
        - compliance form
        - PCI compliance
        - PCI
        - PCI DSS
        - SAQ
  - name: Devices
    description: >
      A `Device` resource represents a Point-of-Sale terminal. Devices are used
      for [In-Person transactions](/guides/in-person-payments).


      **Related Guides:**

      - [In-Person Payments](/guides/in-person-payments)
    keywords:
      includes:
        - devices
        - point of sale
        - point of sale integration
        - POS
        - POS integration
        - POS system integration
  - name: Disbursement Rules
    description: >
      For the Payouts product, when a payout is executed, such as a Push-To-Card
      or ACH transaction, Finix checks the transaction against velocity rules
      and balance rules.


      Rules establish limits on transactions. For example, there may be a daily
      transaction limit of 100 transactions (`count_limit`) or a monthly volume
      limit of $100,000 (`volume_limit`). If a transaction exceeds any defined
      limit, the transaction is rejected. 


      Rules are set for entities involved in transactions, including the
      application, senders, and recipients.


      The "Application" represents the customer to whom Finix is applying the
      rules. Application rules are set solely by Finix and are applied to every
      single transaction.


      You can establish rules for "senders" and "recipients," referring to the
      parties involved in transactions:


      - In the case of a `PULL_FROM_CARD` or `PULL_FROM_ACH` transaction, sender
      rules are applied (either card or ACH rules). The "target" of the pull is
      referred to as the "sender," specifically the customer of Finix's client. 

      - Conversely, in the case of a `PUSH_FROM_CARD` or `PUSH_FROM_ACH`
      transaction, the recipient rules are applied (either card or ACH rules).
      The "target" of the push is referred to as the "recipient," which is, in
      turn, the customer of Finix's client.
    keywords:
      includes:
        - disbursement rules
        - velocity rules
        - balance rules
        - transaction limits
        - count limit
        - volume limit
        - sender rules
        - recipient rules
  - name: Disputes
    description: >
      `Disputes`, also known as chargebacks, represent any customer-disputed
      charges. A core part of the dispute lifecycle is the ability for a
      `Merchant` to upload `Dispute` evidence that supports their side of the
      `Dispute`.


      **Related Guides:**

      - [Managing Disputes](/guides/after-the-payment/disputes)
    x-keywords:
      excludes:
        - address verification
        - verification
      includes:
        - accept dispute
        - accepting disputes
        - avoid disputes
        - best practices disputes
        - chargeback
        - chargeback lifecycle
        - concede dispute
        - dispute evidence
        - dispute lifecycle
        - dispute process
        - dispute state
        - dispute states
        - disputes best practices
        - evidence
        - evidence documentation
        - evidence files
        - managing disputes
        - preventing disputes
        - respond to dispute
        - responding to disputes
        - submitting repsonse to dispute
        - upload evidence
  - name: Fee Profiles
    description: >
      A `fee_profiles` represents a pricing scheme that automatically applies
      fees to each transaction. Changes to `fee_profiles` go into effect
      immediately.


      **Related Guides:**

      - [Merchant Fee
      Profiles](/guides/platform-payments/monetizing-payments/merchant-fee-profiles)
    x-keywords:
      excludes:
        - EFT
      includes:
        - fee profile
        - merchant fee profile
  - name: Fees
    description: >
      A `Fee` is a charge levied against a `Merchant`. It represents how a
      platform charges its sellers for all various types of Fees. Payment
      transactions generate `Fee` resources.
  - name: Files
    description: >
      Use Finix's File API to upload and manage files for your merchants.


      **Related Guides:**

      - [File
      Uploads](/guides/platform-payments/onboarding-sellers/seller-onboarding-uploading-files.md)

      - [Update
      Requests](/guides/platform-payments/onboarding-sellers/seller-onboarding-update-requests.md)
    x-keywords:
      includes:
        - file
        - files
        - file upload
        - external_link
        - upload
        - uploading
        - upload file
        - upload seller files
        - uploading files
  - name: Identities
    description: >
      An `Identity` resource represents either a person or business in Finix.
      You'll create an `Identity` to onboard your sellers, and verify the
      different owners. 


      **Related Guides:**

      - [Getting Started](/guides/getting-started)

      - [Onboarding Sellers](/guides/platform-payments/onboarding-sellers)

      - [Push to Card](/guides/payouts/card-payouts/)
    x-keywords:
      includes:
        - identity
        - identities
  - name: Merchant Profiles
    description: >
      A `merchant_profile` links a `merchant` to it's `risk_profile` and
      `fee_profile`. Each `merchant` has a `merchant_profile`.


      When a `merchant` gets created, a `merchant_profile` also gets created.
      This new `merchant_profile` automatically receives a new `risk_profile`
      and `fee_profile` that are copies of the risk and fee profiles on the
      `application_profile`.


      Related Guides:

      - [Collecting
      Fees](/guides/platform-payments/monetizing-payments/collecting-seller-fees)
    x-keywords:
      includes:
        - merchant profile
  - name: Merchants
    description: >
      A `Merchant` resource represents the entity's merchant account on a
      processor. Your `Merchant` must be `APPROVED` to process payments.


      **Related Guides:**


      - [Getting Started](/guides/getting-started)

      - [Onboarding Sellers](/guides/platform-payments/onboarding-sellers)
    x-keywords:
      excludes:
        - CVV
        - AVS
      includes:
        - merchant
  - name: Onboarding Forms
    description: >
      Finix offers and hosts pre-built onboarding forms that you can use to
      collect onboarding and identity verification information from your users.


      **Related Guides:**

      - [Onboarding via the
      API](/guides/platform-payments/onboarding-sellers/seller-onboarding-via-api)
    x-keywords:
      excludes:
        - address verification
        - verification
      includes:
        - onboarding form
  - name: Payment Instruments
    description: >
      A `Payment Instrument` resource represents the payment details of a credit
      card or bank account. Payment details get tokenized multiple times and
      each tokenization produces a unique `Payment Instrument`. 


      A `Payment Instrument` is associated with a single
      [`Identity`](#Identities). Once a `Payment Instrument` is created, the
      `Identity` it's associated with can't be changed.


      Including an address when creating a `Payment Instrument` can lower
      interchange on credit card transactions.


      **Related Guides:**

      - [Using Hosted
      Fields](/guides/online-payments/payment-tokenization/tokenization-forms)

      - [Getting Started](/guides/getting-started)
    x-keywords:
      excludes:
        - PCI
      includes:
        - payment instrument
  - name: Payment Links
    description: >
      `Payment Links` create individual links you can send to buyers to complete
      a transaction. You can share these links on different platforms such as
      web pages, email, text, or QR codes. 


      **Related Guides:**

      - [Payment Links](/guides/online-payments/low-code-no-code/payment-links)
    x-keywords:
      includes:
        - payment link
  - name: Payout Links
    description: >
      A `Payout Link` is a unique, one-time link you can send via email or text
      to a recipient for fast and secure payouts. For card-based payouts, funds
      are typically available within minutes.


      Payout Links can be used for various purposes, including insurance
      payments, sales commissions, and more. Each link can be customized to
      display your brand name and logo, providing a seamless experience for
      recipients.


      **Related Guides:**

      - [Payout Links](/guides/payouts/payout-links)
    x-keywords:
      includes:
        - payout link
  - name: Payout Profiles
    description: >
      A `Payout Profile` configures how fees and payouts get calculated and
      processed.


      **Related Guides:**

      - [Configuring Payouts](/guides/payouts)
    x-keywords:
      includes:
        - payout profile
  - name: Processors
    description: >
      A `Processor` represents the acquiring platform where `Merchant` accounts
      get provisioned and ultimately where `Transfers` are processed. Your Finix
      point of contact will let you know which processor you should use.


      The Finix Payment Platform is processor agnostic which allows transactions
      to get processed across multiple processors. Once a `Processor` is
      enabled, the `Application` can begin provisioning `Merchant` accounts.


      **Related Guides**:

      - [Onboarding
      Process](/guides/platform-payments/onboarding-sellers/seller-onboarding-process#onboarding-process)
    x-keywords:
      includes:
        - processor
  - name: Receipts
    description: >
      The `Receipt` resource generates a receipt for [Transfers](#Transfers) or
      [Authorizations](#Authorizations). You can then send the `Receipt` via
      Email, SMS, or use the information from the `Receipt` to send it
      yourself. 


      **Related Guides:**

      - [Receipts for Online
      Payments](/guides/online-payments/payment-features/sending-receipts)
    x-keywords:
      includes:
        - receipt
  - name: Review Queue Items
    description: >
      Funds are released to sub-merchants when a `Settlement`'s corresponding
      `Review Queue Item` is marked as `ACCEPTED` by a user with the appropriate
      role permissions.


      **Related Guides:**

      - [Roles &
      Permissions](/guides/managing-operations/managing-team-members/roles-permissions)
    x-keywords:
      includes:
        - review queue item
  - name: Settlement Queue Entries
    description: >
      A `Settlement Queue Entry` resource represents an entry in the settlement
      queue used to track when and how a transfer is queued to be processed.


      If a merchant's `settlement_queue_mode` is set to `MANUAL`, all transfers
      will have a `Settlement Queue Entry` created and will not be placed into
      settlement until the `Settlement Queue Entry` is explicitly released using
      a **PUT** `Update Settlement Queue Entries` request.


      **Related Guides:**

      - [Account Structures and
      Settlements](/additional-resources/developers/resources-and-payment-flows/key-resources#settlements)
    x-keywords:
      includes:
        - settlement queue entry
        - settlement queue entries
  - name: Settlements
    description: >
      A `Settlement` is a logical construct representing a collection (i.e.
      batch) of Settlement Entries that will get paid out to a specific
      [`Merchant`](#Merchants). A Settlement Entry can represent
      [`Transfers`](#Transfers) or [`Split Transfers`](#Split-Transfers)


      **Related Guides:**

      - [Payouts](/guides/payouts)
    x-keywords:
      excludes:
        - address verification
        - verification
      includes:
        - settlement
  - name: Split Transfers
    description: >
      `Transfers` can be split among several different `Merchants.` A
      `split_transfer` represents how the funds from a split `Transfer` were
      distributed into a `Merchants` `Settlement`.


      **Related Guides:**

      - [Online Payments
      Quickstart](/guides/online-payments/online-payments-quickstart)
    x-keywords:
      excludes:
        - address verification
        - verification
      includes:
        - split transfer
  - name: Subscription Plans
    description: >
      A `Subscription Plan` resource is a template with set recurring costs and
      frequencies that can be reused across multiple `Subscription` resources. 


      **Related Guides:**

      - [Creating Subscriptions Plans](/guides/subscriptions/subscription-plans)

      - [Creating Subscriptions](/guides/subscriptions) 

      - [Recurring Payments
      Guidelines](/guides/subscriptions/recurring-payment-guidelines)
    x-keywords:
      excludes:
        - subscription link
      includes:
        - subscription plan
  - name: Subscriptions
    description: >
      A `Subscription` resource represents a recurring charge to a `Payment
      Instrument` at regular intervals. Subscribers can be buyers, customers, or
      merchants. <br><br>

      When creating a `Subscription`, you have the option to use a `Subscription
      Plan`.


      **Limitations**:

      - *Supported countries*: At this time, subscriptions are available in the
      United States.<br>

      - *Supported payment methods*: Subscriptions currently support recurring
      card payments and recurring bank account payments (<a
      href="/guides/online-payments/bank-payments/ach-direct-debits">ACH</a> in
      the USA).<br>

      - *Approved merchants*: At this time, only approved merchants with one of
      the following processors can create subscriptions: `DUMMY_V1` and
      `FINIX_V1`.<br><br>


      **Related Guides:**

      - [Creating Subscriptions](/guides/subscriptions)

      - [Creating Subscription Plans](/guides/subscriptions/subscription-plans)

      - [Recurring Payments
      Guidelines](/guides/subscriptions/recurring-payment-guidelines)
    x-keywords:
      excludes:
        - CVV
        - AVS
      includes:
        - subscription
  - name: Subscription Links
    description: >
      A `Subscription Link` is a link that a `Merchant` can create and send to a
      buyer for subscribing to a service.


      **Related Guides:**

      - [Subscription Links](/guides/subscriptions/subscription-links)
    x-keywords:
      includes:
        - subscription link
  - name: Transfer Attempts
    description: >
      A `Transfer Attempt` is created when a buyer attempts to pay for a payment
      using a `Payment Link` or `Checkout Form`. Using transfer attempts, you
      can track the lifecycle of a payment or a series of payments if you are
      using a multi-use `Payment Link`. 


      Each `transfer_attempt` has as reference to a `transfer_id` to allow you
      to query it for additional data.


      **Related Guides:**

      - [Transfer
      Attempts](/guides/online-payments/low-code-no-code/transfer-attempts)
    x-keywords:
      includes:
        - transfer attempt
  - name: Transfers
    description: >
      A `Transfer` represents any flow of funds either to or from a `Payment
      Instrument`. All payments in Finix are represented by a `Transfer`.


      **Related Guides:**

      - [Online Payments
      Quickstart](/guides/online-payments/online-payments-quickstart)

      - [Level 2 and 3
      Processing](/guides/online-payments/payment-features/level-2-level-3-processing/)

      - [POS
      Integration](/guides/in-person-payments/building-your-integration/pos-integration)

      - [Buyer
      Charges](/guides/online-payments/payment-features/buyer-charges/), 

      - [ACH (eCheck) Direct
      Debit](/guides/online-payments/bank-payments/ach-direct-debits)
    x-keywords:
      excludes:
        - CVV
        - AVS
        - address verification
        - verification
      includes:
        - transfer
  - name: Users
    description: >
      A `User` resource represents a pair of API keys which are used to perform
      authenticated requests against the Finix API. When making authenticated
      requests via HTTP basic access authentication the ID of a `User` resource
      maps to the username, while the `password` corresponds to the password
      (i.e. secret key).


      The password field for a `User` resource is only returned during the
      initial creation. Any following GET requests to the resource returns the
      `password` field as **null** for security purposes.


      **Related Guides:**

      - [Account
      Structure](/additional-resources/developers/resources-and-payment-flows/key-resources#account-structure)
    x-keywords:
      includes:
        - user
  - name: Verifications
    description: >
      `Verifications` are used to verify `Identities` and `Payment Instruments`.


      For `Identities`, a verification represents an attempt to onboard and
      underwrite an identity. 


      For `Payment Instruments`, a verification represents getting additional
      information from the card brands to verify a card is eligible for push to
      card.


      **Related Guides:**

      - [Onboarding with the
      API](/guides/platform-payments/onboarding-sellers/seller-onboarding-via-api)

      - [Push to Card](/guides/payouts/card-payouts)
    x-keywords:
      includes:
        - verification
  - name: Webhooks
    description: >
      `Webhooks` lets you build or set up integrations which subscribe to
      certain automated notifications (i.e. events) on the Finix API. When one
      of those events is triggered, a HTTP POST payload is sent to the webhook's
      configured URL.


      **Related Guides:**

      - [Webhooks](/additional-resources/developers/webhooks)
    x-keywords:
      includes:
        - webhooks
x-tagGroups:
  - name: Main Resources
    tags:
      - Authorizations
      - Compliance Forms
      - Devices
      - Disputes
      - Fees
      - Fee Profiles
      - Files
      - Identities
      - Merchants
      - Onboarding Forms
      - Payment Instruments
      - Settlements
      - Settlement Queue Entries
      - Split Transfers
      - Transfers
      - Users
      - Webhooks
  - name: Low-Code / No-Code Resources
    tags:
      - Checkout Forms
      - Payment Links
      - Payout Links
      - Receipts
      - Subscriptions
      - Subscription Links
      - Subscription Plans
      - Transfer Attempts
  - name: Payout Resources
    tags:
      - Balances
      - Balance Adjustments
      - Disbursement Rules
  - name: Core PayFac Resources
    tags:
      - Application Profiles
      - Applications
      - Balance Transfers
      - Merchant Profiles
      - Payout Profiles
      - Review Queue Items
      - Verifications
paths:
  /application_profiles:
    get:
      tags:
        - Application Profiles
      description: |-
        Retrieve a list of all `application_profiles`.

        For details on how to query endpoints using the available parameters.
      summary: List Application Profiles
      operationId: listApplicationProfiles
      responses:
        '200':
          $ref: '#/components/responses/ApplicationProfilesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-internal: false
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
            default: application/hal+json
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      x-java-method-name: list
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/application_profiles" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      x-group-parameters: true
  /application_profiles/{application_profile_id}:
    get:
      tags:
        - Application Profiles
      description: Retrieve the details of an existing `application_profile`.
      summary: Fetch Application Profile
      operationId: getApplicationProfile
      responses:
        '200':
          $ref: '#/components/responses/ApplicationProfile'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/application_profiles/PPqCt5m7AFobHUQsKxqkCEyT"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - $ref: '#/components/parameters/ApplicationProfileId'
    put:
      tags:
        - Application Profiles
      description: Update an existing `application_profile`.
      summary: Update Application Profile
      operationId: updateApplicationProfile
      requestBody:
        $ref: '#/components/requestBodies/UpdateApplicationProfileRequest'
      responses:
        '200':
          $ref: '#/components/responses/ApplicationProfile'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: update
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/application_profiles/PPqCt5m7AFobHUQsKxqkCEyT"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -X PUT \
                -d '{
                    "fee_profile": "FP9n9pPnDHZ98zxH9S2d1Qwn"
                }'
  /applications:
    post:
      summary: Create an Application
      operationId: createApplication
      description: >-
        Create a `Application`. If created successfully, a 201 response gets
        returned and adds a location header to the response which refers to the
        new created `Application`.
      tags:
        - Applications
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/createApplication'
                - $ref: '#/components/schemas/createApplicationEnableAccountUpdater'
                - $ref: '#/components/schemas/createApplicationEnableNetworkTokens'
                - $ref: '#/components/schemas/createApplicationDisableRefunds'
            examples:
              Application:
                value:
                  entity:
                    business_type: LIMITED_LIABILITY_COMPANY
                    business_phone: +1 (408) 756-4497
                    first_name: dwayne
                    last_name: Sunkhronos
                    dob:
                      year: 1978
                      day: 27
                      month: 5
                    business_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 8
                      line1: 741 Douglass St
                      postal_code: '94114'
                    max_transaction_amount: 1200000
                    phone: '1234567890'
                    doing_business_as: doing_business_as
                    default_statement_descriptor: young money
                    personal_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 7
                      line1: 741 Douglass St
                      postal_code: '94114'
                    business_name: business_name
                    business_tax_id: '123456789'
                    email: user@example.org
                    tax_id: '123456789'
                  user: US7uYoDEvUPuspdfxUsK96Xx
              Application - Enable Account Updater:
                value:
                  account_updater_enabled: true
                  entity:
                    business_type: LIMITED_LIABILITY_COMPANY
                    business_phone: +1 (408) 756-4497
                    first_name: dwayne
                    last_name: Sunkhronos
                    dob:
                      year: 1978
                      day: 27
                      month: 5
                    business_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 8
                      line1: 741 Douglass St
                      postal_code: '94114'
                    max_transaction_amount: 1200000
                    phone: '1234567890'
                    doing_business_as: doing_business_as
                    default_statement_descriptor: young money
                    personal_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 7
                      line1: 741 Douglass St
                      postal_code: '94114'
                    business_name: business_name
                    business_tax_id: '123456789'
                    email: user@example.org
                    tax_id: '123456789'
                  user: US7uYoDEvUPuspdfxUsK96Xx
              Application - Enable Network Tokens:
                value:
                  network_token_enabled: true
                  entity:
                    business_type: LIMITED_LIABILITY_COMPANY
                    business_phone: +1 (408) 756-4497
                    first_name: dwayne
                    last_name: Sunkhronos
                    dob:
                      year: 1978
                      day: 27
                      month: 5
                    business_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 8
                      line1: 741 Douglass St
                      postal_code: '94114'
                    max_transaction_amount: 1200000
                    phone: '1234567890'
                    doing_business_as: doing_business_as
                    default_statement_descriptor: young money
                    personal_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 7
                      line1: 741 Douglass St
                      postal_code: '94114'
                    business_name: business_name
                    business_tax_id: '123456789'
                    email: user@example.org
                    tax_id: '123456789'
                  user: US7uYoDEvUPuspdfxUsK96Xx
              Application - Disable Refunds:
                value:
                  refunds_disabled: true
                  entity:
                    business_type: LIMITED_LIABILITY_COMPANY
                    business_phone: +1 (408) 756-4497
                    first_name: dwayne
                    last_name: Sunkhronos
                    dob:
                      year: 1978
                      day: 27
                      month: 5
                    business_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 8
                      line1: 741 Douglass St
                      postal_code: '94114'
                    max_transaction_amount: 1200000
                    phone: '1234567890'
                    doing_business_as: doing_business_as
                    default_statement_descriptor: young money
                    personal_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 7
                      line1: 741 Douglass St
                      postal_code: '94114'
                    business_name: business_name
                    business_tax_id: '123456789'
                    email: user@example.org
                    tax_id: '123456789'
                  user: US7uYoDEvUPuspdfxUsK96Xx
      responses:
        '201':
          $ref: '#/components/responses/createApplication'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
      keywords:
        includes:
          - create application
    get:
      summary: List Applications
      operationId: listApplications
      description: >
        Retrieve a list of `Applications`. If there are no `Applications`, an
        empty collection is returned. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters).
      tags:
        - Applications
      parameters:
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/Finix-Version'
        - name: id
          description: Filter by the Application's ID.
          in: query
          schema:
            type: string
            example: APgPDQrLD52TYvqazjHJJchM
        - $ref: '#/components/parameters/limit'
        - name: name.like
          description: Filter by the Application's `name`.
          in: query
          schema:
            type: string
            example: Finix%20Flowers
        - name: owner_identity_business_name.like
          description: Filter by the Application Owner Identity's business name.
          in: query
          schema:
            type: string
            example: Finix%20Flowers
        - name: owner_identity_doing_business_as.like
          description: Filter by the Application Owner Identity's Doing Business As (DBA).
          in: query
          schema:
            type: string
            example: Finix%20Flowers%20Inc
        - name: owner_identity_email.like
          description: Filter by the Application Owner Identity's email.
          in: query
          schema:
            type: string
            example: john.doe@finix.com
        - name: owner_identity_first_name.like
          description: Filter by the Application Owner Identity's first name.
          in: query
          schema:
            type: string
            example: john
        - name: owner_identity_id
          description: Filter by the Application Owner Identity's ID.
          in: query
          schema:
            type: string
            example: IDfuTjQubvNjKBwzp2k5WNmW
        - name: owner_identity_last_name.like
          description: Filter by the Application Owner Identity's last name.
          in: query
          schema:
            type: string
            example: doe
        - name: processing_enabled
          description: Filter by whether the Application's processing is enabled.
          in: query
          schema:
            type: boolean
            example: true
        - name: settlement_enabled
          description: Filter by whether the Application's settlements are enabled.
          in: query
          schema:
            type: boolean
            example: true
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/applications" \
            -H "Content-Type: application/json" \
            -H "Finix-Version: 2022-02-01" \
            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listApplications'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /applications/{application_id}:
    get:
      summary: Fetch a Application
      operationId: getApplication
      description: Retrieve the details of an existing `Application`.
      tags:
        - Applications
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          description: A single `Application`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/application'
              examples:
                Application:
                  value:
                    id: APc9vhYcPsRuTSpKD9KpMtPe
                    created_at: '2024-11-14T22:25:06.54Z'
                    updated_at: '2025-02-18T23:40:49.31Z'
                    account_updater_enabled: false
                    card_cvv_required: false
                    card_expiration_date_required: true
                    creating_transfer_from_report_enabled: false
                    disbursements_ach_pull_enabled: true
                    disbursements_ach_push_enabled: true
                    disbursements_card_pull_enabled: true
                    disbursements_card_push_enabled: true
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    enabled: true
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    instant_payouts_card_push_enabled: false
                    name: Finix Documentation 2025
                    network_token_enabled: false
                    owner: IDjvxGeXBLKH1V9YnWm1CS4n
                    processing_enabled: true
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: false
                    settlement_approval_enabled: false
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    tags: {}
                    unreferenced_refund_manual_entry_enabled: false
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      processors:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/processors
                      users:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/users
                      owner_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/transfers
                      disputes:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/disputes
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/authorizations
                      settlements:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/settlements
                      merchants:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/merchants
                      identities:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/identities
                      webhooks:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/webhooks
                      reversals:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/reversals
                      tokens:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/tokens
                      payment_instruments:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/payment_instruments
                      application_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/application_profile
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
    parameters:
      - description: The `Application` ID.
        in: path
        name: application_id
        required: true
        schema:
          type: string
    put:
      summary: Update Application
      operationId: updateApplication
      description: Update the details of a `Application`.
      tags:
        - Applications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateApplication'
            examples:
              Update Application:
                value:
                  tags:
                    application_name: Finix Flowers
              Enable Settlement Approval:
                value:
                  settlement_approval_enabled: true
      responses:
        '200':
          description: A single `Application`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/application'
              examples:
                Update Authorization:
                  value:
                    id: APc9vhYcPsRuTSpKD9KpMtPe
                    created_at: '2024-11-14T22:25:06.54Z'
                    updated_at: '2025-02-18T23:40:49.31Z'
                    account_updater_enabled: false
                    card_cvv_required: false
                    card_expiration_date_required: true
                    creating_transfer_from_report_enabled: false
                    disbursements_ach_pull_enabled: true
                    disbursements_ach_push_enabled: true
                    disbursements_card_pull_enabled: true
                    disbursements_card_push_enabled: true
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    enabled: true
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    instant_payouts_card_push_enabled: false
                    name: Finix Documentation 2025
                    network_token_enabled: false
                    owner: IDjvxGeXBLKH1V9YnWm1CS4n
                    processing_enabled: true
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: false
                    settlement_approval_enabled: false
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    tags: {}
                    unreferenced_refund_manual_entry_enabled: false
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      processors:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/processors
                      users:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/users
                      owner_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/transfers
                      disputes:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/disputes
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/authorizations
                      settlements:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/settlements
                      merchants:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/merchants
                      identities:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/identities
                      webhooks:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/webhooks
                      reversals:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/reversals
                      tokens:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/tokens
                      payment_instruments:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/payment_instruments
                      application_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/application_profile
                Enable Settlement Approval:
                  summary: Enable Settlement Approval
                  value:
                    id: APc9vhYcPsRuTSpKD9KpMtPe
                    created_at: '2024-11-14T22:25:06.54Z'
                    updated_at: '2025-02-18T23:40:49.31Z'
                    account_updater_enabled: false
                    card_cvv_required: false
                    card_expiration_date_required: true
                    creating_transfer_from_report_enabled: false
                    disbursements_ach_pull_enabled: true
                    disbursements_ach_push_enabled: true
                    disbursements_card_pull_enabled: true
                    disbursements_card_push_enabled: true
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    enabled: true
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    instant_payouts_card_push_enabled: false
                    name: Finix Documentation 2025
                    network_token_enabled: false
                    owner: IDjvxGeXBLKH1V9YnWm1CS4n
                    processing_enabled: true
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: false
                    settlement_approval_enabled: true
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    tags: {}
                    unreferenced_refund_manual_entry_enabled: false
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      processors:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/processors
                      users:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/users
                      owner_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/transfers
                      disputes:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/disputes
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/authorizations
                      settlements:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/settlements
                      merchants:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/merchants
                      identities:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/identities
                      webhooks:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/webhooks
                      reversals:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/reversals
                      tokens:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/tokens
                      payment_instruments:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/payment_instruments
                      application_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/application_profile
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: update
  /applications/{application_id}/processors:
    get:
      description: List all `Processors` enabled for an `Application`.
      summary: List Application Processors
      operationId: listApplicationProcessors
      responses:
        '200':
          $ref: '#/components/responses/ProcessorsList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: listByApplicationId
      x-group-parameters: true
      tags:
        - Processors
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors"
            \
              -H "Content-Type: application/json" \
              -H "Finix-Version: 2022-02-01" \
              -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - $ref: '#/components/parameters/ApplicationId'
    post:
      tags:
        - Processors
      description: >
        Enable a `Processor` for an `Application`. If created successfully, a

        201 status is returned with a location header added to the response
        which refers to the

        newly enabled processor.
      summary: Create Application Processor
      operationId: createApplicationProcessor
      requestBody:
        $ref: '#/components/requestBodies/CreateProcessorRequest'
      responses:
        '201':
          $ref: '#/components/responses/Processor'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/processors"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
                -X POST \
                -d '{
                    "config": {
                        "canDebitBankAccount": true
                    },
                    "type": "DUMMY_V1"
                }'
  /applications/{application_id}/processors/{type}:
    get:
      description: Get the `Processors` for an `Application` by `type`.
      summary: Fetch Application Processors
      operationId: getApplicationProcessor
      responses:
        '200':
          $ref: '#/components/responses/Processor'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      tags:
        - Processors
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/applications/APdHjTsAPx81go7ekSMJqQdz/processors/DUMMY_V1"
            \
              -H "Content-Type: application/json" \
              -H "Finix-Version: 2022-02-01" \
              -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - $ref: '#/components/parameters/ApplicationId'
      - description: Type of `Processor`.
        required: true
        in: path
        name: type
        schema:
          type: string
  /applications/{application_id}/users:
    parameters:
      - $ref: '#/components/parameters/ApplicationId'
    post:
      description: >-
        Creating an application user is the equivalent of provisioning API keys
        (i.e. credentials) for an `Application`.


        > Each Application can have multiple `Users` which allows each seller to
        have multiple API keys that can be independently enabled and disabled.
        Merchants only have read access to the API.
      summary: Create an Application User
      operationId: createApplicationUser
      responses:
        '201':
          $ref: '#/components/responses/User'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-internal: false
      tags:
        - Users
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/users"
            \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -X POST \
                -d '{}'
  /authorizations:
    post:
      summary: Create an Authorization
      operationId: createAuthorization
      description: >-
        Create an `Authorization` to process a transaction.


        Related Guides: [Creating and Capturing an
        Authorization](/guides/online-payments/payment-features/auth-and-captures/),
        [Level 2 and 3
        Processing](/guides/online-payments/payment-features/level-2-level-3-processing),
        [POS
        Integration](/guides/in-person-payments/building-your-integration/pos-integration),
        [Buyer Charges](/guides/online-payments/payment-features/buyer-charges)
      tags:
        - Authorizations
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/createAuthorizationMinimalFields'
                - $ref: '#/components/schemas/createAuthorization'
                - $ref: '#/components/schemas/createAuthorizationCanada'
                - $ref: '#/components/schemas/createAuthorization3DSecure'
                - $ref: '#/components/schemas/createAuthorizationBuyerCharges'
                - $ref: '#/components/schemas/createAuthorizationCardPresent'
                - $ref: '#/components/schemas/createAuthorizationCVV'
                - $ref: '#/components/schemas/createAuthorizationFraudDetection'
                - $ref: '#/components/schemas/createAuthorizationGaming'
                - $ref: '#/components/schemas/createAuthorizationHSAorFSACard'
                - $ref: '#/components/schemas/createAuthorizationLevel2Processing'
                - $ref: '#/components/schemas/createAuthorizationLevel3Processing'
                - $ref: '#/components/schemas/createAuthorizationPartialAuthorization'
            examples:
              Authorization - Minimal Fields:
                value:
                  amount: 100
                  currency: USD
                  merchant: MUsVtN9pH65nGw61H7Nv8Apo
                  source: PIkxmtueemLD6dN9ZoWGHT44
                  tags:
                    order_number: 21DFASJSAKAS
              Authorization - All Fields:
                value:
                  3d_secure_authentication:
                    cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
                    electronic_commerce_indicator: AUTHENTICATED
                    transaction_id: EaOMucALHQqLAEGAgk
                  additional_buyer_charges:
                    convenience_amount: 10
                  additional_healthcare_data:
                    clinic_amount: 50
                    dental_amount: 200
                    prescription_amount: 300
                    vision_amount: 300
                  additional_purchase_data:
                    customer_reference_number: 321xyz
                    customs_duty_amount: 10
                    discount_amount: 100
                    item_data:
                      - amount_excluding_sales_tax: 400
                        amount_including_sales_tax: 500
                        commodity_code: 175-62-20
                        cost_per_unit: 500
                        item_description: printing paper
                        item_discount_amount: 100
                        merchant_product_code: '1149611'
                        quantity: 1
                        unit_of_measure: BX
                      - amount_excluding_sales_tax: 400
                        amount_including_sales_tax: 500
                        commodity_code: 207-72-54
                        cost_per_unit: 500
                        item_description: printing ink
                        item_discount_amount: 0
                        merchant_product_code: '2149612'
                        quantity: 1
                        unit_of_measure: CTN
                    shipping_amount: 100
                  amount: 100
                  currency: USD
                  fraud_session_id: 123456789
                  ip_address_v4: 104.59.125.155
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  security_code: '022'
                  source: PIkxmtueemLD6dN9ZoWGHT44
                  statement_descriptor: FLX*FINIX FLOWERS
                  tags:
                    order_number: 21DFASJSAKAS
              Authorization - Canada:
                value:
                  amount: 100
                  currency: CAD
                  merchant: MUoG7LpUyPFT8XTrEFPvwvyJ
                  source: PIkxmtueemLD6dN9ZoWGHT44
                  tags:
                    order_number: 21DFASJSAKAS
              Authorization - 3D Secure:
                value:
                  3d_secure_authentication:
                    cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
                    electronic_commerce_indicator: AUTHENTICATED
                    transaction_id: EaOMucALHQqLAEGAgk
                  amount: 100
                  currency: USD
                  merchant: MU7noQ1wdgdAeAfymw2rfBMq
                  source: PIkxmtueemLD6dN9ZoWGHT44
              Authorization - Authorization with CVV:
                value:
                  amount: 100
                  currency: USD
                  merchant: MU7noQ1wdgdAeAfymw2rfBMq
                  security_code: '022'
                  source: PIkxmtueemLD6dN9ZoWGHT44
              Authorization - Buyer Charges:
                value:
                  additional_buyer_charges:
                    convenience_amount: 150
                  amount: 5200
                  currency: USD
                  merchant: MU7noQ1wdgdAeAfymw2rfBMq
                  source: PIkxmtueemLD6dN9ZoWGHT44
                  tags:
                    test: sale
              Authorization - Card Present:
                value:
                  amount: 150
                  currency: USD
                  device: DVsEanpBtsAVvCHbNXkFaH6f
                  operation_key: CARD_PRESENT_AUTHORIZATION
                  tags:
                    order_number: test123transfer
              Authorization - Fraud Detection:
                value:
                  amount: 100
                  currency: USD
                  fraud_session_id: test_fraud
                  merchant: MU7noQ1wdgdAeAfymw2rfBMq
                  source: PIkxmtueemLD6dN9ZoWGHT44
              Authorization - Gaming:
                value:
                  amount: 100
                  currency: USD
                  merchant: MUmKTKuetVV1MQ5Cq6rjWA5j
                  source: PIkxmtueemLD6dN9ZoWGHT44
                  ip_address_v4: 192.168.1.1
                  tags:
                    order_number: 21DFASJSAKAS
              Authorization - HSA or FSA Card for Non-Healthcare MCC:
                value:
                  additional_healthcare_data:
                    clinic_amount: 50
                    dental_amount: 200
                    prescription_amount: 300
                    vision_amount: 300
                  amount: 950
                  currency: USD
                  merchant: MU7noQ1wdgdAeAfymw2rfBMq
                  source: PIkxmtueemLD6dN9ZoWGHT44
              Authorization - Level 2 Processing:
                value:
                  additional_purchase_data:
                    customer_reference_number: 321xyz
                    sales_tax: 200
                  amount: 1000
                  currency: USD
                  merchant: MU7noQ1wdgdAeAfymw2rfBMq
                  source: PIkxmtueemLD6dN9ZoWGHT44
              Authorization - Level 3 Processing:
                value:
                  additional_purchase_data:
                    customer_reference_number: 321xyz
                    customs_duty_amount: 10
                    discount_amount: 100
                    item_data:
                      - amount_excluding_sales_tax: 400
                        amount_including_sales_tax: 500
                        commodity_code: 175-62-20
                        cost_per_unit: 500
                        item_description: printing paper
                        item_discount_amount: 100
                        merchant_product_code: '1149611'
                        quantity: 1
                        unit_of_measure: BX
                      - amount_excluding_sales_tax: 400
                        amount_including_sales_tax: 500
                        commodity_code: 207-72-54
                        cost_per_unit: 500
                        item_description: printing ink
                        item_discount_amount: 0
                        merchant_product_code: '2149612'
                        quantity: 1
                        unit_of_measure: CTN
                    shipping_amount: 100
                  amount: 1000
                  currency: USD
                  merchant: MU7noQ1wdgdAeAfymw2rfBMq
                  source: PIkxmtueemLD6dN9ZoWGHT44
              Authorization - Partial Authorization:
                value:
                  amount: 100
                  currency: USD
                  merchant: MU7noQ1wdgdAeAfymw2rfBMq
                  partial_authorization: true
                  source: PIkxmtueemLD6dN9ZoWGHT44
      responses:
        '201':
          $ref: '#/components/responses/createAuthorization'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '402':
          $ref: '#/components/responses/402PaymentRequired'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422InvalidField'
      x-java-method-name: create
      keywords:
        includes:
          - authorization
          - authorize funds
          - card hold
    get:
      summary: List Authorizations
      description: >-
        Retrieve a list of `Authorizations`. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      operationId: listAuthorizations
      tags:
        - Authorizations
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/amount.gt'
        - $ref: '#/components/parameters/amount.gte'
        - $ref: '#/components/parameters/amount.lt'
        - $ref: '#/components/parameters/amount.lte'
        - $ref: '#/components/parameters/amount'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/currency'
        - $ref: '#/components/parameters/device'
        - $ref: '#/components/parameters/idempotency_id'
        - name: instrument_account_last4
          description: >-
            Filter Transactions by the last 4 digits of the bank account. The
            bank account last 4 are the last 4 digits of the masked account
            number.
          in: query
          schema:
            type: string
            example: 9444
        - name: instrument_bin
          description: >-
            Filter by Bank Identification Number (BIN). The BIN is the first 6
            digits of the masked number.
          in: query
          schema:
            type: string
            example: 411111
        - name: instrument_brand_type
          description: Filter by card brand.
          in: query
          schema:
            type: string
            example: VISA
        - name: instrument_card_last4
          description: Filter by the payment card last 4 digits.
          in: query
          schema:
            type: string
            example: 1111
        - name: instrument_name
          description: Filter Transactions by the `name` of the `Payment Instrument`.
          in: query
          schema:
            type: string
            example: Alice
        - name: is_void
          description: Show only voided authorizations.
          in: query
          schema:
            type: boolean
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/merchant_id'
        - name: merchant_identity_name
          description: Filter Transactions by name of the `Identity`.
          in: query
          schema:
            type: string
            example: John
        - name: merchant_mid
          description: Filter by Merchant Identification Number (MID).
          in: query
          schema:
            type: string
            example: FNXrzKj8xCLBwB8FdxjfU9txe
        - name: merchant_processor_id
          description: Filter by `Processor` ID.
          in: query
          schema:
            type: string
        - name: state
          description: Filter by transaction state.
          in: query
          schema:
            example: SUCCEEDED
            enum:
              - SUCCEEDED
              - FAILED
              - PENDING
              - CANCELED
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - $ref: '#/components/parameters/trace_id'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/authorizations" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listAuthorizations'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /authorizations/{authorization_id}:
    get:
      summary: Fetch an Authorization
      operationId: getAuthorization
      description: Retrieve the details of a previously created `Authorization`.
      tags:
        - Authorizations
      responses:
        '200':
          description: >-
            Response schema to a request to fetch a single `Authorization`
            object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/authorization'
              examples:
                Authorization:
                  value:
                    id: AUsJgTPyNKUKbkTk4mzq2aoM
                    created_at: '2025-10-27T15:55:36.29Z'
                    updated_at: '2025-10-27T15:55:36.29Z'
                    3ds_redirect_url: null
                    additional_buyer_charges: null
                    additional_healthcare_data: null
                    additional_purchase_data: null
                    address_verification: POSTAL_CODE_AND_STREET_MATCH
                    amount: 100
                    amount_requested: 100
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    currency: USD
                    expires_at: '2025-11-03T15:55:36.29Z'
                    failure_code: null
                    failure_message: null
                    idempotency_id: null
                    ip_address_details: null
                    is_void: false
                    merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                    merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                    messages: []
                    raw: null
                    receipt_last_printed_at: null
                    security_code_verification: MATCHED
                    source: PIkxmtueemLD6dN9ZoWGHT44
                    state: SUCCEEDED
                    supplemental_fee: null
                    tags:
                      order_number: 21DFASJSAKAS
                    trace_id: 0504c0cc-7665-4555-90c3-c460330acf2e
                    transfer: null
                    void_state: UNATTEMPTED
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/authorizations/AUsJgTPyNKUKbkTk4mzq2aoM
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
      x-java-method-name: get
      x-group-parameters: true
    put:
      summary: Capture an Authorization
      operationId: captureAuthorization
      description: >-
        Use a PUT request to capture an `Authorization`. If captured
        successfully, the `transfer` field of the `Authorization` will contain
        the ID of the `Transfer` resource that moves funds.


        Related Guides: [Creating and Capturing an
        Authorization](/guides/online-payments/payment-features/auth-and-captures/),
        [Level 2 and 3
        Processing](/guides/online-payments/payment-features/level-2-level-3-processing),
        [POS
        Integration](/guides/in-person-payments/building-your-integration/pos-integration),
        [Buyer Charges](/guides/online-payments/payment-features/buyer-charges)
      tags:
        - Authorizations
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/captureAuthorization'
                - $ref: '#/components/schemas/captureAuthorizationCardPresent'
                - $ref: '#/components/schemas/captureAuthorizationSplitTransfers'
            examples:
              Capture Authorization:
                value:
                  capture_amount: 100
                  fee: 0
              Capture Card Present Authorization:
                value:
                  capture_amount: 100
              Capture Authorization with Split Transfers:
                value:
                  capture_amount: 100
                  split_transfers:
                    - merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      amount: 60
                    - merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      amount: 40
      responses:
        '200':
          description: Response schema to a request to capture an `Authorization` object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/authorization'
              examples:
                Capture Authorization:
                  value:
                    id: AUcmwpCN6yKJ2HGot6X4YSv7
                    created_at: '2025-04-30T20:31:12.63Z'
                    updated_at: '2025-07-22T16:28:00.67Z'
                    3ds_redirect_url: null
                    additional_buyer_charges: null
                    additional_healthcare_data: null
                    additional_purchase_data: null
                    address_verification: POSTAL_CODE_AND_STREET_MATCH
                    amount: 100
                    amount_requested: 100
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    currency: USD
                    expires_at: '2025-05-07T20:31:12.63Z'
                    failure_code: null
                    failure_message: null
                    idempotency_id: null
                    is_void: false
                    merchant: MU7noQ1wdgdAeAfymw2rfBMq
                    merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                    messages: []
                    raw: null
                    receipt_last_printed_at: null
                    security_code_verification: MATCHED
                    source: PIkxmtueemLD6dN9ZoWGHT44
                    state: SUCCEEDED
                    supplemental_fee: null
                    tags: {}
                    trace_id: 836faa82-15e4-4945-8923-94253464ddc4
                    transfer: TRfbdBWj2Ww6a2j7XfiqEoV4
                    void_state: UNATTEMPTED
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/authorizations/AUcmwpCN6yKJ2HGot6X4YSv7
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      transfer:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRfbdBWj2Ww6a2j7XfiqEoV4
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                Capture Card Present Authorization:
                  value:
                    id: AUcmwpCN6yKJ2HGot6X4YSv7
                    created_at: '2025-04-30T20:31:12.63Z'
                    updated_at: '2025-07-22T16:28:00.67Z'
                    3ds_redirect_url: null
                    additional_buyer_charges: null
                    additional_healthcare_data: null
                    additional_purchase_data: null
                    address_verification: null
                    amount: 100
                    amount_requested: 100
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    card_present_details:
                      emv_data:
                        application_identifier: A0000001523010
                        application_label: DISCOVER
                        application_preferred_name: null
                        application_transaction_counter: '0005'
                        cryptogram: ARCQ F666F8891F870D33
                        issuer_code_table_index: null
                        pin_verified: false
                        tags: null
                      masked_account_number: '************0059'
                      name: Test Card 05
                      brand: DISCOVER
                      entry_mode: CHIP_ENTRY
                      payment_type: CREDIT
                      approval_code: '004839'
                    currency: USD
                    device: DVfKLD9GZtsjcJxLtc2yCcfd
                    expires_at: '2025-05-07T20:31:12.63Z'
                    failure_code: null
                    failure_message: null
                    idempotency_id: null
                    is_void: false
                    merchant: MU4LYrniAvqVKUBqcATb7Y7p
                    merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                    messages: []
                    raw: null
                    receipt_last_printed_at: null
                    security_code_verification: null
                    source: PIkxmtueemLD6dN9ZoWGHT44
                    state: SUCCEEDED
                    supplemental_fee: null
                    tags: {}
                    trace_id: 836faa82-15e4-4945-8923-94253464ddc4
                    transfer: TRfbdBWj2Ww6a2j7XfiqEoV4
                    void_state: UNATTEMPTED
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                      transfer:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd
                      device:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
                Capture Authorization with Split Transfers:
                  value:
                    id: AUn4tMnncUCHDMQYk2sp9otP
                    created_at: '2025-07-21T21:12:47.37Z'
                    updated_at: '2025-07-21T21:13:42.58Z'
                    3ds_redirect_url: null
                    additional_buyer_charges: null
                    additional_healthcare_data: null
                    additional_purchase_data: null
                    address_verification: POSTAL_CODE_AND_STREET_MATCH
                    amount: 100
                    amount_requested: 100
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    currency: USD
                    expires_at: '2025-07-28T21:12:47.37Z'
                    failure_code: null
                    failure_message: null
                    idempotency_id: null
                    is_void: false
                    merchant: MU7noQ1wdgdAeAfymw2rfBMq
                    merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                    messages: []
                    raw: null
                    receipt_last_printed_at: null
                    security_code_verification: MATCHED
                    source: PIkxmtueemLD6dN9ZoWGHT44
                    state: SUCCEEDED
                    supplemental_fee: null
                    tags:
                      order_number: 21DFASJSAKAS
                    trace_id: 2b31f572-981b-4153-a98c-c167167aa958
                    transfer: TRbcxdnBRD894baDUq989nEL
                    void_state: UNATTEMPTED
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/authorizations/AUn4tMnncUCHDMQYk2sp9otP
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      transfer:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRbcxdnBRD894baDUq989nEL
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422InvalidField'
      x-java-method-name: update
      x-group-parameters: true
      keywords:
        includes:
          - capture authorization
          - capture funds
    parameters:
      - name: authorization_id
        description: ID of `Authorization` to fetch.
        required: true
        in: path
        schema:
          type: string
          example: AUrEnGqdBi5oJs68ChNRcHJ3
  /authorizations/{authorization_id_void_to}:
    put:
      summary: Void an Authorization
      operationId: voidAuthorization
      description: >-
        Use a PUT request to void an `Authorization`. If voided successfully,
        funds get released, and the transaction is incomplete. Additionally, a
        voided `Authorization` can no longer be captured. Depending on the
        cardholder’s issuing bank, voids can take up to seven days to remove the
        `Authorization` hold.


        Related Guides: [Creating and Capturing an
        Authorization](/guides/online-payments/payment-features/auth-and-captures/),
        [Level 2 and 3
        Processing](/guides/online-payments/payment-features/level-2-level-3-processing),
        [POS
        Integration](/guides/in-person-payments/building-your-integration/pos-integration),
        [Buyer Charges](/guides/online-payments/payment-features/buyer-charges)
      tags:
        - Authorizations
      parameters:
        - $ref: '#/components/parameters/Content-Type'
        - $ref: '#/components/parameters/Finix-Version'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/voidAuthorization'
            examples:
              Void an Authorization:
                value:
                  void_me: true
      responses:
        '200':
          description: >-
            Response schema to a request to void a single `Authorization`
            object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/authorization'
              examples:
                Authorization:
                  value:
                    id: AUh4LG8REtmRBCxaSp85PMkr
                    created_at: '2024-12-04T10:49:28.93Z'
                    updated_at: '2024-12-04T10:49:51.38Z'
                    3ds_redirect_url: null
                    additional_buyer_charges: null
                    additional_healthcare_data: null
                    additional_purchase_data: null
                    address_verification: POSTAL_CODE_AND_STREET_MATCH
                    amount: 100
                    amount_requested: 100
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    currency: USD
                    expires_at: '2024-12-11T10:49:28.93Z'
                    failure_code: null
                    failure_message: null
                    idempotency_id: null
                    is_void: false
                    merchant: MU7noQ1wdgdAeAfymw2rfBMq
                    merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                    messages: []
                    raw: null
                    receipt_last_printed_at: null
                    security_code_verification: MATCHED
                    source: PIkxmtueemLD6dN9ZoWGHT44
                    state: SUCCEEDED
                    tags:
                      order_number: 21DFASJSAKAS
                    trace_id: f9d829f3-6d84-41f1-a662-38ca99206af2
                    transfer: TRhzVLqF1TKjtMZsMJwA7P9j
                    void_state: PENDING
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/authorizations/AUh4LG8REtmRBCxaSp85PMkr
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      transfer:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRhzVLqF1TKjtMZsMJwA7P9j
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422InvalidField'
      x-java-method-name: update
      x-group-parameters: true
      keywords:
        includes:
          - void an authorization
          - voided authorization
          - voided authorization
    parameters:
      - name: authorization_id_void_to
        schema:
          type: string
        in: path
        required: true
  /balances:
    get:
      summary: List Balances
      description: >
        Retrieve a list of `Balance` resources.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Balances
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/BalanceList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/balances?linked_to=APc9vhYcPsRuTSpKD9KpMtPe"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      operationId: listBalances
      x-java-method-name: list
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).
  /balances/{balance_id}:
    get:
      summary: Fetch a Balance
      description: Retrieve the details of a specific `Balance`.
      tags:
        - Balances
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/FetchBalanceResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >-
            curl
            "https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      operationId: getBalance
      x-java-method-name: get
    parameters:
      - schema:
          type: string
        name: balance_id
        description: The ID of the `Balance`.
        in: path
        required: true
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/guides/developers/versioning/).
  /balances/{balance_id}/balance_entries:
    get:
      summary: List Balance Entries
      description: >
        A `Balance Entry` reflects a change to an application's `Balance` due to
        a `Transfer` or a `Balance Adjustment` (i.e., "top-up").


        You can use this endpoint to obtain a list of `Balance Entry` objects.
      tags:
        - Balances
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      responses:
        '200':
          $ref: '#/components/responses/ListBalanceEntriesResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >-
            curl
            "https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc/balance_entries"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      operationId: listBalanceEntries
      x-java-method-name: list
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/guides/developers/versioning/).
      - schema:
          type: string
        name: balance_id
        description: The ID of the `Balance`.
        in: path
        required: true
  /balance_entries/{balance_entry_id}:
    get:
      summary: Fetch a Balance Entry
      description: Retrieve the details of a specific `Balance Entry`.
      tags:
        - Balances
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/FetchBalanceEntryResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >-
            curl
            "https://finix.sandbox-payments-api.com/balance_entries/balance_entry_i5YzFZYEh6CoCrN2zqgPdW"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      operationId: getBalanceEntry
      x-java-method-name: get
    parameters:
      - schema:
          type: string
        name: balance_entry_id
        description: The ID of the `Balance Entry`.
        in: path
        required: true
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/guides/developers/versioning/).
  /balance_adjustments:
    post:
      summary: Create a Balance Adjustment
      description: >
        Create a `Balance Adjustment` to increase (i.e., 'Top-up') or decrease
        your account balance for Payouts.
      tags:
        - Balance Adjustments
      x-group-parameters: true
      requestBody:
        $ref: '#/components/requestBodies/CreateBalanceAdjustmentRequest'
      responses:
        '201':
          $ref: '#/components/responses/CreateBalanceAdjustmentResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: createBalanceAdjustment
      x-java-method-name: create
    get:
      summary: List Balance Adjustments
      description: >
        Retrieve a list of `Balance Adjustment` resources for an `Application`.


        Only `ROLE_PARTNER` or `ROLE_PLATFORM` credentials can be used to
        retrieve `Balance Adjustment` objects.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Balance Adjustments
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      responses:
        '200':
          $ref: '#/components/responses/BalanceAdjustmentList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/balance_adjustments" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      operationId: listBalanceAdjustments
      x-java-method-name: list
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).
  /balance_transfers:
    post:
      summary: Create a Balance Transfer
      operationId: createBalanceTransfer
      responses:
        '201':
          $ref: '#/components/responses/BalanceTransfer'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: Create a `balance_transfer`.
      tags:
        - Balance Transfers
      requestBody:
        $ref: '#/components/requestBodies/CreateBalanceTransferRequest'
      x-internal: false
      x-java-method-name: create
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/balance_transfers" \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99 \
                -X POST \
                -d '{
                    "amount": 4000,
                    "currency": "USD",
                    "description": "Need to increase buffer given the high number of NSFs on merchant fee debits",
                    "destination": "FOR_BENEFIT_OF_ACCOUNT",
                    "processor_type": "LITLE_V1",
                    "source": "OPERATING_ACCOUNT",
                    "tags": {
                        "example": "documentation tag"
                    }
                }'
    get:
      summary: List Balance Transfers
      operationId: listBalanceTransfers
      responses:
        '200':
          $ref: '#/components/responses/BalanceTransferList'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          description: Not Found
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: >-
        Retrieve a list of all `Balance Transfer` objects.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
        - schema:
            type: integer
          in: query
          name: pageNumber
          description: The page number to list.
        - schema:
            type: integer
          in: query
          name: pageSize
          description: The size of the page.
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
        - $ref: '#/components/parameters/QueryIdempotencyIdFilter'
        - $ref: '#/components/parameters/QueryAmountFilter'
        - in: query
          name: description
          schema:
            type: string
          description: Filter by the `Description` value .
        - schema:
            type: string
          in: query
          name: destination
          description: Filter by the `Payment Instrument` saved in `Destination`.
        - schema:
            type: string
          in: query
          name: external_reference_id
          description: Filter by the value saved in `external_reference_id`.
        - schema:
            type: string
          in: query
          name: reference_id
          description: Filter by the value saved in `reference_id`.
        - schema:
            type: string
          in: query
          description: Filter by the `Payment Instrument` saved in `source`.
          name: source
      tags:
        - Balance Transfers
      x-internal: false
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/balance_transfers/" \
              -H "Finix-Version: 2022-02-01" \
              -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99
  /balance_transfers/{balance_transfers_id}:
    parameters:
      - schema:
          type: string
        name: balance_transfers_id
        in: path
        required: true
        description: ID of the `Balance Transfer` resource.
    get:
      summary: Fetch a Balance Transfer
      tags:
        - Balance Transfers
      responses:
        '200':
          $ref: '#/components/responses/BalanceTransfer'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: getBalanceTransfers
      description: Retrieve the details of a `balance_transfer`.
      x-internal: false
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/balance_transfers/BT_9SLA5BdQs6Z3xFpmjUoqhM"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b9
  /devices:
    get:
      summary: List Devices
      operationId: listDevices
      description: >
        Retrieve a list of `Devices`. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      tags:
        - Devices
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/application_id'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/description'
        - $ref: '#/components/parameters/enabled'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/merchant_id'
        - $ref: '#/components/parameters/name'
        - $ref: '#/components/parameters/model'
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - $ref: '#/components/parameters/serial_number'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/devices" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listDevices'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /devices/{device_id}:
    get:
      summary: Fetch a Device
      operationId: getDevice
      description: Retrieve the details of an existing `Device`.
      tags:
        - Devices
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - schema:
            type: boolean
          in: query
          name: include_connection
          description: Specifies whether the connection information should be included.
      responses:
        '200':
          description: A single `Device`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device'
              examples:
                Device:
                  value:
                    id: DVoDo7F6yYCnX2d6Fj9hvsd
                    created_at: '2025-11-14T19:01:04.638451Z'
                    updated_at: '2025-11-14T19:01:04.638451Z'
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: true
                      prompt_manual_entry: false
                      signature_threshold_amount: 10000
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: true
                      display_tip_on_receipt: false
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: false
                      allow_standalone_sales: false
                      allow_standalone_refunds: false
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      prompt_for_signature: NEVER
                      surcharge_basis_points: null
                    description: Cashier One
                    enabled: false
                    idle_message: null
                    merchant: MUsMvN47nRtdgUkE23SRHDC6
                    model: PAX_A800
                    name: My PAX_A800 Finix Device
                    serial_number: '2210172205'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUsMvN47nRtdgUkE23SRHDC6
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
      x-group-parameters: true
    parameters:
      - description: The `Device` ID.
        in: path
        name: device_id
        required: true
        schema:
          type: string
    put:
      summary: Update Device
      operationId: updateDevice
      description: >
        You can either update the configuration of a device or take an action on
        the device


        Terminals must be online and connected to the network in order for the
        request to be successful.


        You can initiate an action on a `Device`. Actions supported vary by
        gateway.


        FINIX_V1 and DUMMY_V1 terminals support the following actions:

        - `ACTIVATE` - Activate the device to enable processing

        - `DEACTIVATE` - Deactivate the device to disable processing

        - `CANCEL` - Cancel any active transaction and return to the idle screen


        DATACAP_V1 terminals support the following actions:

        - `ACTIVATE` - Activate the device to enable processing

        - `DEACTIVATE` - Deactivate the device to disable processing


        TRIPOS_CLOUD_V1 terminals support following actions:

        - `ACTIVATE` - Activate the device to enable processing

        - `DEACTIVATE` - Deactivate the device to disable processing

        - `CREATE_IDLE_MESSAGE` - Update the idle message content on the
        terminal

        - `REBOOT` - Remotely reboot the terminal


        You can also use a PUT request to update the `configuration`,
        `description`, `name`, and `serial_number` of the `Device`.
        Functionality varies by gateway/device. 
      tags:
        - Devices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - title: Device - Activate (FINIX_V1/DUMMY_V1/DATACAP_V1)
                  type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - ACTIVATE
                      description: >-
                        The action you want to perform on the device. Use
                        **ACTIVATE** to activate a the physical model with the
                        `Device`.
                    tags:
                      $ref: '#/components/schemas/tags'
                  required:
                    - action
                - title: Device - Activate (TRIPOS_CLOUD_V1)
                  type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - ACTIVATE
                      description: >-
                        The action you want to perform on the device. Use
                        `ACTIVATE` to activate a the physical model with the
                        `Device`.
                    activation_code:
                      type: string
                      description: >-
                        Used when `action` is `ACTIVATE`. Provide the input code
                        that shows up on the device screen.
                    tags:
                      $ref: '#/components/schemas/tags'
                  required:
                    - action
                    - activation_code
                - title: Device - Cancel (FINIX_V1/DUMMY_V1)
                  type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - CANCEL
                      description: >-
                        The action you want to perform on the device. Use
                        `CANCEL` to cancel any active transaction and return to
                        the idle screen.
                    tags:
                      $ref: '#/components/schemas/tags'
                  required:
                    - action
                - title: >-
                    Device - Deactivate
                    (FINIX_V1/DUMMY_V1/DATACAP_V1/TRIPOS_CLOUD_V1)
                  type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - DEACTIVATE
                      description: >-
                        The action you want to perform on the device. Use
                        **DEACTIVATE** to deactivate the device.
                  required:
                    - action
                - title: Idle Message Set (TRIPOS_CLOUD_V1)
                  type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - CREATE_IDLE_MESSAGE
                      description: >-
                        The action you want to perform on the device. Use
                        **CREATE\_IDLE\_MESSAGE** to set an idle message on the
                        device.
                    idle_message:
                      type: string
                      description: Message to display on the idle screen.
                  required:
                    - action
                - title: Device - Reboot Device (TRIPOS_CLOUD_V1)
                  type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - REBOOT
                      description: >-
                        The action you want to perform on the device. Use
                        **REBOOT** to restart the device.
                  required:
                    - action
                - title: Device - Update Details
                  type: object
                  properties:
                    configuration:
                      $ref: '#/components/schemas/device_configuration'
                    description:
                      type: string
                      description: >-
                        Additional information about device (e.g. self serving
                        terminal).
                    name:
                      type: string
                      description: Name of the `Device`.
                    serial_number:
                      type: string
                      description: Serial number of the `device`.
                - title: Device - Update Surcharges (FINIX_V1)
                  type: object
                  properties:
                    surcharge_basis_points:
                      type: integer
                      description: >
                        Represents the transaction amount that a `Merchant`
                        charges the buyer when creating a `Transfer` or an
                        `Authorization`. The value cannot exceed `300` (i.e.,
                        3%). For devices on Standalone Mode, the Finix Payment
                        Application on the terminal will calculate and send a
                        `Transfer` or an `Authorization` request with the
                        surcharge added. Customers integrated directly into
                        Finix API must contact Support to incorporate
                        surcharging appropriately into their integration. 
                      default: 0
                      maximum: 300
                - title: Device - Update Idle File Image
                  type: object
                  properties:
                    idle_image_file_id:
                      type: string
                      description: >-
                        The ID of the file to be displayed on the device when it
                        is idle. Passing a value of `null` resets the device's
                        idle image to the default.
                      nullable: true
            examples:
              Device - Activate (FINIX_V1/DUMMY_V1/DATACAP_V1):
                value:
                  action: ACTIVATE
              Device - Activate (TRIPOS_CLOUD_V1):
                value:
                  action: ACTIVATE
                  activation_code: '609732'
              Device - Cancel (FINIX_V1/DUMMY_V1):
                value:
                  action: CANCEL
              Device - Deactivate (FINIX_V1/DUMMY_V1/DATACAP_V1/TRIPOS_CLOUD_V1):
                value:
                  action: DEACTIVATE
              Device - Set Idle Message (TRIPOS_CLOUD_V1):
                value:
                  action: CREATE_IDLE_MESSAGE
                  idle_message: Finix Flowers
              Device - Reboot Device (TRIPOS_CLOUD_V1):
                value:
                  action: REBOOT
              Device - Update Details (DUMMY_V1/FINIX_V1):
                value:
                  configuration:
                    allow_standalone_authorizations: false
                    allow_standalone_sales: false
                    allow_standalone_refunds: false
                    prompt_receipt_confirmation: true
                    prompt_tip_on_receipt: false
              Device - Update Details (TRIPOS_CLOUD_V1):
                value:
                  name: Finix Front Terminal
                  description: Main Use Terminal
                  tags:
                    key: value
                  configuration:
                    allow_debit: true
                    check_for_duplicate_transactions: true
                    prompt_manual_entry: false
                    prompt_amount_confirmation: true
              Device - Update Details (DATACAP_V1):
                value:
                  name: Finix Front Terminal
                  description: Main Use Terminal
                  tags:
                    key: value
                  configuration:
                    check_for_duplicate_transactions: true
                    prompt_manual_entry: false
                    prompt_amount_confirmation: true
              Device - Update Surcharges (FINIX_V1):
                value:
                  configuration:
                    surcharge_basis_points: 300
              Device - Update Idle File Image:
                value:
                  configuration:
                    idle_image_file_id: FILE_abki8bFEjq51eZ5w2pYFik
      responses:
        '200':
          description: A single `Device`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device'
              examples:
                Device - Activate (FINIX_V1/DUMMY_V1/DATACAP_V1):
                  value:
                    id: DVoDo7F6yYCnX2d6Fj9hvsd
                    created_at: '2025-11-14T19:01:04.638451Z'
                    updated_at: '2025-11-14T19:01:04.638451Z'
                    android_version: '10'
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: true
                      prompt_manual_entry: false
                      signature_threshold_amount: 10000
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: true
                      display_tip_on_receipt: false
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: false
                      allow_standalone_sales: false
                      allow_standalone_refunds: false
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      prompt_for_signature: NEVER
                      surcharge_basis_points: null
                    description: Cashier One
                    enabled: true
                    firmware_version: PayDroid_10.0.0_Eucalyptus_V20.1.23_20250108
                    idle_message: null
                    merchant: MUsMvN47nRtdgUkE23SRHDC6
                    model: PAX_A800
                    name: My PAX_A800 Finix Device
                    payment_app_version: 5.9.0
                    serial_number: '2210172205'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUsMvN47nRtdgUkE23SRHDC6
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Activate (TRIPOS_CLOUD_V1):
                  value:
                    id: DVsEanpBtsAVvCHbNXkFaH6f
                    created_at: '2019-03-01T02:27:20.366Z'
                    updated_at: '2022-04-05T18:48:40.383Z'
                    android_version: 13
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: false
                      prompt_manual_entry: true
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: null
                      display_tip_on_receipt: null
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: null
                      allow_standalone_sales: null
                      allow_standalone_refunds: null
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                        allow_custom_tip: false
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      surcharge_basis_points: 0
                    description: Mike Jones
                    enabled: true
                    firmware_version: 2.1.0
                    idle_message: null
                    merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                    model: LANE_3000
                    payment_app_version: 3.2.1
                    name: Johnnys Juice Shop
                    serial_number: '343434343'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Cancel (FINIX_V1/DUMMY_V1):
                  value:
                    id: DVsEanpBtsAVvCHbNXkFaH6f
                    created_at: '2019-03-01T02:27:20.366Z'
                    updated_at: '2022-04-05T18:48:40.383Z'
                    android_version: 13
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: false
                      prompt_manual_entry: true
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: null
                      display_tip_on_receipt: null
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: null
                      allow_standalone_sales: null
                      allow_standalone_refunds: null
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                        allow_custom_tip: true
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      surcharge_basis_points: 0
                    description: Mike Jones
                    enabled: false
                    firmware_version: 2.1.0
                    idle_message: null
                    merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                    model: LANE_3000
                    payment_app_version: 3.2.1
                    name: Johnnys Juice Shop
                    serial_number: '343434343'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Deactivate (FINIX_V1/DUMMY_V1/DATACAP_V1/TRIPOS_CLOUD_V1):
                  value:
                    id: DVsEanpBtsAVvCHbNXkFaH6f
                    created_at: '2019-03-01T02:27:20.366Z'
                    updated_at: '2022-04-05T18:48:40.383Z'
                    android_version: 13
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: false
                      prompt_manual_entry: true
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: null
                      display_tip_on_receipt: null
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: null
                      allow_standalone_sales: null
                      allow_standalone_refunds: null
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                        allow_custom_tip: true
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      surcharge_basis_points: 0
                    description: Mike Jones
                    enabled: false
                    firmware_version: 2.1.0
                    idle_message: null
                    merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                    model: LANE_3000
                    payment_app_version: 3.2.1
                    name: Johnnys Juice Shop
                    serial_number: '343434343'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Set Idle Message (TRIPOS_CLOUD_V1):
                  value:
                    id: DVsEanpBtsAVvCHbNXkFaH6f
                    created_at: '2019-03-01T02:27:20.366Z'
                    updated_at: '2022-04-05T18:48:40.383Z'
                    android_version: 13
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: false
                      prompt_manual_entry: true
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: null
                      display_tip_on_receipt: null
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: null
                      allow_standalone_sales: null
                      allow_standalone_refunds: null
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                        allow_custom_tip: true
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      surcharge_basis_points: 0
                    description: Mike Jones
                    enabled: true
                    firmware_version: 2.1.0
                    idle_message: Finix Flowers
                    merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                    model: LANE_3000
                    payment_app_version: 3.2.1
                    name: Johnnys Juice Shop
                    serial_number: '343434343'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Reboot Device (TRIPOS_CLOUD_V1):
                  value:
                    id: DVsEanpBtsAVvCHbNXkFaH6f
                    created_at: '2019-03-01T02:27:20.366Z'
                    updated_at: '2022-04-05T18:48:40.383Z'
                    android_version: 13
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: false
                      prompt_manual_entry: true
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: null
                      display_tip_on_receipt: null
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: null
                      allow_standalone_sales: null
                      allow_standalone_refunds: null
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                        allow_custom_tip: true
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      surcharge_basis_points: 0
                    description: Mike Jones
                    enabled: true
                    firmware_version: 2.1.0
                    idle_message: Finix Flowers
                    merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                    model: LANE_3000
                    payment_app_version: 3.2.1
                    name: Johnnys Juice Shop
                    serial_number: '343434343'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Update Details (DUMMY_V1/FINIX_V1):
                  value:
                    id: DVsEanpBtsAVvCHbNXkFaH6f
                    created_at: '2019-03-01T02:27:20.366Z'
                    updated_at: '2022-04-05T18:48:40.383Z'
                    android_version: 13
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: false
                      prompt_manual_entry: true
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: true
                      display_tip_on_receipt: false
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: false
                      allow_standalone_sales: false
                      allow_standalone_refunds: false
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                        allow_custom_tip: true
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      surcharge_basis_points: 0
                    description: Mike Jones
                    enabled: false
                    firmware_version: 2.1.0
                    idle_message: null
                    merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                    model: LANE_3000
                    payment_app_version: 3.2.1
                    name: Johnnys Juice Shop
                    serial_number: '343434343'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Update Details (TRIPOS_CLOUD_V1):
                  value:
                    id: DVsEanpBtsAVvCHbNXkFaH6f
                    created_at: '2019-03-01T02:27:20.366Z'
                    updated_at: '2022-04-05T18:48:40.383Z'
                    android_version: 13
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: true
                      prompt_manual_entry: false
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: true
                      display_tip_on_receipt: false
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: false
                      allow_standalone_sales: false
                      allow_standalone_refunds: false
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                        allow_custom_tip: true
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      surcharge_basis_points: 0
                    description: Mike Jones
                    enabled: false
                    firmware_version: 2.1.0
                    idle_message: null
                    merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                    model: LANE_3000
                    payment_app_version: 3.2.1
                    name: Johnnys Juice Shop
                    serial_number: '343434343'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Update Details (DATACAP_V1):
                  value:
                    id: DVsEanpBtsAVvCHbNXkFaH6f
                    created_at: '2019-03-01T02:27:20.366Z'
                    updated_at: '2022-04-05T18:48:40.383Z'
                    android_version: 13
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: true
                      prompt_manual_entry: false
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: true
                      display_tip_on_receipt: false
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: false
                      allow_standalone_sales: false
                      allow_standalone_refunds: false
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                        allow_custom_tip: true
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      surcharge_basis_points: 0
                    description: Mike Jones
                    enabled: false
                    firmware_version: 2.1.0
                    idle_message: null
                    merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                    model: LANE_3000
                    payment_app_version: 3.2.1
                    name: Johnnys Juice Shop
                    serial_number: '343434343'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Update Surcharges (FINIX_V1):
                  value:
                    id: DVhujJBk9YBPYJJEhmCjpWYa
                    created_at: '2025-01-30T21:06:48.752649Z'
                    updated_at: '2025-01-30T21:06:48.752649Z'
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: true
                      prompt_manual_entry: false
                      signature_threshold_amount: 10000
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: true
                      display_tip_on_receipt: false
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: false
                      allow_standalone_sales: false
                      allow_standalone_refunds: false
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      prompt_for_signature: NEVER
                      surcharge_basis_points: 300
                    description: Cashier One
                    enabled: false
                    idle_message: null
                    merchant: MUmUL7aBsHkxVLQawJxEXw6N
                    model: PAX_A800
                    name: My PAX_A800 Finix Device
                    serial_number: '19046260945'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVhujJBk9YBPYJJEhmCjpWYa
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
                Device - Update Idle File Image:
                  value:
                    id: DVhujJBk9YBPYJJEhmCjpWYa
                    created_at: '2025-01-30T21:06:48.752649Z'
                    updated_at: '2025-01-30T21:06:48.752649Z'
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: true
                      prompt_manual_entry: false
                      signature_threshold_amount: 10000
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: true
                      display_tip_on_receipt: false
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: false
                      allow_standalone_sales: false
                      allow_standalone_refunds: false
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                      idle_message: null
                      idle_image_file_id: FILE_abki8bFEjq51eZ5w2pYFik
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      prompt_for_signature: NEVER
                      surcharge_basis_points: 300
                    description: Cashier One
                    enabled: false
                    idle_message: null
                    merchant: MUmUL7aBsHkxVLQawJxEXw6N
                    model: PAX_A800
                    name: My PAX_A800 Finix Device
                    serial_number: '19046260945'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVhujJBk9YBPYJJEhmCjpWYa
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: update
      x-group-parameters: true
  /devices/{device_id_connection}:
    get:
      summary: Check Device Connection
      description: >-
        To check the connection of the `Device`, include
        `?include_connection=true` at the end of the request endpoint.
      operationId: getDeviceConnection
      tags:
        - Devices
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - schema:
            type: boolean
          in: query
          name: include_connection
          description: Specifies whether the connection information should be included.
          required: true
      responses:
        '200':
          description: A single `Device`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device'
              examples:
                Device:
                  value:
                    id: DVoDo7F6yYCnX2d6Fj9hvsd
                    created_at: '2025-11-14T19:01:04.638451Z'
                    updated_at: '2025-11-14T19:01:04.638451Z'
                    android_version: '10'
                    configuration_details:
                      allow_debit: true
                      check_for_duplicate_transactions: true
                      prompt_amount_confirmation: true
                      prompt_manual_entry: false
                      signature_threshold_amount: 10000
                      bypass_device_on_capture: true
                      prompt_receipt_confirmation: true
                      display_tip_on_receipt: false
                      prompt_tip_on_screen: false
                      allow_standalone_authorizations: false
                      allow_standalone_sales: false
                      allow_standalone_refunds: false
                      tipping_details:
                        percent_tipping_threshold: 0
                        percent_options:
                          - 18
                          - 20
                          - 22
                        fixed_options:
                          - 100
                          - 150
                          - 200
                      idle_message: null
                      idle_image_file_id: null
                      automatic_receipt_delivery_methods: null
                      available_receipt_methods: null
                      prompt_for_signature: NEVER
                      surcharge_basis_points: null
                    connection: Open
                    description: Cashier One
                    enabled: false
                    firmware_version: PayDroid_10.0.0_Eucalyptus_V20.1.23_20250108
                    idle_message: null
                    merchant: MUsMvN47nRtdgUkE23SRHDC6
                    model: PAX_A800
                    name: My PAX_A800 Finix Device
                    payment_app_version: 5.9.0
                    serial_number: '2210172205'
                    tags: {}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd
                      merchant:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUsMvN47nRtdgUkE23SRHDC6
                      transfers:
                        href: https://finix.sandbox-payments-api.com/transfers
                      authorizations:
                        href: https://finix.sandbox-payments-api.com/authorizations
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
      x-group-parameters: true
      keywords:
        includes:
          - device connection
          - device connectivity
    parameters:
      - schema:
          type: string
        name: device_id_connection
        description: The `Device` you wish to check the connection status of.
        in: path
        required: true
  /devices/{device_id}/device_metrics:
    get:
      summary: List Device Metrics
      operationId: listDeviceMetrics
      description: >
        Finix collects and analyzes data from payment devices and terminals to
        generate logs, known as `Device Metric` objects. Each `Device Metric`
        log provides insights into device health, network connectivity, and
        payment processing performance.


        Use this endpoint to retrieve a device's `Device Metric` logs.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Devices
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - name: connection
          in: query
          description: >
            Query logs based on the device's connection status (i.e., whether
            the device has an open or closed connection).
          required: false
          schema:
            type: string
            enum:
              - CLOSED
              - OPEN
            example: OPEN
        - name: connectivity_network_type
          in: query
          description: >-
            Query based on the type of network connection (e.g., Wi-Fi,
            cellular, ethernet).
          required: false
          schema:
            type: string
            enum:
              - CELLULAR
              - ETHERNET
              - WIFI
            example: WIFI
        - name: connectivity_signal_strength
          in: query
          description: Query based on the network connection strength.
          required: false
          schema:
            type: string
            enum:
              - EXCELLENT
              - GOOD
              - POOR
              - VERY_POOR
            example: POOR
        - name: device_id
          in: path
          description: The device whose logs you wish to view.
          schema:
            type: string
          required: true
        - name: event_type
          in: query
          description: >-
            Query based on the type of event that triggered the generation of
            the `Device Metric`.
          required: false
          schema:
            type: string
            enum:
              - APP_BACKGROUNDED
              - APP_OPENED
              - CHARGE_STATUS
              - SCHEDULED_INTERVAL
              - SERVER_CONNECTED
              - USER_INITIATED
            example: SCHEDULED_INTERVAL
        - $ref: '#/components/parameters/limit'
        - name: payment_app_state
          in: query
          description: >-
            Query based on whether the payment application was running in the
            background or foreground on the device.
          required: false
          schema:
            type: string
            example: BACKGROUND
            enum:
              - BACKGROUND
              - FOREGROUND
        - name: payment_app_version
          in: query
          description: Query based on the exact version of the payment application.
          required: false
          schema:
            type: string
            example: 3.2.1
        - name: payment_app_version.gte
          in: query
          description: >
            Query *greater than* or *equal to* the specified payment app
            version.
          required: false
          schema:
            type: string
            example: 3.2.1
        - name: payment_app_version.lte
          in: query
          description: Query *less than* or *equal to* the specified payment app version.
          required: false
          schema:
            type: string
            example: 3.2.1
        - name: power_battery_level_percent
          in: query
          description: |
            Query the device's battery level percentage.
          required: false
          schema:
            type: integer
            example: '75'
        - name: power_battery_level_percent.gte
          in: query
          description: >
            Query *greater than* or *equal to* the specified battery level
            percentage.
          required: false
          schema:
            type: integer
            example: '75'
        - name: power_battery_level_percent.lte
          in: query
          description: >
            Query *less than* or *equal to* the specified battery level
            percentage.
          required: false
          schema:
            type: integer
            example: '75'
        - name: power_battery_temperature_celsius
          in: query
          description: |
            Query based on the device's battery temperature in Celsius.
          required: false
          schema:
            type: number
            format: double
            example: '32.5'
        - name: power_battery_temperature_celsius.gte
          in: query
          description: >
            Query *greater than* or *equal to* the specified battery temperature
            in Celsius.
          required: false
          schema:
            type: number
            format: double
            example: '32.5'
        - name: power_battery_temperature_celsius.lte
          in: query
          description: >
            Query *less than* or *equal to* the specified battery temperature in
            Celsius.
          required: false
          schema:
            type: number
            format: double
            example: '32.5'
        - name: power_battery_temperature_fahrenheit
          in: query
          description: |
            Query based on the device's battery temperature in Fahrenheit.
          required: false
          schema:
            type: number
            format: double
            example: '32.5'
        - name: power_battery_temperature_fahrenheit.gte
          in: query
          description: >
            Query *greater than* or *equal to* the specified battery temperature
            in Fahrenheit.
          required: false
          schema:
            type: number
            format: double
            example: '32.5'
        - name: power_battery_temperature_fahrenheit.lte
          in: query
          description: >
            Query *less than* or *equal to* the specified battery temperature in
            Fahrenheit.
          required: false
          schema:
            type: number
            format: double
            example: '32.5'
        - name: power_is_charging
          in: query
          description: Query whether the device was charging or not charging.
          required: false
          schema:
            type: boolean
            example: 'true'
        - name: system_android_version
          in: query
          description: >
            Query based on the Android operating system version installed on the
            device.
          required: false
          schema:
            type: string
            example: '12'
        - name: system_android_version.gte
          in: query
          description: >
            Query *greater than* or *equal to* the specified Android operating
            system version.
          required: false
          schema:
            type: string
            example: '12'
        - name: system_android_version.lte
          in: query
          description: >
            Query *less than* or *equal to* the specified Android operating
            system version.
          required: false
          schema:
            type: string
            example: '12'
        - name: system_firmware_version
          in: query
          description: |
            Query based on the firmware version.
          required: false
          schema:
            type: string
            example: 2.1.0
        - name: system_firmware_version.gte
          in: query
          description: |
            Query *greater than* or *equal to* the specified firmware version.
          required: false
          schema:
            type: string
            example: 2.1.0
        - name: system_firmware_version.lte
          in: query
          description: |
            Query *less than* or *equal to* the specified firmware version.
          required: false
          schema:
            type: string
            example: 2.1.0
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/devices/DVhXqP9onzhA7sxheKXoBc3J/device_metrics"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listDevices'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '422':
          $ref: '#/components/responses/422InvalidField'
      x-java-method-name: list
      keywords:
        includes:
          - device metrics
          - device health
          - device logs
          - terminal monitoring
          - network connectivity
          - battery level
          - battery temperature
          - charging status
          - signal strength
          - wifi
          - cellular
          - ethernet
          - firmware version
          - android version
          - payment app version
          - connection status
          - device diagnostics
    parameters:
      - name: device_id
        in: path
        description: The device whose logs you wish to view.
        schema:
          type: string
        required: true
  /disbursement_rules:
    get:
      summary: List Disbursement Rules
      operationId: listDisbursementRules
      description: >
        Retrieve a list of `Disbursement Rule` resources linked to an
        `Application` / `Platform`. Currently, there is only one `Disbursement
        Rule` object per application / platform.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/overview/#section/Query-Parameters).
      tags:
        - Disbursement Rules
      parameters:
        - name: linked_to
          in: query
          description: >
            The ID of the `Application` or `Platform` that the `Disbursement
            Rule` belongs to.
          schema:
            type: string
          required: true
          example: APc9vhYcPsRuTSpKD9KpMtPe
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/disbursement_rules" \
            -H "Content-Type: application/json" \
            -H "Finix-Version: 2022-02-01" \
            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listDisbursementRules'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: list
  /disbursement_rules/current_usages:
    get:
      summary: List Current Usages
      operationId: listCurrentUsages
      description: |
        Retrieve the current usage for disbursements.
      tags:
        - Disbursement Rules
      parameters:
        - name: linked_to
          in: query
          description: >
            The ID of the `Application` or `Platform` that the `Disbursement
            Rule` belongs to.
          schema:
            type: string
          required: true
          example: APc9vhYcPsRuTSpKD9KpMtPe
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/disbursement_rules/current_usages?linked_to=APc9vhYcPsRuTSpKD9KpMtPe"
            \

            -H "Content-Type: application/json" \

            -H "Finix-Version: 2022-02-01" \

            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listCurrentUsages'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: list
  /disputes:
    get:
      tags:
        - Disputes
      description: >-
        Retrieve a list of `Disputes`. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      summary: List Disputes
      operationId: listDisputes
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
        - $ref: '#/components/parameters/application_id'
        - schema:
            type: string
          in: query
          name: transfer_id
          description: >-
            Filter by the ID of the `Transfer` that's being disputed.
            <br><br>**Note**: If included, all other filter parameters are
            ignored.
        - schema:
            type: string
          in: query
          name: adjustment_transfer_id
          description: >-
            Filter by the ID of the adjustment `Transfer`. <br><br>**Note**: If
            included, all other filter parameters are ignored.
        - $ref: '#/components/parameters/QueryAmountFilter'
        - $ref: '#/components/parameters/QueryAmountGteFilter'
        - $ref: '#/components/parameters/QueryAmountGtFilter'
        - $ref: '#/components/parameters/QueryAmountLtFilter'
        - schema:
            type: string
          in: query
          name: state
          description: Filter by the state of the `Dispute`.
        - schema:
            type: string
          in: query
          name: response_state
          description: Filter by the `response_state` of the `Dispute`.
        - schema:
            type: string
          in: query
          name: respond_by.lte
          description: Filter where `respond_by` is before the given date.
        - schema:
            type: string
          in: query
          name: respond_by.gte
          description: Filter where `respond_by` is after the given date.
        - schema:
            type: string
          in: query
          name: instrument_bin
          description: >-
            Filter by the Bank Identification Number (BIN). The BIN is the first
            6 digits of the masked account number.
        - schema:
            type: string
          in: query
          name: instrument_brand_type
          description: Filter by the card brand used.
        - in: query
          name: merchant_identity_id
          description: Filter by the ID of the `Identity` used by the `Merchant`.
          schema:
            type: string
        - schema:
            type: string
          in: query
          name: merchant_identity_name
          description: Filter by the name used by the `Merchant`.
        - schema:
            type: string
          in: query
          name: merchant_identity_name.like
          description: >-
            Filter by the name used by the `Merchant`. Use this when searching
            with only partial name values.
        - schema:
            type: string
          in: query
          name: instrument_name
          description: Filter by the name of the `Payment Instrument`.
        - schema:
            type: string
          in: query
          name: instrument_type
          description: Filter by `Payment Instrument` type.
        - schema:
            type: string
          in: query
          name: merchant_id
          description: Filter by the ID of the `Merchant`.
        - schema:
            type: string
          in: query
          name: merchant_mid
          description: Filter by the MID of the `Merchant`.
        - schema:
            type: string
          in: query
          name: instrument_card_last4
          description: Filter by the last 4 digits of the card used.
        - schema:
            type: string
          in: query
          name: instrument_card_type
          description: Filter by the card type.
        - schema:
            type: string
          in: query
          name: instrument_fingerprint
          description: Filter by the fingerprint of the `Payment Instrument`.
        - schema:
            type: string
          in: query
          name: before_cursor
          description: Returns every `Dispute` created before the cursor value.
        - $ref: '#/components/parameters/TagsKey'
        - $ref: '#/components/parameters/TagsValue'
      responses:
        '200':
          $ref: '#/components/responses/DisputesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/disputes/" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
  /disputes/{dispute_id}:
    get:
      tags:
        - Disputes
      description: Retrieve the details of a previously created `Dispute`.
      summary: Fetch a Dispute
      operationId: getDispute
      responses:
        '200':
          $ref: '#/components/responses/Dispute'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: get
    parameters:
      - description: ID of `Dispute`.
        required: true
        in: path
        name: dispute_id
        schema:
          type: string
          example: FEvjF5iPwy6zuUEsBWgJ9T79
    put:
      summary: Update a Dispute
      operationId: updateDispute
      responses:
        '200':
          $ref: '#/components/responses/Dispute'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: Update `tags` on `Disputes`.
      requestBody:
        $ref: '#/components/requestBodies/UpdateDisputeEvidence'
      x-java-method: put
      tags:
        - Disputes
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
  /disputes/{dispute_id}/evidence:
    post:
      tags:
        - Disputes
      description: >-
        Upload a file as evidence for a `Dispute`.


        - You can upload up to 8 files; the total size of the uploaded files
        combined cannot exceed 10 MB.

        - The allowed file formats include JPEG, PDF, PNG.

        - Individual JPEG, PDF, PNG files can't exceed 1 MB.

        - PNG files will be automatically converted and returned as JPEG files. 
      summary: Upload Files as Dispute Evidence
      operationId: createDisputeEvidence
      responses:
        '201':
          $ref: '#/components/responses/DisputeEvidence'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl -X POST
            'https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence'
            \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -H "Content-Type: multipart/form-data" \
                -H "Finix-Version: 2022-02-01" \
                -F "file=@evidence.jpeg"
      requestBody:
        $ref: '#/components/requestBodies/CreateDisputeEvidenceRequest'
    get:
      tags:
        - Disputes
      description: >-
        Retrieve a list of dispute evidence for a `Dispute`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)      
      summary: List Dispute Evidence
      operationId: listDisputeEvidence
      responses:
        '200':
          $ref: '#/components/responses/DisputeEvidenceList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: listDisputeEvidenceByDisputeId
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    parameters:
      - description: ID of `Dispute` to mange evidence for.
        required: true
        in: path
        name: dispute_id
        schema:
          type: string
  /disputes/{dispute_id}/evidence/{evidence_id}:
    get:
      tags:
        - Disputes
      description: >-
        Fetch evidence uploaded for a `Dispute`. 


        If you don't have the Finix Dashboard available, you can fetch the
        evidence to review the `state` of the upload to confirm the evidence got
        sent to the processor.
      summary: Fetch Dispute Evidence
      operationId: getDisputeEvidence
      responses:
        '200':
          $ref: '#/components/responses/DisputeEvidence'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence/DFet8gXGsH4kXmDWdLhHoKco"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    parameters:
      - description: ID of `Dispute` to fetch evidence for.
        required: true
        in: path
        name: dispute_id
        schema:
          type: string
      - description: ID of `evidence` to fetch.
        required: true
        in: path
        name: evidence_id
        schema:
          type: string
    put:
      summary: Update Dispute Evidence
      operationId: updateDisputeEvidence
      responses:
        '200':
          $ref: '#/components/responses/DisputeEvidence'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: Update tags on `Dispute` evidence.
      requestBody:
        $ref: '#/components/requestBodies/UpdateDisputeEvidence'
      x-java-method: put
      tags:
        - Disputes
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
    delete:
      summary: Delete Dispute Evidence
      operationId: deleteDisputeEvidence
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: >-
        Delete a `Dispute` evidence file. Evidence files can only be deleted
        before a dispute and it's uploaded evidence has been submitted for the
        first time. Evidence files can only be deleted on `FINIX_V1` or
        `DUMMY_V1`.
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl -X DELETE
            'https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco'
            \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -H "Finix-Version: 2022-02-01" 
      tags:
        - Disputes
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
  /fee_profiles:
    post:
      summary: Create a Fee Profile
      operationId: createFeeProfile
      description: Create a `Fee Profile`.
      x-keywords:
        excludes:
          - EFT
      tags:
        - Fee Profiles
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createFeeProfile'
            examples:
              Minimal Fields:
                value:
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 30
                  fixed_fee: 30
              All Fields:
                value:
                  ach_basis_points_fee_limit: 50
                  ach_basis_points: 30
                  ach_credit_return_fixed_fee: 25
                  ach_debit_return_fixed_fee: 30
                  ach_fixed_fee: 40
                  ach_notice_of_change_credit_fixed_fee: 12
                  ach_notice_of_change_debit_fixed_fee: 25
                  american_express_assessment_basis_points: 20
                  american_express_basis_points: 10
                  american_express_charge_dues_assessments: 12
                  american_express_charge_interchange: true
                  american_express_externally_funded_basis_points: 50
                  american_express_externally_funded_fixed_fee: 25
                  american_express_fixed_fee: 15
                  ancillary_fixed_fee_primary: 32
                  ancillary_fixed_fee_secondary: 80
                  basis_points: 20
                  card_cross_border_basis_points: 15
                  card_cross_border_fixed_fee: 30
                  charge_dues_assessments: true
                  charge_interchange: false
                  compliance_forms_overdue_fixed_fee: 20
                  diners_club_basis_points: 90
                  diners_club_charge_interchange: 180
                  diners_club_fixed_fee: 25
                  discover_assessments_basis_points: 50
                  discover_basis_points: 12
                  discover_charge_dues_assessments: 10
                  discover_charge_interchange: 25
                  discover_data_usage_fixed_fee: 15
                  discover_externally_funded_basis_points: 60
                  discover_externally_funded_fixed_fee: 20
                  discover_fixed_fee: 35
                  discover_network_authorization_fixed_fee: 30
                  dispute_fixed_fee: 1500
                  dispute_inquiry_fixed_fee: 1500
                  eft_basis_points_fee_limit: 20
                  eft_basis_points: 25
                  eft_credit_return_fixed_fee: 35
                  eft_debit_return_fixed_fee: 30
                  eft_fixed_fee: 15
                  externally_funded_basis_points: 15
                  externally_funded_fixed_fee: 20
                  fixed_fee: 20
                  gross_monthly_fees_ach_basis_points: 15
                  gross_monthly_fees_ach_fixed_fee: 15
                  gross_monthly_fees_card_basis_points: 15
                  gross_monthly_fees_card_fixed_fee: 15
                  gross_monthly_fees_eft_basis_points: 15
                  gross_monthly_fees_eft_fixed_fee: 15
                  interac_basis_points: 20
                  interac_fixed_fee: 25
                  jcb_basis_points: 11
                  jcb_charge_interchange: 20
                  jcb_fixed_fee: 20
                  mastercard_acquirer_fees_basis_points: 20
                  mastercard_assessments_over1k_basis_points: 20
                  mastercard_assessments_under1k_basis_points: 25
                  mastercard_basis_points: 30
                  mastercard_charge_dues_assessments: 15
                  mastercard_charge_interchange: 22
                  mastercard_fixed_fee: 18
                  settlement_funding_transfer_ach_basis_points_fee_limit: 15
                  settlement_funding_transfer_ach_basis_points: 10
                  settlement_funding_transfer_ach_card_basis_points_fee_limit: 50
                  settlement_funding_transfer_ach_card_basis_points: 30
                  settlement_funding_transfer_ach_card_fixed_fee: 25
                  settlement_funding_transfer_ach_credit_return_fixed_fee: 10
                  settlement_funding_transfer_ach_debit_return_fixed_fee: 12
                  settlement_funding_transfer_ach_fixed_fee: 10
                  settlement_funding_transfer_eft_basis_points_fee_limit: 40
                  settlement_funding_transfer_eft_basis_points: 20
                  settlement_funding_transfer_eft_credit_return_fixed_fee: 20
                  settlement_funding_transfer_eft_debit_return_fixed_fee: 18
                  settlement_funding_transfer_eft_fixed_fee: 15
                  settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: 70
                  settlement_funding_transfer_instant_payout_card_basis_points: 30
                  settlement_funding_transfer_instant_payout_card_fixed_fee: 45
                  settlement_funding_transfer_noc_credit_fixed_fee: 50
                  settlement_funding_transfer_noc_debit_fixed_fee: 55
                  settlement_funding_transfer_same_day_ach_basis_points_fee_limit: 50
                  settlement_funding_transfer_same_day_ach_basis_points: 20
                  settlement_funding_transfer_same_day_ach_fixed_fee: 35
                  subscription_ach_basis_points: 12
                  subscription_ach_basis_points_fee_limit: 12
                  subscription_ach_fixed_fee: 12
                  subscription_card_basis_points: 12
                  subscription_card_fixed_fee: 12
                  subscription_eft_basis_points: 12
                  subscription_eft_basis_points_fee_limit: 12
                  subscription_eft_fixed_fee: 12
                  visa_acquirer_processing_fixed_fee: 80
                  visa_assessments_basis_points: 40
                  visa_base_II_credit_voucher_fixed_fee: 50
                  visa_base_II_system_file_transmission_fixed_fee: 100
                  visa_basis_points: 10
                  visa_charge_dues_assessments: 50
                  visa_charge_interchange: 30
                  visa_credit_voucher_fixed_fee: 40
                  visa_fixed_fee: 20
                  visa_kilobyte_access_fixed_fee: 25
              Card Fees:
                value:
                  basis_points: 30
                  fixed_fee: 30
                  charge_interchange: true
                  card_cross_border_basis_points: 15
                  card_cross_border_fixed_fee: 30
                  ancillary_fixed_fee_primary: 32
                  ancillary_fixed_fee_secondary: 80
              ACH Fees:
                value:
                  ach_basis_points: 20
                  ach_basis_points_fee_limit: 50
                  ach_credit_return_fixed_fee: 25
                  ach_debit_return_fixed_fee: 30
                  ach_fixed_fee: 30
                  ach_notice_of_change_credit_fixed_fee: 12
                  ach_notice_of_change_debit_fixed_fee: 25
                  basis_points: 80
                  fixed_fee: 3
              Card Brand-Specific Fees - American Express:
                value:
                  american_express_assessment_basis_points: 20
                  american_express_basis_points: 10
                  american_express_charge_dues_assessments: 12
                  american_express_charge_interchange: true
                  american_express_externally_funded_basis_points: 50
                  american_express_externally_funded_fixed_fee: 25
                  american_express_fixed_fee: 15
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Card Brand-Specific Fees - Diner's Club:
                value:
                  diners_club_basis_points: 90
                  diners_club_charge_interchange: 180
                  diners_club_fixed_fee: 25
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Card Brand-Specific Fees - Discover:
                value:
                  discover_assessments_basis_points: 50
                  discover_basis_points: 12
                  discover_charge_dues_assessments: 10
                  discover_charge_interchange: 25
                  discover_data_usage_fixed_fee: 15
                  discover_fixed_fee: 35
                  discover_network_authorization_fixed_fee: 30
                  discover_externally_funded_basis_points: 60
                  discover_externally_funded_fixed_fee: 20
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Card Brand-Specific Fees - Interac:
                value:
                  interac_basis_points: 20
                  interac_fixed_fee: 25
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Card Brand-Specific Fees - JCB:
                value:
                  jcb_basis_points: 11
                  jcb_charge_interchange: 20
                  jcb_fixed_fee: 20
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Card Brand-Specific Fees - Mastercard:
                value:
                  mastercard_acquirer_fees_basis_points: 20
                  mastercard_assessments_over1k_basis_points: 20
                  mastercard_assessments_under1k_basis_points: 25
                  mastercard_basis_points: 30
                  mastercard_charge_dues_assessments: 15
                  mastercard_charge_interchange: 22
                  mastercard_fixed_fee: 18
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Card Brand-Specific Fees - Visa:
                value:
                  visa_acquirer_processing_fixed_fee: 80
                  visa_assessments_basis_points: 40
                  visa_base_II_credit_voucher_fixed_fee: 50
                  visa_base_II_system_file_transmission_fixed_fee: 100
                  visa_basis_points: 10
                  visa_charge_dues_assessments: 50
                  visa_charge_interchange: 30
                  visa_credit_voucher_fixed_fee: 40
                  visa_fixed_fee: 20
                  visa_kilobyte_access_fixed_fee: 25
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Compliance Form Overdue Fee:
                value:
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 30
                  compliance_forms_overdue_fixed_fee: 20
                  fixed_fee: 30
              Dispute Fees:
                value:
                  dispute_fixed_fee: 1500
                  dispute_inquiry_fixed_fee: 1500
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Dues Assessments:
                value:
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 30
                  charge_dues_assessments: true
                  fixed_fee: 30
              EFT Fees:
                value:
                  eft_basis_points_fee_limit: 20
                  eft_basis_points: 25
                  eft_credit_return_fixed_fee: 35
                  eft_debit_return_fixed_fee: 30
                  eft_fixed_fee: 15
                  externally_funded_basis_points: 15
                  externally_funded_fixed_fee: 20
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Gross Monthly Fees:
                value:
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 30
                  fixed_fee: 30
                  gross_monthly_fees_ach_basis_points: 15
                  gross_monthly_fees_ach_fixed_fee: 15
                  gross_monthly_fees_card_basis_points: 15
                  gross_monthly_fees_card_fixed_fee: 15
                  gross_monthly_fees_eft_basis_points: 15
                  gross_monthly_fees_eft_fixed_fee: 15
              Settlement Funding Transfer Fees - ACH:
                value:
                  settlement_funding_transfer_ach_basis_points: 10
                  settlement_funding_transfer_ach_basis_points_fee_limit: 15
                  settlement_funding_transfer_ach_credit_return_fixed_fee: 10
                  settlement_funding_transfer_ach_debit_return_fixed_fee: 12
                  settlement_funding_transfer_ach_fixed_fee: 10
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Settlement Funding Transfer Fees - EFT:
                value:
                  settlement_funding_transfer_eft_basis_points_fee_limit: 40
                  settlement_funding_transfer_eft_basis_points: 20
                  settlement_funding_transfer_eft_credit_return_fixed_fee: 20
                  settlement_funding_transfer_eft_debit_return_fixed_fee: 18
                  settlement_funding_transfer_eft_fixed_fee: 15
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Settlement Funding Transfer Fees - Instant Payout Cards:
                value:
                  settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: 70
                  settlement_funding_transfer_instant_payout_card_basis_points: 30
                  settlement_funding_transfer_instant_payout_card_fixed_fee: 45
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Settlement Funding Transfer Fees - NOC:
                value:
                  settlement_funding_transfer_noc_credit_fixed_fee: 50
                  settlement_funding_transfer_noc_debit_fixed_fee: 55
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Settlement Funding Transfer Fees - Same-Day ACH Fees:
                value:
                  settlement_funding_transfer_same_day_ach_basis_points: 20
                  settlement_funding_transfer_same_day_ach_basis_points_fee_limit: 50
                  settlement_funding_transfer_same_day_ach_fixed_fee: 35
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
              Subscription Fees:
                value:
                  ach_basis_points: 20
                  ach_fixed_fee: 30
                  basis_points: 80
                  fixed_fee: 3
                  subscription_ach_basis_points: 12
                  subscription_ach_basis_points_fee_limit: 12
                  subscription_ach_fixed_fee: 12
                  subscription_card_basis_points: 12
                  subscription_card_fixed_fee: 12
                  subscription_eft_basis_points: 12
                  subscription_eft_basis_points_fee_limit: 12
                  subscription_eft_fixed_fee: 12
      responses:
        '201':
          $ref: '#/components/responses/createFeeProfile'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
      keywords:
        includes:
          - create a fee profile
          - create a fee profiles
          - create a merchant fee profile
          - create fee profile
          - create fee profiles
          - create merchant fee profile
          - fee profile
    get:
      summary: List Fee Profiles
      operationId: listFeeProfiles
      description: Retrieve a list of Fee Profile resources.
      x-keywords:
        excludes:
          - EFT
      tags:
        - Fee Profiles
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/fee_profiles" \
            -H "Content-Type: application/json" \
            -H "Finix-Version: 2022-02-01" \
            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listFeeProfiles'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /fee_profiles/{fee_profile_id}:
    get:
      summary: Fetch a Fee Profile
      operationId: getFeeProfile
      description: Retrieve the details of an existing `Fee Profile`.
      x-keywords:
        excludes:
          - EFT
      tags:
        - Fee Profiles
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          description: A single `Fee Profile`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fee_profile'
              examples:
                Fee Profile:
                  value:
                    $ref: >-
                      ../../examples/fee_profiles/responses/createFeeProfileAllFields.yaml
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
      x-group-parameters: true
    parameters:
      - description: The `Fee Profile` ID.
        in: path
        name: fee_profile_id
        required: true
        schema:
          type: string
  /fees:
    get:
      tags:
        - Fees
      description: >-
        Retrieve a list of `Fee` resources. As a query parameter, pass the ID of
        the [`Transfer`](/#Transfers) or [`Authorization`](#Authorizations) that
        generated the `Fee`.
      summary: List Fees
      operationId: listFees
      responses:
        '200':
          $ref: '#/components/responses/FeesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-group-parameters: true
      parameters:
        - name: linked_to
          in: query
          required: false
          description: >
            The ID of the `TRANSFER` or `AUTHORIZATION` that generated the
            `Fee`.
          schema:
            type: string
          example: TRrB2VG7H84LmRgSTkfR2Cb6
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
      x-java-method-name: list
    post:
      summary: Create a Fee
      tags:
        - Fees
      operationId: createFee
      responses:
        '201':
          $ref: '#/components/responses/Fee'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: Create a custom (i.e. one-time) `Fee`.
      requestBody:
        $ref: '#/components/requestBodies/CreateFeeRequest'
      x-java-method-name: create
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).
  /fees/{fee_id}:
    get:
      tags:
        - Fees
      description: Retrieve the details of a `Fee`.
      summary: Fetch a Fee
      operationId: getFee
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/Fee'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    parameters:
      - schema:
          type: string
        name: fee_id
        description: The ID of the `Fee`.
        in: path
        required: true
        example: FEnCRGg2nSUXY96wd99Hy31R
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).
    put:
      summary: Update Fee
      operationId: updateFee
      responses:
        '200':
          $ref: '#/components/responses/Fee'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      requestBody:
        $ref: '#/components/requestBodies/UpdateFeeRequest'
      description: Update the details of a `fee`.
      tags:
        - Fees
      x-java-method-name: update
  /identities:
    post:
      summary: Create an Identity
      operationId: createIdentity
      description: >
        Create an `Identity` for your Buyer, Recipient, or Seller, using
        `identity_roles` and `type` to indicate the type of Identity you're
        creating.


        Related Guides: [Getting Started](/guides/getting-started/),
        [Onboarding](/guides/platform-payments/onboarding-sellers/)
      tags:
        - Identities
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/createIdentitySellerUSA'
                - $ref: '#/components/schemas/createIdentitySellerCAN'
                - $ref: '#/components/schemas/createIdentityRecipientBusiness'
                - $ref: '#/components/schemas/createIdentityRecipientPersonal'
                - $ref: '#/components/schemas/createIdentityBuyer'
                - $ref: '#/components/schemas/createIdentityBuyerBlank'
                - $ref: '#/components/schemas/createUserRoleMerchant'
            examples:
              Seller (USA):
                value:
                  additional_underwriting_data:
                    annual_ach_volume: 200000
                    average_ach_transfer_amount: 200000
                    average_card_transfer_amount: 200000
                    business_description: SB3 vegan cafe
                    card_volume_distribution:
                      card_present_percentage: 30
                      mail_order_telephone_order_percentage: 10
                      ecommerce_percentage: 60
                    credit_check_allowed: true
                    credit_check_ip_address: 42.1.1.112
                    credit_check_timestamp: '2021-04-28T16:42:55Z'
                    credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
                    merchant_agreement_accepted: true
                    merchant_agreement_ip_address: 42.1.1.113
                    merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
                    merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)
                    refund_policy: MERCHANDISE_EXCHANGE_ONLY
                    volume_distribution_by_business_type:
                      other_volume_percentage: 0
                      consumer_to_consumer_volume_percentage: 0
                      business_to_consumer_volume_percentage: 0
                      business_to_business_volume_percentage: 100
                      person_to_person_volume_percentage: 0
                  entity:
                    annual_card_volume: 12000000
                    business_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 8
                      line1: 741 Douglass St
                      postal_code: '94114'
                    business_name: Finix Flowers
                    business_phone: +1 (408) 756-4497
                    business_tax_id: '123456789'
                    business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
                    default_statement_descriptor: Finix Flowers
                    dob:
                      year: 1978
                      day: 27
                      month: 6
                    doing_business_as: Finix Flowers
                    email: user@example.org
                    first_name: John
                    has_accepted_credit_cards_previously: true
                    incorporation_date:
                      year: 1978
                      day: 27
                      month: 6
                    last_name: Smith
                    max_transaction_amount: 1000000
                    ach_max_transaction_amount: 1000000
                    mcc: '4900'
                    ownership_type: PRIVATE
                    personal_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 7
                      line1: 741 Douglass St
                      postal_code: '94114'
                    phone: '14158885080'
                    principal_percentage_ownership: 50
                    tax_id: '123456789'
                    title: CEO
                    url: https://www.finix.com
                  identity_roles:
                    - SELLER
                  tags:
                    Studio Rating: '4.7'
                  type: BUSINESS
              Seller (CAN):
                value:
                  additional_underwriting_data:
                    annual_ach_volume: 200000
                    average_ach_transfer_amount: 200000
                    average_card_transfer_amount: 200000
                    business_description: Business offering video editing services.
                    card_volume_distribution:
                      card_present_percentage: 30
                      mail_order_telephone_order_percentage: 10
                      ecommerce_percentage: 60
                    credit_check_allowed: true
                    credit_check_ip_address: 42.1.1.112
                    credit_check_timestamp: '2021-04-28T16:42:55Z'
                    credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
                    merchant_agreement_accepted: true
                    merchant_agreement_ip_address: 42.1.1.113
                    merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
                    merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)
                    refund_policy: MERCHANDISE_EXCHANGE_ONLY
                    volume_distribution_by_business_type:
                      other_volume_percentage: 0
                      consumer_to_consumer_volume_percentage: 0
                      business_to_consumer_volume_percentage: 0
                      business_to_business_volume_percentage: 100
                      person_to_person_volume_percentage: 0
                  entity:
                    annual_card_volume: 12000000
                    business_address:
                      city: Vancouver
                      country: CAN
                      region: BC
                      line2: null
                      line1: 456 Elm Avenue
                      postal_code: V6B 2L2
                    business_name: Video Editing Services
                    business_phone: +1 (416) 555-7890
                    business_tax_id: '123456789'
                    business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
                    default_statement_descriptor: Video Services
                    dob:
                      year: 1978
                      day: 27
                      month: 6
                    doing_business_as: Video Editing Services
                    email: info@video-editing-services.com
                    first_name: Jerry
                    has_accepted_credit_cards_previously: true
                    incorporation_date:
                      year: 1978
                      day: 27
                      month: 6
                    last_name: Dunhill
                    max_transaction_amount: 1000000
                    ach_max_transaction_amount: 1000000
                    mcc: '4900'
                    ownership_type: PRIVATE
                    personal_address:
                      city: Vancouver
                      country: CAN
                      region: BC
                      line2: null
                      line1: 987 Milo Street
                      postal_code: V5K 1Z5
                    phone: '14158885080'
                    principal_percentage_ownership: 50
                    tax_id: '123456789'
                    title: CEO
                    url: https://www.video-editing-services.com
                  identity_roles:
                    - SELLER
                  tags:
                    Studio Rating: '4.7'
                  type: BUSINESS
              Recipient (Business):
                value:
                  entity:
                    business_address:
                      line1: 7890 Oak Drive
                      line2: Suite 101
                      city: Smalltown
                      region: TX
                      postal_code: '75432'
                      country: USA
                    business_name: Blue Horizon Technologies
                    doing_business_as: B.H. Technologies
                    first_name: John
                    last_name: Jeremy
                    personal_address:
                      line1: 741 Douglass St
                      line2: Apartment 7
                      city: San Mateo
                      region: CA
                      country: USA
                      postal_code: '94114'
                  identity_roles:
                    - RECIPIENT
                  type: BUSINESS
              Recipient (Personal):
                value:
                  entity:
                    first_name: Michael
                    last_name: Johnson
                    personal_address:
                      line1: 789 Oak Drive
                      line2: null
                      city: Springfield
                      region: IL
                      country: USA
                      postal_code: '62704'
                  identity_roles:
                    - RECIPIENT
                  type: PERSONAL
              Buyer:
                value:
                  entity:
                    phone: '7145677613'
                    first_name: John
                    last_name: Smith
                    email: finix_example@finix.com
                    personal_address:
                      city: San Mateo
                      country: USA
                      region: CA
                      line2: Apartment 7
                      line1: 741 Douglass St
                      postal_code: '94114'
                  identity_roles:
                    - BUYER
                  tags:
                    key: value
                  type: PERSONAL
              Buyer - Blank:
                value:
                  entity: {}
              User - ROLE_MERCHANT:
                value: {}
      responses:
        '201':
          $ref: '#/components/responses/createIdentity'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
    get:
      summary: List Identities
      operationId: listIdentities
      description: >
        Retrieve a list the previously created `Identities`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Identities
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - name: business_name
          in: query
          required: false
          schema:
            type: string
            example: Finix%20Flowers
          description: >-
            Filter by the full business name. Partial business names are not
            supported.
        - name: business_type
          in: query
          required: false
          schema:
            type: string
            example: INDIVIDUAL_SOLE_PROPRIETORSHIP
            enum:
              - INDIVIDUAL_SOLE_PROPRIETORSHIP
              - CORPORATION
              - LIMITED_LIABILITY_COMPANY
              - PARTNERSHIP
              - LIMITED_PARTNERSHIP
              - GENERAL_PARTNERSHIP
              - ASSOCIATION_ESTATE_TRUST
              - TAX_EXEMPT_ORGANIZATION
              - INTERNATIONAL_ORGANIZATION
              - GOVERNMENT_AGENCY
              - JOINT_VENTURE
          description: >-
            Filter by the business type. Partial business types are not
            supported.
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - description: Filter by the `default_statement_descriptor`.
          in: query
          name: default_statement_descriptor
          schema:
            type: string
            example: Finix%20Flowers
        - name: email
          in: query
          required: false
          schema:
            type: string
            example: user@example.org
          description: >-
            Filter by the email address or email domain. Partial emails are not
            supported.
        - name: first_name
          in: query
          required: false
          schema:
            type: string
            example: John
          description: Filter by the first name of the person associated to the `Identity`.
        - $ref: '#/components/parameters/id'
        - name: last_name
          in: query
          required: false
          schema:
            type: string
            example: Smith
          description: Filter by the last name of the person associated to the `Identity`.
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - name: title
          in: query
          required: false
          schema:
            type: string
            example: ceo
          description: Filter by the title if available.
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/identities" \
              -H "Content-Type: application/json" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listIdentities'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /identities/{identity_id}:
    get:
      summary: Fetch an Identity
      operationId: getIdentity
      description: Retrieve the details of a previously created `Identity`.
      tags:
        - Identities
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          $ref: '#/components/responses/createIdentity'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
    parameters:
      - description: The `Identity` ID.
        in: path
        name: identity_id
        required: true
        schema:
          type: string
    put:
      summary: Update an Identity
      operationId: updateIdentity
      description: >
        Update an existing `Identity`.


        If you are updating the `Identity` of a `Merchant` that’s already been
        onboarded, you need to [verify the merchant
        again](#operation/createMerchantVerification).
      tags:
        - Identities
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateIdentity'
            examples:
              Update an Identity:
                value:
                  entity:
                    email: user@example.org
                    first_name: John
                    last_name: Smith
                    phone: '7145677613'
      responses:
        '200':
          $ref: '#/components/responses/createIdentity'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: update
  /identities/{identity_id}/associated_identities:
    post:
      summary: Create an Associated Identity
      operationId: createAssociatedIdentity
      description: >
        Create an associated `Identity` for [every owner with 25% or more
        ownership](/guides/platform-payments/onboarding-sellers/seller-onboarding-via-api#step-3-add-associated-identities)
        over the merchant.
      tags:
        - Identities
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createAssociatedIdentity'
            examples:
              Associated Identity:
                value:
                  entity:
                    first_name: John
                    last_name: Smith
                    title: Founder
                    dob:
                      month: 1
                      day: 1
                      year: 2013
                    principal_percentage_ownership: 25
                    phone: '14158885080'
                    personal_address:
                      city: San Francisco
                      region: CA
                      postal_code: '90650'
                      line1: 123 Main Street
                      country: USA
                    email: john.smith@company1.com
                    tax_id: '123456789'
      responses:
        '201':
          description: Associated `Identity` successfully created.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/associatedIdentityBuyer'
                  - $ref: '#/components/schemas/associatedIdentitySeller'
              examples:
                Associated Identity:
                  value:
                    id: IDiLhNvSHfxkR4xvENPVqW1g
                    created_at: '2024-08-09T08:34:22.30Z'
                    updated_at: '2024-08-09T08:34:22.30Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    entity:
                      ach_max_transaction_amount: 0
                      amex_mid: null
                      annual_card_volume: 0
                      business_address: null
                      business_name: null
                      business_phone: null
                      business_tax_id_provided: false
                      business_type: null
                      default_statement_descriptor: null
                      discover_mid: null
                      dob:
                        day: 1
                        month: 1
                        year: 2013
                      doing_business_as: null
                      email: john.smith@company1.com
                      first_name: John
                      has_accepted_credit_cards_previously: false
                      incorporation_date: null
                      last_name: Smith
                      max_transaction_amount: 0
                      mcc: null
                      ownership_type: null
                      personal_address:
                        line1: 123 Main Street
                        line2: null
                        city: San Francisco
                        region: CA
                        postal_code: '90650'
                        country: USA
                      phone: '14158885080'
                      principal_percentage_ownership: 25
                      short_business_name: null
                      tax_authority: null
                      tax_id_provided: true
                      title: Founder
                      url: null
                    identity_roles:
                      - BENEFICIAL_OWNER
                    tags: {}
                    type: PERSONAL
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDiLhNvSHfxkR4xvENPVqW1g
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDiLhNvSHfxkR4xvENPVqW1g/verifications
                      merchants:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDiLhNvSHfxkR4xvENPVqW1g/merchants
                      settlements:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDiLhNvSHfxkR4xvENPVqW1g/settlements
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDiLhNvSHfxkR4xvENPVqW1g/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDiLhNvSHfxkR4xvENPVqW1g/transfers
                      payment_instruments:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDiLhNvSHfxkR4xvENPVqW1g/payment_instruments
                      associated_identities:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDiLhNvSHfxkR4xvENPVqW1g/associated_identities
                      disputes:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDiLhNvSHfxkR4xvENPVqW1g/disputes
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: createAssociatedIdentity
      keywords:
        includes:
          - associated identity
          - associated identities
          - add associated identity
          - add associated identities
    get:
      tags:
        - Identities
      description: >-
        Retrieve a list of `Associated Identities` for an `Identity`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)      
      summary: List Associated Identities
      operationId: listIdentityAssociatedIdentities
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listIdentities'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: listAssociatedIdentities
      x-group-parameters: true
    parameters:
      - description: >-
          The `Identity` ID of the beneficial owner from which you wish to
          create the associated identity.
        in: path
        name: identity_id
        required: true
        schema:
          type: string
  /identities/{identity_id}/merchants:
    post:
      summary: Create a Merchant
      operationId: createMerchant
      description: >
        Create a `Merchant` to start the underwriting (also called provisioning)
        process for your seller. `Merchants` must be created under an
        [`Identity`](#Identities).


        A bank account must be associated with the previously created `Identity`
        before a `Merchant` can be successfully onboarded and verified.
      tags:
        - Merchants
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createMerchant'
            examples:
              Merchant - Minimal Fields:
                value:
                  processor: DUMMY_V1
                  tags:
                    key_2: value_2
              Merchant - All Fields:
                value:
                  default_partial_authorization_enabled: true
                  gateway: TRIPOS_CLOUD_V1
                  processor: DUMMY_V1
                  refunds_disabled: true
                  tags:
                    key_2: value_2
              Merchant - Card Present Enabled:
                value:
                  gateway: TRIPOS_CLOUD_V1
                  processor: DUMMY_V1
              Merchant - Default Partial Authorization Enabled:
                value:
                  default_partial_authorization_enabled: true
                  processor: DUMMY_V1
              Merchant - Loan Repayment Enabled:
                value:
                  processor: DUMMY_V1
                  loan_repayment: true
              Merchant - Refunds Disabled:
                value:
                  processor: DUMMY_V1
                  refunds_disabled: true
      responses:
        '201':
          description: Single Merchant object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/merchant'
              examples:
                Merchant - Minimal Fields:
                  value:
                    id: MUeTBamsYxqr1KSnT4U2x9SP
                    created_at: '2024-08-16T13:11:36.72Z'
                    updated_at: '2024-08-16T13:11:36.72Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: USA
                    creating_transfer_from_report_enabled: true
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    gateway: null
                    gross_settlement_enabled: false
                    identity: ID6ZC4KedcaCwECQcWr7SM4m
                    instant_payouts_card_push_enabled: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: '4900'
                    merchant_name: Finix Flowers
                    merchant_profile: MP8aC84QAtA69Qhv6BJSyvHr
                    mid: null
                    onboarding_state: PROVISIONING
                    processing_enabled: false
                    processor: DUMMY_V1
                    processor_details: {}
                    ready_to_settle_upon: RECONCILIATION
                    ready_to_settle_upon_delay_alignment: NONE
                    rent_surcharges_enabled: false
                    settlement_enabled: false
                    settlement_funding_identifier: UNSET
                    surcharges_enabled: false
                    tags:
                      key_2: value_2
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VI7jopNSiaVMXWKkhxt6dJm7
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUeTBamsYxqr1KSnT4U2x9SP
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/ID6ZC4KedcaCwECQcWr7SM4m
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUeTBamsYxqr1KSnT4U2x9SP/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MP8aC84QAtA69Qhv6BJSyvHr
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VI7jopNSiaVMXWKkhxt6dJm7
                Merchant - All Fields:
                  value:
                    id: MU5yqwnm9MhyhDXCBaahWYgf
                    created_at: '2025-11-19T16:56:32.75Z'
                    updated_at: '2025-11-19T16:56:32.75Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: USA
                    creating_transfer_from_report_enabled: false
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: true
                    disbursements_ach_push_enabled: true
                    disbursements_card_pull_enabled: true
                    disbursements_card_push_enabled: true
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    first_approved_at: null
                    gateway: TRIPOS_CLOUD_V1
                    gross_settlement_enabled: false
                    identity: IDhC29dXMAkbmr1aBpS91Hpx
                    instant_payouts_card_push_enabled: false
                    is_terminated: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: '9399'
                    merchant_name: Finix Flowers
                    merchant_profile: MPi9TcqRi7XRdh38rHMrTX3b
                    mid: null
                    onboarding_state: PROVISIONING
                    processing_enabled: false
                    processor: DUMMY_V1
                    processor_details: {}
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: false
                    rent_surcharges_enabled: false
                    settlement_enabled: false
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    surcharges_enabled: false
                    tags:
                      key_2: value_2
                    termination_details: null
                    unreferenced_refund_card_present_enabled: true
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VImR52v1Cng5P7Qcsgeo4oAB
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU5yqwnm9MhyhDXCBaahWYgf
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU5yqwnm9MhyhDXCBaahWYgf/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPi9TcqRi7XRdh38rHMrTX3b
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VImR52v1Cng5P7Qcsgeo4oAB
                Merchant - Card Present Enabled:
                  value:
                    id: MUrbTzjE1dqRKujCBweaWWoX
                    created_at: '2024-08-16T12:28:45.70Z'
                    updated_at: '2024-08-16T12:28:45.70Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: USA
                    creating_transfer_from_report_enabled: true
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    gateway: TRIPOS_CLOUD_V1
                    gross_settlement_enabled: false
                    identity: ID2GsDQpDJPH648q76Y8hY66
                    instant_payouts_card_push_enabled: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: '4900'
                    merchant_name: Finix Flowers
                    merchant_profile: MP9NrEi7G37d8c1DVsNnhwBQ
                    mid: null
                    onboarding_state: PROVISIONING
                    processing_enabled: false
                    processor: DUMMY_V1
                    processor_details: {}
                    ready_to_settle_upon: RECONCILIATION
                    ready_to_settle_upon_delay_alignment: NONE
                    rent_surcharges_enabled: false
                    settlement_enabled: false
                    settlement_funding_identifier: UNSET
                    surcharges_enabled: false
                    tags:
                      key_2: value_2
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VIhWE7GQfiQUMKpWkKYpKVQs
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUrbTzjE1dqRKujCBweaWWoX
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/ID2GsDQpDJPH648q76Y8hY66
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUrbTzjE1dqRKujCBweaWWoX/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MP9NrEi7G37d8c1DVsNnhwBQ
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VIhWE7GQfiQUMKpWkKYpKVQs
                Merchant - Default Partial Authorization Enabled:
                  value:
                    id: MUvWVhLpLj9w7kV1EXA7yvzc
                    created_at: '2025-11-19T16:59:18.04Z'
                    updated_at: '2025-11-19T16:59:18.04Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: USA
                    creating_transfer_from_report_enabled: false
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: true
                    disbursements_ach_push_enabled: true
                    disbursements_card_pull_enabled: true
                    disbursements_card_push_enabled: true
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    first_approved_at: null
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDnT3ff71VShf6dB2ShcPozq
                    instant_payouts_card_push_enabled: false
                    is_terminated: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: '4900'
                    merchant_name: Finix Flowers
                    merchant_profile: MPi6VASLrAyCCKpEJLdD7PXy
                    mid: null
                    onboarding_state: PROVISIONING
                    processing_enabled: false
                    processor: DUMMY_V1
                    processor_details: {}
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: false
                    rent_surcharges_enabled: false
                    settlement_enabled: false
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    surcharges_enabled: false
                    tags: {}
                    termination_details: null
                    unreferenced_refund_card_present_enabled: true
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VI7mAamRFajxHzhAHYnPgVMx
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUvWVhLpLj9w7kV1EXA7yvzc
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDnT3ff71VShf6dB2ShcPozq
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUvWVhLpLj9w7kV1EXA7yvzc/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPi6VASLrAyCCKpEJLdD7PXy
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VI7mAamRFajxHzhAHYnPgVMx
                Merchant - Loan Repayment Enabled:
                  value:
                    id: MUwfZPNW3r4EqLMzwgr6txw4
                    created_at: '2025-07-07T18:04:14.14Z'
                    updated_at: '2025-07-07T18:05:01.23Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: USA
                    creating_transfer_from_report_enabled: false
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: true
                    disbursements_ach_push_enabled: true
                    disbursements_card_pull_enabled: true
                    disbursements_card_push_enabled: true
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDhC29dXMAkbmr1aBpS91Hpx
                    instant_payouts_card_push_enabled: false
                    is_terminated: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: true
                    mcc: '4900'
                    merchant_name: Finix Flowers
                    merchant_profile: MPpxQZAuHheULikbLYhJCNUd
                    mid: FNXdRZueYNvyKu8PUJvii1y6o
                    onboarding_state: APPROVED
                    processing_enabled: true
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNXdRZueYNvyKu8PUJvii1y6o
                      api_key: secretValue
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: false
                    rent_surcharges_enabled: false
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    surcharges_enabled: false
                    tags:
                      key_2: value_2
                    termination_details: null
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VIgAjKdUb98ajv3jpNUpwCjJ
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPpxQZAuHheULikbLYhJCNUd
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VIgAjKdUb98ajv3jpNUpwCjJ
                Merchant - Refunds Disabled:
                  value:
                    id: MUw1HqVK7is9No8qTKKYJLVy
                    created_at: '2025-08-29T15:09:21.43Z'
                    updated_at: '2025-08-29T15:09:21.43Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: USA
                    creating_transfer_from_report_enabled: false
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: true
                    disbursements_ach_push_enabled: true
                    disbursements_card_pull_enabled: true
                    disbursements_card_push_enabled: true
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDswxAn2UuRiHvZ5aJZ1oufY
                    instant_payouts_card_push_enabled: false
                    is_terminated: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: '4900'
                    merchant_name: Finix Flowers
                    merchant_profile: MP4p29UEGEvUKXdgXXVejm4z
                    mid: null
                    onboarding_state: PROVISIONING
                    processing_enabled: false
                    processor: DUMMY_V1
                    processor_details: {}
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: true
                    rent_surcharges_enabled: false
                    settlement_enabled: false
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    surcharges_enabled: false
                    tags: {}
                    termination_details: null
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VIx8tSchdh78yQum4uumaSju
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUw1HqVK7is9No8qTKKYJLVy
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDswxAn2UuRiHvZ5aJZ1oufY
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUw1HqVK7is9No8qTKKYJLVy/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MP4p29UEGEvUKXdgXXVejm4z
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VIx8tSchdh78yQum4uumaSju
          headers:
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            date:
              $ref: '#/components/headers/date'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
      keywords:
        includes:
          - create merchant
          - merchant
          - merchants
          - onboarding
          - underwriting
    get:
      summary: Fetch an Identity's Merchant
      operationId: getIdentityMerchant
      description: |
        Retrieve the `Merchant` resource for an `Identity`.
      tags:
        - Identities
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/identities/ID6NvZy42D7PChZL8GKKD87F/merchants"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listMerchants'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: getIdentityMerchant
      x-group-parameters: true
    parameters:
      - description: The `Identity` ID.
        in: path
        name: identity_id
        required: true
        schema:
          type: string
  /identities/{identity_id}/verifications:
    post:
      summary: Verify an Identity
      operationId: createIdentityVerification
      description: Verify an `Identity`.
      tags:
        - Identities
      parameters:
        - description: The `Identity` ID for the `Merchant` you wish to verify.
          required: true
          in: path
          name: identity_id
          schema:
            type: string
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema: {}
            examples:
              Verify Identity:
                value:
                  identity: ID2CGJmjqyYaQAu6qyuvGeWK
                  merchant: MUgWbPVvtKbzjKNNGKqdQYV7
                  tags:
                    card_name: Business_Card
      responses:
        '200':
          description: The `Identity` was successfully verified.
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      keywords:
        includes:
          - identity verification
          - verify a merchant identity
          - verify an identity
          - verify identity
          - verify merchant identity
  /merchant_profiles:
    get:
      tags:
        - Merchant Profiles
      description: >-
        Retrieve a list of `Merchant Profiles`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      summary: List Merchant Profiles
      operationId: listMerchantProfiles
      parameters:
        - $ref: '#/components/parameters/QueryIdFilter'
        - $ref: '#/components/parameters/QueryBeforeCursor'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
      responses:
        '200':
          $ref: '#/components/responses/MerchantProfilesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/merchant_profiles" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
  /merchants:
    get:
      summary: List Merchants
      operationId: listMerchants
      description: Retrieve a list of `Merchant` resources.
      tags:
        - Merchants
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/application_id'
        - name: country
          in: query
          description: Filter by the Merchant's `country` (ISO 3166 alpha-3).
          schema:
            type: string
            example: USA
            enum:
              - USA
              - CAN
        - name: currency
          in: query
          description: Filter by the Merchant's `currencies` (ISO 4217).
          schema:
            type: string
            example: USD
            enum:
              - USD
              - CAD
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/id'
        - name: identity_business_name
          in: query
          description: >-
            Filter by the `business_name` of the Merchant's `identity` (exact
            match).
          schema:
            type: string
            example: finix%20flowers
        - name: identity_business_name.like
          in: query
          description: >-
            Filter by the `business_name` of the Merchant's `identity` (partial
            match).
          schema:
            type: string
            example: finix
        - name: identity_doing_business_as
          in: query
          description: >-
            Filter by the `doing_business_as` of the Merchant's `identity`
            (exact match).
          schema:
            type: string
            example: finix%20flowers
        - name: identity_doing_business_as.like
          in: query
          description: >-
            Filter by the `doing_business_as` of the Merchant's `identity`
            (partial match).
          schema:
            type: string
            example: finix
        - name: identity_first_name
          in: query
          description: >-
            Filter by the `first_name` of the Merchant's `identity` (exact
            match).
          schema:
            type: string
            example: jonathan
        - name: identity_first_name.like
          in: query
          description: >-
            Filter by the `first_name` of the Merchant's `identity` (partial
            match).
          schema:
            type: string
            example: jon
        - name: identity_id
          in: query
          description: Filter by the Merchant's `identity`.
          schema:
            type: string
            example: ID6ZC4KedcaCwECQcWr7SM4m
        - name: identity_last_name
          in: query
          description: >-
            Filter by the `last_name` of the Merchant's `identity` (exact
            match).
          schema:
            type: string
            example: williams
        - name: identity_last_name.like
          in: query
          description: >-
            Filter by the `last_name` of the Merchant's `identity` (partial
            match).
          schema:
            type: string
            example: will
        - name: identity_role
          in: query
          description: Filter by the `identity_roles` of the Merchant's `identity`.
          schema:
            type: string
            example: SELLER
            enum:
              - APPLICATION_OWNER
              - RECIPIENT
              - SELLER
        - name: mcc
          in: query
          description: Filter by the Merchant's `mcc`.
          schema:
            type: string
            example: 4900
        - name: merchant_name
          in: query
          description: Filter by the Merchant's `merchant_name` (exact match).
          schema:
            type: string
            example: finix%20flowers
        - name: merchant_name.like
          in: query
          description: Filter by the Merchant's `merchant_name` (partial match).
          schema:
            type: string
            example: finix
        - name: processing_enabled
          in: query
          description: >-
            Filter by whether the Merchant's processing is enabled
            (`processing_enabled`).
          schema:
            type: boolean
            example: true
        - name: processor_type
          in: query
          description: Filter by the Merchant's `processor`.
          schema:
            type: string
            example: DUMMY_V1
            enum:
              - FINIX_V1
              - LITLE_V1
              - VANTIV_V1
              - DUMMY_V1
        - name: settlement_enabled
          in: query
          description: >-
            Filter by whether the Merchant's settlements are enabled
            (`settlement_enabled`).
          schema:
            type: boolean
            example: true
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
        - name: verification_id
          in: query
          description: Filter by the Merchant's `verification`.
          schema:
            type: string
            example: VI7jopNSiaVMXWKkhxt6dJm7
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/merchants" \
            -H "Content-Type: application/json" \
            -H "Finix-Version: 2022-02-01" \
            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listMerchants'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /merchants/{merchant_id}/devices:
    post:
      summary: Create a Merchant Device
      operationId: createMerchantDevice
      description: Create a `Device` under a `Merchant`.
      tags:
        - Devices
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
        - description: The ID of the `Merchant` the `Device` will be created under.
          required: true
          in: path
          name: merchant_id
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createMerchantDevice'
            examples:
              Create a Device - Model PAX_A800:
                value:
                  description: Cashier One
                  model: PAX_A800
                  name: My PAX_A800 Finix Device
                  serial_number: '19046260945'
                  configuration:
                    allow_debit: true
                    check_for_duplicate_transactions: true
                    prompt_amount_confirmation: true
                    prompt_manual_entry: false
                    bypass_device_on_capture: true
                    prompt_receipt_confirmation: true
                    display_tip_on_receipt: false
                    prompt_tip_on_screen: false
                    allow_standalone_authorizations: false
                    allow_standalone_sales: false
                    allow_standalone_refunds: false
                    tipping_details:
                      percent_tipping_threshold: 0
                      percent_options:
                        - 18
                        - 20
                        - 22
                      fixed_options:
                        - 100
                        - 150
                        - 200
                      allow_custom_tip: true
              Create a Device - Model PAX_A920PRO:
                value:
                  description: Cashier Two
                  model: PAX_A920PRO
                  name: My PAX_A920PRO Finix Device
                  serial_number: '19046260946'
                  configuration:
                    allow_debit: true
                    check_for_duplicate_transactions: true
                    prompt_amount_confirmation: true
                    prompt_manual_entry: false
                    bypass_device_on_capture: true
                    prompt_receipt_confirmation: true
                    display_tip_on_receipt: false
                    prompt_tip_on_screen: false
                    allow_standalone_authorizations: false
                    allow_standalone_sales: false
                    allow_standalone_refunds: false
                    tipping_details:
                      percent_tipping_threshold: 0
                      percent_options:
                        - 18
                        - 20
                        - 22
                      fixed_options:
                        - 100
                        - 150
                        - 200
                      allow_custom_tip: true
              Create a Device - Model PAX_D135:
                value:
                  description: Cashier Three
                  model: PAX_D135
                  name: My PAX_D135 Finix Device
                  serial_number: '19046260947'
                  configuration:
                    allow_debit: true
                    check_for_duplicate_transactions: true
                    prompt_amount_confirmation: true
                    prompt_manual_entry: false
                    bypass_device_on_capture: true
                    prompt_receipt_confirmation: true
                    display_tip_on_receipt: false
                    prompt_tip_on_screen: false
                    allow_standalone_authorizations: false
                    allow_standalone_sales: false
                    allow_standalone_refunds: false
                    tipping_details:
                      percent_tipping_threshold: 0
                      percent_options:
                        - 18
                        - 20
                        - 22
                      fixed_options:
                        - 100
                        - 150
                        - 200
                      allow_custom_tip: true
              Create a Device - Surcharges - Standalone Mode:
                value:
                  description: Cashier One
                  model: PAX_A800
                  name: My PAX_A800 Finix Device
                  serial_number: '19046260945'
                  configuration:
                    surcharge_basis_points: 300
      responses:
        '201':
          $ref: '#/components/responses/createMerchantDevice'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: create
      keywords:
        includes:
          - create device
          - device
          - merchant device
  /merchants/{merchant_id}:
    get:
      summary: Fetch a Merchant
      operationId: getMerchant
      description: Retrieve the details of a `Merchant`.
      tags:
        - Merchants
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          description: A single `Merchant`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/merchant'
              examples:
                Merchant:
                  value:
                    id: MU5yqwnm9MhyhDXCBaahWYgf
                    created_at: '2025-11-19T16:56:32.75Z'
                    updated_at: '2025-11-19T16:56:32.75Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: USA
                    creating_transfer_from_report_enabled: false
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: true
                    disbursements_ach_push_enabled: true
                    disbursements_card_pull_enabled: true
                    disbursements_card_push_enabled: true
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    first_approved_at: null
                    gateway: TRIPOS_CLOUD_V1
                    gross_settlement_enabled: false
                    identity: IDhC29dXMAkbmr1aBpS91Hpx
                    instant_payouts_card_push_enabled: false
                    is_terminated: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: '9399'
                    merchant_name: Finix Flowers
                    merchant_profile: MPi9TcqRi7XRdh38rHMrTX3b
                    mid: null
                    onboarding_state: PROVISIONING
                    processing_enabled: false
                    processor: DUMMY_V1
                    processor_details: {}
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: false
                    rent_surcharges_enabled: false
                    settlement_enabled: false
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    surcharges_enabled: false
                    tags:
                      key_2: value_2
                    termination_details: null
                    unreferenced_refund_card_present_enabled: true
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VImR52v1Cng5P7Qcsgeo4oAB
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU5yqwnm9MhyhDXCBaahWYgf
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU5yqwnm9MhyhDXCBaahWYgf/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPi9TcqRi7XRdh38rHMrTX3b
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VImR52v1Cng5P7Qcsgeo4oAB
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
      x-group-parameters: true
    parameters:
      - description: The `Merchant` ID.
        in: path
        name: merchant_id
        required: true
        schema:
          type: string
    put:
      summary: Update a Merchant
      operationId: updateMerchant
      description: >
        Update a `Merchant` to: 

        - Change the `Identity` information saved with the underlying processor

        - [Enable Level 2/3
        processing](/guides/online-payments/payment-features/level-2-level-3-processing)

        - Enable [Buyer
        Charges](/guides/online-payments/payment-features/buyer-charges)

        - Enable partial authorizations

        - Disable a `Merchant` so the seller can't create new `Transfers` and
        `Authorizations`

        - Disable a `Merchant` so their `Settlements` cannot be approved.

        - Enable a `Merchant` to use the Settlement Queue

        - Terminate a `Merchant` for suspected fraud, compliance violations,
        excessive chargebacks, or merchant churn.
      tags:
        - Merchants
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/updateMerchantDisableProcessing'
                - $ref: '#/components/schemas/updateMerchantDisableSettlements'
                - $ref: '#/components/schemas/updateMerchantEnableBuyerCharges'
                - $ref: '#/components/schemas/updateMerchantEnableL2L3Processing'
                - $ref: '#/components/schemas/updateMerchantEnableLoanRepayment'
                - $ref: >-
                    #/components/schemas/updateMerchantEnablePartialAuthorizations
                - $ref: '#/components/schemas/updateMerchantEnableSameDayACH'
                - $ref: '#/components/schemas/updateMerchantSettlementQueue'
                - $ref: '#/components/schemas/updateMerchantTerminate'
            examples:
              Disable Processing:
                value:
                  processing_enabled: false
              Disable Settlements:
                value:
                  settlement_enabled: false
              Enable Buyer Charges:
                value:
                  convenience_charges_enabled: true
              Enable Level 2/3 Processing:
                value:
                  level_two_level_three_data_enabled: true
              Enable Loan Repayment:
                value:
                  loan_repayment: true
              Enable Partial Authorizations:
                value:
                  default_partial_authorization_enabled: true
              Enable Disbursements Same-Day ACH Push & Pull:
                value:
                  disbursements_same_day_ach_pull_enabled: true
                  disbursements_same_day_ach_push_enabled: true
              Enable Settlement Queue:
                value:
                  settlement_queue_mode: MANUAL
              Terminate Merchant:
                value:
                  is_terminated: true
                  termination_details:
                    reason: CHURNED
                    description: Customer canceled
      responses:
        '200':
          description: A single `Merchant`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/merchant'
              examples:
                Disable Processing:
                  value:
                    id: MUmUL7aBsHkxVLQawJxEXw6N
                    created_at: '2022-08-17T20:33:34.04Z'
                    updated_at: '2024-08-16T13:52:37.98Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: null
                    creating_transfer_from_report_enabled: true
                    currencies: null
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDrH4G2VTfNjn1VFkvhcyMYj
                    instant_payouts_card_push_enabled: false
                    level_two_level_three_data_enabled: true
                    loan_repayment: null
                    mcc: null
                    merchant_name: John Smith
                    merchant_profile: MPjBZguwk8oJ9H5ouJo3jaG4
                    mid: FNX6ugoYdmmmRkDAEn59nhEai
                    onboarding_state: APPROVED
                    processing_enabled: false
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNX6ugoYdmmmRkDAEn59nhEai
                      api_key: secretValue
                    ready_to_settle_upon: RECONCILIATION
                    ready_to_settle_upon_delay_alignment: NONE
                    rent_surcharges_enabled: false
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    surcharges_enabled: false
                    tags:
                      key_2: value_2
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VIn6CKA39fArkcyJF6V4yrGv
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPjBZguwk8oJ9H5ouJo3jaG4
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VIn6CKA39fArkcyJF6V4yrGv
                Disable Settlements:
                  value:
                    id: MUgGByM8bC2d9eFDPd1gEkod
                    created_at: '2024-06-04T15:10:07.87Z'
                    updated_at: '2024-08-16T13:55:02.14Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: null
                    creating_transfer_from_report_enabled: true
                    currencies: null
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDmHKH4fS7tXGPx5eVGb9BjD
                    instant_payouts_card_push_enabled: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: null
                    merchant_name: John Doe
                    merchant_profile: MP5XbzPkfZyQH5TW3yFbNYi8
                    mid: FNXajDZm7byhbQBwRK3jNpWcp
                    onboarding_state: APPROVED
                    processing_enabled: true
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNXajDZm7byhbQBwRK3jNpWcp
                      api_key: secretValue
                    ready_to_settle_upon: RECONCILIATION
                    ready_to_settle_upon_delay_alignment: NONE
                    rent_surcharges_enabled: false
                    settlement_enabled: false
                    settlement_funding_identifier: UNSET
                    surcharges_enabled: false
                    tags: {}
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VImpD4oqrjLqhZ3aHwjcMx9B
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUgGByM8bC2d9eFDPd1gEkod
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDmHKH4fS7tXGPx5eVGb9BjD
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUgGByM8bC2d9eFDPd1gEkod/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MP5XbzPkfZyQH5TW3yFbNYi8
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VImpD4oqrjLqhZ3aHwjcMx9B
                Enable Buyer Charges:
                  value:
                    id: MU3ueKsz9vDKMDYceKUchPbV
                    created_at: '2024-06-04T15:08:42.17Z'
                    updated_at: '2024-08-16T13:57:26.14Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: true
                    country: null
                    creating_transfer_from_report_enabled: true
                    currencies: null
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDm2Cw1vfQdTneyP9GGLodJ
                    instant_payouts_card_push_enabled: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: null
                    merchant_name: John Doe
                    merchant_profile: MP5zfQvyWWjuxXMaUAJ9XwcG
                    mid: FNXaxFkRzhvNBQfse2Qy63NK3
                    onboarding_state: APPROVED
                    processing_enabled: true
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNXaxFkRzhvNBQfse2Qy63NK3
                      api_key: secretValue
                    ready_to_settle_upon: RECONCILIATION
                    ready_to_settle_upon_delay_alignment: NONE
                    rent_surcharges_enabled: true
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    surcharges_enabled: false
                    tags: {}
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VImMWXG7W8WYGcPiHcv7ED6m
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU3ueKsz9vDKMDYceKUchPbV
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDm2Cw1vfQdTneyP9GGLodJ
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU3ueKsz9vDKMDYceKUchPbV/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MP5zfQvyWWjuxXMaUAJ9XwcG
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VImMWXG7W8WYGcPiHcv7ED6m
                Enable Level 2/3 Processing:
                  value:
                    id: MUcDAtijYcoVLamxHhzQc7fZ
                    created_at: '2024-06-04T15:08:28.57Z'
                    updated_at: '2024-08-16T14:00:33.06Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: null
                    creating_transfer_from_report_enabled: true
                    currencies: null
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDwq5EgdjhsWvpkJQEdfrs9y
                    instant_payouts_card_push_enabled: false
                    level_two_level_three_data_enabled: true
                    loan_repayment: null
                    mcc: null
                    merchant_name: John Doe
                    merchant_profile: MPgivonuyqNTmZ3xsXyFnoYf
                    mid: FNX8RFGJ2BWc7CufRXpvbeUVV
                    onboarding_state: APPROVED
                    processing_enabled: true
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNX8RFGJ2BWc7CufRXpvbeUVV
                      api_key: secretValue
                    ready_to_settle_upon: RECONCILIATION
                    ready_to_settle_upon_delay_alignment: NONE
                    rent_surcharges_enabled: false
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    surcharges_enabled: false
                    tags: {}
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VIjcwzg18pa3u384cGkT1R9L
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUcDAtijYcoVLamxHhzQc7fZ
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDwq5EgdjhsWvpkJQEdfrs9y
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUcDAtijYcoVLamxHhzQc7fZ/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPgivonuyqNTmZ3xsXyFnoYf
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VIjcwzg18pa3u384cGkT1R9L
                Enable Loan Repayment:
                  value:
                    id: MU7noQ1wdgdAeAfymw2rfBMq
                    created_at: '2024-11-14T22:25:07.80Z'
                    updated_at: '2025-07-18T18:40:12.02Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: true
                    country: USA
                    creating_transfer_from_report_enabled: false
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDjvxGeXBLKH1V9YnWm1CS4n
                    instant_payouts_card_push_enabled: false
                    is_terminated: false
                    level_two_level_three_data_enabled: true
                    loan_repayment: true
                    mcc: null
                    merchant_name: BrainTree
                    merchant_profile: MPrqHHN5y5Up4AGYENnEGvah
                    mid: FNXdp4rntUy6oRgNDBARQQZou
                    onboarding_state: APPROVED
                    processing_enabled: true
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNXdp4rntUy6oRgNDBARQQZou
                      api_key: secretValue
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: false
                    rent_surcharges_enabled: true
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: MANUAL
                    surcharges_enabled: false
                    tags:
                      type: facilitator
                    termination_details: null
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VIiq2VoSUWphJvSNCgqrBsaB
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPrqHHN5y5Up4AGYENnEGvah
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VIiq2VoSUWphJvSNCgqrBsaB
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                Enable Partial Authorizations:
                  value:
                    id: MUthGS9FJ6ciwja4WUiT8krZ
                    created_at: '2024-06-04T15:06:14.30Z'
                    updated_at: '2024-08-16T14:07:33.62Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: null
                    creating_transfer_from_report_enabled: true
                    currencies: null
                    default_partial_authorization_enabled: true
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDoP8WczKuyWjzkt3gpvgKXh
                    instant_payouts_card_push_enabled: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: null
                    merchant_name: John Doe
                    merchant_profile: MPESXU26wZPvmQqa3rvLiLh
                    mid: FNXtRNDfR6jhZs5aZYSTTT572
                    onboarding_state: APPROVED
                    processing_enabled: true
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNXtRNDfR6jhZs5aZYSTTT572
                      api_key: secretValue
                    ready_to_settle_upon: RECONCILIATION
                    ready_to_settle_upon_delay_alignment: NONE
                    rent_surcharges_enabled: false
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    surcharges_enabled: false
                    tags: {}
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VI3tCD2q4fvzQJHnEC8ewqsM
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUthGS9FJ6ciwja4WUiT8krZ
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDoP8WczKuyWjzkt3gpvgKXh
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUthGS9FJ6ciwja4WUiT8krZ/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPESXU26wZPvmQqa3rvLiLh
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VI3tCD2q4fvzQJHnEC8ewqsM
                Enable Disbursements Same-Day ACH Push & Pull:
                  value:
                    id: MU7noQ1wdgdAeAfymw2rfBMq
                    created_at: '2024-11-14T22:25:07.80Z'
                    updated_at: '2025-04-30T00:30:02.48Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: true
                    country: USA
                    creating_transfer_from_report_enabled: false
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDjvxGeXBLKH1V9YnWm1CS4n
                    instant_payouts_card_push_enabled: false
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: null
                    merchant_name: BrainTree
                    merchant_profile: MPrqHHN5y5Up4AGYENnEGvah
                    mid: FNX5By5Cw5SRgySYWTHbrZQgi
                    onboarding_state: APPROVED
                    processing_enabled: true
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNX5By5Cw5SRgySYWTHbrZQgi
                      api_key: secretValue
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    rent_surcharges_enabled: true
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    surcharges_enabled: false
                    tags:
                      type: facilitator
                    verification: VIsvHdX9BRZAQPKvx1g6mssB
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPrqHHN5y5Up4AGYENnEGvah
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VIsvHdX9BRZAQPKvx1g6mssB
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                Enable Settlement Queue:
                  value:
                    id: MUmUL7aBsHkxVLQawJxEXw6N
                    created_at: '2022-08-17T20:33:34.04Z'
                    updated_at: '2025-12-09T20:58:17.17Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: null
                    creating_transfer_from_report_enabled: true
                    currencies: null
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: false
                    disbursements_ach_push_enabled: false
                    disbursements_card_pull_enabled: false
                    disbursements_card_push_enabled: false
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    first_approved_at: '2022-08-17T20:33:34.25Z'
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDrH4G2VTfNjn1VFkvhcyMYj
                    instant_payouts_card_push_enabled: false
                    is_terminated: false
                    level_two_level_three_data_enabled: true
                    loan_repayment: null
                    mcc: null
                    merchant_name: John Smith
                    merchant_profile: MPjBZguwk8oJ9H5ouJo3jaG4
                    mid: FNX4phCMkq2sPb1XGUK61rywV
                    onboarding_state: APPROVED
                    processing_enabled: false
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNX4phCMkq2sPb1XGUK61rywV
                      api_key: secretValue
                    ready_to_settle_upon: RECONCILIATION
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: false
                    rent_surcharges_enabled: false
                    settlement_enabled: false
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: MANUAL
                    surcharges_enabled: false
                    tags:
                      key_2: value_2
                    termination_details: null
                    unreferenced_refund_card_present_enabled: true
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VIsNauxw77oKzXZxRofDeo8i
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MPjBZguwk8oJ9H5ouJo3jaG4
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VIsNauxw77oKzXZxRofDeo8i
                Terminate Merchant:
                  value:
                    id: MUmRJeeFrAZnBwQrjGfVSZqP
                    created_at: '2025-07-30T16:57:54.70Z'
                    updated_at: '2025-07-30T16:58:01.52Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    card_cvv_required: false
                    card_expiration_date_required: true
                    card_network_details: null
                    convenience_charges_enabled: false
                    country: USA
                    creating_transfer_from_report_enabled: false
                    currencies:
                      - USD
                    default_partial_authorization_enabled: false
                    disbursements_ach_pull_enabled: true
                    disbursements_ach_push_enabled: true
                    disbursements_card_pull_enabled: true
                    disbursements_card_push_enabled: true
                    disbursements_same_day_ach_pull_enabled: false
                    disbursements_same_day_ach_push_enabled: false
                    fee_ready_to_settle_upon: PROCESSOR_WINDOW
                    gateway: null
                    gross_settlement_enabled: false
                    identity: IDgcKMCFHPfM1pNJURXrWXNH
                    instant_payouts_card_push_enabled: false
                    is_terminated: true
                    level_two_level_three_data_enabled: false
                    loan_repayment: null
                    mcc: '4900'
                    merchant_name: Finix Flowers
                    merchant_profile: MP27puKXFYrpW5WJ4oyzNxXq
                    mid: FNXv6Se7kDvLXqR2cfkVzd6re
                    onboarding_state: APPROVED
                    processing_enabled: false
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNXv6Se7kDvLXqR2cfkVzd6re
                      api_key: secretValue
                    ready_to_settle_upon: PROCESSOR_WINDOW
                    ready_to_settle_upon_delay_alignment: NONE
                    refunds_disabled: true
                    rent_surcharges_enabled: false
                    settlement_enabled: false
                    settlement_funding_identifier: UNSET
                    settlement_queue_mode: UNSET
                    surcharges_enabled: false
                    tags:
                      key_2: value_2
                    termination_details:
                      terminated_at: '2025-07-25T23:19:47.67Z'
                      reason: CHURNED
                      description: Customer canceled
                      terminated_by: PARTNER_USER
                      terminated_by_user_id: US8yu2RAvRssVMQBD5uWA9gt
                    unreferenced_refund_manual_entry_enabled: false
                    verification: VImEZXyqfXTpxPCRM6u1WcYT
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUmRJeeFrAZnBwQrjGfVSZqP
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDgcKMCFHPfM1pNJURXrWXNH
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchants/MUmRJeeFrAZnBwQrjGfVSZqP/verifications
                      merchant_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/merchant_profiles/MP27puKXFYrpW5WJ4oyzNxXq
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      verification:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VImEZXyqfXTpxPCRM6u1WcYT
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: update
      x-group-parameters: true
  /merchant/{merchant_id}/verifications:
    post:
      summary: Verify a Merchant
      operationId: createMerchantVerification
      description: >
        Create a `Verification` on a Merchant to get them Approved. This request
        will create a new `PENDING` Verification. Listen to updates and re-fetch
        the Verification when it is `SUCCEEDED` or `FAILED`.


        For handling `FAILED` Verifications, see [Fetch a
        Verification](/api/verifications/getverification). See also [Onboarding
        Process](/guides/platform-payments/onboarding-sellers/seller-onboarding-process)
        for Seller Merchants and [Verification Requirements for
        Payouts](/guides/payouts/recipient-verification-process) for Recipient
        Merchants.
      tags:
        - Merchants
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
            examples:
              Verify a Merchant:
                value: {}
      responses:
        '201':
          $ref: '#/components/responses/createMerchantVerification'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
      x-group-parameters: true
      keywords:
        includes:
          - merchant verification
          - verify merchant
          - verify a merchant
    get:
      summary: List Merchant Verifications
      operationId: listMerchantVerifications
      description: >
        Retrieve a list of all the `Verifications` for a `Merchant` resource.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Verifications
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/limit'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq/verifications"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listMerchantVerifications'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
      x-group-parameters: true
    parameters:
      - description: The `Merchant` ID.
        in: path
        name: merchant_id
        required: true
        schema:
          type: string
  /merchant_profiles/{merchant_profile_id}:
    get:
      tags:
        - Merchant Profiles
      description: Retrieve the details of a previously created `Merchant Profile`.
      summary: Fetch a Merchant Profile
      operationId: getMerchantProfile
      responses:
        '200':
          $ref: '#/components/responses/MerchantProfile'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/merchant_profiles/MPfRU8XJ8sDZryZhoYCyjtyB"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    parameters:
      - description: ID of `Merchant Profile`.
        required: true
        in: path
        name: merchant_profile_id
        schema:
          type: string
    put:
      tags:
        - Merchant Profiles
      description: Update a `Merchant Profile`.
      summary: Update a Merchant Profile
      operationId: updateMerchantProfile
      requestBody:
        $ref: '#/components/requestBodies/UpdateMerchantProfileRequest'
      responses:
        '200':
          $ref: '#/components/responses/MerchantProfile'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: update
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/merchant_profiles/MPfRU8XJ8sDZryZhoYCyjtyB"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -X PUT \
                -d '{
                    "fee_profile": "FP9F2KEnY4wt1XjFvhLBJVjb"
                }'
      x-internal: false
  /payment_instruments:
    post:
      summary: Create a Payment Instrument
      operationId: createPaymentInstrument
      description: >
        Create a `Payment Instrument` resource using a card or bank account.


        - The creation of `Payment Instruments` directly via Finix's API should
        only be done for testing purposes. You must use [our hosted
        fields](/guides/online-payments/payment-tokenization/tokenization-forms)
        or the javascript client to remain out of PCI scope.
      tags:
        - Payment Instruments
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/createPaymentInstrumentCard'
                - $ref: '#/components/schemas/createPaymentInstrumentAccountUpdater'
                - $ref: '#/components/schemas/createPaymentInstrumentNetworkTokens'
                - $ref: '#/components/schemas/createPaymentInstrumentBankAccount'
                - $ref: '#/components/schemas/createPaymentInstrumentPlaidBankAccount'
                - $ref: >-
                    #/components/schemas/createPaymentInstrumentCanadianBankAccount
                - $ref: '#/components/schemas/createPaymentInstrumentTokenCard'
                - $ref: >-
                    #/components/schemas/createPaymentInstrumentTokenAccountUpdater
                - $ref: '#/components/schemas/createPaymentInstrumentTokenBankAccount'
                - $ref: >-
                    #/components/schemas/createPaymentInstrumentTokenNetworkTokens
                - $ref: '#/components/schemas/createPaymentInstrumentApplePay'
                - $ref: '#/components/schemas/createPaymentInstrumentGooglePay'
            examples:
              Payment Instrument - Card:
                value:
                  address:
                    city: San Francisco
                    country: USA
                    line1: 900 Metro Center Blv
                    postal_code: '94404'
                    region: CA
                  expiration_month: 12
                  expiration_year: 2029
                  identity: IDmj1yA97RS4rMjiQgvK3Vio
                  name: John Smith
                  number: '5200828282828210'
                  security_code: '022'
                  type: PAYMENT_CARD
              Payment Instrument - Card - Enable Account Updater:
                value:
                  account_updater_enabled: true
                  address:
                    city: San Francisco
                    country: USA
                    line1: 900 Metro Center Blv
                    postal_code: '94404'
                    region: CA
                  expiration_month: 12
                  expiration_year: 2029
                  identity: IDmj1yA97RS4rMjiQgvK3Vio
                  name: John Smith
                  number: '5200828282828210'
                  security_code: '022'
                  type: PAYMENT_CARD
              Payment Instrument - Card - Enable Network Tokens:
                value:
                  address:
                    city: San Francisco
                    country: USA
                    line1: 900 Metro Center Blv
                    postal_code: '94404'
                    region: CA
                  expiration_month: 12
                  expiration_year: 2029
                  identity: IDmj1yA97RS4rMjiQgvK3Vio
                  name: John Smith
                  network_token_enabled: true
                  number: '5200828282828210'
                  security_code: '022'
                  type: PAYMENT_CARD
              Payment Instrument - Bank Account:
                value:
                  account_number: '0000000019'
                  account_type: BUSINESS_CHECKING
                  attempt_bank_account_validation_check: true
                  bank_code: '122105278'
                  identity: IDmj1yA97RS4rMjiQgvK3Vio
                  name: Smith & Associates Consulting
                  type: BANK_ACCOUNT
              Payment Instrument - Plaid Bank Account:
                value:
                  third_party: PLAID
                  third_party_token: processor-sandbox-4855f0a2-c6f4-440c-9e6b-1d0ad9ca0010
                  type: BANK_ACCOUNT
                  identity: IDmj1yA97RS4rMjiQgvK3Vio
              Payment Instrument - Canadian Bank Account:
                value:
                  account_number: '123123123'
                  account_type: PERSONAL_CHECKING
                  country: CAN
                  currency: CAD
                  identity: IDmj1yA97RS4rMjiQgvK3Vio
                  institution_number: '123'
                  name: John Smith
                  transit_number: '12345'
                  type: BANK_ACCOUNT
              Payment Instrument - Token - Enable Account Updater:
                value:
                  account_updater_enabled: true
                  token: TKiMxe323RE5Dq3wLVtG8kSW
                  type: TOKEN
                  identity: IDjvxGeXBLKH1V9YnWm1CS4n
              Payment Instrument - Token - Bank Account:
                value:
                  attempt_bank_account_validation_check: true
                  token: TKiMxe323RE5Dq3wLVtG8kSW
                  type: TOKEN
                  identity: IDjvxGeXBLKH1V9YnWm1CS4n
              Payment Instrument - Token - Card:
                value:
                  token: TKiMxe323RE5Dq3wLVtG8kSW
                  type: TOKEN
                  identity: IDjvxGeXBLKH1V9YnWm1CS4n
              Payment Instrument - Token - Enable Network Tokens:
                value:
                  network_token_enabled: true
                  token: TKiMxe323RE5Dq3wLVtG8kSW
                  type: TOKEN
                  identity: IDjvxGeXBLKH1V9YnWm1CS4n
              Payment Instrument - Apple Pay:
                value:
                  identity: IDmj1yA97RS4rMjiQgvK3Vio
                  merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                  name: John Smith
                  third_party_token: >-
                    {"token":{"paymentMethod":{"network":"barcode","type":"credit","displayName":""},"transactionIdentifier":"AE514ADAA44E9C3A0A862C7E4EDEE43C422556FA4748B045F1764860557E8EE6","paymentData":{"data":"IOg9H5\/hdpccvHZ03ESJwlJXFlmcnI18WXTSOHOPA82ewYoWVyEMiy63HCsdejXsHIR8a+N\/5aR24OeJrkxheck2AAl5o1LLJ7jL+75scnf7Z55uQmtVyKITTkH22LrC6E6SgMnXaefJYOTUcG1Veqb\/dXtpPzqaKACEKDkbVivpDk+A2iX5PLROFTMRgmb9a0HYwHOnVGQzXwiHkX1g6f1R4rILUyMaQ5qLxCplE1t\/guEYmkGBtOb\/v8+GRDTl8YrC1tOe\/cs4aQm4cAKJktFQUTbfAApNFBnKI06mtCM7e7qRna\/YON3gyci035jA7Zq4kBMo7rQB8puGH6dDqB\/KsPS6Ps+w688+rqEKz16YUJ\/LMCOzzBM6bCTOS6eouB1eCh3SJdm\/lmY=","signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID4zCCA4igAwIBAgIITDBBSVGdVDYwCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE5MDUxODAxMzI1N1oXDTI0MDUxNjAxMzI1N1owXzElMCMGA1UEAwwcZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtUFJPRDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwhV37evWx7Ihj2jdcJChIY3HsL1vLCg9hGCV2Ur0pUEbg0IO2BHzQH6DMx8cVMP36zIg1rrV1O\/0komJPnwPE6OCAhEwggINMAwGA1UdEwEB\/wQCMAAwHwYDVR0jBBgwFoAUI\/JJxE+T5O8n5sT2KGw\/orv9LkswRQYIKwYBBQUHAQEEOTA3MDUGCCsGAQUFBzABhilodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlYWljYTMwMjCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZIhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRwOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNAYDVR0fBC0wKzApoCegJYYjaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVhaWNhMy5jcmwwHQYDVR0OBBYEFJRX22\/VdIGGiYl2L35XhQfnm1gkMA4GA1UdDwEB\/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0kAMEYCIQC+CVcf5x4ec1tV5a+stMcv60RfMBhSIsclEAK2Hr1vVQIhANGLNQpd1t1usXRgNbEess6Hz6Pmr2y9g4CJDcgs3apjMIIC7jCCAnWgAwIBAgIISW0vvzqY2pcwCgYIKoZIzj0EAwIwZzEbMBkGA1UEAwwSQXBwbGUgUm9vdCBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwHhcNMTQwNTA2MjM0NjMwWhcNMjkwNTA2MjM0NjMwWjB6MS4wLAYDVQQDDCVBcHBsZSBBcHBsaWNhdGlvbiBJbnRlZ3JhdGlvbiBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATwFxGEGddkhdUaXiWBB3bogKLv3nuuTeCN\/EuT4TNW1WZbNa4i0Jd2DSJOe7oI\/XYXzojLdrtmcL7I6CmE\/1RFo4H3MIH0MEYGCCsGAQUFBwEBBDowODA2BggrBgEFBQcwAYYqaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZXJvb3RjYWczMB0GA1UdDgQWBBQj8knET5Pk7yfmxPYobD+iu\/0uSzAPBgNVHRMBAf8EBTADAQH\/MB8GA1UdIwQYMBaAFLuw3qFYM4iapIqZ3r6966\/ayySrMDcGA1UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkiG92NkBgIOBAIFADAKBggqhkjOPQQDAgNnADBkAjA6z3KDURaZsYb7NcNWymK\/9Bft2Q91TaKOvvGcgV5Ct4n4mPebWZ+Y1UENj53pwv4CMDIt1UQhsKMFd2xd8zg7kGf9F3wsIW2WT8ZyaYISb1T4en0bmcubCYkhYQaZDwmSHQAAMYIBjDCCAYgCAQEwgYYwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTAghMMEFJUZ1UNjANBglghkgBZQMEAgEFAKCBlTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0yMjA0MDExODE2MjJaMCoGCSqGSIb3DQEJNDEdMBswDQYJYIZIAWUDBAIBBQChCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEINpyGxYyGbl1Kj57wU\/3PijxngHUcidFy9jukG9sccOHMAoGCCqGSM49BAMCBEcwRQIhAPHvbeAIDmJKf2YGS5xcCoySSeCeFf6ThUsKE3UIPWBJAiBQIZZu4wTlZn7R16N+2iTfvuvzJKgeSv8rAs3YM6z56AAAAAAAAA==","header":{"publicKeyHash":"eOvce9ya55opFC5EXVWlLwzZRVDEY3Hgakf3+C+0zkc=","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE3VnkF5JR9cWuYoeT68dUNp\/2\/jGaOiid19UfCV9rEkcPomrzFWEZw\/dN1uU9RTblnrIQPajFj4R2ZKIpYIlkgA==","transactionId":"ae514adaa44e9c3a0a862c7e4edee43c422556fa4748b045f1764860557e8ee6"},"version":"EC_v1"}}}
                  type: APPLE_PAY
                  address:
                    city: San Francisco
                    country: USA
                    line1: 900 Metro Center Blv
                    line2: APT 200
                    postal_code: '94404'
                    region: CA
              Payment Instrument - Google Pay:
                value:
                  identity: ID78Fh8mcnnzukVzbdoyex5y
                  merchant_identity: IDwhCCvPwCDEmiFd8Be7pDzN
                  name: Finix Sandbox
                  third_party_token: >-
                    {"signature":"MEYCIQCYTkaEMgug7pcjzEEdbIn+R57kYO5yYc2KYj41AQQn9wIhAN1QvylvZ2XydVecfejwi2xYS9y3Y9y/MmDnRnUfNw5H","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4xc3fjeM9SMTjd1TL2GQCPmgqPf2h42aM3akPh/mTUBqWEgOITruK10A02rQ+4YZOvLCpQKQZzLSAd09nctnuA\\u003d\\u003d\",\"keyExpiration\":\"1648843199734\"}","signatures":["MEQCICwCI4s5YCLu4qRCyXwSJ3qG8y3ocFtP1Mque4Uzysl8AiARoD/0qbj5W0Q2PWKpxkEnfcP+nU5kwYS8FyQ9boDTmQ\u003d\u003d"]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"roD4ikTpZ7Srunq+0zUnp+eiXzcuZBfIFSuZAJu1PQLXcP0RvnGDiGKtoarNCHvn+cnXsHCzIBWXMZSJ9Aglqky9VfP5a+qsXQhf5m5AFUbT2xnihtKwageGQQK6HzyjHSXXSjvuCzeo75ToOgIUxLFASZyaZ89u3Jifqhhc2c4a0Mtlx564BxXiwcxDFdtNkOle7uAIsJzsryk7Rcwgr8ZMJJM//XpvaeE5wNmkVFHUtR2uTqPm0BvkoYkFHCTRo4NHXWpxeLjXWzKGk2ELyTK1diuCa6c9ig0jO3t8BIh1cR63UeP8Ar7u5fh8C9FPPAsgPbTGLfiaRe615e4SxASgcZ4/8uWo5mikEPFqA5s2K2mid9ncXoMNYaHUc3qzJAyxHVYSd5SRNZYXHMkEcWcjnpDx+ErYjR1sMo1LMYXfrfGyZz3M69bQLKPYFe7ChjvgFI9MnfcFTNB4HAdNKMhbZT0EKinfxxGWkT7LVbGnUuqPlHp4toCe4kpbx7fulwXTj3bAFvg/qvxxwGOS38iP0HR/f+4GF0xHspqYVbdWdIJ5iJUdpBG8Nu5P56h2GEDxXMkKSmh+qbvKWlYipNNGoeg8uHc\\u003d\",\"ephemeralPublicKey\":\"BMqIyb1IyXhuZ4YpWm1PiRr74i3tCwDfQqJ1P4OZ3zK4Rq16SuwgJ605fCEvlViwSQuo2Hpv+CcR+2D3+/YrLB8\\u003d\",\"tag\":\"5K4LlTucDK7jAThbIozYtyoxX95hRNd5cJJGfxWAxw8\\u003d\"}"}
                  type: GOOGLE_PAY
                  address:
                    city: San Francisco
                    country: USA
                    line1: 900 Metro Center Blv
                    line2: APT 200
                    postal_code: '94404'
                    region: CA
      responses:
        '201':
          $ref: '#/components/responses/createPaymentInstrument'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
      keywords:
        includes:
          - create payment instrument
          - payment instrument
          - payment instruments
    get:
      summary: List Payment Instruments
      operationId: listPaymentInstruments
      description: >
        Retrieve a list of `Payment Instrument` resources.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      tags:
        - Payment Instruments
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - name: account_last4
          in: query
          required: false
          schema:
            type: string
            example: '4242'
          description: Filter by the last 4 digits of the account if available.
        - name: account_routing_number
          in: query
          required: false
          schema:
            type: string
            example: '9444'
          description: Filter by the account routing number if available.
        - name: bin
          in: query
          required: false
          schema:
            type: string
            example: '411111'
          description: >-
            Filter by Bank Identification Number (BIN). The BIN is the first 6
            digits of the masked number.
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - name: expiration_month
          in: query
          required: false
          schema:
            type: string
            example: '9'
          description: >-
            Filter by the expiration month associated with the `Payment
            Instrument` if applicable. This filter only applies to payment
            cards.
        - name: expiration_year
          in: query
          required: false
          schema:
            type: string
            example: '2029'
          description: >-
            Filter by the 4 digit expiration year associated with the Payment
            Instrument if applicable. This filter only applies to payment cards.
        - $ref: '#/components/parameters/id'
        - name: last4
          in: query
          required: false
          schema:
            type: string
            example: '0454'
          description: >-
            Filter by the last 4 digits of the `Payment Instrument` card. This
            filter only applies to payment cards.
        - $ref: '#/components/parameters/limit'
        - name: name
          in: query
          required: false
          schema:
            type: string
          description: Filter by the name.
        - name: owner_identity_id
          in: query
          required: false
          schema:
            type: string
            example: IDcWwprrKrD6cSh225JWPri3
          description: Filter by the owner id of the associated `Identity`.
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - ALL
              - BANK_ACCOUNT
              - PAYMENT_CARD
            example: BANK_ACCOUNT
          description: Filter by the `Payment Instrument` type.
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/payment_instruments" \
              -H "Content-Type: application/json" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listPaymentInstruments'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /payment_instruments/{payment_instrument_id}:
    get:
      summary: Fetch a Payment Instrument
      operationId: getPaymentInstrument
      description: Retrieve the details of an existing `Payment Instrument`.
      tags:
        - Payment Instruments
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          description: A single `Payment Instrument`
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/payment_instrument_card'
                  - $ref: '#/components/schemas/payment_instrument_bank'
              examples:
                Payment Instrument:
                  value:
                    id: PI6F5kkcCB3dtGhFy1t8Aua5
                    created_at: '2024-11-15T09:42:33.42Z'
                    updated_at: '2024-11-15T09:42:33.42Z'
                    account_updater_enabled: false
                    application: APgPDQrLD52TYvqazjHJJchM
                    created_via: API
                    currency: USD
                    disabled_code: null
                    disabled_message: null
                    enabled: true
                    fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
                    identity: IDgWxBhfGYLLdkhxx2ddYf9K
                    instrument_type: PAYMENT_CARD
                    address:
                      line1: 900 Metro Center Blv
                      line2: null
                      city: San Francisco
                      region: CA
                      postal_code: '94404'
                      country: USA
                    address_verification: UNKNOWN
                    bin: '520082'
                    brand: MASTERCARD
                    card_type: DEBIT
                    expiration_month: 12
                    expiration_year: 2029
                    issuer_country: NON_USA
                    last_four: '8210'
                    name: John Smith
                    network_token_enabled: false
                    network_token_state: NOT_ENABLED
                    security_code_verification: UNKNOWN
                    tags: {}
                    third_party: null
                    third_party_token: null
                    type: PAYMENT_CARD
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                      updates:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/updates
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
      x-group-parameters: true
    parameters:
      - description: The `Payment Instrument` ID.
        in: path
        name: payment_instrument_id
        required: true
        schema:
          type: string
    put:
      summary: Update a Payment Instrument
      operationId: updatePaymentInstrument
      description: >-
        Update a `Payment Instrument` to:

        - Change the **billing address** in case the account holder moved
        (`instrument_type`:**PAYMENT_CARD** only).

        - Disable the `Payment Instrument` resource so it can't be used in
        requests.

        - Update the `name` on the `Payment Instrument`.

        - Change the `tags`.

        - Enable or disable **Account Updater**.

        - Enable or disable **Network Tokens**.
      tags:
        - Payment Instruments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: >-
                    #/components/schemas/updatePaymentInstrumentBankAccountValidationCheck
                - $ref: '#/components/schemas/updatePaymentInstrumentDisable'
                - $ref: '#/components/schemas/updatePaymentInstrumentAccountUpdater'
                - $ref: '#/components/schemas/updatePaymentInstrumentNetworkTokens'
                - $ref: '#/components/schemas/updatePaymentInstrumentCardAddress'
                - $ref: '#/components/schemas/updatePaymentInstrumentName'
                - $ref: '#/components/schemas/updatePaymentInstrumentTags'
                - $ref: >-
                    #/components/schemas/updatePaymentInstrumentAddressGoogleApplePay
            examples:
              Payment Instrument - Bank Account Validation Check:
                value:
                  attempt_bank_account_validation_check: 'true'
              Payment Instrument - Disable a Payment Instrument:
                value:
                  enabled: false
              Payment Instrument - Enable Account Updater:
                value:
                  account_updater_enabled: true
              Payment Instrument - Enable Network Tokens:
                value:
                  network_token_enabled: true
              Payment Instrument - Update Card Address:
                value:
                  address:
                    city: Los Angeles
                    region: CA
                    postal_code: '90036'
                    line1: 270 Lincoln Center Blv
                    line2: Suite 1A
                    country: USA
                  merchant: MUjJUJxMKoL24H8MotYNjtZP
                  verify_payment_card: true
              Payment Instrument - Update Name:
                value:
                  name: Todd Murphy
              Payment Instrument - Update Tags:
                value:
                  tags:
                    card_name: Personal Card
              Payment Instrument - Add Address for Google or Apply Pay:
                value:
                  address:
                    city: San Francisco
                    country: USA
                    line1: 900 Metro Center Blv
                    line2: APT 200
                    postal_code: '94404'
                    region: CA
      responses:
        '200':
          description: A single `Payment Instrument`
          content:
            application/json:
              schema:
                oneOf:
                  - title: Payment Instrument - Bank Account Validation Check
                    allOf:
                      - $ref: '#/components/schemas/payment_instrument_bank'
                  - title: Payment Instrument - Disable a Payment Instrument
                    allOf:
                      - $ref: '#/components/schemas/payment_instrument_card'
                  - title: Payment Instrument - Enable Account Updater
                    allOf:
                      - $ref: '#/components/schemas/payment_instrument_card'
                  - title: Payment Instrument - Enable Network Tokens
                    allOf:
                      - $ref: '#/components/schemas/payment_instrument_card'
                  - title: Payment Instrument - Update Card Address
                    allOf:
                      - $ref: '#/components/schemas/payment_instrument_card'
                  - title: Payment Instrument - Update Name
                    allOf:
                      - $ref: '#/components/schemas/payment_instrument_card'
                  - title: Payment Instrument - Update Tags
                    allOf:
                      - $ref: '#/components/schemas/payment_instrument_card'
                  - title: Payment Instrument - Add Address for Google or Apply Pay
                    allOf:
                      - $ref: '#/components/schemas/payment_instrument_card'
              examples:
                Payment Instrument - Bank Account Validation Check:
                  value:
                    id: PIpU66orYpdrPSs91fqRJd66
                    created_at: '2023-03-13T23:28:34.10Z'
                    updated_at: '2023-03-13T23:28:34.10Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    created_via: API
                    currency: USD
                    disabled_code: null
                    disabled_message: null
                    enabled: true
                    fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
                    identity: IDpYDM7J9n57q849o9E9yNrG
                    instrument_type: BANK_ACCOUNT
                    account_type: SAVINGS
                    bank_account_validation_check: VALID
                    bank_code: '123123123'
                    country: USA
                    masked_account_number: XXXXX3123
                    name: null
                    tags: {}
                    type: BANK_ACCOUNT
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
                Payment Instrument - Disable a Payment Instrument:
                  value:
                    id: PIwbvcQGrEP33HShmYM7BR8o
                    created_at: '2023-02-28T19:05:56.24Z'
                    updated_at: '2023-02-28T21:16:18.80Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    created_via: API
                    currency: USD
                    disabled_code: USER_INITIATED
                    disabled_message: The card has been disabled by a user.
                    enabled: false
                    fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
                    identity: IDpYDM7J9n57q849o9E9yNrG
                    instrument_type: BANK_ACCOUNT
                    account_type: SAVINGS
                    bank_account_validation_check: NOT_ATTEMPTED
                    bank_code: '123123123'
                    country: USA
                    masked_account_number: XXXXX3123
                    name: null
                    tags:
                      card_name: Personal Card
                    type: BANK_ACCOUNT
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
                Payment Instrument - Enable Account Updater:
                  value:
                    id: PIwWisLuZNwPBoLbCgQVTCoY
                    created_at: '2022-08-15T23:13:06.13Z'
                    updated_at: '2024-11-15T12:38:05.33Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    created_via: API
                    currency: USD
                    disabled_code: null
                    disabled_message: null
                    enabled: true
                    fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
                    identity: IDgWxBhfGYLLdkhxx2ddYf9K
                    instrument_type: PAYMENT_CARD
                    account_updater_enabled: true
                    address:
                      line1: 270 Lincoln Center Blv
                      line2: Suite 1A
                      city: Los Angeles test
                      region: CA
                      postal_code: '90036'
                      country: USA
                    address_verification: UNKNOWN
                    bin: '400000'
                    brand: VISA
                    card_type: UNKNOWN
                    expiration_month: 12
                    expiration_year: 2029
                    issuer_country: UNKNOWN
                    last_four: '9979'
                    name: Todd Murphy
                    network_token_enabled: false
                    network_token_state: NOT_ENABLED
                    security_code_verification: MATCHED
                    online_gambling_block_indicator: testValue
                    tags:
                      card_name: Personal Card
                    third_party: null
                    third_party_token: null
                    type: PAYMENT_CARD
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                      updates:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates
                Payment Instrument - Enable Network Tokens:
                  value:
                    id: PIwWisLuZNwPBoLbCgQVTCoY
                    created_at: '2022-08-15T23:13:06.13Z'
                    updated_at: '2024-11-15T12:39:28.53Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    created_via: API
                    currency: USD
                    disabled_code: null
                    disabled_message: null
                    enabled: true
                    fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
                    identity: IDgWxBhfGYLLdkhxx2ddYf9K
                    instrument_type: PAYMENT_CARD
                    account_updater_enabled: false
                    address:
                      line1: 270 Lincoln Center Blv
                      line2: Suite 1A
                      city: Los Angeles test
                      region: CA
                      postal_code: '90036'
                      country: USA
                    address_verification: UNKNOWN
                    bin: '400000'
                    brand: VISA
                    card_type: UNKNOWN
                    expiration_month: 12
                    expiration_year: 2029
                    issuer_country: UNKNOWN
                    last_four: '9979'
                    name: Todd Murphy
                    network_token_enabled: true
                    network_token_state: ENABLED
                    security_code_verification: MATCHED
                    online_gambling_block_indicator: testValue
                    tags:
                      card_name: Personal Card
                    third_party: null
                    third_party_token: null
                    type: PAYMENT_CARD
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                      updates:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates
                Payment Instrument - Update Card Address:
                  value:
                    id: PIwWisLuZNwPBoLbCgQVTCoY
                    created_at: '2022-08-15T23:13:06.13Z'
                    updated_at: '2023-02-28T21:12:29.72Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    created_via: API
                    currency: USD
                    disabled_code: null
                    disabled_message: null
                    enabled: true
                    fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
                    identity: IDgWxBhfGYLLdkhxx2ddYf9K
                    instrument_type: PAYMENT_CARD
                    address:
                      line1: 900 Metro Center Blv
                      line2: Suite 200
                      city: Los Angeles
                      region: CA
                      postal_code: '94404'
                      country: USA
                    address_verification: UNKNOWN
                    bin: '400000'
                    brand: VISA
                    card_type: UNKNOWN
                    expiration_month: 12
                    expiration_year: 2029
                    issuer_country: UNKNOWN
                    last_four: '9979'
                    name: Amy White
                    security_code_verification: UNMATCHED
                    tags:
                      card_name: Business Card
                      custom_key: custome value
                    type: PAYMENT_CARD
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                      updates:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates
                Payment Instrument - Update Name:
                  value:
                    id: PIwWisLuZNwPBoLbCgQVTCoY
                    created_at: '2022-08-15T23:13:06.13Z'
                    updated_at: '2023-02-28T21:12:29.72Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    created_via: API
                    currency: USD
                    disabled_code: null
                    disabled_message: null
                    enabled: true
                    fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
                    identity: IDgWxBhfGYLLdkhxx2ddYf9K
                    instrument_type: PAYMENT_CARD
                    address:
                      line1: 900 Metro Center Blv
                      line2: Suite 200
                      city: Los Angeles
                      region: CA
                      postal_code: '94404'
                      country: USA
                    address_verification: UNKNOWN
                    bin: '400000'
                    brand: VISA
                    card_type: UNKNOWN
                    expiration_month: 12
                    expiration_year: 2029
                    issuer_country: UNKNOWN
                    last_four: '9979'
                    name: Todd Murphy
                    security_code_verification: UNMATCHED
                    tags:
                      card_name: Business Card
                      custom_key: custome value
                    type: PAYMENT_CARD
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                      updates:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates
                Payment Instrument - Update Tags:
                  value:
                    id: PIwbvcQGrEP33HShmYM7BR8o
                    created_at: '2023-02-28T19:05:56.24Z'
                    updated_at: '2023-02-28T21:18:24.79Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    created_via: API
                    currency: USD
                    disabled_code: null
                    disabled_message: null
                    enabled: true
                    fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
                    identity: IDpYDM7J9n57q849o9E9yNrG
                    instrument_type: BANK_ACCOUNT
                    account_type: SAVINGS
                    bank_account_validation_check: NOT_ATTEMPTED
                    bank_code: '123123123'
                    country: USA
                    masked_account_number: XXXXX3123
                    name: null
                    tags:
                      card_name: Personal Card
                    type: BANK_ACCOUNT
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
                Payment Instrument - Add Address for Google or Apply Pay:
                  value:
                    id: PIf8dyFFcEGBqPhaG22hPyYs
                    created_at: '2022-10-10T05:36:55.27Z'
                    updated_at: '2022-10-10T05:36:55.27Z'
                    address:
                      city: San Francisco
                      country: USA
                      line1: 900 Metro Center Blv
                      line2: APT 200
                      postal_code: '94404'
                      region: CA
                    application: APeUfzF5qdNkBCtdgcf3333n
                    created_via: API
                    currency: USD
                    enabled: true
                    fingerprint: FPRrcobjtdU98gr4sjiqYR1Qg
                    identity: ID78Fh8mcnnzukVzbdoyex5y
                    instrument_type: GOOGLE_PAY
                    bin: '411111'
                    brand: VISA
                    card_type: UNKNOWN
                    expiration_month: 12
                    expiration_year: 2027
                    issuer_country: UNKNOWN
                    last_four: '1111'
                    name: Finix Sandbox
                    tags: {}
                    type: GOOGLE_PAY
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APeUfzF5qdNkBCtdgcf3333n
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/ID78Fh8mcnnzukVzbdoyex5y
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: update
      x-group-parameters: true
  /payment_instruments/{payment_instrument_id}/instrument_history:
    get:
      summary: List Instrument History Entries
      operationId: listInstrumentHistoryEntries
      description: >
        Whenever a stored payment card's details are updated, an `Instrument
        History Entry` is created. Use this endpoint to retrieve a list of
        `Instrument History Entries` for a specific `Payment Instrument`.
      tags:
        - Payment Instruments
      parameters:
        - schema:
            type: string
          name: payment_instrument_id
          description: >
            The `Payment Instrument` that triggered the creation of this
            `Instrument History Entry`.
          in: path
          required: true
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/limit'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl -i -X GET \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
              'https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history' \
              -H 'Finix-Version: 2022-02-01'
      responses:
        '200':
          $ref: '#/components/responses/listInstrumentHistoryEntries'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /payment_instruments/{payment_instrument_id_verify}:
    parameters:
      - schema:
          type: string
        name: payment_instrument_id_verify
        description: The ID of the `Payment Instrument` you wish to verify.
        in: path
        required: true
    put:
      summary: Verify CVV and AVS
      operationId: createPaymentInstrumentVerification
      description: Verify a `Payment Instrument` to determine CVV and AVS results.
      tags:
        - Payment Instruments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/updatePaymentInstrumentVerificationCVV'
                - $ref: >-
                    #/components/schemas/updatePaymentInstrumentVerificationAddress
            examples:
              CVV Verification:
                value:
                  merchant: MUcgYZswyRfqSSbvMsxuaHxZ
                  security_code: '123'
                  verify_payment_card: true
              Address Verification:
                value:
                  address:
                    city: San Francisco
                    country: USA
                    line1: 900 Metro Center Blv
                    postal_code: '94404'
                    region: CA
                  merchant: MUcgYZswyRfqSSbvMsxuaHxZ
                  verify_payment_card: true
      responses:
        '200':
          description: A single Payment Instrument.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_instrument_card'
              examples:
                CVV Verification:
                  value:
                    id: PImD9Yi8Q3cCqkaYUUQat8NS
                    created_at: '2024-12-04T07:58:45.34Z'
                    updated_at: '2025-08-12T15:40:13.74Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    created_via: API
                    currency: USD
                    disabled_code: null
                    disabled_message: null
                    enabled: true
                    fingerprint: FPRogKWsRQks2HGaau5eGR9AF
                    identity: ID6UfSm1d4WPiWgLYmbyeo3H
                    instrument_type: PAYMENT_CARD
                    account_updater_enabled: false
                    address:
                      line1: 900 Metro Center Blv
                      line2: null
                      city: San Francisco
                      region: CA
                      postal_code: '94404'
                      country: USA
                    address_verification: UNKNOWN
                    bin: '489514'
                    brand: VISA
                    card_type: UNKNOWN
                    expiration_month: 12
                    expiration_year: 2029
                    issuer_country: UNKNOWN
                    last_four: '0006'
                    name: Collen Wade
                    network_token_enabled: false
                    network_token_state: NOT_ENABLED
                    security_code_verification: MATCHED
                    online_gambing_block_indicator: testValue
                    tags:
                      card_name: Business_Card
                    third_party: null
                    third_party_token: null
                    type: PAYMENT_CARD
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                      updates:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/updates
                Address Verification:
                  value:
                    id: PImD9Yi8Q3cCqkaYUUQat8NS
                    created_at: '2024-12-04T07:58:45.34Z'
                    updated_at: '2025-11-07T21:47:31.04Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    created_via: API
                    currency: USD
                    disabled_code: null
                    disabled_message: null
                    enabled: true
                    fingerprint: FPRogKWsRQks2HGaau5eGR9AF
                    identity: ID6UfSm1d4WPiWgLYmbyeo3H
                    instrument_type: PAYMENT_CARD
                    account_updater_enabled: false
                    address:
                      line1: 900 Metro Center Blv
                      line2: null
                      city: San Francisco
                      region: CA
                      postal_code: '94404'
                      country: USA
                    address_verification: POSTAL_CODE_AND_STREET_MATCH
                    bin: '489514'
                    brand: VISA
                    card_type: UNKNOWN
                    expiration_month: 12
                    expiration_year: 2029
                    issuer_country: UNKNOWN
                    last_four: '0006'
                    name: Collen Wade
                    network_token_enabled: false
                    network_token_state: NOT_ENABLED
                    security_code_verification: UNKNOWN
                    online_gambing_block_indicator: testValue
                    tags:
                      card_name: Business_Card
                    third_party: null
                    third_party_token: null
                    type: PAYMENT_CARD
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS
                      authorizations:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/authorizations
                      transfers:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/transfers
                      verifications:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/verifications
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                      updates:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/updates
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: update
      keywords:
        includes:
          - address verification
          - AVS
          - card checks
          - card verification code
          - CVC
          - CVV
          - risk rules
          - security code
  /payment_instruments/{payment_instrument_id_verify}/verifications:
    parameters:
      - schema:
          type: string
        name: payment_instrument_id_verify
        description: The ID of the `Payment Instrument` you wish to verify.
        in: path
        required: true
    post:
      summary: Verify Push-to-Card Eligibility
      operationId: createPaymentInstrumentVerificationPushToCard
      description: >-
        Determine Push To Card eligibility for [Push To
        Card](../../../../guides/payouts/card-payouts) customers.
      tags:
        - Payment Instruments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/createPaymentInstrumentVerificationPushToCard
            examples:
              Verify Push-to-Card Eligibility:
                value:
                  processor: DUMMY_V1
                  tags:
                    card_name: Business_Card
      responses:
        '200':
          description: A single `Verification`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment-instrument-verification'
              examples:
                Verify Push-to-Card Eligibility:
                  value:
                    id: VI9cSUm3SDaLKtuL92Z34rK9
                    created_at: '2025-11-07T20:36:16.90Z'
                    updated_at: '2025-11-07T20:36:16.92Z'
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    identity: null
                    merchant: null
                    merchant_identity: null
                    messages: []
                    outcome_summary: null
                    outcomes: null
                    payment_instrument: PImD9Yi8Q3cCqkaYUUQat8NS
                    payment_instrument_verification_details:
                      push_to_card_domestic: null
                      push_to_card_cross_border: null
                      card_type: null
                      billing_currency: null
                      issuer_country: UNKNOWN
                    processor: DUMMY_V1
                    raw: null
                    state: PENDING
                    tags:
                      card_name: Business_Card
                    trace_id: 63eefc66-81a3-4f24-a09d-bb7650e23943
                    type: PAYMENT_INSTRUMENT
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/verifications/VI9cSUm3SDaLKtuL92Z34rK9
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      payment_instrument:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
      keywords:
        includes:
          - push-to-card verification
          - verify push-to-card
          - verify push-to-card eligibility
  /receipts:
    post:
      summary: Create a Receipt
      operationId: createReceipt
      description: >
        Create a `Receipt` resource to generate a receipt for a
        [Transfer](#Transfers) or [Authorization](#Authorizations). 


        ### Basic Details


        A `Receipt` should include basic details, such as the total amount,
        buyer billing information, merchant name, and contact information.


        ### Additional Details


        You can provide additional details on the `Receipt` as described below. 


        #### Include a breakdown of charges


        You can provide a breakdown of the additional charges/fees
        (`amount_breakdown`) that add up to the total amount, such as subtotal,
        shipping amount, or surcharge. 


        #### Display an itemized product list


        You can provide details of the products in the order (`items`),
        including product name, description, price, quantity, etc., for each
        item in this order.


        #### Include Additional Details


        You can provide additional details to be included on the receipt such as
        "Invoice Number", "VIN", "Service Date", or "Technician".
      x-group-parameters: true
      requestBody:
        $ref: '#/components/requestBodies/CreateReceiptRequest'
      responses:
        '201':
          $ref: '#/components/responses/Receipt'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      tags:
        - Receipts
      x-java-method-name: create
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
  /receipts/{receipt_id}:
    get:
      summary: Fetch a Receipt
      x-group-parameters: true
      parameters:
        - name: entity_id
          in: query
          schema:
            type: string
          description: >-
            The ID of the `Transfer` or `Authorization` for which the receipt
            was be generated.
      responses:
        '200':
          $ref: '#/components/responses/Receipt'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: getReceipt
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      x-java-method-name: get
      description: Retrieve the details of a previously created `Receipt`.
      tags:
        - Receipts
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
      - schema:
          type: string
        name: receipt_id
        description: The ID of the `Receipt`.
        in: path
        required: true
  /receipts/{receipt_id}/delivery_attempts:
    post:
      summary: Create a Delivery Attempt
      operationId: createReceiptDeliveryAttempt
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl -i -X POST \
                'https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts' \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -H 'Content-Type: application/json' \
                -H 'Finix-Version: 2022-02-01' \
                -d '{
                    "requested_delivery_methods": [
                        {
                            "type": "EMAIL",
                            "destinations": ["benroundtree@gmail.com"]
                        },
                        {
                            "type": "SMS",
                            "destinations": ["8005550175"]
                        },
                        {
                            "type": "PRINT",
                            "destinations": ["DVsEanpBtsAVvCHbNXkFaH6f"]
                        }
                    ]
                }'
      description: |
        Create a `Delivery Attempt` on an existing `Receipt` resource.
      x-group-parameters: true
      requestBody:
        $ref: '#/components/requestBodies/CreateDeliveryAttemptRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      tags:
        - Receipts
      x-java-method-name: create
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning)
    get:
      summary: List Delivery Attempts for a Receipt
      responses:
        '200':
          $ref: '#/components/responses/ListDeliveryAttemptsResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      operationId: listReceiptDeliveryAttempts
      x-java-method-name: list
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      description: >-
        Whenever a receipt is sent, a `Delivery Attempt` resource is created.
        Use this endpoint to retrieve a list of delivery attempts for a specific
        `Receipt`.
      tags:
        - Receipts
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
      - schema:
          type: string
        name: receipt_id
        description: The ID of the `Receipt`.
        in: path
        required: true
  /review_queue:
    get:
      summary: List Review Queue Items
      description: >
        Retrieve a list of `Review Queue Item` resources. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Review Queue Items
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/application_id'
        - $ref: '#/components/parameters/QueryBeforeCursor'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryEntityId'
        - $ref: '#/components/parameters/QueryEntityType'
        - $ref: '#/components/parameters/QueryIdFilter'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryOutcome'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
      responses:
        '200':
          $ref: '#/components/responses/ReviewQueueItemsResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/review_queue" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      operationId: listReviewQueueItems
      x-java-method-name: list
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
  /review_queue/{review_queue_item_id}:
    get:
      summary: Fetch a Review Queue Item
      description: >-
        Retrieve the details of a `Review Queue Item` corresponding to a
        `Settlement`.
      tags:
        - Review Queue Items
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/ReviewQueueItemResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/review_queue/RKf8WeNhCKbjPv5Kc8ehc19R"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      operationId: getReviewQueueItem
      x-java-method-name: get
    put:
      summary: Update a Review Queue Item
      description: |
        Update an existing `Review Queue Item` resource.
      tags:
        - Review Queue Items
      x-group-parameters: true
      requestBody:
        $ref: '#/components/requestBodies/UpdateReviewQueueItemRequest'
      responses:
        '200':
          $ref: '#/components/responses/ReviewQueueItemResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: updateReviewQueueItem
      x-java-method-name: update
    parameters:
      - schema:
          type: string
        name: review_queue_item_id
        description: The ID of the `Review Queue Item`.
        in: path
        required: true
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
  /settlements:
    get:
      tags:
        - Settlements
      description: >-
        Retrieve a list of `Settlements`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      summary: List All Settlements
      operationId: listSettlements
      parameters:
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
        - $ref: '#/components/parameters/application_id'
        - $ref: '#/components/parameters/QueryTotalAmountFilter'
        - $ref: '#/components/parameters/QueryTotalAmountGteFilter'
        - $ref: '#/components/parameters/QueryTotalAmountGtFilter'
        - $ref: '#/components/parameters/QueryTotalAmountLteFilter'
        - $ref: '#/components/parameters/QueryTotalAmountLtFilter'
        - $ref: '#/components/parameters/QueryStatus'
        - $ref: '#/components/parameters/merchant_id'
        - schema:
            type: boolean
          in: query
          name: is_exception
          description: Filter to return if settlement is an exception settlement.
        - schema:
            type: string
          in: query
          name: transfer_id
          description: Filter by a `transfer_id` a `Settlement` has accrued.
        - schema:
            type: string
          in: query
          name: split_transfer_id
          description: Filter by a `split_transfer_id` a `Settlement` has accrued.
        - schema:
            type: string
          in: query
          name: funding_transfer_id
          description: Filter by a `funding_transfer` a `Settlement` has created.
      responses:
        '200':
          $ref: '#/components/responses/SettlementsList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/settlements/" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
  /settlements/{settlement_id}:
    get:
      tags:
        - Settlements
      description: Retrieve the details of a `Settlement`.
      summary: Fetch a Settlement
      operationId: getSettlement
      responses:
        '200':
          $ref: '#/components/responses/Settlement'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    parameters:
      - description: ID of `Settlement` object.
        required: true
        in: path
        name: settlement_id
        schema:
          type: string
    put:
      summary: Close a Settlement
      operationId: closesettlements
      responses:
        '201':
          $ref: '#/components/responses/CloseSettlementResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorUnauthorized'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: >-
        Close an accruing `settlement`.


        Finix, by default, creates accruing `settlements` then closes them based
        on your payout configurations. Use this endpoint to manually close a
        specific `settlement`.


        The closed `Settlement` will not accrue any further transactions and
        gets immediately submitted for approval.

        - This endpoint is only available to Finix Core customers. If you have
        any questions, please contact the [Finix Support
        Team](mailto:support@finix.com).

        - Any refunded `Transfers` get included in `Settlements` as a
        deduction. 

        - **PENDING** `Transfers` don't get included in `Settlements`.

        - The `total_amount` minus the `total_fee` equals the `net_amount`. The
        `net_amount` is the amount in cents that gets deposited into the
        seller's bank account.
      requestBody:
        $ref: '#/components/requestBodies/CloseSettlement'
      x-java-method-name: put
      tags:
        - Settlements
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
  /settlements/{settlement_id}/entries:
    get:
      description: >-
        Retrieve a list of every `Settlement Entry` in a `Settlement`. A
        settlement entry is an object that describes the item inside of a
        settlement. Transfers, Split Transfers and Custom fees can all be
        represented by a Settlement Entry. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)      
      summary: List all Entries in a Settlement
      operationId: listSettlementEntries
      responses:
        '200':
          $ref: '#/components/responses/SettlementEntriesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-internal: false
      x-java-method-name: listEntriesBySettlementId
      x-group-parameters: true
      tags:
        - Settlements
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    delete:
      tags:
        - Settlements
      description: >-
        Remove a `Settlement Entry` that makes up a `Settlement`.


        As long as the `Settlement` hasn't been funded, you can remove the
        `Settlement Entry` or an array of `Settlement Entries`, along with its
        corresponding fee entry from the encompassing `Settlement`.


        > Per the JSON API for deleting a resource, our API doesn't have a
        response body when removing a `Settlement Entry` from a `Settlement`.
      summary: Delete Settlement Entries
      operationId: removeSettlementEntries
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-internal: false
      x-java-method-name: removeEntriesFromSettlement
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -X DELETE \
                -d '{
                    "settlement_entry_ids": ["SES3mw1tex35wqhh7fUQTPv"]
                }'
      requestBody:
        $ref: '#/components/requestBodies/RemoveSettlementEntries'
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - description: ID of `Settlement` object.
        required: true
        in: path
        name: settlement_id
        schema:
          type: string
  /settlements/{settlement_id}/funding_transfers:
    get:
      tags:
        - Settlements
      description: >-
        List the funding `Transfers` that were created when a `Settlement` was
        approved that have `type` **CREDIT** or **DEBIT**.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      summary: List Settlement Funding Transfers
      operationId: listSettlementFundingTransfers
      responses:
        '200':
          $ref: '#/components/responses/ListSettlementFundingTransfersResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: listFundingTransfers
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    parameters:
      - description: ID of `Settlement` object.
        required: true
        in: path
        name: settlement_id
        schema:
          type: string
  /settlements/{settlement_id}/transfers:
    delete:
      tags:
        - Settlements
      description: >-
        Remove one or more `Transfer` objects that make up a `Settlement`.


        As long as the `Settlement` has not been funded, you can remove the
        `Transfer` or an array of `Transfers`, along with its corresponding
        `fee` from the encompassing `Settlement`.

        - Funding `transfers` can't be deleted.



        > Per the JSON API for deleting a resource, our API doesn't have a
        response body when removing a `Transfer` from a `Settlement`.
      summary: Delete Settlement Transfers
      operationId: removeSettlementTransfers
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-internal: false
      x-java-method-name: removeTransfersFromSettlement
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/transfers"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -X DELETE \
                -d '{
                    "transfers": ["TRtxYyGJXZ5h1kENd2aMeqjK"]
                }'
      requestBody:
        $ref: '#/components/requestBodies/RemoveSettlementTransfer'
    get:
      description: >-
        > ##### <u>This endpoint is deprecated</u>.<br/>

        > Use [List all Entries in a
        Settlement](/api/settlements/listsettlemententries) instead.

        ---


        Retrieve a list of every `Transfer` in a `Settlement` that has `type`
        `DEBIT` or `REFUND`. This is not an exhaustive list of everything that
        comprises a settlement. We recommend using  [List Settlement
        Entries](#operation/listSettlementEntries).


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)      
      summary: List all Transfers in a Settlement
      operationId: listSettlementTransfers
      responses:
        '200':
          $ref: '#/components/responses/ListSettlementTransfersResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-internal: false
      x-java-method-name: listTransfersBySettlementId
      x-group-parameters: true
      tags:
        - Settlements
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - description: ID of `Settlement` object.
        required: true
        in: path
        name: settlement_id
        schema:
          type: string
  /settlements/{settlement_id}/funding_transfer_attempts:
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - description: ID of `Settlement` object.
        required: true
        in: path
        name: settlement_id
        schema:
          type: string
    get:
      tags:
        - Settlements
      description: >-
        Lists all funding transfer attempts associated for the settlement. A
        Funding Transfer Attempt resource is created when requesting an instant
        payout of funds for the settlement.
      summary: List Settlement Funding Transfer Attempts
      responses:
        '200':
          $ref: '#/components/responses/FundingTransferAttemptsList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: listSettlementFundingTransferAttempts
    post:
      tags:
        - Settlements
      description: >-
        Create a funding transfer attempt for this settlement. Funding transfer
        attempts are used to submit funds for instant payout.
      summary: Create Settlement Funding Transfer Attempt
      requestBody:
        $ref: '#/components/requestBodies/CreateFundingTransferAttemptRequest'
      responses:
        '201':
          $ref: '#/components/responses/FundingTransferAttempt'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: createSettlementFundingTransferAttempt
  /settlement_queue_entries:
    get:
      summary: List Settlement Queue Entries
      description: >
        Retrieve a list of `Settlement Queue Entry` resources. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Settlement Queue Entries
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/application_id'
        - $ref: '#/components/parameters/QueryBeforeCursor'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - name: entity_id
          description: >-
            Filter by the entity_id of the resource inside the
            settlement_queue_entry.
          in: query
          schema:
            type: string
            example: TRdhp3DszqDKbNvwtn7DDcUi
        - name: entity_type
          description: Filter by `entity_type`.
          in: query
          schema:
            type: string
            example: TRANSFER
          style: form
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/merchant_id'
        - name: ready_to_settle_after.gte
          description: |
            Filter where `ready_to_settle_after` is after the given date.
          in: query
          schema:
            type: string
            example: '2023-06-28T00:00:00'
            format: date-time
          style: form
        - name: ready_to_settle_after.lte
          description: |
            Filter where `ready_to_settle_after` is before the given date.
          in: query
          schema:
            type: string
            example: '2026-09-27T11:21:23'
            format: date-time
          style: form
        - $ref: '#/components/parameters/state'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
      responses:
        '200':
          $ref: '#/components/responses/SettlementQueueEntries'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: listSettlementQueueEntries
      x-java-method-name: list
    put:
      summary: Update Settlement Queue Entries
      description: >
        This action is used to release a number of `Settlement Queue Entry`
        resources, allowing them to be included in a `Settlement` as `Settlement
        Entry` resources.
      tags:
        - Settlement Queue Entries
      x-group-parameters: true
      requestBody:
        $ref: '#/components/requestBodies/UpdateSettlementQueueEntriesRequest'
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: updateSettlementQueueEntries
      x-java-method-name: update
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).
  /settlement_queue_entries/{settlement_queue_entry_id}:
    get:
      summary: Fetch a Settlement Queue Entry
      description: >-
        Retrieve the details of a `Settlement Queue Entry` created from a
        `Transfer`, `Fee`, or `Reversal`.
      tags:
        - Settlement Queue Entries
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/SettlementQueueEntry'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: getSettlementQueueEntry
      x-java-method-name: get
    parameters:
      - schema:
          type: string
        name: settlement_queue_entry_id
        description: The ID of the `Settlement Queue Entry`.
        in: path
        required: true
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).
  /transfers:
    post:
      summary: Create a Transfer
      operationId: createTransfer
      description: Create a `Transfer`.
      tags:
        - Transfers
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/createTransferMinimalFields'
                - $ref: '#/components/schemas/createTransferAllFields'
                - $ref: '#/components/schemas/createTransferCanadaEFT'
                - $ref: '#/components/schemas/createTransfer3DSecure'
                - $ref: '#/components/schemas/createTransferBankPayout'
                - $ref: '#/components/schemas/createTransferBankPayoutSameDay'
                - $ref: '#/components/schemas/createTransferCardPayout'
                - $ref: '#/components/schemas/createTransferCardPresent'
                - $ref: '#/components/schemas/createTransferUnreferencedRefund'
                - $ref: '#/components/schemas/createTransferCardVerificationCheck'
                - $ref: '#/components/schemas/createTransferConvenienceFee'
                - $ref: '#/components/schemas/createTransferDebitBankAccount'
                - $ref: '#/components/schemas/createTransferFeeProfile'
                - $ref: '#/components/schemas/createTransferFraudDetection'
                - $ref: '#/components/schemas/createTransferGaming'
                - $ref: '#/components/schemas/createTransferHSAorFSACard'
                - $ref: '#/components/schemas/createTransferLvl2Processing'
                - $ref: '#/components/schemas/createTransferLvl3Processing'
                - $ref: '#/components/schemas/createTransferPartialAuthorization'
                - $ref: '#/components/schemas/createTransferRentSurcharge'
                - $ref: '#/components/schemas/createTransferSplitTransaction'
                - $ref: '#/components/schemas/createTransferSurcharge'
            examples:
              Transfer - Minimal Fields:
                value:
                  amount: 662154
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PI6iQcTtJNCS8GZAVKYi5Ueb
                  tags:
                    test: Sale
              Transfer - All Fields:
                value:
                  3d_secure_authentication:
                    cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
                    electronic_commerce_indicator: AUTHENTICATED
                    transaction_id: EaOMucALHQqLAEGAgk
                  additional_buyer_charges:
                    convenience_amount: 150
                  amount: 1000
                  additional_purchase_data:
                    item_data:
                      - amount_excluding_sales_tax: 400
                        amount_including_sales_tax: 500
                        commodity_code: 175-62-20
                        cost_per_unit: 500
                        item_description: printing paper
                        item_discount_amount: 100
                        merchant_product_code: '1149611'
                        quantity: 1
                        unit_of_measure: BX
                      - amount_excluding_sales_tax: 400
                        amount_including_sales_tax: 500
                        commodity_code: 207-72-54
                        cost_per_unit: 500
                        item_description: printing ink
                        item_discount_amount: 0
                        merchant_product_code: '2149612'
                        quantity: 1
                        unit_of_measure: CTN
                    customer_reference_number: 321xyz
                    customs_duty_amount: 10
                    discount_amount: 100
                    shipping_amount: 100
                  currency: USD
                  fee_profile: FP9F2KEnY4wt1XjFvhLBJVjb
                  fraud_session_id: test_fraud
                  idempotency_id: 1234567890
                  ip_address_v4: 104.59.125.155
                  merchant: MUe17jKSrfPetoeiJQzzjmA2
                  source: PI6iQcTtJNCS8GZAVKYi5Ueb
                  security_code: '022'
                  split_transfers:
                    - merchant: MUe17jKSrfPetoeiJQzzjmA2
                      amount: 500
                      tags:
                        key: value
                    - merchant: MUgpr2egkP7mPvYF4HcK1ieV
                      amount: 500
                      fee: 100
                  statement_descriptor: Flex Gym
                  tags:
                    tip: 50
              Transfer - Canada - EFT:
                value:
                  amount: 662154
                  currency: CAD
                  merchant: MUhwFv8Lu47h8Uwrtjeksovd
                  source: PIsKASzY2Xn5M15n2TuCY8D5
                  tags:
                    test: Sale
              Transfer - 3D Secure:
                value:
                  3d_secure_authentication:
                    cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
                    electronic_commerce_indicator: AUTHENTICATED
                    transaction_id: EaOMucALHQqLAEGAgk
                  amount: 92169
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PI6iQcTtJNCS8GZAVKYi5Ueb
                  tags:
                    test: Sale
              Transfer - Bank Payout:
                value:
                  currency: USD
                  amount: 15000
                  operation_key: PUSH_TO_ACH
                  processor: DUMMY_V1
                  destination: PI95jTbyzcdjhWsgFEK6vqSU
              Transfer - Bank Payout - Same Day:
                value:
                  currency: USD
                  amount: 15000
                  operation_key: PUSH_TO_SAME_DAY_ACH
                  processor: DUMMY_V1
                  destination: PI95jTbyzcdjhWsgFEK6vqSU
              Transfer - Card Payout:
                value:
                  currency: USD
                  amount: 15000
                  operation_key: PUSH_TO_CARD
                  processor: DUMMY_V1
                  destination: PIveyqg2bVkKo6SHsstxBSDc
              Transfer - Card Present:
                value:
                  amount: 150
                  currency: USD
                  device: DVhXqP9onzhA7sxheKXoBc3J
                  operation_key: CARD_PRESENT_SALE
              Transfer - Card Present - Unreferenced Refund:
                value:
                  amount: 150
                  currency: USD
                  device: DVoDo7F6yYCnX2d6Fj9hvsd
                  operation_key: CARD_PRESENT_UNREFERENCED_REFUND
              Transfer - Card Verification Checks:
                value:
                  amount: 92169
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  security_code: '022'
                  source: PIkxmtueemLD6dN9ZoWGHT44
                  tags:
                    order_number: 21DFASJSAKAS
              Transfer - Convenience Fee:
                value:
                  additional_buyer_charges:
                    convenience_amount: 150
                  amount: 5200
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PIkxmtueemLD6dN9ZoWGHT44
                  tags:
                    delivery_service_fee: 30000
              Transfer - Debit Bank Account:
                value:
                  amount: 6031
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PI9XuhFdFzJ5V9aGYUm6XtH
                  tags:
                    order_number: 21DFASJSAKAS
              Transfer - Fee Profile:
                value:
                  amount: 662154
                  currency: USD
                  fee_profile: FP9F2KEnY4wt1XjFvhLBJVjb
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PI6iQcTtJNCS8GZAVKYi5Ueb
              Transfer - Fraud Detection:
                value:
                  amount: 662154
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PI6iQcTtJNCS8GZAVKYi5Ueb
                  fraud_session_id: test_fraud
                  tags:
                    test: Sale
              Transfer - Gaming:
                value:
                  amount: 100
                  currency: USD
                  merchant: MUmKTKuetVV1MQ5Cq6rjWA5j
                  source: PIkxmtueemLD6dN9ZoWGHT44
                  ip_address_v4: 192.168.1.1
                  tags:
                    order_number: 21DFASJSAKAS
              Transfer - HSA or FSA Card for Non-Healthcare MCC:
                value:
                  additional_healthcare_data:
                    clinic_amount: 50
                    dental_amount: 200
                    prescription_amount: 300
                    vision_amount: 300
                  amount: 950
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PI6iQcTtJNCS8GZAVKYi5Ueb
                  tags:
                    order_number: 21DFASJSAKAS
              Transfer - Level 2 Processing:
                value:
                  additional_purchase_data:
                    customer_reference_number: 321xyz
                    sales_tax: 200
                  amount: 1000
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PI6iQcTtJNCS8GZAVKYi5Ueb
                  tags:
                    test: Sale
              Transfer - Level 3 Processing:
                value:
                  additional_purchase_data:
                    item_data:
                      - amount_excluding_sales_tax: 400
                        amount_including_sales_tax: 500
                        commodity_code: 175-62-20
                        cost_per_unit: 500
                        item_description: printing paper
                        item_discount_amount: 100
                        merchant_product_code: '1149611'
                        quantity: 1
                        unit_of_measure: BX
                      - amount_excluding_sales_tax: 400
                        amount_including_sales_tax: 500
                        commodity_code: 207-72-54
                        cost_per_unit: 500
                        item_description: printing ink
                        item_discount_amount: 0
                        merchant_product_code: '2149612'
                        quantity: 1
                        unit_of_measure: CTN
                    customer_reference_number: 321xyz
                    customs_duty_amount: 10
                    discount_amount: 100
                    shipping_amount: 100
                  amount: 1000
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PI6iQcTtJNCS8GZAVKYi5Ueb
                  tags:
                    test: Sale
              Transfer - Partial Authorization:
                value:
                  amount: 662154
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  partial_authorization: true
                  source: PI6iQcTtJNCS8GZAVKYi5Ueb
              Transfer - Rent Surcharge:
                value:
                  additional_buyer_charges:
                    rent_surcharge_amount: 1000
                  amount: 1001000
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PIkxmtueemLD6dN9ZoWGHT44
                  tags:
                    rental_fee: 1000
              Transfer - Split Transaction:
                value:
                  amount: 1000
                  currency: USD
                  merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                  source: PI5benj4eVhCL4ALMv6SFxJG
                  split_transfers:
                    - merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      amount: 600
                      tags:
                        key: value
                    - merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      amount: 400
                      fee: 100
              Transfer - Surcharge:
                value:
                  additional_buyer_charges:
                    surcharge_amount: 700
                  amount: 10000
                  currency: USD
                  merchant: MU3PLsrxmHcKRKhSoHDJ2FPP
                  source: PImn9EAtceoUcBoXG2n73LY9
                  tags:
                    surcharge_amount: 300
      responses:
        '201':
          $ref: '#/components/responses/createTransfer'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
    get:
      summary: List Transfers
      operationId: listTransfers
      description: >
        Retrieve a list of `Transfers`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Transfers
      parameters:
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/amount.gt'
        - $ref: '#/components/parameters/amount.gte'
        - $ref: '#/components/parameters/amount.lt'
        - $ref: '#/components/parameters/amount.lte'
        - $ref: '#/components/parameters/amount'
        - name: bank_return_reason_code
          description: >-
            Filter bank reversals by ACH Return Code. Use comma-separation to
            query for multiple values.
          in: query
          schema:
            type: string
            example: R03,R07
        - $ref: '#/components/parameters/before_cursor'
        - name: buyer_business_name
          description: Filter by the Buyer Identity's business name (exact match).
          in: query
          schema:
            type: string
            example: Finix%20Flowers
        - name: buyer_business_name.like
          description: Filter by the Buyer Identity's business name (partial match).
          in: query
          schema:
            type: string
            example: finix
        - name: buyer_doing_business_as
          description: Filter by the Buyer Identity's Doing Business As (exact match).
          in: query
          schema:
            type: string
            example: Finix%20Flowers
        - name: buyer_doing_business_as.like
          description: Filter by the Buyer Identity's Doing Business As (partial match).
          in: query
          schema:
            type: string
            example: finix
        - name: buyer_identity_first_name
          description: Filter by the Buyer Identity's first name (exact match).
          in: query
          schema:
            type: string
            example: John
        - name: buyer_identity_first_name.like
          description: Filter by the Buyer Identity's first name (partial match).
          in: query
          schema:
            type: string
            example: joh
        - name: buyer_identity_id
          description: Filter by the Buyer Identity's ID.
          in: query
          schema:
            type: string
            example: ID6Qm3BQUxGFcCWZ185TS8sn
        - name: buyer_identity_last_name
          description: Filter by the Buyer Identity's last name (exact match).
          in: query
          schema:
            type: string
            example: Doe
        - name: buyer_identity_last_name.like
          description: Filter by the Buyer Identity's last name (partial match).
          in: query
          schema:
            type: string
            example: do
        - name: buyer_identity_name
          description: Filter by the Buyer Identity's full personal name (exact match).
          in: query
          schema:
            type: string
            example: John%20Doe
        - name: buyer_identity_name.like
          description: Filter by the Buyer Identity's full personal name (partial match).
          in: query
          schema:
            type: string
            example: john
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/currency'
        - $ref: '#/components/parameters/device'
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/idempotency_id'
        - name: instrument_account_last4
          description: >-
            For `BANK_ACCOUNT` Payment Instruments, filter by the last-4 digits
            of the bank account number (i.e., from the Payment Instrument's
            `masked_account_number`).
          in: query
          schema:
            type: string
            example: 1234
        - name: instrument_bin
          description: >-
            For `PAYMENT_CARD` Payment Instruments, filter by the first-6 digits
            of the card's number (i.e., the Payment Instrument's `bin`).
          in: query
          schema:
            type: string
            example: 601100
          style: form
        - name: instrument_brand_type
          description: >-
            For `PAYMENT_CARD` Payment Instruments, filter by the card's
            `brand`.
          in: query
          schema:
            type: string
            example: MASTERCARD
        - name: instrument_card_last4
          description: >-
            For `PAYMENT_CARD` Payment Instruments, filter by the last-4 digits
            of the card's number (i.e., the Payment Instrument's `last_four`).
          in: query
          schema:
            type: string
            example: 4242
        - name: instrument_issuer_country
          description: >-
            For `PAYMENT_CARD` Payment Instruments, filter by the card's issuing
            country (i.e., the Payment Instrument's `issuer_country`). Use
            comma-separation to query for multiple values.
          in: query
          schema:
            type: string
            example: USA,CAN
        - name: instrument_name
          description: Filter by the Payment Instrument's `name` (exact match).
          in: query
          schema:
            type: string
            example: Business%20Card
        - name: instrument_type
          description: Filter by the Payment Instrument's `type`.
          in: query
          schema:
            type: string
            enum:
              - PAYMENT_CARD
              - BANK_ACCOUNT
            example: PAYMENT_CARD
        - $ref: '#/components/parameters/limit'
        - name: merchant_id
          description: Filter by the Merchant's ID (i.e., the Transfer's `merchant`).
          in: query
          schema:
            type: string
            example: MUtAWVfXkf149BVi2cL2HvPU
        - name: merchant_identity_id
          description: >-
            Filter by the Merchant's Identity ID (i.e., the Transfer's
            `merchant_identity`).
          in: query
          schema:
            type: string
            example: IDtX3ciHPq2DDquCQJRwj7VW
        - name: merchant_identity_name
          description: >-
            Filter by the Merchant's name (i.e., the Merchant's
            `merchant_name`).
          in: query
          schema:
            type: string
            example: Finix%20Flowers
        - name: merchant_mid
          description: >-
            Filter by the Merchant's Merchant Identification Number (MID) (i.e.,
            the Merchant's `mid`).
          in: query
          schema:
            type: string
            example: FNXkitpwdmgMJ8Vz9FxKBCSza
        - name: merchant_processor_id
          description: >-
            Filter by the Merchant's processor (i.e., the Merchant's
            `processor`).
          in: query
          schema:
            type: string
            example: DUMMY_V1
        - name: ready_to_settle_at.gte
          description: >-
            Filter where `ready_to_settle_at` is after the given date. Only
            available on `Finix-Version: 2022-02-01`. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
          in: query
          schema:
            type: string
            example: '2023-06-28T00:00:00'
            format: date-time
        - name: ready_to_settle_at.lte
          description: >-
            Filter where `ready_to_settle_at` is before the given date. Only
            available on `Finix-Version: 2022-02-01`. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
          in: query
          schema:
            type: string
            example: '2023-06-28T00:00:00'
            format: date-time
        - name: state
          description: Filter by the transfer's state.
          in: query
          schema:
            type: string
            enum:
              - ALL
              - CANCELED
              - FAILED
              - PENDING
              - RETURNED
              - SUCCEEDED
            example: SUCCEEDED
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - $ref: '#/components/parameters/trace_id'
        - name: type
          description: Filter by `Transfer` type.
          in: query
          schema:
            type: string
            enum:
              - ALL
              - DEBIT
              - CREDIT
              - REVERSAL
              - SETTLEMENT
            example: REVERSAL
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/transfers" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listTransfers'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /transfers/{transfer_id}:
    get:
      summary: Fetch a Transfer
      operationId: getTransfer
      description: Retrieve a `Transfer`.
      tags:
        - Transfers
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          description: A single `Transfer` object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transfer'
              examples:
                Transfer:
                  value:
                    id: TR8fezr4xCMFJvH5rzCqrUkF
                    created_at: '2025-10-24T17:38:19.09Z'
                    updated_at: '2025-10-24T17:38:19.09Z'
                    additional_buyer_charges:
                      convenience_amount: 150
                      surcharge_amount: 0
                      rent_surcharge_amount: 0
                    additional_healthcare_data: null
                    additional_purchase_data:
                      customer_reference_number: 321xyz
                      customs_duty_amount: 10
                      destination_country_code: null
                      destination_postal_code: null
                      discount_amount: 100
                      invoice_reference_number: null
                      order_date: null
                      sales_tax: null
                      sales_tax_finix_generated: 200
                      ship_from_postal_code: null
                      shipping_amount: 100
                      tax_exempt: false
                      item_data:
                        - cost_per_unit: 500
                          item_description: printing paper
                          item_discount_amount: 100
                          merchant_product_code: '1149611'
                          quantity: 1
                          amount_excluding_sales_tax: 400
                          amount_including_sales_tax: 500
                          unit_of_measure: BX
                          commodity_code: 175-62-20
                          sales_tax_amount: 100
                          sales_tax_rate: 0.25
                        - cost_per_unit: 500
                          item_description: printing ink
                          item_discount_amount: 0
                          merchant_product_code: '2149612'
                          quantity: 1
                          amount_excluding_sales_tax: 400
                          amount_including_sales_tax: 500
                          unit_of_measure: CTN
                          commodity_code: 207-72-54
                          sales_tax_amount: 100
                          sales_tax_rate: 0.25
                    address_verification: POSTAL_CODE_AND_STREET_MATCH
                    amount: 1000
                    amount_requested: 1000
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    currency: USD
                    destination: null
                    externally_funded: UNKNOWN
                    failure_code: null
                    failure_message: null
                    fee: 0
                    fee_profile: FP9F2KEnY4wt1XjFvhLBJVjb
                    idempotency_id: '1234567890'
                    ip_address_details: null
                    merchant: MUe17jKSrfPetoeiJQzzjmA2
                    merchant_identity: ID6NvZy42D7PChZL8GKKD87F
                    messages: []
                    network_details:
                      brand: VISA
                      authorization_code: '252819'
                      acquirer_reference_number: null
                    operation_key: CARD_NOT_PRESENT_SALE
                    parent_transfer: null
                    parent_transfer_trace_id: null
                    raw: null
                    ready_to_settle_at: null
                    receipt_last_printed_at: null
                    security_code_verification: MATCHED
                    source: PI6iQcTtJNCS8GZAVKYi5Ueb
                    split_transfers:
                      - split_transfer_8fv2kE5eWtCvru1NG5gyRL
                      - split_transfer_8fvi9GJdhMbpWWJwKkHzct
                    state: SUCCEEDED
                    statement_descriptor: FLX*FLEX GYM
                    subtype: API
                    supplemental_fee: null
                    tags:
                      tip: '50'
                    tip_amount: null
                    trace_id: 0db5b7cf-6fe3-4508-ac52-15b26b9b5e0a
                    type: DEBIT
                    _links:
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/ID6NvZy42D7PChZL8GKKD87F
                      payment_instruments:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/payment_instruments
                      reversals:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/reversals
                      fees:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/fees
                      disputes:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/disputes
                      source:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                      fee_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/fee_profiles/FP9F2KEnY4wt1XjFvhLBJVjb
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
    parameters:
      - description: The ID of the `Transfer` resource.
        in: path
        name: transfer_id
        required: true
        schema:
          type: string
    put:
      summary: Update a Transfer
      operationId: updateTransfer
      description: Update a `Transfer`.
      tags:
        - Transfers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateTransfer'
            examples:
              Update a Transfer:
                value:
                  tags:
                    test: sale
      responses:
        '200':
          description: A single `Transfer`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transfer'
              examples:
                Transfer:
                  value:
                    id: TR8fezr4xCMFJvH5rzCqrUkF
                    created_at: '2025-10-24T17:38:19.09Z'
                    updated_at: '2025-10-24T17:38:19.09Z'
                    additional_buyer_charges:
                      convenience_amount: 150
                      surcharge_amount: 0
                      rent_surcharge_amount: 0
                    additional_healthcare_data: null
                    additional_purchase_data:
                      customer_reference_number: 321xyz
                      customs_duty_amount: 10
                      destination_country_code: null
                      destination_postal_code: null
                      discount_amount: 100
                      invoice_reference_number: null
                      order_date: null
                      sales_tax: null
                      sales_tax_finix_generated: 200
                      ship_from_postal_code: null
                      shipping_amount: 100
                      tax_exempt: false
                      item_data:
                        - cost_per_unit: 500
                          item_description: printing paper
                          item_discount_amount: 100
                          merchant_product_code: '1149611'
                          quantity: 1
                          amount_excluding_sales_tax: 400
                          amount_including_sales_tax: 500
                          unit_of_measure: BX
                          commodity_code: 175-62-20
                          sales_tax_amount: 100
                          sales_tax_rate: 0.25
                        - cost_per_unit: 500
                          item_description: printing ink
                          item_discount_amount: 0
                          merchant_product_code: '2149612'
                          quantity: 1
                          amount_excluding_sales_tax: 400
                          amount_including_sales_tax: 500
                          unit_of_measure: CTN
                          commodity_code: 207-72-54
                          sales_tax_amount: 100
                          sales_tax_rate: 0.25
                    address_verification: POSTAL_CODE_AND_STREET_MATCH
                    amount: 1000
                    amount_requested: 1000
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    currency: USD
                    destination: null
                    externally_funded: UNKNOWN
                    failure_code: null
                    failure_message: null
                    fee: 0
                    fee_profile: FP9F2KEnY4wt1XjFvhLBJVjb
                    idempotency_id: '1234567890'
                    ip_address_details: null
                    merchant: MUe17jKSrfPetoeiJQzzjmA2
                    merchant_identity: ID6NvZy42D7PChZL8GKKD87F
                    messages: []
                    network_details:
                      brand: VISA
                      authorization_code: '252819'
                      acquirer_reference_number: null
                    operation_key: CARD_NOT_PRESENT_SALE
                    parent_transfer: null
                    parent_transfer_trace_id: null
                    raw: null
                    ready_to_settle_at: null
                    receipt_last_printed_at: null
                    security_code_verification: MATCHED
                    source: PI6iQcTtJNCS8GZAVKYi5Ueb
                    split_transfers:
                      - split_transfer_8fv2kE5eWtCvru1NG5gyRL
                      - split_transfer_8fvi9GJdhMbpWWJwKkHzct
                    state: SUCCEEDED
                    statement_descriptor: FLX*FLEX GYM
                    subtype: API
                    supplemental_fee: null
                    tags:
                      tip: '50'
                    tip_amount: null
                    trace_id: 0db5b7cf-6fe3-4508-ac52-15b26b9b5e0a
                    type: DEBIT
                    _links:
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/ID6NvZy42D7PChZL8GKKD87F
                      payment_instruments:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/payment_instruments
                      reversals:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/reversals
                      fees:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/fees
                      disputes:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/disputes
                      source:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                      fee_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/fee_profiles/FP9F2KEnY4wt1XjFvhLBJVjb
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: update
  /transfers/{transfer_id}/reversals:
    post:
      summary: Refund or Reverse a Transfer
      operationId: createTransferReversal
      description: >
        Reverse a transfer with a `type` of `DEBIT`. This reversal creates a new
        `Transfer` resource with a `type` of `REVERSAL`. 


        Related Guides: [Refunding Payments](/guides/after-the-payment/refunds)
      tags:
        - Transfers
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/createTransferReversal'
                - $ref: '#/components/schemas/createTransferReversalSplitTransaction'
                - $ref: '#/components/schemas/createTransferReversalReferencedRefund'
            examples:
              Refund Transfer:
                value:
                  refund_amount: 662154
                  tags:
                    test: Refund
              Refund Transfer - Split Transaction:
                value:
                  refund_amount: 1000
                  split_transfers:
                    - merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      amount: 600
                      tags:
                        key: value
                    - merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      amount: 300
                      fee: 100
                  tags:
                    test: Refund
              Refund Card Present Transfer - Referenced:
                value:
                  device: DVtk6E4eWHsMzgZXvFaaUigM
                  refund_amount: 150
      responses:
        '201':
          description: The `Transfer` was successfully reversed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transfer'
              examples:
                Refund Transfer:
                  value:
                    id: TRi87Kgx6NdZFXkQtLXQ9NMJ
                    created_at: '2025-08-05T17:22:50.40Z'
                    updated_at: '2025-08-05T17:22:50.44Z'
                    additional_buyer_charges: null
                    additional_healthcare_data: null
                    additional_purchase_data: null
                    address_verification: null
                    amount: 50
                    amount_requested: 50
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    currency: USD
                    destination: PImXAVgkKVshKWWHUk4xXbve
                    externally_funded: UNKNOWN
                    failure_code: null
                    failure_message: null
                    fee: 0
                    fee_profile: FPmtT4MYmiAs1qjLjneQmk4d
                    idempotency_id: null
                    merchant: MUcgYZswyRfqSSbvMsxuaHxZ
                    merchant_identity: IDgCoio3FfaMSKPNM35atXPU
                    messages: []
                    operation_key: CARD_NOT_PRESENT_REFUND
                    parent_transfer: TRjAnCNNSxDCW8GDsxYobHHe
                    parent_transfer_trace_id: null
                    raw: null
                    ready_to_settle_at: null
                    receipt_last_printed_at: null
                    security_code_verification: null
                    source: null
                    split_transfers: []
                    state: PENDING
                    statement_descriptor: FLX*FINIX FLOWERS
                    subtype: API
                    supplemental_fee: null
                    tags:
                      test: Refund
                    tip_amount: null
                    trace_id: d1cb23da-3368-473d-bf8e-68d8e093839b
                    type: REVERSAL
                    _links:
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRi87Kgx6NdZFXkQtLXQ9NMJ
                      parent:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRjAnCNNSxDCW8GDsxYobHHe
                      destination:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PImXAVgkKVshKWWHUk4xXbve
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDgCoio3FfaMSKPNM35atXPU
                      payment_instruments:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRi87Kgx6NdZFXkQtLXQ9NMJ/payment_instruments
                      fee_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
                Refund Transfer - Split Transaction:
                  value:
                    id: TRXuEhedfgPC6T1aCjdUdKB
                    created_at: '2025-07-31T17:01:15.15Z'
                    updated_at: '2025-07-31T17:01:15.21Z'
                    additional_buyer_charges: null
                    additional_healthcare_data: null
                    additional_purchase_data: null
                    address_verification: null
                    amount: 1000
                    amount_requested: 1000
                    application: APc9vhYcPsRuTSpKD9KpMtPe
                    currency: USD
                    destination: PI5benj4eVhCL4ALMv6SFxJG
                    externally_funded: UNKNOWN
                    failure_code: null
                    failure_message: null
                    fee: 0
                    fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                    idempotency_id: null
                    merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                    merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                    messages: []
                    operation_key: CARD_NOT_PRESENT_REFUND
                    parent_transfer: TRi3he8Z3rk9KrayX4R5DLfc
                    parent_transfer_trace_id: null
                    raw: null
                    ready_to_settle_at: null
                    receipt_last_printed_at: null
                    security_code_verification: null
                    source: null
                    split_transfers:
                      - split_transfer_wCdwFDcfBZTpP5tjcf3Ufx
                      - split_transfer_wCdQkisfcEV6M1BQs3o2tK
                    state: PENDING
                    statement_descriptor: FLX*FINIX FLOWERS
                    subtype: API
                    supplemental_fee: null
                    tags:
                      test: Refund
                    tip_amount: null
                    trace_id: d0f74627-829f-47c1-ab24-ec1de1f0e2b2
                    type: REVERSAL
                    _links:
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRXuEhedfgPC6T1aCjdUdKB
                      parent:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRi3he8Z3rk9KrayX4R5DLfc
                      destination:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PI5benj4eVhCL4ALMv6SFxJG
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                      payment_instruments:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRXuEhedfgPC6T1aCjdUdKB/payment_instruments
                      fee_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
                Refund Card Present Transfer - Referenced:
                  value:
                    id: TRh57kBu89GbiaPmQ243DMUV
                    created_at: '2024-12-23T05:54:03.62Z'
                    updated_at: '2024-12-23T05:54:03.62Z'
                    additional_buyer_charges: null
                    additional_healthcare_data: null
                    additional_purchase_data: null
                    address_verification: null
                    amount: 150
                    amount_requested: 150
                    application: APeUbTUjvYb1CdPXvNcwW1wP
                    card_present_details:
                      emv_data: null
                      masked_account_number: null
                      name: null
                      brand: null
                      entry_mode: null
                      payment_type: NONE
                      approval_code: null
                    currency: USD
                    destination: PInUwPXf1MYj7xJ8jfmdksa5
                    device: DVtk6E4eWHsMzgZXvFaaUigM
                    externally_funded: UNKNOWN
                    failure_code: null
                    failure_message: null
                    fee: 0
                    idempotency_id: null
                    merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                    merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                    messages: []
                    raw: null
                    ready_to_settle_at: null
                    receipt_last_printed_at: null
                    security_code_verification: null
                    source: null
                    state: SUCCEEDED
                    statement_descriptor: FIN*FINIX FLOWERS
                    subtype: API
                    tags: {}
                    tip_amount: null
                    trace_id: FNX9HJndPy6MvvHwRszcyPsPW
                    type: REVERSAL
                    _links:
                      application:
                        href: >-
                          https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRh57kBu89GbiaPmQ243DMUV
                      parent:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRn9pzzn1NVLdwwBwVrqSwAX
                      destination:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_instruments/PInUwPXf1MYj7xJ8jfmdksa5
                      merchant_identity:
                        href: >-
                          https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
                      payment_instruments:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRh57kBu89GbiaPmQ243DMUV/payment_instruments
                      fee_profile:
                        href: >-
                          https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
      keywords:
        includes:
          - refund
          - refund payment
          - refunding
          - refunds
          - reversal
          - reverse
    get:
      summary: List Transfer Reversals
      operationId: listTransferReversals
      description: >
        Retrieve a list of reversals for a `Transfer`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Transfers
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/limit'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/transfers/TRvU2qRMSYGnJY6dcAXehJqd/reversals"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          description: List of reversed `Transfer` objects.
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    $ref: '#/components/schemas/page'
                  _embedded:
                    type: object
                    properties:
                      transfers:
                        type: array
                        uniqueItems: true
                        items:
                          $ref: '#/components/schemas/transfer'
                  _links:
                    type: object
                    properties:
                      self:
                        $ref: '#/components/schemas/self'
                      next:
                        $ref: '#/components/schemas/next'
              examples:
                List of Reversed Transfers:
                  value:
                    _embedded:
                      transfers:
                        - id: TR8K7zFd9wvEwAG7AvCMLShg
                          created_at: '2025-07-29T17:19:11.26Z'
                          updated_at: '2025-07-29T17:20:02.68Z'
                          additional_buyer_charges: null
                          additional_healthcare_data: null
                          additional_purchase_data: null
                          address_verification: null
                          amount: 662154
                          amount_requested: 662154
                          application: APc9vhYcPsRuTSpKD9KpMtPe
                          currency: USD
                          destination: PI6iQcTtJNCS8GZAVKYi5Ueb
                          externally_funded: UNKNOWN
                          failure_code: null
                          failure_message: null
                          fee: 0
                          fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                          idempotency_id: null
                          merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                          merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                          messages: []
                          operation_key: CARD_NOT_PRESENT_REFUND
                          parent_transfer: TRvU2qRMSYGnJY6dcAXehJqd
                          parent_transfer_trace_id: 1364ccb4-7fb1-4960-9a43-26255d3ed911
                          raw: null
                          ready_to_settle_at: '2025-07-30T17:20:02.74Z'
                          receipt_last_printed_at: null
                          security_code_verification: null
                          source: null
                          split_transfers: null
                          state: SUCCEEDED
                          statement_descriptor: FLX*FINIX FLOWERS
                          subtype: API
                          supplemental_fee: null
                          tags:
                            test: Refund
                          tip_amount: null
                          trace_id: 2cdfa359-b9d5-4185-aa66-252a00001ea5
                          type: REVERSAL
                          _links:
                            application:
                              href: >-
                                https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                            self:
                              href: >-
                                https://finix.sandbox-payments-api.com/transfers/TR8K7zFd9wvEwAG7AvCMLShg
                            parent:
                              href: >-
                                https://finix.sandbox-payments-api.com/transfers/TRvU2qRMSYGnJY6dcAXehJqd
                            destination:
                              href: >-
                                https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                            merchant_identity:
                              href: >-
                                https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                            payment_instruments:
                              href: >-
                                https://finix.sandbox-payments-api.com/transfers/TR8K7zFd9wvEwAG7AvCMLShg/payment_instruments
                            fee_profile:
                              href: >-
                                https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRvU2qRMSYGnJY6dcAXehJqd/reversals?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                      parent:
                        href: >-
                          https://finix.sandbox-payments-api.com/transfers/TRvU2qRMSYGnJY6dcAXehJqd
                    page:
                      offset: 0
                      limit: 20
                      count: 1
                    unreversed_amount: 0
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
    parameters:
      - description: The ID of the parent `Transfer` resource.
        in: path
        name: transfer_id
        required: true
        schema:
          type: string
  /transfer_attempts:
    get:
      summary: List Transfer Attempts
      description: >
        Retrieve a list of all `Transfer Attempt` resources, or filter the
        results to a specific `Checkout Form`, `Payment Link`, and `Payout Link`
        using the `entity_id` query parameter.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Transfer Attempts
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
        - name: entity_id
          description: >-
            Filter by the ID of the `Checkout Form`, `Payment Link` or `Payout
            Link`.
          in: query
          schema:
            type: string
            example: checkout_form_ciADaDNMFAHdyNbDPuByS
          style: form
        - $ref: '#/components/parameters/QueryLimit'
      responses:
        '200':
          $ref: '#/components/responses/ListTransferAttemptsResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/transfer_attempts" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      operationId: listTransferAttempts
      x-java-method-name: list
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).
  /transfer_attempts/{transfer_attempt_id}:
    get:
      summary: Fetch a Transfer Attempt
      description: >-
        Retrieve the details of a `Transfer Attempt` initiated from a `Checkout
        Form`, `Payment Link` or `Payout Link`.
      tags:
        - Transfer Attempts
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/FetchTransferAttemptResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/transfer_attempts/transfer_attempt_ciACBK59kDhfx2Mi4Vy81"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      operationId: getTransferAttempt
      x-java-method-name: get
    parameters:
      - schema:
          type: string
        name: transfer_attempt_id
        description: The ID of the `Transfer Attempt`.
        in: path
        required: true
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).
  /users:
    get:
      tags:
        - Users
      description: >-
        Retrieve a list of all `Users`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      summary: List all Users
      operationId: listUsers
      responses:
        '200':
          $ref: '#/components/responses/UsersList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/users" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
  /users/{user_id}:
    get:
      tags:
        - Users
      description: Retrieve a specific user with the ID of the `User`.
      summary: Fetch a User by ID
      operationId: getUser
      responses:
        '200':
          $ref: '#/components/responses/User'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/users/USfdccsr1Z5iVbXDyYt7hjZZ"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    parameters:
      - description: ID of `User` object.
        required: true
        in: path
        name: user_id
        schema:
          type: string
    put:
      tags:
        - Users
      description: >-
        Update a `User` with new tags or disable the `User` and their
        credentials.
      summary: Update a User
      operationId: updateUser
      responses:
        '200':
          $ref: '#/components/responses/User'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      requestBody:
        $ref: '#/components/requestBodies/UpdateUserRequest'
      x-java-method-name: update
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/users/USfdccsr1Z5iVbXDyYt7hjZZ"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -X PUT \
                -d '{
                    "tags": {
                        "card_name": "New Employee"
                    }
                }'
  /verifications:
    get:
      tags:
        - Verifications
      description: >-
        Retrieve a list of `Verifications`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      summary: List Verifications
      operationId: listVerifications
      parameters:
        - name: Accept
          in: header
          description: Body Header
          schema:
            type: string
            default: application/hal+json
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      responses:
        '200':
          $ref: '#/components/responses/VerificationsList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/verifications" \
              -H "Finix-Version: 2022-02-01" \
              -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
  /verifications/{verification_id}:
    get:
      tags:
        - Verifications
      description: Retrieve the details of a `Verification`.
      summary: Fetch a Verification
      operationId: getVerification
      responses:
        '200':
          $ref: '#/components/responses/VerificationResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: get
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - description: The `Verification` object ID.
        required: true
        in: path
        name: verification_id
        schema:
          type: string
  /webhooks:
    post:
      tags:
        - Webhooks
      description: Create a `Webhook` to specify an endpoint where Finix can send events.
      summary: Create a Webhook
      operationId: createWebhook
      requestBody:
        $ref: '#/components/requestBodies/CreateWebhookRequest'
      responses:
        '201':
          $ref: '#/components/responses/Webhook'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-java-method-name: create
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
    get:
      tags:
        - Webhooks
      description: >-
        Retrieve a list of `Webhooks`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      summary: List Webhooks
      operationId: listWebhooks
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      responses:
        '200':
          $ref: '#/components/responses/WebhooksList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/webhooks" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
  /webhooks/{webhook_id}:
    get:
      tags:
        - Webhooks
      description: Retrieve the details of a `Webhook`.
      summary: Fetch a Webhook
      operationId: getWebhook
      responses:
        '200':
          $ref: '#/components/responses/Webhook'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: get
    parameters:
      - description: ID of `Webhook` object.
        required: true
        in: path
        name: webhook_id
        schema:
          type: string
    put:
      tags:
        - Webhooks
      description: >-
        Update an existing `Webhook`to:

        - Disable or enable an endpoint URL to receive webhook events.

        - Add [authentication to a
        `Webhook`](/additional-resources/developers/webhooks/integrating-into-webhooks#authenticating-webhooks).

        - Filter the [webhook events sent to an endpoint
        URL](/additional-resources/developers/webhooks/integrating-into-webhooks#filtering-webhooks).
      summary: Update a Webhook
      operationId: updateWebhook
      requestBody:
        $ref: '#/components/requestBodies/UpdateWebhookRequest'
      responses:
        '200':
          $ref: '#/components/responses/Webhook'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: update
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
  /files:
    post:
      summary: Create a File
      operationId: createFiles
      responses:
        '200':
          $ref: '#/components/responses/FileResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/files" \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -X POST \
                -d '{
                    "display_name": "Bank Statement (January 2024)",
                    "linked_to": "MUmfEGv5bMpSJ9k5TFRUjkmm",
                    "type": "BANK_STATEMENT"
                }'
      description: >-
        Before uploading a file, you need to create a `File` resource. 


        Once created, you can
        [upload](/guides/platform-payments/onboarding-sellers/seller-onboarding-uploading-files/)
        your file to the new `File` resource.
      requestBody:
        $ref: '#/components/requestBodies/CreateFileRequest'
      tags:
        - Files
      x-java-method-name: create
    get:
      summary: List all Files
      tags:
        - Files
      responses:
        '200':
          $ref: '#/components/responses/FilesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: listFiles
      description: >-
        Retrieve a list of previously created `files`. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      parameters:
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryIdFilter'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/files" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
  /files/{file_id}:
    parameters:
      - schema:
          type: string
        name: file_id
        in: path
        required: true
        description: Your `File` ID.
    get:
      summary: Fetch a File
      tags:
        - Files
      responses:
        '200':
          $ref: '#/components/responses/FileResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: getFile
      description: Retrieve the details of a `File` resource.
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
  /files/{file_id}/external_links:
    parameters:
      - schema:
          type: string
        name: file_id
        in: path
        required: true
        description: Your `File` ID.
    get:
      summary: List all External Links
      tags:
        - Files
      responses:
        '200':
          $ref: '#/components/responses/ExternalLinksList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          description: Not Acceptable
      operationId: listExternalLinks
      description: >-
        List the previously created `external_links` for a `File`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      parameters:
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryIdFilter'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
    post:
      summary: Create an External Link
      operationId: createExternalLink
      responses:
        '200':
          $ref: '#/components/responses/CreateExternalLinkResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: >-
        Create an `external_link` resource to share with users so they can
        upload files directly from their browser. For more info, see [Uploading
        files to
        Finix](/guides/platform-payments/onboarding-sellers/seller-onboarding-uploading-files/).
      requestBody:
        $ref: '#/components/requestBodies/CreateExternalLinkRequest'
      tags:
        - Files
  /files/{file_id}/upload:
    parameters:
      - schema:
          type: string
        name: file_id
        in: path
        required: true
        description: The ID of the `File` that was created to upload the file.
    post:
      summary: Upload files directly
      operationId: uploadFile
      responses:
        '200':
          $ref: '#/components/responses/UploadFileResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: Upload files directly with a `multipart/form-data` request.
      x-java-method-name: upload
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/upload"
            \
                -H "Content-Type: multipart/form-data" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -X POST \
                -F "file=@finix_file.png"
      tags:
        - Files
      requestBody:
        $ref: '#/components/requestBodies/UploadFileRequest'
  /files/{file_id}/download:
    parameters:
      - schema:
          type: string
        name: file_id
        in: path
        required: true
        description: The ID of the `File` that was created to upload the file.
    get:
      summary: Download a File
      tags:
        - Files
      responses:
        '200':
          $ref: '#/components/responses/FileDownload'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: downloadFile
      x-java-method-name: download
      description: Download a file that was uploaded to a `File` resource.
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/download"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      parameters:
        - schema:
            type: boolean
          in: query
          name: stream
          description: >-
            Stream the contents of the `File` so it's displayed inline in the
            user's web browser.
  /files/{file_id}/external_links/{external_link_id}:
    parameters:
      - schema:
          type: string
        name: file_id
        in: path
        required: true
        description: The ID of the `File` that has the links you want to retrieve.
      - schema:
          type: string
        name: external_link_id
        in: path
        required: true
        description: The ID of the `external_link` that you want to retrieve.
    get:
      summary: Fetch an External Link
      tags:
        - Files
      responses:
        '200':
          $ref: '#/components/responses/ExternalLink'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: getExternalLink
      description: Fetch a previously created `External_link` resource.
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links/EL_9NjudbF2eCjjdKnPu3UjL1"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
  /apple_pay_sessions:
    post:
      summary: Create an Apple Pay Session
      operationId: createApplePaySession
      description: >
        Create an `apple_pay_session` to process Apple Pay transactions on the
        web.


        To create an Apple Pay Session, pass the unique `validation_url`
        (provided by Apple) while creating an `apple_pay_sessions` resource.
        Finix returns a `merchantSession` object that you can use to create a
        payment. For more information, see [Apple
        Pay](/guides/online-payments/digital-wallets/apple-pay).
      tags:
        - Payment Instruments
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createApplePaySession'
            examples:
              Payment Instrument - Apple Pay Session:
                value:
                  display_name: Finix Test Merchant
                  domain: www.finixtestmerchant.com
                  merchant_identity: IDmULj61C8ke6Y7qQiKENJ7
                  validation_url: >-
                    https://apple-pay-gateway-cert.apple.com/paymentservices/paymentSession
      responses:
        '201':
          description: Apply Pay Session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_instrument_apple_pay_session'
              examples:
                Payment Instrument - Apple Pay Session:
                  value:
                    id: APPLEPAYSESSION_xxx
                    created_at: '2021-11-22T23:58:19.50Z'
                    updated_at: '2021-11-22T23:58:19.50Z'
                    session_details: >-
                      {"epochTimestamp":1640213041060,"expiresAt":1640216641060,"merchantSessionIdentifier":"SSH1524BA9006A944B8B9B8FB60227D9990_916523AAED1343F5BC5815E12BEE9250AFFDC1A17C46B0DE5A943F0F94927C24","nonce":"a5ee8554","merchantIdentifier":"23D5E1F154400B277E14CC8361878AA0AAFD46B2DF74003C7587B256269102BD","domainName":"tj.ngrok.io","displayName":"Christmas
                      Shopping","signature":"...","operationalAnalyticsIdentifier":"Christmas
                      Shopping:23D5E1F154400B277E14CC8361878AA0AAFD46B2DF74003C7587B256269102BD","retries":0}
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/apple_pay_sessions/APPLEPAYSESSION_xxx
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: createApplePaySession
      keywords:
        includes:
          - apple pay session
          - apple pay
          - create apple pay session
          - create apple pay sessions
  /disputes/{dispute_id}/adjustment_transfers:
    parameters:
      - schema:
          type: string
        name: dispute_id
        in: path
        required: true
        description: ID of the `Dispute` resource.
    get:
      summary: List Dispute Adjustment Transfers
      tags:
        - Disputes
      responses:
        '200':
          $ref: '#/components/responses/AdjustmentTransfersList'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: listDisputesAdjustments
      description: >-
        List the adjustment `Transfers` for a `Dispute`. Depending on the stage
        of the `Dispute`, different adjustment `Transfer` subtypes can be
        applied.


        There are four available subtypes for adjustment `Transfers` in
        `Disputes`:
        <ul><li><strong>PLATFORM\_CREDIT</strong><li><strong>MERCHANT\_DEBIT</strong><li><strong>MERCHANT\_CREDIT</strong><li><strong>PLATFORM\_DEBIT</strong></ul>
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
  /compliance_forms/{compliance_form_id}:
    parameters:
      - schema:
          type: string
        name: compliance_form_id
        in: path
        required: true
    get:
      summary: Fetch a Compliance Form
      tags:
        - Compliance Forms
      responses:
        '200':
          $ref: '#/components/responses/ComplianceForm'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: getComplianceForm
      x-group-parameters: true
      x-java-method-name: list
      description: >-
        Finix will deliver a webhook when we create a new `Compliance Form` for
        your Merchant. Use the webhook to fetch the `Compliance Form` from the
        `/compliance_forms/{id}` endpoint.
    put:
      summary: Complete a Compliance Form
      operationId: updateComplianceForm
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/CompleteComplianceFormResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      description: >-
        As part of onboarding, your Merchants need to review and agree to their
        `Compliance Form`. Afterward, you need to update their `Compliance Form`
        with details about their digital signature. Finix will update their
        `Compliance Form` with those details, along with a reference to the new
        `signed_file` with their digital signature.


        For more information, see [Managing Compliance
        Forms](/guides/managing-operations/security-compliance/managing-pci-compliance#completing-compliance-forms).
      tags:
        - Compliance Forms
      requestBody:
        $ref: '#/components/requestBodies/CompleteComplianceFormRequest'
      x-java-method-name: update
  /compliance_forms:
    get:
      summary: List Compliance Forms
      tags:
        - Compliance Forms
      responses:
        '200':
          $ref: '#/components/responses/ComplianceFormList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: listComplianceForms
      x-java-method-name: list
      description: >-
        Get all `Compliance Forms` linked to your Merchants.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      parameters:
        - schema:
            type: string
            enum:
              - INCOMPLETE
              - OVERDUE
              - COMPLETE
              - EXPIRED
              - INVALID
            example: COMPLETE
          in: query
          name: state
          description: >-
            Filter by the Compliance Form's `state`. Use comma-separated values
            to filter for multiple states (for example, you can specify
            `?state=INCOMPLETE,EXPIRED`).
        - schema:
            type: string
            example: MUwfZPNW3r4EqLMzwgr6txw4
          in: query
          name: linked_to
          description: Filter by whom the Compliance Form resource is linked to.
  /onboarding_forms:
    post:
      summary: Create an Onboarding Form
      operationId: createOnboardingForm
      description: >
        Create an `Onboarding Form` by entering the processor’s name you want to
        onboard users to. Also, provide the links to send users after they
        finish or leave the form.


        You can only create an `Onboarding Form` if you have `ROLE_PARTNER`
        credentials.
      tags:
        - Onboarding Forms
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createOnboardingForm'
            examples:
              Onboarding Form - Minimal Fields:
                value:
                  merchant_processors:
                    - processor: DUMMY_V1
                  onboarding_data:
                    max_transaction_amount: 100000
                  onboarding_link_details:
                    return_url: https://www.democompany.com/home
                    expired_session_url: https://www.democompany.com/login
                    fee_details_url: https://www.democompany.com/fee_details
                    terms_of_service_url: https://www.democompany.com/ToS
                    expiration_in_minutes: 10080
              Onboarding Form - All Fields:
                value:
                  onboarding_data:
                    entity:
                      title: CEO
                      first_name: John
                      last_name: Smith
                      email: john.smith@finix.com
                      business_name: Finix Flowers
                      business_type: CORPORATION
                      doing_business_as: Finix Flowers
                      phone: '14158885080'
                      business_phone: '14158885080'
                      personal_address:
                        city: Seattle
                        country: USA
                        line1: 123 Boren Ave
                        postal_code: '98040'
                        region: WA
                      business_address:
                        city: Bellevue
                        country: USA
                        line1: 123 Bellevue Way
                        postal_code: '98039'
                        region: WA
                      dob:
                        day: 13
                        month: 4
                        year: 1982
                      incorporation_date:
                        day: 9
                        month: 3
                        year: 2018
                      mcc: '4900'
                      url: https://www.finix.com
                      ownership_type: PRIVATE
                      default_statement_descriptor: DEMOCOMPANY
                      annual_card_volume: 1000000
                      principal_percentage_ownership: 75
                      tax_id: '123456789'
                      business_tax_id: '123456789'
                      has_accepted_credit_cards_previously: false
                    additional_underwriting_data:
                      refund_policy: NO_REFUNDS
                      card_volume_distribution:
                        ecommerce_percentage: 100
                        card_present_percentage: 0
                        mail_order_telephone_order_percentage: 0
                      average_ach_transfer_amount: 200000
                      average_card_transfer_amount: 20000
                      annual_ach_volume: 2000000
                      business_description: CONSUMER
                      merchant_agreement_ip_address: 42.1.1.113
                      merchant_agreement_accepted: true
                      merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
                      merchant_agreement_user_agent: Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)
                      volume_distribution_by_business_type:
                        other_volume_percentage: 0
                        person_to_person_volume_percentage: 0
                        business_to_business_volume_percentage: 90
                        business_to_consumer_volume_percentage: 10
                        consumer_to_consumer_volume_percentage: 0
                      amex_marketing_consent:
                        accepted: false
                        ip_address: 42.1.1.113
                        user_agent: Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)
                        timestamp: '2021-04-28T16:42:55Z'
                    associated_entities:
                      - title: CFO
                        first_name: Alex
                        last_name: Smith
                        email: alex.smith@finix.com
                        phone: '14158885080'
                        personal_address:
                          city: Bellevue
                          country: USA
                          line1: 4848 84th St
                          postal_code: '98032'
                          region: WA
                        dob:
                          day: 13
                          month: 4
                          year: 1985
                        principal_percentage_ownership: 25
                        tax_id: '123456789'
                    payment_instruments:
                      name: SARAH BANKER
                      bank_code: '123456789'
                      account_number: '123456789'
                      account_type: CHECKING
                      type: BANK_ACCOUNT
                      country: USA
                      currency: USD
                    max_transaction_amount: 100000
                    ach_max_transaction_amount: 100000
                    country: USA
                  merchant_processors:
                    - processor: LITLE_V1
                  onboarding_link_details:
                    return_url: https://www.democompany.com/home
                    expired_session_url: https://www.democompany.com/login
                    fee_details_url: https://www.democompany.com/fee_details
                    terms_of_service_url: https://www.democompany.com/ToS
                    merchant_max_transaction_amount: 100000
                    merchant_ach_max_transaction_amount: 100000
                    expiration_in_minutes: 10080
      responses:
        '201':
          $ref: '#/components/responses/createOnboardingForm'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
  /onboarding_forms/{onboarding_form_id}:
    parameters:
      - schema:
          type: string
        name: onboarding_form_id
        description: The id of the `onboarding_form`.
        in: path
        required: true
    get:
      summary: Fetch an Onboarding Form
      operationId: getOnboardingForm
      description: Retrieve the details of an existing `Onboarding Form`.
      tags:
        - Onboarding Forms
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          description: A single `Onboarding Form`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/onboarding_form'
              examples:
                Onboarding Form:
                  value:
                    id: obf_6ifdXromWyVHRVjRx5dRXt
                    onboarding_data:
                      entity:
                        title: CEO
                        first_name: John
                        last_name: Smith
                        email: john.smith@finix.com
                        business_name: Finix Flowers
                        business_type: CORPORATION
                        doing_business_as: Finix Flowers
                        phone: '14158885080'
                        business_phone: '14158885080'
                        mcc: '4900'
                        url: https://www.finix.com
                        ownership_type: PRIVATE
                        default_statement_descriptor: DEMOCOMPANY
                        annual_card_volume: '1000000'
                        principal_percentage_ownership: '75'
                        tax_id: '*****6789'
                        business_tax_id: '*****6789'
                        has_accepted_credit_cards_previously: false
                        personal_address:
                          line1: 123 Boren Ave
                          city: Seattle
                          region: WA
                          postal_code: '98040'
                          country: USA
                        business_address:
                          line1: 123 Bellevue Way
                          city: Bellevue
                          region: WA
                          postal_code: '98039'
                          country: USA
                        dob:
                          day: 13
                          month: 4
                          year: 1982
                        incorporation_date:
                          day: 9
                          month: 3
                          year: 2018
                      associated_entities:
                        - title: CFO
                          first_name: Alex
                          last_name: Smith
                          email: alex.smith@finix.com
                          phone: '14158885080'
                          personal_address:
                            line1: 4848 84th St
                            city: Bellevue
                            region: WA
                            postal_code: '98032'
                            country: USA
                          dob:
                            day: 13
                            month: 4
                            year: 1985
                          principal_percentage_ownership: 25
                          tax_id: '*****6789'
                      payment_instruments:
                        name: SARAH BANKER
                        bank_code: '123456789'
                        account_number: '*****6789'
                        account_type: CHECKING
                        type: BANK_ACCOUNT
                        country: USA
                        currency: USD
                      additional_underwriting_data:
                        refund_policy: NO_REFUNDS
                        average_ach_transfer_amount: 200000
                        average_card_transfer_amount: 20000
                        merchant_agreement_ip_address: 42.1.1.113
                        merchant_agreement_accepted: true
                        merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
                        merchant_agreement_user_agent: Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)
                        credit_check_timestamp: null
                        credit_check_user_agent: null
                        annual_ach_volume: 2000000
                        business_description: CONSUMER
                        volume_distribution_by_business_type:
                          other_volume_percentage: 0
                          person_to_person_volume_percentage: 0
                          business_to_business_volume_percentage: 90
                          business_to_consumer_volume_percentage: 10
                          consumer_to_consumer_volume_percentage: 0
                        card_volume_distribution:
                          ecommerce_percentage: 100
                          card_present_percentage: 0
                          mail_order_telephone_order_percentage: 0
                        amex_marketing_consent:
                          accepted: false
                          ip_address: 42.1.1.113
                          user_agent: Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)
                          timestamp: '2021-04-28T16:42:55Z'
                      max_transaction_amount: 100000
                      ach_max_transaction_amount: 100000
                      country: USA
                      associated_files: []
                    merchant_processors:
                      - processor: LITLE_V1
                    onboarding_link_details:
                      return_url: https://www.democompany.com/home
                      expired_session_url: https://www.democompany.com/login
                      fee_details_url: https://www.democompany.com/fee_details
                      merchant_max_transaction_amount: 100000
                      merchant_ach_max_transaction_amount: 100000
                      terms_of_service_url: https://www.democompany.com/ToS
                      expiration_in_minutes: 10080
                    onboarding_link:
                      expires_at: '2025-12-17T20:38:21.642Z'
                      link_url: >-
                        https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_6ifdXromWyVHRVjRx5dRXt&applicationId=APc9vhYcPsRuTSpKD9KpMtPe&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfNmlmZFhyb21XeVZIUlZqUng1ZFJYdCIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmRlbW9jb21wYW55LmNvbS9mZWVfZGV0YWlscyIsImV4cGlyZWRfc2Vzc2lvbl91cmwiOiJodHRwczovL3d3dy5kZW1vY29tcGFueS5jb20vbG9naW4iLCJtZXJjaGFudF9hY2hfbWF4X3RyYW5zYWN0aW9uX2Ftb3VudCI6MTAwMDAwLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZGVtb2NvbXBhbnkuY29tL2hvbWUiLCJleHAiOjE3NjYwMDM5MDEsImFwcGxpY2F0aW9uX2lkIjoiQVBjOXZoWWNQc1J1VFNwS0Q5S3BNdFBlIiwiaWF0IjoxNzY1Mzk5MTAxLCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZGVtb2NvbXBhbnkuY29tL1RvUyJ9.3nL570FQLPj8jRT4wBI959mg1g8dEmj4fEFgaDWAwBBGFRmCv0w-F7R5YxdDmPJfoiNh1uud6fR8UrI1azejWA
                    status: IN_PROGRESS
                    identity_id: null
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    created_at: '2025-12-10T20:38:21.628367Z'
                    updated_at: '2025-12-10T20:38:21.628367Z'
                    tags: {}
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: get
      x-group-parameters: true
  /onboarding_forms/{onboarding_form_id}/links:
    parameters:
      - schema:
          type: string
        name: onboarding_form_id
        in: path
        required: true
        description: The ID of the `onboarding_form` resource.
    post:
      summary: Create an Onboarding Form Link
      operationId: createOnboardingFormLink
      description: Create a link that lets users resume their `Onboarding Form`.
      tags:
        - Onboarding Forms
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/onboarding_link_details'
            examples:
              Onboarding Form Link:
                value:
                  return_url: https://www.democompany.com/home
                  expired_session_url: https://www.democompany.com/login
                  fee_details_url: https://www.democompany.com/fee_details
                  terms_of_service_url: https://www.democompany.com/ToS
                  merchant_max_transaction_amount: 100000
                  merchant_ach_max_transaction_amount: 100000
                  expiration_in_minutes: 10080
      responses:
        '201':
          $ref: '#/components/responses/createOnboardingLink'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: createLink
  /payout_profiles:
    get:
      summary: List Payout Profiles
      responses:
        '200':
          $ref: '#/components/responses/PayoutProfilesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          description: Not Acceptable
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: listPayoutprofiles
      description: >-
        Retrieve a list of `payout_profiles`.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      x-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/payout_profiles" \
              -H "Finix-Version: 2022-02-01" \
              -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
      tags:
        - Payout Profiles
      parameters:
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryLimit'
  /payout_profiles/{payout_profile_id}:
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - schema:
          type: string
        name: payout_profile_id
        in: path
        required: true
        description: ID of the `Payout Profile`.
    get:
      summary: Fetch a Payout Profile
      responses:
        '200':
          $ref: '#/components/responses/PayoutProfile'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: getPayoutprofile
      description: Retrieve the details of a previously created `Payout Profile`.
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf"
            \
              -H "Finix-Version: 2022-02-01" \
              -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
      tags:
        - Payout Profiles
    put:
      summary: Update a Payout Profile
      operationId: updatePayoutProfileRequest
      responses:
        '200':
          $ref: '#/components/responses/PayoutProfile'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      description: >-
        Update a `Payout Profile` to configure how fees and payouts get
        calculated, credited, and debited.


        By default, `Merchants` get configured with daily net settlements.
        Payouts get submitted using the **Next-Day ACH** `rail`. Contact [Finix
        Support](/guides/getting-started/support-at-finix/) to configure payouts
        on a custom schedule.
      requestBody:
        $ref: '#/components/requestBodies/UpdatePayoutProfileRequest'
      tags:
        - Payout Profiles
      x-java-method-name: update
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/payout_profiles/POmhJeq1AsfwetG8LwhA4S9U"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1 \
                -X PUT \
                -d '{
                    "type": "GROSS",
                    "gross": {
                        "payouts": {
                            "frequency": "DAILY",
                            "submission_delay_days": "1",
                            "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
                            "rail": "SAME_DAY_ACH"
                        },
                        "fees": {
                            "frequency": "MONTHLY",
                            "day_of_month": "1",
                            "submission_delay_days": "3",
                            "payment_instrument_id": "PI2EmosKE8tvfSiF7Pd4SYE",
                            "rail": "NEXT_DAY_ACH"
                        }
                    }
                }'
  /merchants/{merchant_id}/payout_profile:
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - schema:
          type: string
        name: merchant_id
        in: path
        required: true
        description: ID of the `Merchant`.
    get:
      summary: Fetch Payout Profile by Merchant
      responses:
        '200':
          $ref: '#/components/responses/PayoutProfile'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: fetchPayoutProfilesbyMerchant
      description: Fetch the the `Payout Profile` created for a specific `Merchant`.
      x-java-method-name: getByMerchantId
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/merchants/MUfbbKm7vRmBX2bP92pKw9zZ/payout_profile"
            \
              -H "Finix-Version: 2022-02-01" \
              -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
      tags:
        - Payout Profiles
  /disputes/{dispute_id}/submit:
    parameters:
      - name: Accept
        in: header
        schema:
          type: string
          default: application/hal+json
      - schema:
          type: string
        name: dispute_id
        in: path
        required: true
        description: ID of `Dispute` to move forward and submit evidence.
    post:
      summary: Submit Dispute Evidence
      operationId: submitDisputeEvidence
      responses:
        '202':
          $ref: '#/components/responses/Dispute'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
      tags:
        - Disputes
      description: >-
        You can manually submit evidence to the issuing bank to manually move a
        dispute forward. Use the `/disputes/DISPUTE_ID/submit` endpoint to
        submit evidence. Making a POST request lets the issuing bank know the
        seller has completed submitting evidence and is prepared to move forward
        with the dispute.


        Related guides: [Responding to
        Disputes](/guides/after-the-payment/disputes/responding-to-disputes).
      x-java-method-name: post
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/submit"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -d '{
                    "note": "Partial rebuttal is due to double charging cardholder due to technical malfunction on point of sale, but we have attached receipt as proof that cardhoder received item."
                }'
      requestBody:
        $ref: '#/components/requestBodies/SubmitDisputeEvidence'
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
  /disputes/{dispute_id}/accept:
    parameters:
      - schema:
          type: string
        name: dispute_id
        in: path
        required: true
        description: ID of `Dispute` to move forward and submit evidence.
    post:
      summary: Accept a Dispute
      operationId: acceptDispute
      responses:
        '202':
          $ref: '#/components/responses/Dispute'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
      description: >
        You can accept a `Dispute` to prevent a long (and potentially expensive)
        process. When you accept a `Dispute`, you concede that the Dispute is
        not worth challenging or representing.


        Related guides: [Accepting a
        Dispute](/guides/after-the-payment/disputes/accepting-disputes/)
      x-java-method-name: post
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/accept"
            \
                -H "Content-Type: application/json" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                -d '{
                    "note": "Accepting Dispute: Valid Reason"
                }'
      requestBody:
        $ref: '#/components/requestBodies/AcceptDisputeRequest'
      tags:
        - Disputes
  /disputes/{dispute_id}/evidence/{evidence_id}/download:
    parameters:
      - schema:
          type: string
          example: DIpCy4sZTx6im6U1ofBBPzdM
        name: dispute_id
        in: path
        required: true
        description: ID of `Dispute` to download evidence from.
      - schema:
          type: string
          example: DFtiQ1LoNbjBTYiuuxju6tE2
        name: evidence_id
        in: path
        required: true
        description: ID of `evidence` to download.
    get:
      summary: Download Dispute Evidence
      tags:
        - Disputes
      responses:
        '200':
          $ref: '#/components/responses/FileDownload'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: downloadDisputeEvidence
      description: >-
        Download a file uploaded as `Dispute Evidence`.


        **Note**: The file extension included in `output` must match the
        extension of the original uploaded file.
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >-
            curl
            "https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco/download"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
                --output evidence-download.jpg
      parameters: []
  /split_transfers/{split_transfer_id}:
    parameters:
      - schema:
          type: string
        name: split_transfer_id
        in: path
        required: true
    get:
      summary: Fetch a Split Transfer
      responses:
        '200':
          $ref: '#/components/responses/SplitTransfer'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: getSplitTransfer
      description: >-
        Fetch a `split_transfer` that was created from a split transaction.


        For more information, see [Split a
        Transaction](/guides/online-payments/payment-features/split-transactions).
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/split_transfers/split_transfer_duVsX6CRTjZah9eKWCKRak"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      tags:
        - Split Transfers
      parameters: []
  /split_transfers/{split_transfer_id}/fees:
    parameters:
      - schema:
          type: string
        name: split_transfer_id
        in: path
        required: true
    get:
      summary: Fetch Split Transfer Fees
      responses:
        '200':
          $ref: '#/components/responses/ListSplitTransferFeesResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: getSplitTransferFees
      description: >-
        Fetch the fees associated with a `split_transfer`.



        For more information, see [Split a
        Transaction](/guides/online-payments/payment-features/split-transactions).
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/split_transfers/split_transfer_duVsX6CRTjZah9eKWCKRak/fees"
            \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      tags:
        - Split Transfers
      parameters: []
  /split_transfers:
    parameters: []
    get:
      summary: List Split Transfers
      responses:
        '200':
          $ref: '#/components/responses/SplitTransfersList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: listSplitTransfer
      description: >-
        retrieve a list of `split_transfers` created for a specific split
        `Transfer`.


        For more information, see [Split a
        Transaction](/guides/online-payments/payment-features/split-transactions).
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/split_transfers/split_transfers?parent_transfer_id=TRvQN3v5mhA2Ttc78hzjLV3j"
            \

            -H "Content-Type: application/json" \

            -H "Finix-Version: 2022-02-01" \

            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      parameters:
        - schema:
            type: string
            example: TRvQN3v5mhA2Ttc78hzjLV3j
            pattern: TRxxxxxxxxxxxxxxxxxxxxxx
          in: query
          name: parent_transfer_id
          description: '**ID** of the parent `Transfer` that was split.'
          required: true
  /payment_links:
    get:
      summary: List Payment Links
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
        - schema:
            type: string
            enum:
              - ACTIVE
              - EXPIRED
              - COMPLETED
              - DEACTIVATED
          in: query
          name: state
          description: The state of the payment link.
        - schema:
            type: string
          in: query
          name: application_id
          description: The ID of the `Application` that the Payment Link was created under.
        - schema:
            type: string
            format: date-time
          in: query
          name: created_at.gte
          description: Filter where `created_at` is after the given date.
        - schema:
            type: string
            format: date-time
          in: query
          name: created_at.lte
          description: Filter where `created_at` is before the given date.
        - schema:
            type: string
          in: query
          name: merchant_id
          description: The ID of the `Merchant` the payment is getting created under.
        - schema:
            type: string
          in: query
          name: updated_at.gte
          description: Filter where `updated_at` is after the given date.
        - schema:
            type: string
          in: query
          description: Filter where `updated_at` is before the given date.
          name: updated_at.lte
      responses:
        '200':
          $ref: '#/components/responses/listPaymentLinks'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      description: >-
        Retrieve a list of previously created `Payment Links`.


        Related guides: [Payment
        Links](../../../../guides/online-payments/low-code-no-code/payment-links).


        For details on how to query endpoints using the available parameters,
        see [Query Parameters.](/api/section/query-parameters)
      operationId: listPaymentLinks
      x-java-method-name: list
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/payment_links" \
            -H "Finix-Version: 2022-02-01" \
            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      tags:
        - Payment Links
    post:
      summary: Create a Payment Link
      operationId: createPaymentLink
      description: >
        Create a `Payment Link` to help a buyer submit a payment. 


        Related guides: [Payment
        Links](../../../../guides/online-payments/low-code-no-code/payment-links).
      tags:
        - Payment Links
      responses:
        '201':
          $ref: '#/components/responses/createPaymentLink'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: create
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](../../../../additional-resources/developers/authentication-and-api-basics/versioning).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createPaymentLink'
            examples:
              Payment Link - Minimal Fields:
                value:
                  merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                  application_id: APc9vhYcPsRuTSpKD9KpMtPe
                  payment_frequency: ONE_TIME
                  is_multiple_use: false
                  allowed_payment_methods:
                    - PAYMENT_CARD
                    - BANK_ACCOUNT
                  amount_details:
                    amount_type: FIXED
                    total_amount: 7500
                    currency: USD
                  additional_details:
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    button_font_color: '#111823'
              Payment Link - All Fields:
                value:
                  merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                  application_id: APc9vhYcPsRuTSpKD9KpMtPe
                  payment_frequency: ONE_TIME
                  is_multiple_use: false
                  allowed_payment_methods:
                    - APPLE_PAY
                    - BANK_ACCOUNT
                    - GOOGLE_PAY
                    - PAYMENT_CARD
                  nickname: Basketball League Holiday Dinner 2
                  items:
                    - name: Holiday Dinner Contribution
                      description: Your personal contribution to the holiday dinner.
                      quantity: '1'
                      image_details:
                        primary_image_url: >-
                          https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                      price_details:
                        amount_excluding_sales_tax: 5000
                        currency: USD
                        item_discount_amount: 1000
                        price_type: PROMOTIONAL
                        regular_amount: 5000
                        sale_amount: 7500
                  amount_details:
                    amount_breakdown:
                      subtotal_amount: 3994
                      shipping_amount: 995
                      estimated_tax_amount: 429
                      additional_buyer_charges:
                        convenience_amount: 1000
                      discount_amount: 1000
                      tip_amount: 1000
                    amount_type: FIXED
                    currency: USD
                    max_amount: null
                    min_amount: null
                    total_amount: 6418
                  additional_details:
                    collect_name: true
                    collect_email: true
                    collect_phone: false
                    collect_billing_address: false
                    collect_shipping_address: false
                    expiration_in_minutes: 1576800
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                    success_return_url: https://mybasketball-leaguexyz.com/success
                    unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                    expired_session_url: https://mybasketball-leaguexyz.com/expired
                    send_receipt: true
                    receipt_requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - abc@test.com
                      - type: SMS
                        destinations:
                          - '2348765431'
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    logo_alternative_text: Alternative text
                    button_font_color: '#111823'
                  buyer_details:
                    first_name: John
                    last_name: Adams
                    email: segmewoodmerellc@gmail.com
                    identity_id: IDsjnoZb6VcRhGKNP29QFXtc
                    phone: null
                    billing_address:
                      city: San Jose
                      country: USA
                      line1: 818 Tempest Drive
                      line2: APT A2
                      postal_code: 95112
                      region: CA
                    shipping_address:
                      city: San Jose
                      country: USA
                      line1: 222 Memorial Street
                      line2: APT A4
                      postal_code: 93111
                      region: CA
                  split_transfers:
                    - merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      amount: 3000
                      tags:
                        key: value
                    - merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      amount: 3418
                      fee: 100
              Payment Link - Single-Use:
                value:
                  merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                  application_id: APc9vhYcPsRuTSpKD9KpMtPe
                  payment_frequency: ONE_TIME
                  is_multiple_use: false
                  allowed_payment_methods:
                    - PAYMENT_CARD
                    - BANK_ACCOUNT
                  amount_details:
                    amount_type: FIXED
                    total_amount: 7500
                    currency: USD
                  additional_details:
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    button_font_color: '#111823'
              Payment Link - Multi-Use:
                value:
                  merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                  application_id: APc9vhYcPsRuTSpKD9KpMtPe
                  payment_frequency: ONE_TIME
                  is_multiple_use: true
                  allowed_payment_methods:
                    - PAYMENT_CARD
                    - BANK_ACCOUNT
                  amount_details:
                    amount_type: FIXED
                    total_amount: 7500
                    currency: USD
                  additional_details:
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    button_font_color: '#111823'
              Payment Link - Authorization:
                value:
                  merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                  application_id: APc9vhYcPsRuTSpKD9KpMtPe
                  payment_frequency: ONE_TIME
                  is_authorization: true
                  is_multiple_use: false
                  allowed_payment_methods:
                    - PAYMENT_CARD
                  nickname: Basketball League Holiday Dinner 2
                  items:
                    - name: Holiday Dinner Contribution
                      quantity: '1'
                      image_details:
                        primary_image_url: >-
                          https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                      price_details:
                        sale_amount: 7500
                        currency: USD
                  amount_details:
                    amount_type: FIXED
                    total_amount: 7500
                    currency: USD
                  additional_details:
                    collect_name: true
                    collect_email: true
                    collect_phone: false
                    collect_billing_address: false
                    collect_shipping_address: false
                    expiration_in_minutes: 1576800
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                    success_return_url: https://mybasketball-leaguexyz.com/success
                    unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                    expired_session_url: https://mybasketball-leaguexyz.com/expired
                    send_receipt: true
                    receipt_requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - abc@test.com
                      - type: SMS
                        destinations:
                          - '2348765431'
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    logo_alternative_text: Alternative text
                    button_font_color: '#111823'
              Payment Link - Split Transaction:
                value:
                  merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                  application_id: APc9vhYcPsRuTSpKD9KpMtPe
                  payment_frequency: ONE_TIME
                  is_multiple_use: false
                  allowed_payment_methods:
                    - PAYMENT_CARD
                    - BANK_ACCOUNT
                  amount_details:
                    amount_type: FIXED
                    total_amount: 7500
                    currency: USD
                  additional_details:
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    button_font_color: '#111823'
                  split_transfers:
                    - merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      amount: 5000
                      tags:
                        key: value
                    - merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      amount: 2500
                      fee: 100
              Payment Link - Level 2 Processing:
                value:
                  merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                  application_id: APc9vhYcPsRuTSpKD9KpMtPe
                  payment_frequency: ONE_TIME
                  is_multiple_use: false
                  allowed_payment_methods:
                    - PAYMENT_CARD
                    - BANK_ACCOUNT
                  amount_details:
                    amount_breakdown:
                      estimated_tax_amount: 429
                      tax_exempt: true
                    amount_type: FIXED
                    total_amount: 429
                    currency: USD
                  additional_details:
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  attempt_level_two_level_three_payment: true
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    button_font_color: '#111823'
                  buyer_details:
                    customer_reference_number: 321xyz
              Payment Link - Level 3 Processing:
                value:
                  merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                  application_id: APc9vhYcPsRuTSpKD9KpMtPe
                  payment_frequency: ONE_TIME
                  is_multiple_use: false
                  allowed_payment_methods:
                    - PAYMENT_CARD
                    - BANK_ACCOUNT
                  amount_details:
                    amount_breakdown:
                      subtotal_amount: 3994
                      estimated_tax_amount: null
                      discount_amount: 1000
                      shipping_amount: 995
                      customs_duty_amount: 10
                      tax_exempt: true
                    amount_type: FIXED
                    total_amount: 3999
                    currency: USD
                  additional_details:
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  attempt_level_two_level_three_payment: true
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    button_font_color: '#111823'
                  buyer_details:
                    customer_reference_number: 321xyz
                  items:
                    - name: Holiday Dinner Contribution
                      description: Your personal contribution to the holiday dinner.
                      quantity: '1'
                      image_details:
                        primary_image_url: >-
                          https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                      item_details:
                        commodity_code: 175-62-20
                        merchant_product_code: '1149611'
                        unit_of_measure: BX
                        cost_per_unit: 500
                      price_details:
                        amount_excluding_sales_tax: 5000
                        currency: USD
                        item_discount_amount: 1000
                        price_type: PROMOTIONAL
                        regular_amount: 5000
                        sale_amount: 7500
      keywords:
        includes:
          - payment links
          - single-use link
          - multiple-use link
          - multi-use link
  /payment_links/{payment_link_id}:
    get:
      summary: Fetch a Payment Link
      description: Retrieve the details of a previously created `Payment Link`.
      tags:
        - Payment Links
      responses:
        '200':
          description: Payment Link
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_link'
              examples:
                Payment Link:
                  value:
                    id: payment_link_ctZKJBuMdQJRmrbLKtabZ
                    additional_details:
                      collect_billing_address: false
                      collect_email: true
                      collect_name: true
                      collect_phone: false
                      collect_shipping_address: false
                      expiration_in_minutes: 1576800
                      expired_session_url: null
                      receipt_requested_delivery_methods: []
                      send_receipt: false
                      success_return_url: null
                      terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                      unsuccessful_return_url: null
                    allowed_payment_methods:
                      - BANK_ACCOUNT
                      - PAYMENT_CARD
                    amount_details:
                      amount_breakdown: null
                      amount_type: FIXED
                      currency: USD
                      max_amount: null
                      min_amount: null
                      total_amount: 7500
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    attempt_level_two_level_three_payment: false
                    branding:
                      accent_color: '#f3eeee'
                      brand_color: '#111823'
                      button_font_color: '#111823'
                      icon: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      logo: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      logo_alternative_text: null
                    buyer_details: null
                    created_at: '2025-11-10T19:23:44.732243Z'
                    is_authorization: false
                    is_multiple_use: true
                    items: []
                    link_expires_at: '2028-11-09T19:23:44.70264Z'
                    link_url: https://link.sandbox-payments-checkout.com/irHFxX
                    merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                    nickname: null
                    payment_frequency: ONE_TIME
                    split_transfers: []
                    state: ACTIVE
                    tags: {}
                    updated_at: '2025-11-10T19:23:44.732243Z'
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_links/payment_link_ctZKJBuMdQJRmrbLKtabZ
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      operationId: getPaymentLink
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/payment_links/payment_link_ciACu5E9CqjqTmPq4k5WT"
            \

            -H "Finix-Version: 2022-02-01" \

            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      x-group-parameters: true
    put:
      summary: Update a Payment Link
      description: >
        Update an existing `Payment Link` resource, commonly used for:


        - Adding or updating tags and `nickname`

        - Toggling the payment link's `state` between `ACTIVE` and `DEACTIVATED`

        - Modifying `allowed_payment_methods` for an `ACTIVE` payment link

        - Modifying `buyer_details` for an `ACTIVE` single-use payment link


        The only fields that can be updated for `COMPLETED`, `EXPIRED`, or
        `DEACTIVATED` payment links are `nickname` and `tags`.
      tags:
        - Payment Links
      x-group-parameters: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updatePaymentLink'
            examples:
              Update Payment Link:
                value:
                  nickname: Utilities Payment – Apartment 105
                  tags:
                    order: '73312'
              Update Payment Link - Multi-Use Active:
                value:
                  additional_details:
                    collect_name: true
                    collect_email: true
                    collect_phone: true
                    collect_billing_address: true
                    collect_shipping_address: true
                    success_return_url: url
                    unsuccessful_return_url: url
                    expired_session_url: url
                    terms_of_service: url
                    requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - abc@test.com
                          - abc1@test.com
                      - type: SMS
                        destinations:
                          - '2348765431'
                    send_receipt: true
                  allowed_payment_methods:
                    - PAYMENT_CARD
                    - BANK_ACCOUNT
                  amount_details:
                    amount_type: FIXED
                    total_amount: 7500
                    currency: USD
                  nickname: Rental Payment – Apartment 101
                  state: ACTIVE
                  tags:
                    order: '94752'
              Update Payment Link - Single-Use Active:
                value:
                  additional_details:
                    collect_name: true
                    collect_email: true
                    collect_phone: true
                    collect_billing_address: true
                    collect_shipping_address: true
                    success_return_url: url
                    unsuccessful_return_url: url
                    expired_session_url: url
                    terms_of_service: url
                    requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - abc@test.com
                          - abc1@test.com
                      - type: SMS
                        destinations:
                          - '2348765431'
                    send_receipt: true
                  allowed_payment_methods:
                    - PAYMENT_CARD
                    - BANK_ACCOUNT
                  amount_details:
                    amount_type: FIXED
                    total_amount: 7500
                    currency: USD
                  buyer_details:
                    first_name: John
                    last_name: Adams
                    email: segmewoodmerellc@gmail.com
                    identity_id: IDmj1yA97RS4rMjiQgvK3Vio
                    phone: null
                    billing_address: null
                    shipping_address:
                      city: null
                      country: USA
                      line1: null
                      line2: null
                      postal_code: null
                      region: null
                  items:
                    - image_details:
                        primary_image_url: >-
                          https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                        alternative_image_urls: []
                      description: null
                      price_details:
                        sale_amount: 7500
                        currency: USD
                        price_type: null
                        regular_amount: 0
                      name: Holiday Dinner Contribution
                      quantity: 1
                  nickname: Rental Payment – Apartment 101
                  state: ACTIVE
                  tags:
                    order: '94752'
              Update Payment Link - Deactivate:
                value:
                  state: DEACTIVATED
      responses:
        '200':
          description: Payment Link
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_link'
              examples:
                Update Payment Link:
                  value:
                    id: payment_link_ciL8rqqShe8SdssbmfTnA
                    created_at: '2025-01-01T06:15:26.097859Z'
                    updated_at: '2025-01-01T06:15:26.097859Z'
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                    payment_frequency: ONE_TIME
                    is_multiple_use: false
                    allowed_payment_methods:
                      - BANK_ACCOUNT
                      - PAYMENT_CARD
                    nickname: Utilities Payment – Apartment 105
                    items:
                      - image_details:
                          primary_image_url: >-
                            https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                          alternative_image_urls: []
                        description: null
                        price_details:
                          sale_amount: 7500
                          currency: USD
                          price_type: null
                          regular_amount: 0
                        name: Holiday Dinner Contribution
                        quantity: 1
                    buyer_details: null
                    amount_details:
                      amount_type: FIXED
                      total_amount: 7500
                      currency: USD
                      min_amount: null
                      max_amount: null
                      amount_breakdown: null
                    branding:
                      brand_color: '#111823'
                      accent_color: '#f3eeee'
                      logo: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      icon: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      logo_alternative_text: null
                      button_font_color: null
                    additional_details:
                      collect_name: true
                      collect_email: true
                      collect_phone: false
                      collect_billing_address: false
                      collect_shipping_address: false
                      success_return_url: https://mybasketball-leaguexyz.com/success
                      unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                      expired_session_url: https://mybasketball-leaguexyz.com/expired
                      terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                      expiration_in_minutes: 1576800
                      send_receipt: true
                      receipt_requested_delivery_methods:
                        - type: EMAIL
                          destinations:
                            - abc@test.com
                        - type: SMS
                          destinations:
                            - '2348765431'
                    state: ACTIVE
                    tags:
                      order: '73312'
                    link_url: https://link.sandbox-payments-checkout.com/2Ze8WI
                    link_expires_at: '2028-01-01T06:15:26.044257Z'
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_links/payment_link_ciL8rqqShe8SdssbmfTnA
                Update Payment Link - Multi-Use Active:
                  value:
                    id: payment_link_ciL8wB6rAVZVqTX8wnCf6
                    created_at: '2025-01-01T06:16:36.42257Z'
                    updated_at: '2025-01-01T06:19:51.690276Z'
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                    payment_frequency: ONE_TIME
                    is_multiple_use: true
                    allowed_payment_methods:
                      - BANK_ACCOUNT
                      - PAYMENT_CARD
                    nickname: Rental Payment – Apartment 101
                    items:
                      - image_details:
                          primary_image_url: >-
                            https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                          alternative_image_urls: []
                        description: null
                        price_details:
                          sale_amount: 7500
                          currency: USD
                          price_type: null
                          regular_amount: 0
                        name: Holiday Dinner Contribution
                        quantity: 1
                    buyer_details: null
                    amount_details:
                      amount_type: FIXED
                      total_amount: 7500
                      currency: USD
                      min_amount: null
                      max_amount: null
                      amount_breakdown: null
                    branding:
                      brand_color: '#111823'
                      accent_color: '#f3eeee'
                      logo: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      icon: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      logo_alternative_text: null
                      button_font_color: null
                    additional_details:
                      collect_name: true
                      collect_email: true
                      collect_phone: false
                      collect_billing_address: false
                      collect_shipping_address: false
                      success_return_url: https://mybasketball-leaguexyz.com/success
                      unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                      expired_session_url: https://mybasketball-leaguexyz.com/expired
                      terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                      expiration_in_minutes: 1576800
                      send_receipt: true
                      receipt_requested_delivery_methods:
                        - type: EMAIL
                          destinations:
                            - abc@test.com
                        - type: SMS
                          destinations:
                            - '2348765431'
                    state: ACTIVE
                    tags:
                      order: '94752'
                    link_url: https://link.sandbox-payments-checkout.com/m9hDx6
                    link_expires_at: '2028-01-01T06:16:36.353206Z'
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_links/payment_link_ciL8wB6rAVZVqTX8wnCf6
                Update Payment Link - Single-Use Active:
                  value:
                    id: payment_link_ciL8rqqShe8SdssbmfTnA
                    created_at: '2025-01-01T06:15:26.097859Z'
                    updated_at: '2025-01-01T06:19:00.724691Z'
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                    payment_frequency: ONE_TIME
                    is_multiple_use: false
                    allowed_payment_methods:
                      - BANK_ACCOUNT
                      - PAYMENT_CARD
                    nickname: Rental Payment – Apartment 101
                    items:
                      - image_details:
                          primary_image_url: >-
                            https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                          alternative_image_urls: []
                        description: null
                        price_details:
                          sale_amount: 7500
                          currency: USD
                          price_type: null
                          regular_amount: 0
                        name: Holiday Dinner Contribution
                        quantity: 1
                    buyer_details:
                      identity_id: IDmj1yA97RS4rMjiQgvK3Vio
                      first_name: John
                      last_name: Adams
                    amount_details:
                      amount_type: FIXED
                      total_amount: 7500
                      currency: USD
                      min_amount: null
                      max_amount: null
                      amount_breakdown: null
                    branding:
                      brand_color: '#111823'
                      accent_color: '#f3eeee'
                      logo: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      icon: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      logo_alternative_text: null
                      button_font_color: null
                    additional_details:
                      collect_name: true
                      collect_email: true
                      collect_phone: false
                      collect_billing_address: false
                      collect_shipping_address: false
                      success_return_url: https://mybasketball-leaguexyz.com/success
                      unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                      expired_session_url: https://mybasketball-leaguexyz.com/expired
                      terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                      expiration_in_minutes: 1576800
                      send_receipt: true
                      receipt_requested_delivery_methods:
                        - type: EMAIL
                          destinations:
                            - abc@test.com
                        - type: SMS
                          destinations:
                            - '2348765431'
                    state: ACTIVE
                    tags:
                      order: '94752'
                    link_url: https://link.sandbox-payments-checkout.com/2Ze8WI
                    link_expires_at: '2028-01-01T06:15:26.044257Z'
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_links/payment_link_ciL8rqqShe8SdssbmfTnA
                Update Payment Link - Deactivate:
                  value:
                    id: payment_link_ciACu5E9CqjqTmPq4k5WT
                    created_at: '2024-12-27T05:50:23.493769Z'
                    updated_at: '2025-01-01T07:00:45.684194Z'
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                    payment_frequency: ONE_TIME
                    is_multiple_use: true
                    allowed_payment_methods:
                      - BANK_ACCOUNT
                      - PAYMENT_CARD
                    nickname: Rental Payment – Apartment 101
                    items:
                      - image_details:
                          primary_image_url: null
                          alternative_image_urls: []
                        description: adsfd
                        price_details:
                          sale_amount: 100
                          currency: USD
                          price_type: null
                          regular_amount: 0
                        name: asdfd
                        quantity: 2
                    buyer_details: null
                    amount_details:
                      amount_type: FIXED
                      total_amount: 200
                      currency: USD
                      min_amount: null
                      max_amount: null
                      amount_breakdown: null
                    branding:
                      brand_color: '#FFFFFF'
                      accent_color: '#0B5DBC'
                      logo: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/05-30-2024-08_46_01_Screenshot%202024-05-30%20at%208.45.55%E2%80%AFPM.png_f4efa5b7-ee2d-4167-af48-0567a6bb22c4
                      icon: ''
                      logo_alternative_text: null
                      button_font_color: '#FFFFFF'
                    additional_details:
                      collect_name: false
                      collect_email: true
                      collect_phone: false
                      collect_billing_address: false
                      collect_shipping_address: false
                      success_return_url: ''
                      unsuccessful_return_url: ''
                      expired_session_url: ''
                      terms_of_service_url: https://www.google.com
                      expiration_in_minutes: 1576800
                      send_receipt: true
                      receipt_requested_delivery_methods: []
                    state: DEACTIVATED
                    tags:
                      order: '94752'
                    link_url: https://link.sandbox-payments-checkout.com/mUOcNH
                    link_expires_at: '2027-12-27T05:50:23.43608Z'
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payment_links/payment_link_ciACu5E9CqjqTmPq4k5WT
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      operationId: updatePaymentLink
      x-java-method-name: update
    parameters:
      - schema:
          type: string
        name: payment_link_id
        description: The ID of the `Payment Link`.
        in: path
        required: true
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).
  /checkout_forms:
    post:
      summary: Create a Checkout Form
      operationId: createCheckoutForm
      description: >
        Create a `Checkout Form` to accept the details of buyers. 


        Related guides: [Checkout
        Forms](/guides/online-payments/low-code-no-code/checkout-pages).
      tags:
        - Checkout Forms
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCheckoutForm'
            examples:
              Checkout Form - Minimal Fields:
                value:
                  merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                  payment_frequency: ONE_TIME
                  allowed_payment_methods:
                    - PAYMENT_CARD
                  nickname: Gym Membership Signup Deposit
                  amount_details:
                    amount_type: FIXED
                    total_amount: 5418
                    currency: USD
                  branding:
                    brand_color: '#FFFFFF'
                    accent_color: '#000000'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                  additional_details:
                    terms_of_service_url: https://sweat.com/terms_of_service.html
              Checkout Form - All Fields:
                value:
                  merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                  payment_frequency: ONE_TIME
                  allowed_payment_methods:
                    - APPLE_PAY
                    - BANK_ACCOUNT
                    - GOOGLE_PAY
                    - PAYMENT_CARD
                  nickname: Gym Membership Signup Deposit
                  items:
                    - image_details:
                        primary_image_url: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                      description: Gym membership deposit
                      price_details:
                        sale_amount: 4000
                        currency: USD
                        price_type: PROMOTIONAL
                        regular_amount: 5000
                      quantity: '1'
                  amount_details:
                    amount_type: FIXED
                    total_amount: 5418
                    currency: USD
                    min_amount: null
                    max_amount: null
                    amount_breakdown:
                      subtotal_amount: 3994
                      shipping_amount: 995
                      estimated_tax_amount: 429
                      discount_amount: 1000
                      tip_amount: 1000
                  branding:
                    brand_color: '#FFFFFF'
                    accent_color: '#000000'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                    logo_alternative_text: Alternative text
                    button_font_color: '#111823'
                  additional_details:
                    collect_name: true
                    collect_email: true
                    collect_phone_number: false
                    collect_billing_address: false
                    collect_shipping_address: false
                    success_return_url: https://www.sweat.com/success/123rw21w.html
                    unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                    cart_return_url: https://www.sweat.com/my_cart.html
                    expired_session_url: https://sweat.com/error.html
                    terms_of_service_url: https://sweat.com/terms_of_service.html
                    expiration_in_minutes: 10080
              Checkout Form - Split Transaction:
                value:
                  merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                  payment_frequency: ONE_TIME
                  allowed_payment_methods:
                    - PAYMENT_CARD
                  nickname: Gym Membership Signup Deposit
                  items:
                    - image_details:
                        primary_image_url: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                      description: Gym membership deposit
                      price_details:
                        sale_amount: 4000
                        currency: USD
                        price_type: PROMOTIONAL
                        regular_amount: 5000
                      quantity: '1'
                  amount_details:
                    amount_type: FIXED
                    total_amount: 5418
                    currency: USD
                    amount_breakdown:
                      subtotal_amount: 3994
                      shipping_amount: 995
                      estimated_tax_amount: 429
                      discount_amount: 1000
                      tip_amount: 1000
                  branding:
                    brand_color: '#FFFFFF'
                    accent_color: '#000000'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                    logo_alternative_text: Alternative text
                    button_font_color: '#111823'
                  additional_details:
                    collect_name: true
                    collect_email: true
                    collect_phone_number: false
                    collect_billing_address: false
                    collect_shipping_address: false
                    success_return_url: https://www.sweat.com/success/123rw21w.html
                    cart_return_url: https://www.sweat.com/my_cart.html
                    expired_session_url: https://sweat.com/error.html
                    terms_of_service_url: https://sweat.com/terms_of_service.html
                    expiration_in_minutes: 10080
                  split_transfers:
                    - merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      amount: 2709
                      tags:
                        key: value
                    - merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      amount: 2709
                      fee: 100
      responses:
        '201':
          $ref: '#/components/responses/createCheckoutForm'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: create
    get:
      summary: List Checkout Forms
      operationId: listCheckoutForms
      description: Retrieve a list of `Checkout Form` resources.
      tags:
        - Checkout Forms
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/checkout_forms" \
            -H "Finix-Version: 2022-02-01" \
            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listCheckoutForms'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: list
  /checkout_forms/{checkout_forms_id}:
    get:
      summary: Fetch a Checkout Form
      operationId: getCheckoutForm
      description: Retrieve the details of an existing `Checkout Form`.
      tags:
        - Checkout Forms
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          description: A single `Checkout Form`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkout_form'
              examples:
                Checkout Form:
                  value:
                    id: checkout_form_cv1vZM3wciUyUjjJ4Kxbi
                    additional_details:
                      cart_return_url: https://www.sweat.com/my_cart.html
                      collect_billing_address: false
                      collect_email: true
                      collect_name: true
                      collect_phone: false
                      collect_shipping_address: false
                      expiration_in_minutes: 10080
                      expired_session_url: https://sweat.com/error.html
                      receipt_requested_delivery_methods: []
                      send_receipt: false
                      success_return_url: https://www.sweat.com/success/123rw21w.html
                      terms_of_service_url: https://sweat.com/terms_of_service.html
                      unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                    allowed_payment_methods:
                      - APPLE_PAY
                      - BANK_ACCOUNT
                      - GOOGLE_PAY
                      - PAYMENT_CARD
                    amount_details:
                      amount_breakdown:
                        tax_exempt: false
                        subtotal_amount: 3994
                        shipping_amount: 995
                        estimated_tax_amount: 429
                        discount_amount: 1000
                        tip_amount: 1000
                        customs_duty_amount: null
                        additional_buyer_charges: null
                      amount_type: FIXED
                      currency: USD
                      max_amount: null
                      min_amount: null
                      total_amount: 5418
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    attempt_level_two_level_three_payment: false
                    branding:
                      accent_color: '#000000'
                      brand_color: '#FFFFFF'
                      button_font_color: '#111823'
                      icon: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                      logo: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                      logo_alternative_text: Alternative text
                    buyer_details: null
                    created_at: '2025-12-11T20:18:38.241501Z'
                    is_authorization: false
                    items:
                      - description: Gym membership deposit
                        image_details:
                          primary_image_url: >-
                            https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                          alternative_image_urls: []
                        item_details: null
                        name: null
                        price_details:
                          sale_amount: 4000
                          currency: USD
                          price_type: PROMOTIONAL
                          regular_amount: 5000
                          amount_excluding_sales_tax: null
                          item_discount_amount: null
                        quantity: 1
                    link_expires_at: '2025-12-18T20:18:38.229569Z'
                    link_url: https://link.sandbox-payments-checkout.com/J9WZkk
                    merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                    nickname: Gym Membership Signup Deposit
                    payment_frequency: ONE_TIME
                    split_transfers: []
                    state: ACTIVE
                    tags: {}
                    updated_at: '2025-12-11T20:18:38.241501Z'
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/checkout_forms/checkout_form_cv1vZM3wciUyUjjJ4Kxbi
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: get
      x-group-parameters: true
    parameters:
      - schema:
          type: string
        name: checkout_forms_id
        in: path
        required: true
  /payout_links:
    post:
      summary: Create a Payout Link
      operationId: createPayoutLink
      description: >-
        Generate a `Payout Link` resource to create a single-use link for
        sending a payout to a recipient.
      tags:
        - Payout Links
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createPayoutLink'
            examples:
              Payout Link - Minimal Fields:
                value:
                  allowed_payout_operations:
                    - PUSH_TO_CARD
                  amount_details:
                    total_amount: 100000
                    currency: USD
                  additional_details:
                    terms_of_service_url: https://example.com/terms
                  branding:
                    icon: ''
                    brand_color: '#0D121A'
                    accent_color: '#0B5DBC'
                    logo: >
                      https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png
              Payout Link - All Fields:
                value:
                  allowed_payout_operations:
                    - PUSH_TO_ACH
                    - PUSH_TO_CARD
                  nickname: 'Auto Insurance Claim Settlement #INS-2024-7891'
                  tags:
                    collectEmail: true
                    collectPhoneNumber: true
                    claimNumber: INS-2024-7891
                    policyNumber: POL-456789
                  items:
                    - name: Vehicle Damage Settlement
                      description: Collision damage repair settlement for 2019 Honda Accord
                      quantity: '1'
                      image_details:
                        primary_image_url: >-
                          https://images.unsplash.com/photo-1558618666-fcd25c85cd64?w=400
                      price_details:
                        amount: 850000
                        currency: USD
                  amount_details:
                    total_amount: 850000
                    currency: USD
                  additional_details:
                    success_return_url: https://www.safeguardinsurance.com/claims/success
                    unsuccessful_return_url: https://www.safeguardinsurance.com/claims/error
                    expired_session_url: https://www.safeguardinsurance.com/claims/expired
                    terms_of_service_url: https://www.safeguardinsurance.com/terms
                    expiration_in_minutes: 4320
                  branding:
                    icon: https://www.safeguardinsurance.com/assets/favicon.ico
                    brand_color: '#1E3A8A'
                    accent_color: '#3B82F6'
                    button_font_color: '#FFFFFF'
                    logo: https://www.safeguardinsurance.com/assets/logo.png
                    logo_alternative_text: Safeguard Insurance Company Logo
                  recipient_details:
                    merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                    first_name: Sarah
                    last_name: Johnson
                    business_name: null
                    doing_business_as: null
                    email: sarah.johnson@email.com
              Payout Link - Push to Card:
                value:
                  allowed_payout_operations:
                    - PUSH_TO_CARD
                  amount_details:
                    total_amount: 100000
                    currency: USD
                  additional_details:
                    terms_of_service_url: https://example.com/terms
                  branding:
                    icon: ''
                    brand_color: '#0D121A'
                    accent_color: '#0B5DBC'
                    logo: >
                      https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png
              Payout Link - Push to ACH:
                value:
                  allowed_payout_operations:
                    - PUSH_TO_ACH
                  amount_details:
                    total_amount: 100000
                    currency: USD
                  additional_details:
                    terms_of_service_url: https://example.com/terms
                  branding:
                    icon: ''
                    brand_color: '#0D121A'
                    accent_color: '#0B5DBC'
                    logo: >
                      https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png
      responses:
        '201':
          $ref: '#/components/responses/createPayoutLink'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: create
    get:
      summary: List Payout Links
      operationId: listPayoutLinks
      description: Retrieve a list of Payout Link resources.
      tags:
        - Payout Links
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/payout_links" \
              -H "Content-Type: application/json" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listPayoutLinks'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: list
  /payout_links/{payout_link_id}:
    get:
      summary: Fetch a Payout Link
      operationId: getPayoutLink
      description: Retrieve the details of an existing `Payout Link`.
      tags:
        - Payout Links
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          description: A single `Payout Link`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payout_link'
              examples:
                Payout Link:
                  value:
                    id: payout_link_ches9gZg2WWM7ARM53pmP
                    additional_details:
                      success_return_url: null
                      unsuccessful_return_url: null
                      expired_session_url: null
                      terms_of_service_url: https://example.com/terms
                      expiration_in_minutes: 10080
                    allowed_payout_operations:
                      - PUSH_TO_ACH
                    amount_details:
                      total_amount: 100000
                      currency: USD
                    application_id: AP5Tq3MMxKwHYX7soDncrCQ3
                    branding:
                      brand_color: '#0D121A'
                      accent_color: '#0B5DBC'
                      logo: >-
                        https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png
                      icon: ''
                      logo_alternative_text: null
                      button_font_color: '#FFFFFF'
                    created_at: '2024-11-15T10:07:50.353254Z'
                    items:
                      - name: 'Insurance Payout #2552'
                        image_details:
                          primary_image_url: >-
                            https://upload.wikimedia.org/wikipedia/commons/thumb/8/88/Uninsured_cars_seized_by_police_in_Liverpool.JPG/220px-Uninsured_cars_seized_by_police_in_Liverpool.JPG
                          alternative_image_urls: []
                        price_details:
                          amount: 100000
                          currency: USD
                        description: Car Damage
                        quantity: 1
                    link_expires_at: '2024-11-22T10:07:50.335572Z'
                    link_url: https://link.sandbox-payments-checkout.com/Xjts64
                    nickname: 'Insurance Claim #2552'
                    recipient_details: null
                    state: ACTIVE
                    tags:
                      collectPhoneNumber: false
                      collectEmail: false
                    updated_at: '2024-11-15T10:07:50.596865Z'
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payout_links/payout_link_ches9gZg2WWM7ARM53pmP
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
      x-group-parameters: true
    put:
      summary: Update Payout Link
      operationId: updatePayoutLink
      description: >
        Update the details of a `Payout Link`. 


        The `state` must be `ACTIVE` to update `allowed_payout_operations` and
        `recipient_details`.
      tags:
        - Payout Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updatePayoutLink'
            examples:
              Update Payout Link - Minimal Fields:
                value:
                  nickname: 'Insurance Claim #2551'
                  tags:
                    collectEmail: true
                    collectPhoneNumber: true
              Update Payout Link (Active) - All Fields:
                value:
                  allowed_payout_operations:
                    - PUSH_TO_ACH
                  nickname: 'Insurance Claim #2551'
                  recipient_details:
                    merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                    first_name: Todd
                    last_name: Berry
                    email: null
                    business_name: null
                    doing_business_as: null
                  tags:
                    collectEmail: true
                    collectPhoneNumber: true
              Deactivate a Payout Link:
                value:
                  state: DEACTIVATED
              Update a Deactivated Payout Link:
                value:
                  nickname: 'Insurance Claim #2551'
                  state: ACTIVE
                  tags:
                    collectEmail: false
                    collectPhoneNumber: true
      responses:
        '200':
          description: A single `Payout Link`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payout_link'
              examples:
                Update Payout Link:
                  value:
                    id: payout_link_ches9gZg2WWM7ARM53pmP
                    additional_details:
                      success_return_url: null
                      unsuccessful_return_url: null
                      expired_session_url: null
                      terms_of_service_url: https://example.com/terms
                      expiration_in_minutes: 10080
                    allowed_payout_operations:
                      - PUSH_TO_ACH
                    amount_details:
                      total_amount: 100000
                      currency: USD
                    application_id: AP5Tq3MMxKwHYX7soDncrCQ3
                    branding:
                      brand_color: '#0D121A'
                      accent_color: '#0B5DBC'
                      logo: >-
                        https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png
                      icon: ''
                      logo_alternative_text: null
                      button_font_color: '#FFFFFF'
                    created_at: '2024-11-15T10:07:50.353254Z'
                    items:
                      - name: 'Insurance Payout #2552'
                        image_details:
                          primary_image_url: >-
                            https://upload.wikimedia.org/wikipedia/commons/thumb/8/88/Uninsured_cars_seized_by_police_in_Liverpool.JPG/220px-Uninsured_cars_seized_by_police_in_Liverpool.JPG
                          alternative_image_urls: []
                        price_details:
                          amount: 100000
                          currency: USD
                        description: Car Damage
                        quantity: 1
                    link_expires_at: '2024-11-22T10:07:50.335572Z'
                    link_url: https://link.sandbox-payments-checkout.com/Xjts64
                    nickname: 'Insurance Claim #2552'
                    recipient_details: null
                    state: ACTIVE
                    tags:
                      collectPhoneNumber: false
                      collectEmail: false
                    updated_at: '2024-11-15T10:07:50.596865Z'
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/payout_links/payout_link_ches9gZg2WWM7ARM53pmP
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
        '422':
          $ref: '#/components/responses/422UnprocessableEntity'
      x-java-method-name: update
      x-group-parameters: true
    parameters:
      - schema:
          type: string
        name: payout_link_id
        description: The ID of the `Payout Link`.
        in: path
        required: true
  /subscriptions:
    post:
      summary: Create a Subscription
      operationId: createSubscription
      description: >
        Create a `Subscription` resource to charge a [`Payment
        Instrument`](#Payment-Instruments) regularly. 


        If there is no trial period, the subscription will create a
        [`Transfer`](#Transfers) shortly after creation (within 60 minutes).


        The following options are available when creating a subscription.


        ### Adding a trial period


        You can create a subscription with a trial period by providing
        `trial_details` in the request body. After creating a subscription, a
        `Transfer` will occur after the trial period has elapsed. The
        `first_charge_at` property in the response determines when the transfer
        will take place.


        ### Adding a discount phase


        To apply a discount, include `discount_phase_details` in the request
        body. Set `discount_phase_details.amount` as the discounted price and
        `discount_phase_details.billing_interval_count` to specify how many
        billing intervals the discount applies. After this period, the customer
        is charged the full amount from the `Subscription`.


        ### Using a Subscription Plan


        Think of a [`Subscription Plan`](#Subscription-Plans) as a template for
        the `Subscription` resource. When creating a subscription, you can use a
        `Subscription Plan` by providing a `subscription_plan_id`. Doing so lets
        you base a subscription on existing values for `amount`,
        `billing_interval`, and more.


        ### Future Subscription


        Schedule a subscription by setting `start_subscription_at` to a future
        timestamp. The response will show `subscription_phase` as `NONE` and
        `state` as `NOT_STARTED`, indicating it has not started. This applies to
        both subscriptions with or without a subscription plan.


        ### Fixed-Length Subscription


        You can set a subscription to expire by specifying the
        `total_billing_intervals`, which indicates the number of recurring
        billing cycles in months or weeks. You can set subscriptions created
        from subscription plans to expire.


        ### Card Validation with $0 Authorization


        When creating a subscription using a card-type [`Payment
        Instrument`](#Payment-Instruments), Finix performs a [$0
        `Authorization`](#Authorizations) to validate the card. This check
        confirms that the card is active and verifies the billing address and
        security code (AVS and CVV).


        If the card fails validation, the API returns a `422 Unprocessable
        Entity` error and the subscription is not created. This protects against
        invalid or risky cards, helping reduce failed payments and fraud.
      tags:
        - Subscriptions
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/createSubscriptionMinimalFields'
                - $ref: '#/components/schemas/createSubscription'
                - $ref: '#/components/schemas/createSubscriptionDiscountPhase'
                - $ref: '#/components/schemas/createSubscriptionFixed'
                - $ref: '#/components/schemas/createSubscriptionFuture'
                - $ref: '#/components/schemas/createSubscriptionTrial'
                - $ref: '#/components/schemas/createSubscriptionFromPlan'
                - $ref: '#/components/schemas/createSubscriptionFromPlanMinimalFields'
                - $ref: '#/components/schemas/createSubscriptionFromPlanFixed'
                - $ref: '#/components/schemas/createSubscriptionFromPlanFuture'
            examples:
              Subscription - Minimal Fields:
                value:
                  amount: 19900
                  currency: USD
                  linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                  linked_type: MERCHANT
                  billing_interval: MONTHLY
                  subscription_details:
                    collection_method: BILL_AUTOMATICALLY
                  buyer_details:
                    receipt_requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - abc@test.com
                      - type: SMS
                        destinations:
                          - '2348765431'
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
                  tags:
                    order_number: 21DFASJSAKAS
              Subscription - All Fields:
                value:
                  amount: 19900
                  currency: USD
                  linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                  linked_type: MERCHANT
                  billing_interval: MONTHLY
                  subscription_details:
                    collection_method: BILL_AUTOMATICALLY
                    discount_phase_details:
                      amount: 1000
                      billing_interval_count: 3
                    trial_details:
                      interval_type: MONTH
                      interval_count: 2
                  buyer_details:
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
                    receipt_requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - abc@test.com
                      - type: SMS
                        destinations:
                          - '2348765431'
                  nickname: Finflix Gold Package
                  start_subscription_at: '2029-05-05T22:42:05.490Z'
                  total_billing_intervals: 12
                  tags:
                    order_number: 21DFASJSAKAS
              Subscription - Discount Phase:
                value:
                  amount: 2000
                  currency: USD
                  linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                  linked_type: MERCHANT
                  nickname: Finflix Gold Package
                  billing_interval: MONTHLY
                  subscription_details:
                    collection_method: BILL_AUTOMATICALLY
                    discount_phase_details:
                      amount: 1000
                      billing_interval_count: 3
                  buyer_details:
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
              Subscription - Fixed-Length:
                value:
                  amount: 19900
                  currency: USD
                  linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                  linked_type: MERCHANT
                  billing_interval: MONTHLY
                  total_billing_intervals: 12
                  subscription_details:
                    collection_method: BILL_AUTOMATICALLY
                  buyer_details:
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
              Subscription - Future Start Date:
                value:
                  amount: 10000
                  currency: USD
                  linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                  linked_type: MERCHANT
                  nickname: Monthly Cheese Delivery Club
                  billing_interval: MONTHLY
                  start_subscription_at: '2029-05-05T22:42:05.490Z'
                  subscription_details:
                    collection_method: BILL_AUTOMATICALLY
                  buyer_details:
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
              Subscription - Trial Period:
                value:
                  amount: 19900
                  currency: USD
                  linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                  linked_type: MERCHANT
                  billing_interval: MONTHLY
                  subscription_details:
                    collection_method: BILL_AUTOMATICALLY
                    trial_details:
                      interval_type: MONTH
                      interval_count: 1
                  buyer_details:
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
              Subscription - Subscription Plan - All Fields:
                value:
                  linked_to: MUxdJCr9xTMnmt1vGUAqV9z4
                  linked_type: MERCHANT
                  subscription_plan_id: subscription_plan_ctBbJ1ihsC8Hpju4RQfZE
                  buyer_details:
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
                  total_billing_intervals: 12
                  start_subscription_at: '2029-05-05T22:42:05.490Z'
              Subscription - Subscription Plan - Minimal Fields:
                value:
                  buyer_details:
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
                  linked_to: MUxdJCr9xTMnmt1vGUAqV9z4
                  linked_type: MERCHANT
                  subscription_plan_id: subscription_plan_ctBbJ1ihsC8Hpju4RQfZE
              Subscription - Subscription Plan - Fixed-Length:
                value:
                  buyer_details:
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
                  linked_to: MUxdJCr9xTMnmt1vGUAqV9z4
                  linked_type: MERCHANT
                  subscription_plan_id: subscription_plan_ctBbJ1ihsC8Hpju4RQfZE
                  total_billing_intervals: 12
              Subscription - Subscription Plan - Future Start Date:
                value:
                  buyer_details:
                    identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
                  linked_to: MUxdJCr9xTMnmt1vGUAqV9z4
                  linked_type: MERCHANT
                  subscription_plan_id: subscription_plan_ctBbJ1ihsC8Hpju4RQfZE
                  start_subscription_at: '2029-05-05T22:42:05.490Z'
      responses:
        '201':
          $ref: '#/components/responses/createSubscription'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
      x-keywords:
        includes:
          - subscription
    get:
      summary: List Subscriptions
      operationId: listSubscriptions
      description: >
        Retrieve a list of `Subscription` resources. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      tags:
        - Subscriptions
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/amount'
        - $ref: '#/components/parameters/amount.gt'
        - $ref: '#/components/parameters/amount.gte'
        - $ref: '#/components/parameters/amount.lt'
        - $ref: '#/components/parameters/amount.lte'
        - $ref: '#/components/parameters/application_id'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/buyer_identity_id'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/limit'
        - name: linked_to
          in: query
          description: |
            Filter subscriptions linked to a specific `Merchant`.
          schema:
            type: string
            example: MUcgYZswyRfqSSbvMsxuaHxZ
        - name: state
          description: |
            Filter by `state`:
            - `ACTIVE`
            - `CANCELED`
            - `EXPIRED`
            - `NOT_STARTED`
            - `PAST DUE`
          in: query
          schema:
            type: string
            example: NOT_STARTED
          style: form
        - name: subscription_plan_id
          in: query
          description: >
            Filter subscriptions that were created using a specific
            `Subscription Plan`.
          schema:
            type: string
            example: subscription_plan_ciLn19pSKDTFoehtH7ET
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/subscriptions" \
            -H "Content-Type: application/json" \
            -H "Finix-Version: 2022-02-01" \
            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listSubscriptions'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /subscriptions/{subscription_id}:
    get:
      summary: Fetch a Subscription
      operationId: getSubscription
      description: Retrieve the details of a previously created `Subscription`.
      tags:
        - Subscriptions
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          description: A single `Subscription`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscription'
              examples:
                Subscription:
                  value:
                    id: subscription_ctB8iXsBuQwpSzvyXMmUf
                    created_at: '2025-10-29T20:33:00.40Z'
                    updated_at: '2025-10-29T20:33:00.40Z'
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    first_charge_at: '2029-07-05T22:42:05.49Z'
                    next_billing_date:
                      year: 2029
                      month: 7
                      day: 5
                    amount: 19900
                    buyer_details:
                      identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                      instrument_id: PImXAVgkKVshKWWHUk4xXbve
                      requested_delivery_methods: []
                      shipping_address: null
                    currency: USD
                    linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                    linked_type: MERCHANT
                    nickname: Finflix Gold Package
                    billing_interval: MONTHLY
                    subscription_details:
                      collection_method: BILL_AUTOMATICALLY
                      send_invoice: false
                      send_receipt: false
                      trial_details:
                        interval_type: MONTH
                        interval_count: 2
                        trial_started_at: null
                        trial_expected_start_at: '2029-05-05T22:42:05.49Z'
                        trial_expected_end_at: '2029-07-05T19:40:17.49Z'
                      discount_phase_details:
                        amount: 1000
                        billing_interval_count: 3
                        discount_phase_started_at: null
                        discount_phase_expected_start_at: '2029-07-05T19:40:17.49Z'
                        discount_phase_expected_end_at: '2029-10-05T19:40:17.49Z'
                      notification_preferences:
                        send_confirmation: false
                    subscription_phase: NONE
                    state: NOT_STARTED
                    subscription_plan_id: null
                    start_subscription_at: '2029-05-05T22:42:05.490Z'
                    total_billing_intervals: 12
                    expires_at: '2030-07-05T19:40:17.490Z'
                    canceled_via: null
                    tags:
                      order_number: 21DFASJSAKAS
                    subscription_link_id: null
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/subscriptions/subscription_ctB8iXsBuQwpSzvyXMmUf
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
      x-group-parameters: true
    parameters:
      - description: The `Subscription` ID.
        in: path
        name: subscription_id
        required: true
        schema:
          type: string
    put:
      summary: Update Subscription
      operationId: updateSubscription
      description: >
        Update an existing `Subscription` resource, typically used for
        subscriptions created without a `Subscription Plan`. Note that you can
        only update specific resource fields.


        Two common use cases for updating a `Subscription` are:


        ### Updating the payment amount


        This operation allows for adjusting the payment amount, such as when a
        subscriber decides to donate more or less money to a charity or
        upgrade/downgrade a product or service.


        ### Updating billing details


        If the subscriber wishes to change their payment details, you can update
        the [`buyer_details.instrument_id`] property with a new [`Payment
        Instrument`](#Payment-Instruments).
      tags:
        - Subscriptions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateSubscription'
            examples:
              Update Subscription:
                value:
                  buyer_details:
                    instrument_id: PImXAVgkKVshKWWHUk4xXbve
                    requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - string
                  subscription_details:
                    send_invoice: true
                    send_receipt: true
              Update Subscription - New Subscription Plan:
                value:
                  subscription_plan_id: subscription_plan_cqsXxZf3Qd6ieEYEipM9Y
      responses:
        '200':
          description: A single `Subscription`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscription'
              examples:
                Update Subscription:
                  value:
                    id: subscription_ctB8iXsBuQwpSzvyXMmUf
                    created_at: '2025-10-29T20:33:00.40Z'
                    updated_at: '2025-10-29T20:33:00.40Z'
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    first_charge_at: '2029-07-05T22:42:05.49Z'
                    next_billing_date:
                      year: 2029
                      month: 7
                      day: 5
                    amount: 19900
                    buyer_details:
                      identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                      instrument_id: PImXAVgkKVshKWWHUk4xXbve
                      requested_delivery_methods: []
                      shipping_address: null
                    currency: USD
                    linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                    linked_type: MERCHANT
                    nickname: Finflix Gold Package
                    billing_interval: MONTHLY
                    subscription_details:
                      collection_method: BILL_AUTOMATICALLY
                      send_invoice: false
                      send_receipt: false
                      trial_details:
                        interval_type: MONTH
                        interval_count: 2
                        trial_started_at: null
                        trial_expected_start_at: '2029-05-05T22:42:05.49Z'
                        trial_expected_end_at: '2029-07-05T19:40:17.49Z'
                      discount_phase_details:
                        amount: 1000
                        billing_interval_count: 3
                        discount_phase_started_at: null
                        discount_phase_expected_start_at: '2029-07-05T19:40:17.49Z'
                        discount_phase_expected_end_at: '2029-10-05T19:40:17.49Z'
                      notification_preferences:
                        send_confirmation: false
                    subscription_phase: NONE
                    state: NOT_STARTED
                    subscription_plan_id: null
                    start_subscription_at: '2029-05-05T22:42:05.490Z'
                    total_billing_intervals: 12
                    expires_at: '2030-07-05T19:40:17.490Z'
                    canceled_via: null
                    tags:
                      order_number: 21DFASJSAKAS
                    subscription_link_id: null
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/subscriptions/subscription_ctB8iXsBuQwpSzvyXMmUf
                Update Subscription - New Subscription Plan:
                  value:
                    id: subscription_ctnvvR3JQvj8ZS6TtJXLh
                    created_at: '2025-10-22T15:55:52.67Z'
                    updated_at: '2025-10-22T15:55:52.67Z'
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    first_charge_at: '2025-10-22T15:55:52.00Z'
                    next_billing_date:
                      year: 2025
                      month: 10
                      day: 22
                    amount: 19900
                    buyer_details:
                      identity_id: IDsuVDUYpUS2pzqQVsuUZzNH
                      instrument_id: PIjRceA8GheFS4Dd72hShqZ3
                      requested_delivery_methods: []
                      shipping_address: null
                    currency: USD
                    linked_to: MUmKTKuetVV1MQ5Cq6rjWA5j
                    linked_type: MERCHANT
                    nickname: null
                    billing_interval: MONTHLY
                    subscription_details:
                      collection_method: BILL_AUTOMATICALLY
                      send_invoice: false
                      send_receipt: false
                      trial_details:
                        interval_type: MONTH
                        interval_count: 2
                        trial_started_at: '2025-01-01T00:00:00.00Z'
                        trial_expected_end_at: '2025-03-01T00:00:00.00Z'
                      discount_phase_details:
                        amount: 1000
                        billing_interval_count: 3
                      notification_preferences:
                        send_confirmation: false
                    subscription_phase: EVERGREEN
                    state: ACTIVE
                    subscription_plan_id: subscription_plan_cqsXxZf3Qd6ieEYEipM9Y
                    start_subscription_at: '2025-10-22T15:54:52.404Z'
                    total_billing_intervals: null
                    expires_at: null
                    canceled_via: null
                    tags: {}
                    subscription_link_id: null
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/subscriptions/subscription_ctnvvR3JQvj8ZS6TtJXLh
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: update
      x-group-parameters: true
    delete:
      summary: Cancel a Subscription
      operationId: removeSubscription
      description: Cancel a `Subscription`.
      tags:
        - Subscriptions
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '204':
          description: Deleted. No resource to return.
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
      x-java-method-name: removeSubscription
      x-group-parameters: true
  /subscriptions/{subscription_id}/subscription_balance_entries:
    post:
      summary: Create a Subscription Balance Entry
      operationId: createSubscriptionBalanceEntry
      description: >
        A `Subscription Balance Entry` represents a credit applied to a
        `Subscription`. 
      requestBody:
        $ref: '#/components/requestBodies/CreateSubscriptionBalanceEntryRequest'
      responses:
        '201':
          $ref: '#/components/responses/SubscriptionBalanceEntryResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      tags:
        - Subscriptions
      x-java-method-name: create
      x-group-parameters: true
    get:
      summary: List Subscription Balance Entries
      responses:
        '200':
          $ref: '#/components/responses/SubscriptionBalanceEntryList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryAmountFilter'
        - $ref: '#/components/parameters/QueryAmountGtFilter'
        - $ref: '#/components/parameters/QueryAmountGteFilter'
        - $ref: '#/components/parameters/QueryAmountLtFilter'
        - $ref: '#/components/parameters/QueryAmountLteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
        - name: sort
          description: >
            Specify the key to be used for sorting the collection. Acceptable
            values are:


            - updated_at

            - created_at
          in: query
          schema:
            type: string
          style: form
      operationId: listSubscriptionBalanceEntries
      x-java-method-name: list
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >-
            curl
            "https://finix.sandbox-payments-api.com/subscriptions/subscription_ciLn4PwcoNUiHLAzLf3y2/subscription_balance_entries"
            \
              -H "Content-Type: application/json" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      description: >-
        Retrieve a list of `Subscription Balance Entry` resources to view a
        timeline of all changes to a subscription's balance by a user.
        Currently, only credits can modify a subscription's balance.


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/overview/#section/Query-Parameters).
      tags:
        - Subscriptions
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](https://finix.com/docs/guides/developers/versioning/).
      - schema:
          type: string
        name: subscription_id
        description: The ID of the `Subscription`.
        in: path
        required: true
  /subscriptions/{subscription_id}/subscription_balance_entries/{subscription_balance_entry_id}:
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](https://finix.com/docs/guides/developers/versioning/).
      - schema:
          type: string
        name: subscription_id
        description: The ID of the `Subscription`.
        in: path
        required: true
      - schema:
          type: string
        name: subscription_balance_entry_id
        description: The ID of the `Subscription Balance Entry`.
        in: path
        required: true
    put:
      tags:
        - Subscriptions
      description: >
        This operation allows you to update the tags for an existing
        `Subscription Balance Entry`.
      summary: Update a Subscription Balance Entry
      operationId: updateSubscriptionBalanceEntry
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/SubscriptionBalanceEntryResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >-
            curl
            "https://finix.sandbox-payments-api.com/subscriptions/subscription_ciLn4PwcoNUiHLAzLf3y2/subscription_balance_entries/subscription_balance_entry_9Hom3R92btyMXKqh4JFyEw"
            \
              -H "Content-Type: application/json" \
              -H "Finix-Version: 2022-02-01" \
              -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
              -X PUT \
              -d '
              {
                "tags": {
                  "internal_code": "1234E"
                }
              }'
      x-java-method-name: update
  /subscription_links:
    post:
      summary: Create a Subscription Link
      operationId: createSubscriptionLink
      description: >-
        Create a `Subscription Link` to send to a buyer for subscribing to a
        service.
      tags:
        - Subscription Links
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: >-
                    #/components/schemas/createSubscriptionLinkOneSubscriptionPlan
                - $ref: >-
                    #/components/schemas/createSubscriptionLinkMultipleSubscriptionPlans
                - $ref: '#/components/schemas/createSubscriptionLinkConfirmation'
            examples:
              Subscription Link - One Subscription Plan:
                value:
                  currency: USD
                  merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                  is_multiple_use: true
                  nickname: Subscription Link for John
                  type: SUBSCRIPTION_PLAN
                  plans:
                    - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                      name: Subscription Plan XYZ
                      image_details:
                        primary_image_url: >-
                          https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                      url_details:
                        success_return_url: https://mybasketball-leaguexyz.com/success
                        unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    logo_alternative_text: Alternative text
                    button_font_color: '#111823'
                    button_label: Subscribe Now
                  allowed_payment_methods:
                    - APPLE_PAY
                    - BANK_ACCOUNT
                    - GOOGLE_PAY
                    - PAYMENT_CARD
                  additional_details:
                    collect_name: true
                    collect_email: true
                    collect_phone: false
                    collect_billing_address: false
                    collect_shipping_address: false
                    expiration_in_minutes: 1576800
                    send_receipt: true
                    receipt_requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - abc@test.com
                      - type: SMS
                        destinations:
                          - '2348765431'
                    expired_session_url: https://mybasketball-leaguexyz.com/expired
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
              Subscription Link - Multiple Subscription Plans:
                value:
                  currency: USD
                  merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                  is_multiple_use: true
                  nickname: Subscription Link for John
                  type: MULTIPLE_SUBSCRIPTION_PLANS
                  plans:
                    - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                      name: Subscription Plan XYZ @ $30 a Month
                      image_details:
                        primary_image_url: >-
                          https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                      url_details:
                        success_return_url: https://mybasketball-leaguexyz.com/success
                        unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                        expired_session_url: https://mybasketball-leaguexyz.com/expired
                        terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                    - subscription_plan_id: subscription_plan_cqsXxZf3Qd6ieEYEipM9Y
                      name: Subscription Plan XYZ at $300 a Month
                      image_details:
                        primary_image_url: >-
                          https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                      url_details:
                        success_return_url: https://mybasketball-leaguexyz.com/success
                        unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                        expired_session_url: https://mybasketball-leaguexyz.com/expired
                        terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    logo_alternative_text: Alternative text
                    button_font_color: '#111823'
                  allowed_payment_methods:
                    - APPLE_PAY
                    - BANK_ACCOUNT
                    - GOOGLE_PAY
                    - PAYMENT_CARD
                  additional_details:
                    collect_name: true
                    collect_email: true
                    collect_phone: false
                    collect_billing_address: false
                    collect_shipping_address: false
                    expiration_in_minutes: 1576800
                    send_receipt: true
                    receipt_requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - abc@test.com
                      - type: SMS
                        destinations:
                          - '2348765431'
                    expired_session_url: https://mybasketball-leaguexyz.com/expired
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
              Subscription Link - Send Confirmation Email:
                value:
                  currency: USD
                  merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                  is_multiple_use: true
                  nickname: Subscription Link for John
                  type: SUBSCRIPTION_PLAN
                  plans:
                    - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                      name: Subscription Plan XYZ
                      image_details:
                        primary_image_url: >-
                          https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                      url_details:
                        success_return_url: https://mybasketball-leaguexyz.com/success
                        unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                  branding:
                    brand_color: '#111823'
                    accent_color: '#f3eeee'
                    logo: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    icon: >-
                      https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                    logo_alternative_text: Alternative text
                    button_font_color: '#111823'
                    button_label: Subscribe Now
                  allowed_payment_methods:
                    - APPLE_PAY
                    - BANK_ACCOUNT
                    - GOOGLE_PAY
                    - PAYMENT_CARD
                  additional_details:
                    collect_name: true
                    collect_email: true
                    collect_phone: false
                    collect_billing_address: false
                    collect_shipping_address: false
                    expiration_in_minutes: 1576800
                    send_confirmation: true
                    send_receipt: true
                    receipt_requested_delivery_methods:
                      - type: EMAIL
                        destinations:
                          - abc@test.com
                      - type: SMS
                        destinations:
                          - '2348765431'
                    expired_session_url: https://mybasketball-leaguexyz.com/expired
                    terms_of_service_url: https://mybasketball-leaguexyz.com/terms
      responses:
        '201':
          $ref: '#/components/responses/createSubscriptionLink'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: create
      x-keywords:
        includes:
          - subscription link
          - subscription links
    get:
      summary: List Subscription Links
      operationId: listSubscriptionLinks
      description: Retrieve a list of `Subscription Link` resources.
      tags:
        - Subscription Links
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
        - $ref: '#/components/parameters/after_cursor'
        - $ref: '#/components/parameters/before_cursor'
        - $ref: '#/components/parameters/created_at.gte'
        - $ref: '#/components/parameters/created_at.lte'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/tags.key'
        - $ref: '#/components/parameters/tags.value'
        - $ref: '#/components/parameters/updated_at.gte'
        - $ref: '#/components/parameters/updated_at.lte'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/subscription_links" \
            -H "Content-Type: application/json" \
            -H "Finix-Version: 2022-02-01" \
            -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      responses:
        '200':
          $ref: '#/components/responses/listSubscriptionLinks'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: list
  /subscription_links/{subscription_link_id}:
    get:
      summary: Fetch a Subscription Link
      operationId: getSubscriptionLink
      description: Retrieve the details of a previously created `Subscription Link`.
      tags:
        - Subscription Links
      parameters:
        - $ref: '#/components/parameters/Finix-Version'
      responses:
        '200':
          $ref: '#/components/responses/createSubscriptionLink'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: get
    parameters:
      - description: The `Subscription Link` ID.
        in: path
        name: subscription_link_id
        required: true
        schema:
          type: string
    put:
      summary: Deactivate a Subscription Link
      operationId: updateSubscriptionLink
      description: Deactivate an existing `Subscription Link`.
      tags:
        - Subscription Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deactivateSubscriptionLink'
            examples:
              Deactivate a Subscription Link:
                value:
                  state: DEACTIVATED
      responses:
        '200':
          description: >-
            Response schema to a request to deactivate a `Subscription Link`
            object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscription_link'
              examples:
                Deactivated Subscription Link:
                  value:
                    id: subscription_link_cqsYdCRxog2345YdM8TTT
                    additional_details:
                      collect_billing_address: false
                      collect_email: true
                      collect_name: true
                      collect_phone: false
                      collect_shipping_address: false
                      expiration_in_minutes: 1576800
                      expired_session_url: https://mybasketball-leaguexyz.com/expired
                      receipt_requested_delivery_methods:
                        - type: EMAIL
                          destinations:
                            - abc@test.com
                        - type: SMS
                          destinations:
                            - '2348765431'
                      send_receipt: true
                      success_return_url: null
                      terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                      unsuccessful_return_url: null
                    allowed_payment_methods:
                      - BANK_ACCOUNT
                      - PAYMENT_CARD
                    application_id: APc9vhYcPsRuTSpKD9KpMtPe
                    branding:
                      accent_color: '#f3eeee'
                      brand_color: '#111823'
                      button_font_color: '#111823'
                      button_label: Subscribe Now
                      icon: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      logo: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                      logo_alternative_text: Alternative text
                    created_at: '2025-07-25T15:25:38.70Z'
                    is_multiple_use: true
                    link_expires_at: '2028-07-24T15:25:38.67Z'
                    link_url: https://link.sandbox-payments-checkout.com/4tkvMt
                    merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                    nickname: Subscription Link for John
                    plans:
                      - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                        name: Subscription Plan XYZ
                        image_details:
                          primary_image_url: >-
                            https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                          alternative_image_urls: []
                        url_details:
                          success_return_url: https://mybasketball-leaguexyz.com/success
                          unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                    state: DEACTIVATED
                    tags: {}
                    type: SUBSCRIPTION_PLAN
                    updated_at: '2025-07-25T15:27:36.24Z'
                    _links:
                      self:
                        href: >-
                          https://finix.sandbox-payments-api.com/subscription_links/subscription_link_cqsYdCRxog2345YdM8TTT
          headers:
            date:
              $ref: '#/components/headers/date'
            finix-apiuser-role:
              $ref: '#/components/headers/finix-apiuser-role'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '406':
          $ref: '#/components/responses/406NotAcceptable'
      x-java-method-name: update
  /subscription_plans:
    post:
      summary: Create a Subscription Plan
      operationId: createSubscriptionPlan
      description: >
        Create a `Subscription Plan` resource to group and manage recurring
        payments for individual `Subscription` resources. You can create a
        `Subscription Plan` with or without a trial period.
      requestBody:
        $ref: '#/components/requestBodies/CreateSubscriptionPlanRequest'
      responses:
        '201':
          $ref: '#/components/responses/SubscriptionPlan'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      tags:
        - Subscription Plans
      x-java-method-name: create
      x-group-parameters: true
    get:
      summary: List Subscription Plans
      responses:
        '200':
          $ref: '#/components/responses/SubscriptionPlanList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryAmountFilter'
        - $ref: '#/components/parameters/QueryAmountLtFilter'
        - $ref: '#/components/parameters/QueryAmountLteFilter'
        - $ref: '#/components/parameters/QueryAmountGtFilter'
        - $ref: '#/components/parameters/QueryAmountGteFilter'
        - $ref: '#/components/parameters/application_id'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
        - name: linked_to
          in: query
          required: false
          description: |
            Filter subscription plans linked to a specific `Merchant`.
          schema:
            type: string
          example: MUcgYZswyRfqSSbvMsxuaHxZ
        - name: state
          description: |
            Filter by `state`:
            - ACTIVE
            - INACTIVE
          in: query
          schema:
            type: string
            example: INACTIVE
          style: form
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      operationId: listSubscriptionPlans
      x-java-method-name: list
      description: >-
        Retrieve a list of `Subscription Plans`. 


        For details on how to query endpoints using the available parameters,
        see [Query Parameters](/api/section/query-parameters).
      x-codeSamples:
        - lang: cURL
          label: curl
          source: |
            curl "https://finix.sandbox-payments-api.com/subscription_plans" \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      tags:
        - Subscription Plans
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
  /subscription_plans/{subscription_plan_id}:
    get:
      summary: Fetch a Subscription Plan
      parameters:
        - schema:
            type: string
            default: '2022-02-01'
            example: '2022-02-01'
          in: header
          name: Finix-Version
          description: >-
            Specify the API version of your request. For more details, see
            [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
      x-group-parameters: true
      responses:
        '200':
          $ref: '#/components/responses/SubscriptionPlan'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      operationId: getSubscriptionPlan
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: >
            curl
            "https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"
            \
                -H "Finix-Version: 2022-02-01" \
                -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
      description: Retrieve the details of a previously created `Subscription Plan`.
      tags:
        - Subscription Plans
    parameters:
      - schema:
          type: string
          default: '2022-02-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: >-
          Specify the API version of your request. For more details, see
          [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning).
      - schema:
          type: string
        name: subscription_plan_id
        description: The ID of the `Subscription Plan`.
        in: path
        required: true
    put:
      tags:
        - Subscription Plans
      description: >
        Update an existing `Subscription Plan`.


        Options:

        - Set `update_existing_subscriptions` to `true` to update existing
        subscriptions.

        - Archive the `Subscription Plan` by setting its `state` to `INACTIVE`.
      summary: Update a Subscription Plan
      operationId: updateSubscriptionPlan
      x-group-parameters: true
      requestBody:
        $ref: '#/components/requestBodies/UpdateSubscriptionPlanRequest'
      responses:
        '202':
          $ref: '#/components/responses/UpdateSubscriptionPlanResponse'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-java-method-name: update
components:
  headers:
    finix-apiuser-role:
      description: >-
        This response header indicating the role of the user who sent the API
        request.
      schema:
        type: string
        enum:
          - ROLE_ADMIN
          - ROLE_PLATFORM
          - ROLE_PARTNER
          - ROLE_MERCHANT
        example: ROLE_PARTNER
    date:
      description: A response header indicating the date and time of the API request.
      schema:
        type: string
        example: Tue, 08 Jul 2025 17:38:01 GMT
    x-request-id:
      description: This response header provides a unique identifier for the API request.
      schema:
        type: string
        example: 055972f6534f92a896fbb61b11313ebb
  parameters:
    ApplicationId:
      description: ID of `Application` to use.
      in: path
      name: application_id
      schema:
        type: string
        example: APc9vhYcPsRuTSpKD9KpMtPe
      required: true
    ApplicationProfileId:
      description: ID of `Application` profile to use.
      required: true
      in: path
      name: application_profile_id
      schema:
        example: PPqjTEKAmRNGLquQUeLKmXhi
        type: string
    AuthorizationId:
      description: ID of `Authorization` to fetch.
      required: true
      in: path
      name: authorization_id
      schema:
        type: string
        example: AUrEnGqdBi5oJs68ChNRcHJ3
    FeeId:
      description: ID of `fee` to use.
      required: true
      in: path
      name: fee_id
      schema:
        type: string
    QueryAmountFilter:
      description: Filter by an amount equal to the given value.
      in: query
      name: amount
      schema:
        type: integer
        example: 100
      style: form
    QueryAmountGtFilter:
      description: Filter by an amount greater than.
      in: query
      name: amount.gt
      schema:
        type: integer
        example: 100
      style: form
    QueryAmountGteFilter:
      description: Filter by an amount greater than or equal.
      in: query
      name: amount.gte
      schema:
        type: integer
        example: 100
      style: form
    QueryAmountLtFilter:
      description: Filter by an amount less than.
      in: query
      name: amount.lt
      schema:
        type: integer
        example: 100
      style: form
    QueryAmountLteFilter:
      description: Filter by an amount less than or equal.
      in: query
      name: amount.lte
      schema:
        type: integer
        example: 100
      style: form
    QueryCreatedAtGteFilter:
      description: Filter where `created_at` is after the given date.
      in: query
      name: created_at.gte
      schema:
        type: string
        example: '2022-09-27T11:21:23'
        format: date-time
      style: form
    QueryCreatedAtLteFilter:
      description: Filter where `created_at` is before the given date.
      in: query
      name: created_at.lte
      schema:
        type: string
        example: '2026-09-27T11:21:23'
        format: date-time
      style: form
    QueryDefaultStatementDescriptorFilter:
      description: Filter by the `default_statement_descriptor`.
      in: query
      name: default_statement_descriptor
      schema:
        type: string
        example: Finix%20Flowers
      style: form
    QueryIdFilter:
      description: Filter by `id`.
      in: query
      name: id
      schema:
        type: string
      style: form
    QueryIdempotencyIdFilter:
      description: Filter by Idempotency ID.
      in: query
      name: idempotency_id
      schema:
        type: string
        example: 15d32948-c766-4033-8d87-dfbdcabcbc5c
      style: form
    QueryLimit:
      description: The numbers of items to return.
      example: 10
      in: query
      name: limit
      schema:
        type: integer
        example: 3
      style: form
    QueryOffset:
      description: The number of items to skip before starting to collect the result set.
      example: 20
      in: query
      name: offset
      schema:
        type: integer
        example: 10
      style: form
    QuerySort:
      description: Specify key to be used for sorting the collection.
      in: query
      name: sort
      schema:
        type: string
      style: form
    QueryTraceIdFilter:
      description: Filter by `trace_id`.
      in: query
      name: trace_id
      schema:
        type: string
        example: 021fc4ed-f0a8-4932-820c-b22b542526f8
      style: form
    QueryUpdatedAtGteFilter:
      description: Filter where `updated_at` is after the given date.
      in: query
      name: updated_at.gte
      schema:
        type: string
        example: '2022-09-27T11:21:23'
        format: date-time
      style: form
    QueryUpdatedAtLteFilter:
      description: Filter where `updated_at` is before the given date.
      in: query
      name: updated_at.lte
      schema:
        type: string
        example: '2026-09-27T11:21:23'
        format: date-time
      style: form
    QueryVoidFilter:
      description: Filter by `idempotency_id`.
      in: query
      name: is_void
      schema:
        type: string
        example: S6cVkY
      style: form
    QueryBusinessName:
      name: business_name
      in: query
      required: false
      schema:
        type: string
        example: Finix%20Flowers
      description: >-
        Filter by the full business name. Partial business names are not
        supported.
    QueryBusinessType:
      name: business_type
      in: query
      required: false
      schema:
        type: string
        example: INDIVIDUAL_SOLE_PROPRIETORSHIP
        enum:
          - INDIVIDUAL_SOLE_PROPRIETORSHIP
          - CORPORATION
          - LIMITED_LIABILITY_COMPANY
          - PARTNERSHIP
          - LIMITED_PARTNERSHIP
          - GENERAL_PARTNERSHIP
          - ASSOCIATION_ESTATE_TRUST
          - TAX_EXEMPT_ORGANIZATION
          - INTERNATIONAL_ORGANIZATION
          - GOVERNMENT_AGENCY
          - JOINT_VENTURE
      description: Filter by the business type. Partial business types are not supported.
    QueryEmail:
      name: email
      in: query
      required: false
      schema:
        type: string
        example: user@example.org
      description: >-
        Filter by the email address or email domain. Partial emails are not
        supported.
    QueryFirstName:
      name: first_name
      in: query
      required: false
      schema:
        type: string
        example: John
      description: Filter by the first name of the person associated to the `Identity`.
    QueryLastName:
      name: last_name
      in: query
      required: false
      schema:
        type: string
        example: Smith
      description: Filter by the last name of the person associated to the `Identity`.
    QueryTitle:
      name: title
      in: query
      required: false
      schema:
        type: string
        example: ceo
      description: Filter by the title if available.
    QueryAfterCursor:
      name: after_cursor
      in: query
      required: false
      schema:
        type: string
      description: Return every resource created after the cursor value.
    QueryBeforeCursor:
      name: before_cursor
      in: query
      required: false
      schema:
        type: string
      description: Return every resource created before the cursor value.
    QueryFormat:
      name: format
      in: query
      required: false
      schema:
        type: string
        example: json
      description: >-
        Specify the format you'd like to download the response in (JSON is the
        only other format available for download).
    TagsKey:
      name: tags.key
      in: query
      required: false
      schema:
        type: string
        example: card_type
      description: >-
        Filter by the tag's key. For more information, see
        [Tags](/api/section/tags).
    TagsValue:
      name: tags.value
      in: query
      required: false
      schema:
        type: string
        example: business_card
      description: >-
        Filter by the tag's value. For more information, see
        [Tags](/api/section/tags).
    QueryStatus:
      name: status
      in: query
      required: false
      schema:
        type: string
        enum:
          - APPROVED
          - AWAITING_APPROVAL
          - PENDING
      description: >-
        Filter by the status of the `Settlement`. Available values
        include:<ul><li>**APPROVED**<li>**AWAITING_APPROVAL**<li>**PENDING**</ul>
        Merchants only receive payouts when `Settlements` are **APPROVED**. For
        more information, see [Payouts](/guides/payouts/).
    QueryTotalAmountFilter:
      description: Filter by a `total_amount` equal to the given value.
      in: query
      name: total_amount
      schema:
        type: integer
      style: form
    QueryTotalAmountLteFilter:
      description: Filter by an `total_amount` less than or equal to the given value.
      in: query
      name: total_amount.lte
      schema:
        type: integer
        example: 2000
      style: form
    QueryTotalAmountLtFilter:
      description: Filter by an `total_amount` less than the given value.
      in: query
      name: total_amount.lt
      schema:
        type: integer
        example: 2000
      style: form
    QueryTotalAmountGteFilter:
      description: Filter by an `total_amount` greater than or equal to the given value.
      in: query
      name: total_amount.gte
      schema:
        type: integer
        example: 2
      style: form
    QueryTotalAmountGtFilter:
      description: Filter by an `total_amount` greater than the given value.
      in: query
      name: total_amount.gt
      schema:
        type: integer
        example: 2
      style: form
    QueryEntityId:
      description: Filter by `entity_id`.
      in: query
      name: entity_id
      schema:
        type: string
        example: STiuhZx9SQ6B2D72AacxJY3n
      style: form
    QueryEntityType:
      description: Filter by `entity_type`.
      in: query
      name: entity_type
      schema:
        type: string
        example: SETTLEMENT_V2
      style: form
    QueryOutcome:
      description: Filter by `outcome`.
      in: query
      name: outcome
      schema:
        type: string
        example: PENDING
      style: form
    after_cursor:
      description: Return every resource created after the cursor value.
      in: query
      name: after_cursor
      required: false
      schema:
        type: string
    before_cursor:
      description: Return every resource created before the cursor value.
      in: query
      name: before_cursor
      required: false
      schema:
        type: string
    created_at.gte:
      description: Filter where `created_at` is after the given date.
      in: query
      name: created_at.gte
      required: false
      schema:
        type: string
        example: '2022-09-27T11:21:23'
        format: date-time
    created_at.lte:
      description: Filter where `created_at` is before the given date.
      in: query
      name: created_at.lte
      required: false
      schema:
        type: string
        example: '2026-09-27T11:21:23'
        format: date-time
    Finix-Version:
      name: Finix-Version
      description: >-
        Specify the API version of your request. For more details, see
        [Versioning](../../../../additional-resources/developers/authentication-and-api-basics/versioning).
      in: header
      schema:
        type: string
        default: '2022-02-01'
        example: '2022-02-01'
    limit:
      description: The numbers of items to return.
      in: query
      name: limit
      required: false
      schema:
        type: integer
        example: 10
    updated_at.gte:
      description: Filter where `updated_at` is after the given date.
      in: query
      name: updated_at.gte
      required: false
      schema:
        type: string
        example: '2022-09-27T11:21:23'
        format: date-time
    updated_at.lte:
      description: Filter where `updated_at` is before the given date.
      in: query
      name: updated_at.lte
      required: false
      schema:
        type: string
        example: '2026-09-27T11:21:23'
        format: date-time
    Content-Type:
      name: Content-Type
      description: The data type being sent in the request body must be `application/json`.
      in: header
      schema:
        type: string
        example: application/json
    amount.gt:
      description: Filter by an amount greater than.
      in: query
      name: amount.gt
      required: false
      schema:
        type: integer
        example: 100
    amount.gte:
      description: Filter by an amount greater than or equal.
      in: query
      name: amount.gte
      required: false
      schema:
        type: integer
        example: 100
    amount.lt:
      description: Filter by an amount less than.
      in: query
      name: amount.lt
      required: false
      schema:
        type: integer
        example: 100
    amount.lte:
      description: Filter by an amount less than or equal.
      in: query
      name: amount.lte
      required: false
      schema:
        type: integer
        example: 100
    amount:
      description: Filter by an amount equal to the given value.
      in: query
      name: amount
      required: false
      schema:
        type: integer
        example: 100
    currency:
      name: currency
      description: Filter by the currency of the resource.
      in: query
      required: false
      schema:
        type: string
        example: USD
    device:
      description: Filter by the device's ID.
      name: device
      in: query
      schema:
        type: string
        example: DVsEanpBtsAVvCHbNXkFaH6f
    idempotency_id:
      description: Filter by Idempotency ID.
      in: query
      name: idempotency_id
      schema:
        type: string
        example: 15d32948-c766-4033-8d87-dfbdcabcbc5c
    merchant_id:
      description: Filter by `Merchant` ID.
      in: query
      name: merchant_id
      schema:
        type: string
        example: MUeDVrf2ahuKc9Eg5TeZugvs
    tags.key:
      description: >-
        Filter by the tag's key. For more information, see
        [Tags](/api/section/tags).
      in: query
      name: tags.key
      required: false
      schema:
        type: string
        example: card_type
    tags.value:
      description: >-
        Filter by the tag's value. For more information, see
        [Tags](/api/section/tags).
      in: query
      name: tags.value
      required: false
      schema:
        type: string
        example: business_card
    trace_id:
      description: Filter by `trace_id`.
      in: query
      name: trace_id
      required: false
      schema:
        type: string
        example: 021fc4ed-f0a8-4932-820c-b22b542526f8
    application_id:
      description: Filter by `Application` ID.
      in: query
      name: application_id
      schema:
        type: string
        example: APc9vhYcPsRuTSpKD9KpMtPe
    description:
      name: description
      in: query
      required: false
      schema:
        type: string
      description: Filter by the description.
    enabled:
      name: enabled
      in: query
      required: false
      schema:
        type: boolean
        example: true
      description: Filter by the enabled value.
    name:
      description: Filter by the name.
      in: query
      name: name
      required: false
      schema:
        type: string
        example: john%%20smith
    model:
      name: model
      in: query
      required: false
      schema:
        type: string
        example: PAX_A800
      description: Filter by the model.
    serial_number:
      name: serial_number
      in: query
      required: false
      schema:
        type: string
        example: '2210074802'
      description: Filter by the serial number.
    id:
      description: Filter by `id`.
      in: query
      name: id
      schema:
        type: string
    state:
      description: Filter by `state`.
      in: query
      name: state
      schema:
        type: string
      style: form
    buyer_identity_id:
      description: Filter by the Buyer Identity's ID.
      in: query
      name: buyer_identity_id
      schema:
        type: string
        example: ID6Qm3BQUxGFcCWZ185TS8sn
  requestBodies:
    UpdateApplicationProfileRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateApplicationProfileRequest'
    CreateDisputeEvidenceRequest:
      content:
        multipart/form-data:
          schema:
            $ref: '#/components/schemas/CreateDisputeEvidenceRequest'
          examples:
            Upload Dispute Evidence:
              value:
                file: '@path/to/local/file'
    CreateFeeRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateFeeRequest'
          examples:
            Fee:
              value:
                amount: 100
                currency: USD
                display_name: April_Monthly_Fee
                fee_subtype: CUSTOM
                fee_type: CUSTOM
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                tags:
                  test: tag
    UpdateFeeRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateFeeRequest'
          examples:
            Update Fee:
              value:
                tags:
                  test: test
    CreateIdentitySettlementRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateSettlementRequest'
          examples:
            Create a Settlement:
              value:
                currency: USD
                processor: DUMMY_V1
                tags:
                  Internal Daily Settlement ID: 21DFASJSAKAS
    UpdateMerchantProfileRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateMerchantProfileRequest'
          examples:
            Update the Fee Profile for a Merchant Profile:
              value:
                fee_profile: FP4xXhxyFRiRePKBQXmueVTh
    CreateProcessorRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateProcessorRequest'
          examples:
            'Enable an Application Processor ':
              value:
                config:
                  canDebitBankAccount: true
                type: DUMMY_V1
    UpdateProcessorRequest:
      content:
        application/json:
          schema:
            type: object
    CreateSettlementRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateSettlementRequest'
    CreateUserRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateUserRequest'
    CreateWebhookRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateWebhookRequest'
          examples:
            Webhook - No Authentication:
              value:
                authentication:
                  type: NONE
                url: https://httpbin.org/post
            Webhook - Basic Authentication:
              value:
                authentication:
                  type: BASIC
                  basic:
                    username: basic-auth-username
                    password: basic-auth-password
                url: https://httpbin.org/post
            Webhook - Bearer Token Authentication:
              value:
                authentication:
                  type: BEARER
                  bearer:
                    token: U3VwZXIgc2VjcmV0IGVuY29kZWQgdG9rZW4=
                enabled: true
                url: https://httpbin.org/post
            Webhook - Enable Event Filtering:
              value:
                enabled_events:
                  - entity: transfer
                    types:
                      - created
                  - entity: merchant
                    types:
                      - created
                      - underwritten
    UpdateSettlementRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateSettlementRequest'
    UpdateUserRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateUserRequest'
          examples:
            Update User:
              value:
                tags:
                  card_name: New Employee
    CreateBalanceTransferRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateBalanceTransferRequest'
          examples:
            Create a Balance Transfer:
              value:
                amount: 4000
                currency: USD
                description: >-
                  Need to increase buffer given the high number of NSFs on
                  merchant fee debits
                destination: FOR_BENEFIT_OF_ACCOUNT
                processor_type: LITLE_V1
                source: OPERATING_ACCOUNT
                tags:
                  example: documentation tag
    CreateInstrumentUpdateRequest:
      content:
        multipart/form-data:
          schema:
            $ref: '#/components/schemas/CreateInstrumentUpdateRequest'
          examples:
            Instrument Update Request:
              value:
                request: >-
                  {"merchant": "MUucec6fHeaWo3VHYoSkUySM","idempotency_id":
                  "123xyz testing"}
      description: ''
    CreateFileRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateFileRequest'
          examples:
            Create a File:
              value:
                display_name: Bank Statement (January 2024)
                linked_to: MUmfEGv5bMpSJ9k5TFRUjkmm
                type: BANK_STATEMENT
    CreateExternalLinkRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateExternalLinkRequest'
          examples:
            External Link - Upload:
              value:
                duration: 15
                type: UPLOAD
            External Link - Download:
              value:
                duration: 20
                type: DOWNLOAD
            External Link - View:
              value:
                duration: 30
                type: VIEW
    RemoveSettlementTransfer:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RemoveSettlementTransfer'
          examples:
            Remove a Transfer in a Settlement:
              value:
                transfers:
                  - TRr61njQxaa7AJf6E1C3QwCc
    RemoveSettlementEntries:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RemoveSettlementEntries'
          examples:
            Remove an Entry in a Settlement:
              value:
                settlement_entry_ids:
                  - SEivAwLLW6c62Nbvvj7TcDAN
    UploadFileRequest:
      content:
        multipart/form-data:
          schema:
            $ref: '#/components/schemas/UploadFileRequest'
    UpdateWebhookRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateWebhookRequest'
          examples:
            Disable or Enable Webhook Events:
              value:
                enabled: true
                url: https://eohzjuj2prziycz.m.pipedream.net
            Add Authentication to a Webhook:
              value:
                authentication:
                  type: BASIC
                  basic:
                    username: basic-auth-username
                    password: basic-auth-password
                url: https://httpbin.org/post
            Enable Event Filtering:
              value:
                enabled_events:
                  - entity: merchant
                    types:
                      - created
                      - underwritten
                  - entity: transfer
                    types:
                      - created
    CompleteComplianceFormRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/updateComplianceForm'
          examples:
            Complete Compliance Form:
              value:
                pci_saq_a:
                  ip_address: 42.1.1.113
                  name: John Smith
                  signed_at: '2022-03-18T16:42:55Z'
                  title: CTO
                  user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
    UpdatePayoutProfileRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdatePayoutProfileRequest'
          examples:
            Payout Profile - Gross:
              value:
                type: GROSS
                gross:
                  payouts:
                    frequency: DAILY
                    submission_delay_days: '1'
                    payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                    rail: SAME_DAY_ACH
                  fees:
                    frequency: MONTHLY
                    day_of_month: '1'
                    submission_delay_days: '3'
                    payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                    rail: SAME_DAY_ACH
            Payout Profile - Net:
              value:
                type: NET
                net:
                  frequency: CONTINUOUS
                  submission_delay_days: '1'
                  payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                  rail: SAME_DAY_ACH
    CreateBalanceAdjustmentRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateBalanceAdjustmentRequest'
          examples:
            Balance Adjustment:
              value:
                amount: 19
                currency: USD
                description: Sample balance adjustment
                instrument_id: PI4Ppf8rxWYapuEqQr3u6efi
                processor: DUMMY_V1
                rail: ACH
                type: TOP_UP
                tags:
                  name: Sample balance adjustment
    SubmitDisputeEvidence:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubmitDisputeEvidence'
          examples:
            Example 1:
              value:
                note: '"Submitting Dispute Evidence: July 23rd Receipt"'
    UpdateDisputeEvidence:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateDisputeEvidence'
          examples:
            Dispute - Tags:
              value:
                tags:
                  order_number: 41BFASJSAKAS
    AcceptDisputeRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AcceptDispute'
          examples:
            Dispute Accepted:
              value:
                note: 'Accepting Dispute: Valid Reason'
    CloseSettlement:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CloseSettlement'
          examples:
            Close Settlement:
              value:
                action: STOP_ACCRUAL
    UpdateSettlementQueueEntriesRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateSettlementQueueEntriesRequest'
          examples:
            Update Settlement Queue Entries:
              value:
                ids:
                  - settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M
                  - settlement_queue_entry_cpuisgcFNiNtBmC4rm4z9
                action: RELEASE
    CreateFundingTransferAttemptRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateFundingTransferAttemptRequest'
          examples:
            Update Settlement Queue Entries:
              value:
                instrument_id: PImXAVgkKVshKWWHUk4xXbve
                amount: 101059
    CreateSubscriptionBalanceEntryRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateSubscriptionBalanceEntryRequest'
          examples:
            Subscription Balance Entry:
              value:
                type: CREDIT
                amount: 1000
                currency: USD
                description: >-
                  Applying a credit since I accidentally overcharged this
                  subscription.
                tags: {}
    CreateSubscriptionPlanRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateSubscriptionPlanRequest'
          examples:
            Subscription Plan:
              value:
                amount: 19900
                currency: USD
                plan_name: API portal - Basic
                description: A basic API portal account with the least features.
                linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                linked_type: MERCHANT
                billing_interval: MONTHLY
                billing_defaults:
                  collection_method: BILL_AUTOMATICALLY
            Subscription Plan - With Trial Period:
              value:
                amount: 19900
                currency: USD
                plan_name: API portal - Basic
                description: A basic API portal account with the least features.
                linked_to: MU7noQ1wdgdAeAfymw2rfBMq
                linked_type: MERCHANT
                billing_interval: MONTHLY
                billing_defaults:
                  collection_method: BILL_AUTOMATICALLY
                trial_defaults:
                  interval_type: DAY
                  interval_count: 30
            Subscription Plan - With Discount Phase:
              value:
                amount: 19900
                currency: USD
                plan_name: API portal - Basic
                description: A basic API portal account with the least features.
                discount_phase_defaults:
                  amount: 1000
                  billing_interval_count: 3
                linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                linked_type: MERCHANT
                billing_interval: MONTHLY
                billing_defaults:
                  collection_method: BILL_AUTOMATICALLY
    UpdateSubscriptionPlanRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateSubscriptionPlanRequest'
          examples:
            Update Subscription Plan:
              value:
                amount: 19900
                nickname: API portal - Basic plan
                description: A starter plan with minimal features
                update_existing_subscriptions: true
                tags:
                  order_number: 21DFASJSAKAS
            Archive Subscription Plan:
              value:
                amount: 19900
                nickname: API portal - Basic
                description: A basic API portal account with the least features.
                state: INACTIVE
                update_existing_subscriptions: true
    CreateReceiptRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateReceiptRequest'
          examples:
            Receipt - Basic Details:
              value:
                entity_id: TRnErBfrHLgdAi3BqAkWLN27
                send_receipt_to_buyer: true
                requested_delivery_methods:
                  - type: EMAIL
                    destinations:
                      - johndoe@gmail.com
                  - type: SMS
                    destinations:
                      - '3346497818'
                  - type: PRINT
                    destinations:
                      - DV12343234
            Receipt - Additional Details:
              value:
                entity_id: TRnErBfrHLgdAi3BqAkWLN27
                send_receipt_to_buyer: true
                requested_delivery_methods:
                  - type: EMAIL
                    destinations:
                      - johndoe@gmail.com
                  - type: SMS
                    destinations:
                      - '3346497818'
                  - type: PRINT
                    destinations:
                      - DV12343234
                amount_breakdown:
                  subtotal_amount: 20300
                  shipping_amount: 2000
                items:
                  - name: Leather couch
                    description: A fine-leather couch.
                    quantity: '1'
                    image_details:
                      primary_image_url: https://www.fineleather.com/leather-couch.jpg
                    price_details:
                      sale_amount: 15000
                      currency: USD
                      price_type: REGULAR
                      regular_amount: 5300
                  - name: Antique end table
                    description: A wooden end table.
                    quantity: '1'
                    image_details:
                      primary_image_url: https://www.fineleather.com/end-table.jpg
                      alternative_image_urls:
                        - https://www.fineleather.com/end-table-alt1.jpg
                        - https://www.fineleather.com/end-table-alt2.jpg
                    price_details:
                      sale_amount: 5300
                      currency: USD
                      price_type: REGULAR
                      regular_amount: 5300
                additional_details:
                  - name: Invoice Number
                    value: '123456789'
                  - name: VIN
                    value: '44455556666'
    CreateDeliveryAttemptRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateDeliveryAttempt'
          examples:
            Delivery Attempt:
              value:
                requested_delivery_methods:
                  - type: EMAIL
                    destinations:
                      - benroundtree@gmail.com
                  - type: SMS
                    destinations:
                      - '8005550175'
                  - type: PRINT
                    destinations:
                      - DVsEanpBtsAVvCHbNXkFaH6f
    UpdateReviewQueueItemRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateReviewQueueItemRequest'
          examples:
            Update Review Queue Item - Accepted:
              value:
                outcome: ACCEPTED
                tags: {}
            Update Review Queue Item - Rejected:
              value:
                outcome: REJECTED
                tags: {}
            Update Review Queue Item - Manual Review:
              value:
                outcome: MANUAL_REVIEW
                tags: {}
            Update Review Queue Item - Pending:
              value:
                outcome: PENDING
                tags: {}
  responses:
    ApplicationProfile:
      description: Single application_profile object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApplicationProfile'
          examples:
            Application Profile:
              value:
                id: PPqCt5m7AFobHUQsKxqkCEyT
                created_at: '2024-11-14T22:25:06.78Z'
                updated_at: '2024-11-14T22:25:06.78Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                card_present_fee_profile: null
                fee_profile: RP3X1FMA23pSsP9dJRMmQ4Pf
                risk_profile: RP3X1FMA23pSsP9dJRMmQ4Pf
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/application_profiles/PPqCt5m7AFobHUQsKxqkCEyT
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  risk_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/risk_profiles/RP3X1FMA23pSsP9dJRMmQ4Pf
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/RP3X1FMA23pSsP9dJRMmQ4Pf
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ApplicationProfilesList:
      description: List of application_profile objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApplicationProfilesList'
          examples:
            List of Application Profiles:
              value:
                _embedded:
                  application_profiles:
                    - id: PPqCt5m7AFobHUQsKxqkCEyT
                      created_at: '2024-11-14T22:25:06.78Z'
                      updated_at: '2024-11-14T22:25:06.78Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      card_present_fee_profile: null
                      fee_profile: null
                      risk_profile: RP3X1FMA23pSsP9dJRMmQ4Pf
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/application_profiles/PPqCt5m7AFobHUQsKxqkCEyT
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        risk_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/risk_profiles/RP3X1FMA23pSsP9dJRMmQ4Pf
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/RP3X1FMA23pSsP9dJRMmQ4Pf
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/application_profiles
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/application_profiles?after_cursor=PPqCt5m7AFobHUQsKxqkCEyT
                page:
                  limit: 100
                  next_cursor: PPqCt5m7AFobHUQsKxqkCEyT
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FetchBalanceResponse:
      description: Response example for a request to fetch a `Balance`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Balance'
          examples:
            Balance:
              value:
                id: balance_dyz5APsJebDef9oTW9J2Hc
                created_at: '2024-11-14T22:25:48.01Z'
                updated_at: '2024-11-14T22:25:48.01Z'
                available_amount: 9970019
                currency: USD
                linked_to: APc9vhYcPsRuTSpKD9KpMtPe
                linked_type: APPLICATION
                pending_amount: 9970019
                posted_amount: 9970019
                tags:
                  created_via: SYSTEM
                  description: BrainTree
                type: DISBURSEMENT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FetchBalanceEntryResponse:
      description: Response example for a request to fetch a `Balance Entry`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BalanceEntry'
          examples:
            BalanceEntry:
              value:
                id: balance_entry_i5YzFZYEh6CoCrN2zqgPdW
                created_at: '2025-02-18T23:10:27.13Z'
                updated_at: '2025-02-18T23:10:27.13Z'
                amount: 19
                created_by: SYSTEM
                currency: USD
                description: null
                entity_id: balance_adjustment_i548hz2CJuK8U2b4RB2QaZ
                entity_type: BALANCE_ADJUSTMENT
                estimated_posted_date: '2025-02-18T23:10:27.210Z'
                linked_to: APc9vhYcPsRuTSpKD9KpMtPe
                linked_type: APPLICATION
                parent_balance_entry_id: null
                posted_at: '2025-02-18T23:10:27.210Z'
                state: SUCCEEDED
                tags: {}
                transaction_date: null
                type: BALANCE_TOP_UP_ACH
                wire_details:
                  external_reference_number: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/balance_entries/balance_entry_i5YzFZYEh6CoCrN2zqgPdW
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ListBalanceEntriesResponse:
      description: |
        List of `Balance Entry` objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BalanceEntryList'
          examples:
            List of Balance Entries:
              value:
                _embedded:
                  balance_entries:
                    - id: balance_entry_i5YzFZYEh6CoCrN2zqgPdW
                      created_at: '2025-02-18T23:10:27.13Z'
                      updated_at: '2025-02-18T23:10:27.13Z'
                      amount: 19
                      created_by: SYSTEM
                      currency: USD
                      description: null
                      entity_id: balance_adjustment_i548hz2CJuK8U2b4RB2QaZ
                      entity_type: BALANCE_ADJUSTMENT
                      estimated_posted_date: '2025-02-18T23:10:27.210Z'
                      linked_to: APc9vhYcPsRuTSpKD9KpMtPe
                      linked_type: APPLICATION
                      parent_balance_entry_id: null
                      posted_at: '2025-02-18T23:10:27.210Z'
                      state: SUCCEEDED
                      tags: {}
                      transaction_date: null
                      type: BALANCE_TOP_UP_ACH
                      wire_details:
                        external_reference_number: null
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/balance_entries/balance_entry_i5YzFZYEh6CoCrN2zqgPdW
                    - id: balance_entry_odbuSMLDG2BSyKWLs42uCx
                      created_at: '2024-12-27T06:35:02.40Z'
                      updated_at: '2024-12-28T08:00:05.15Z'
                      amount: 100000
                      created_by: SYSTEM
                      currency: USD
                      description: null
                      entity_id: TRo9MsQ6Li9NYbYXuHrhY4kC
                      entity_type: TRANSFER
                      estimated_posted_date: '2024-12-28T08:00:05.301Z'
                      linked_to: APc9vhYcPsRuTSpKD9KpMtPe
                      linked_type: APPLICATION
                      parent_balance_entry_id: null
                      posted_at: '2024-12-28T08:00:05.301Z'
                      state: SUCCEEDED
                      tags: {}
                      transaction_date: null
                      type: PUSH_TO_CARD
                      wire_details:
                        external_reference_number: null
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/balance_entries/balance_entry_odbuSMLDG2BSyKWLs42uCx
                  _links:
                    self:
                      href: >-
                        https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc/balance_entries
                    next:
                      href: >-
                        https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc/balance_entries?after_cursor=balance_entry_kqHCSjHXbSeqBZSgsMUfJv
                  page:
                    limit: 100
                    next_cursor: balance_entry_kqHCSjHXbSeqBZSgsMUfJv
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Dispute:
      description: Single Dispute object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Dispute'
          examples:
            Dispute:
              value:
                id: DIkigGVrJPjDyAXejvvKXv9e
                created_at: '2023-11-24T13:04:33.63Z'
                updated_at: '2024-09-10T13:17:32.08Z'
                action: null
                amount: 888888
                application: APgPDQrLD52TYvqazjHJJchM
                dispute_details:
                  arn: '123'
                evidence_submitted: CHARGEBACK
                identity: ID4sanuCPqjmkmP4Q3Shkvww
                merchant: MUcvYR7tboSRejbVzHJSjXct
                message: null
                occurred_at: '2023-11-24T13:04:32.99Z'
                reason: FRAUD
                respond_by: '2023-12-01T13:04:33.60Z'
                response_state: ACCEPTED
                state: WON
                tags: {}
                transfer: TRm2U5wQo5S2UBdVJo4xVeh
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e
                  transfer:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRm2U5wQo5S2UBdVJo4xVeh
                  evidence:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence
                  adjustment_transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/adjustment_transfers
            Dispute - Inquiry:
              value:
                id: DIkigGVrJPjDyAXejvvKXv9e
                created_at: '2023-11-24T13:04:33.63Z'
                updated_at: '2024-09-10T13:17:32.08Z'
                action: null
                amount: 888888
                application: APgPDQrLD52TYvqazjHJJchM
                dispute_details:
                  arn: '123'
                evidence_submitted: INQUIRY
                identity: ID4sanuCPqjmkmP4Q3Shkvww
                merchant: MUcvYR7tboSRejbVzHJSjXct
                message: null
                occurred_at: '2023-11-24T13:04:32.99Z'
                reason: FRAUD
                respond_by: '2023-12-01T13:04:33.60Z'
                response_state: ACCEPTED
                state: INQUIRY
                tags: {}
                transfer: TRm2U5wQo5S2UBdVJo4xVeh
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e
                  transfer:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRm2U5wQo5S2UBdVJo4xVeh
                  evidence:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence
                  adjustment_transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/adjustment_transfers
            Dispute - Chargeback:
              value:
                id: DIkigGVrJPjDyAXejvvKXv9e
                created_at: '2023-11-24T13:04:33.63Z'
                updated_at: '2024-09-10T13:17:32.08Z'
                action: null
                amount: 888888
                application: APgPDQrLD52TYvqazjHJJchM
                dispute_details:
                  arn: '123'
                evidence_submitted: CHARGEBACK
                identity: ID4sanuCPqjmkmP4Q3Shkvww
                merchant: MUcvYR7tboSRejbVzHJSjXct
                message: null
                occurred_at: '2023-11-24T13:04:32.99Z'
                reason: FRAUD
                respond_by: '2023-12-01T13:04:33.60Z'
                response_state: RESPONDED
                state: PENDING
                tags: {}
                transfer: TRm2U5wQo5S2UBdVJo4xVeh
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e
                  transfer:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRm2U5wQo5S2UBdVJo4xVeh
                  evidence:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence
                  adjustment_transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/adjustment_transfers
            Dispute - Accepted:
              value:
                id: DIkigGVrJPjDyAXejvvKXv9e
                created_at: '2023-11-24T13:04:33.63Z'
                updated_at: '2024-09-10T13:17:32.08Z'
                action: null
                amount: 888888
                application: APgPDQrLD52TYvqazjHJJchM
                dispute_details:
                  arn: '123'
                evidence_submitted: INQUIRY
                identity: ID4sanuCPqjmkmP4Q3Shkvww
                merchant: MUcvYR7tboSRejbVzHJSjXct
                message: null
                occurred_at: '2023-11-24T13:04:32.99Z'
                reason: FRAUD
                respond_by: '2023-12-01T13:04:33.60Z'
                response_state: ACCEPTED
                state: INQUIRY
                tags: {}
                transfer: TRm2U5wQo5S2UBdVJo4xVeh
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e
                  transfer:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRm2U5wQo5S2UBdVJo4xVeh
                  evidence:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence
                  adjustment_transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/adjustment_transfers
            Dispute - Tags:
              value:
                id: DIkigGVrJPjDyAXejvvKXv9e
                created_at: '2023-11-24T13:04:33.63Z'
                updated_at: '2024-09-10T13:17:32.08Z'
                action: null
                amount: 888888
                application: APgPDQrLD52TYvqazjHJJchM
                dispute_details:
                  arn: '123'
                evidence_submitted: CHARGEBACK
                identity: ID4sanuCPqjmkmP4Q3Shkvww
                merchant: MUcvYR7tboSRejbVzHJSjXct
                message: null
                occurred_at: '2023-11-24T13:04:32.99Z'
                reason: FRAUD
                respond_by: '2023-12-01T13:04:33.60Z'
                response_state: ACCEPTED
                state: WON
                tags:
                  order_number: 41BFASJSAKAS
                transfer: TRm2U5wQo5S2UBdVJo4xVeh
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e
                  transfer:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRm2U5wQo5S2UBdVJo4xVeh
                  evidence:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence
                  adjustment_transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/adjustment_transfers
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    DisputeEvidence:
      description: Single Evidence object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DisputeEvidence'
          examples:
            Dispute Evidence:
              value:
                id: DFvJbk7HS3p1LEoQpViJJSCB
                created_at: '2024-12-17T07:35:17.32Z'
                updated_at: '2024-12-17T07:35:17.32Z'
                application: APgPDQrLD52TYvqazjHJJchM
                dispute: DIkigGVrJPjDyAXejvvKXv9e
                identity: ID4sanuCPqjmkmP4Q3Shkvww
                merchant: MUcvYR7tboSRejbVzHJSjXct
                state: PENDING
                tags:
                  file-extension: .jpg
                  content-type: image/jpeg
                  file-name: evidence.jpg
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence/DFvJbk7HS3p1LEoQpViJJSCB
            Dispute - Tags:
              value:
                id: DFvJbk7HS3p1LEoQpViJJSCB
                created_at: '2024-12-17T07:35:17.32Z'
                updated_at: '2024-12-17T07:35:17.32Z'
                application: APgPDQrLD52TYvqazjHJJchM
                dispute: DIkigGVrJPjDyAXejvvKXv9e
                identity: ID4sanuCPqjmkmP4Q3Shkvww
                merchant: MUcvYR7tboSRejbVzHJSjXct
                state: PENDING
                tags:
                  file-extension: .jpeg
                  content-type: image/jpeg
                  file-name: evidence.jpeg
                  order_number: 41BFASJSAKAS
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence/DFvJbk7HS3p1LEoQpViJJSCB
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    DisputeEvidenceList:
      description: List of Evidence objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DisputeEvidenceList'
          examples:
            List of Dispute Evidence:
              value:
                _embedded:
                  evidences:
                    - id: DFujEkQdyK1TGchmPuduvMeg
                      created_at: '2024-12-17T05:48:29.59Z'
                      updated_at: '2024-12-17T05:48:30.35Z'
                      application: APgPDQrLD52TYvqazjHJJchM
                      dispute: DIkigGVrJPjDyAXejvvKXv9e
                      identity: ID4sanuCPqjmkmP4Q3Shkvww
                      merchant: MUcvYR7tboSRejbVzHJSjXct
                      state: SUCCEEDED
                      tags:
                        file-extension: .jpeg
                        content-type: image/jpeg
                        file-name: test_file.jpeg
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence/DFujEkQdyK1TGchmPuduvMeg
                    - id: DFdEdexaPHqyVnwiNvfdx7az
                      created_at: '2024-12-17T05:41:23.79Z'
                      updated_at: '2024-12-17T05:41:24.52Z'
                      application: APgPDQrLD52TYvqazjHJJchM
                      dispute: DIkigGVrJPjDyAXejvvKXv9e
                      identity: ID4sanuCPqjmkmP4Q3Shkvww
                      merchant: MUcvYR7tboSRejbVzHJSjXct
                      state: SUCCEEDED
                      tags:
                        file-extension: .jpeg
                        content-type: image/jpeg
                        file-name: test_file.jpeg
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence/DFdEdexaPHqyVnwiNvfdx7az
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence?after_cursor=DFdEdexaPHqyVnwiNvfdx7az
                page:
                  limit: 100
                  next_cursor: DFdEdexaPHqyVnwiNvfdx7az
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    DisputesList:
      description: List of Disputes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DisputesList'
          examples:
            List of Disputes:
              value:
                _embedded:
                  disputes:
                    - id: DIkigGVrJPjDyAXejvvKXv9e
                      created_at: '2023-11-24T13:04:33.63Z'
                      updated_at: '2024-09-10T13:17:32.08Z'
                      action: null
                      amount: 888888
                      application: APgPDQrLD52TYvqazjHJJchM
                      dispute_details:
                        arn: '123'
                      evidence_submitted: NOT_SUPPORTED
                      identity: ID4sanuCPqjmkmP4Q3Shkvww
                      merchant: MUcvYR7tboSRejbVzHJSjXct
                      message: null
                      occurred_at: '2023-11-24T13:04:32.99Z'
                      reason: FRAUD
                      respond_by: '2023-12-01T13:04:33.60Z'
                      response_state: ACCEPTED
                      state: PENDING
                      tags: {}
                      transfer: TRm2U5wQo5S2UBdVJo4xVeh
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e
                        transfer:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRm2U5wQo5S2UBdVJo4xVeh
                        evidence:
                          href: >-
                            https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/evidence
                        adjustment_transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/adjustment_transfers
                    - id: DI62ASQdJEMCNeNGkdC2ErHu
                      created_at: '2023-11-24T12:55:42.89Z'
                      updated_at: '2023-11-24T12:55:42.25Z'
                      action: null
                      amount: 888888
                      application: APgPDQrLD52TYvqazjHJJchM
                      dispute_details:
                        arn: '123'
                      evidence_submitted: NOT_SUPPORTED
                      identity: ID4sanuCPqjmkmP4Q3Shkvww
                      merchant: MUcvYR7tboSRejbVzHJSjXct
                      message: null
                      occurred_at: '2023-11-24T12:55:41.99Z'
                      reason: FRAUD
                      respond_by: '2023-12-01T12:55:42.84Z'
                      response_state: NEEDS_RESPONSE
                      state: PENDING
                      tags: {}
                      transfer: TRqubC2Kkq9w9nLft9iW4eP3
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/disputes/DI62ASQdJEMCNeNGkdC2ErHu
                        transfer:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRqubC2Kkq9w9nLft9iW4eP3
                        evidence:
                          href: >-
                            https://finix.sandbox-payments-api.com/disputes/DI62ASQdJEMCNeNGkdC2ErHu/evidence
                        adjustment_transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/disputes/DI62ASQdJEMCNeNGkdC2ErHu/adjustment_transfers
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/disputes
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes?after_cursor=DIs7yQRkHDdMYhurzYz72SFk
                page:
                  limit: 100
                  next_cursor: DIs7yQRkHDdMYhurzYz72SFk
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Error406NotAcceptable:
      description: Not Acceptable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error406NotAcceptable'
          examples: {}
    Error422InvalidField:
      description: Invalid field
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error422InvalidFieldList'
    ErrorForbidden403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error403ForbiddenList'
    ErrorMerchantIdentityDisabled:
      description: Merchant identity disabled error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
    ErrorMethodNotAllowed:
      description: 405 - Method not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
    ErrorNotFound:
      description: Object does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error404NotFoundList'
    ErrorPaymentRequired:
      description: Payment Required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
    ErrorTransfers402:
      description: 402 - Payment required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error402PaymentRequired'
    ErrorUnauthorized:
      description: Authentication information is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error401Unauthorized'
    ErrorUnprocessableEntity:
      description: The server understood the request but could not process it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error422UnprocessableEntity'
    Fee:
      description: Single Fee object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Fee'
          examples:
            Fee:
              value:
                id: FEvjF5iPwy6zuUEsBWgJ9T79
                created_at: '2024-12-16T08:33:42.12Z'
                updated_at: '2024-12-16T08:33:42.12Z'
                amount: 151
                category: PROCESSOR
                currency: USD
                display_name: null
                fee_subtype: PLATFORM_FEE
                fee_type: CARD_BASIS_POINTS
                label: null
                linked_id: TRfnif8f9U1r6k2zys27U4yP
                linked_to: TRfnif8f9U1r6k2zys27U4yP
                linked_type: TRANSFER
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79
                  merchant:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm
                  transfer:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRfnif8f9U1r6k2zys27U4yP
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FeesList:
      description: List of Fee objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FeesList'
          examples:
            List of Fees:
              value:
                _embedded:
                  fees:
                    - id: FEvjF5iPwy6zuUEsBWgJ9T79
                      created_at: '2024-12-16T08:33:42.12Z'
                      updated_at: '2024-12-16T08:33:42.12Z'
                      amount: 151
                      category: PROCESSOR
                      currency: USD
                      display_name: null
                      fee_subtype: PLATFORM_FEE
                      fee_type: CARD_BASIS_POINTS
                      label: null
                      linked_id: TRfnif8f9U1r6k2zys27U4yP
                      linked_to: TRfnif8f9U1r6k2zys27U4yP
                      linked_type: TRANSFER
                      merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79
                        merchant:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm
                        transfer:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRfnif8f9U1r6k2zys27U4yP
                    - id: FEnCRGg2nSUXY96wd99Hy31R
                      created_at: '2024-12-16T08:33:42.12Z'
                      updated_at: '2024-12-16T08:33:42.12Z'
                      amount: 30
                      category: PROCESSOR
                      currency: USD
                      display_name: null
                      fee_subtype: PLATFORM_FEE
                      fee_type: CARD_FIXED
                      label: null
                      linked_id: TRfnif8f9U1r6k2zys27U4yP
                      linked_to: TRfnif8f9U1r6k2zys27U4yP
                      linked_type: TRANSFER
                      merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/fees/FEnCRGg2nSUXY96wd99Hy31R
                        merchant:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm
                        transfer:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRfnif8f9U1r6k2zys27U4yP
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fees?linked_id=TRfnif8f9U1r6k2zys27U4yP
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/fees?linked_id=TRfnif8f9U1r6k2zys27U4yP&after_cursor=FEnCRGg2nSUXY96wd99Hy31R
                page:
                  limit: 100
                  next_cursor: FEnCRGg2nSUXY96wd99Hy31R
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    MerchantProfile:
      description: Single merchant profile object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MerchantProfile'
          examples:
            Merchant Profile:
              value:
                id: MPfRU8XJ8sDZryZhoYCyjtyB
                created_at: '2024-11-14T22:25:06.76Z'
                updated_at: '2024-11-14T22:25:39.56Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                card_present_fee_profile: null
                fee_profile: null
                payout_profile: POcWbEcDftaX474HhUgDS4pC
                risk_profile: RP8z1UutdHx921DEcfnLRNs6
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchant_profiles/MPfRU8XJ8sDZryZhoYCyjtyB
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  risk_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/risk_profiles/RP8z1UutdHx921DEcfnLRNs6
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    MerchantProfilesList:
      description: Single merchant profile object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MerchantProfilesList'
          examples:
            List of Merchant Profiles:
              value:
                _embedded:
                  merchant_profiles:
                    - id: MPo2FsjMoEV2xjq81cMWEjJ4
                      created_at: '2024-12-27T06:34:21.36Z'
                      updated_at: '2024-12-27T06:34:21.36Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      card_present_fee_profile: null
                      fee_profile: null
                      payout_profile: null
                      risk_profile: RP8z1UutdHx921DEcfnLRNs6
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchant_profiles/MPo2FsjMoEV2xjq81cMWEjJ4
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        risk_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/risk_profiles/RP8z1UutdHx921DEcfnLRNs6
                    - id: MPkqsHYxQ4SCLGbtAm4HMWsr
                      created_at: '2024-12-04T07:55:59.88Z'
                      updated_at: '2025-01-02T09:42:17.82Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      card_present_fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                      fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                      payout_profile: PO7oz3zVcGFrxPWZoRAy9oXd
                      risk_profile: RP37kQLfxBQiXLEMnb4YCPPg
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchant_profiles/MPkqsHYxQ4SCLGbtAm4HMWsr
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        risk_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/risk_profiles/RP37kQLfxBQiXLEMnb4YCPPg
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
                    - id: MPfRU8XJ8sDZryZhoYCyjtyB
                      created_at: '2024-11-14T22:25:06.76Z'
                      updated_at: '2024-11-14T22:25:39.56Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      card_present_fee_profile: null
                      fee_profile: null
                      payout_profile: POcWbEcDftaX474HhUgDS4pC
                      risk_profile: RP8z1UutdHx921DEcfnLRNs6
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchant_profiles/MPfRU8XJ8sDZryZhoYCyjtyB
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        risk_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/risk_profiles/RP8z1UutdHx921DEcfnLRNs6
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchant_profiles?after_cursor=MPfRU8XJ8sDZryZhoYCyjtyB
                page:
                  limit: 100
                  next_cursor: MPfRU8XJ8sDZryZhoYCyjtyB
    NoContent:
      description: No content
    PaymentInstrumentUpdatesList:
      description: List of Update objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentInstrumentUpdatesList'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Processor:
      description: Single Processor object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Processor'
          examples:
            Application Processor:
              value:
                id: PR9DvbgX5uuhqyKuBBD6VmFi
                created_at: '2022-04-29T18:29:23.07Z'
                updated_at: '2022-04-29T18:29:22.97Z'
                application: APdHjTsAPx81go7ekSMJqQdz
                application_config:
                  key1: value-1
                  key2: value-2
                  can_debit_bank_account: true
                  allow_split_payouts: false
                  ach_immediate_destination_name: null
                  default_currencies:
                    - USD
                  ach_settlement_delay_days: null
                  default_level_two_level_three_data_enabled: false
                  template_countries_available: []
                  alert_on_unknown_merchants: false
                config:
                  key1: value-1
                  key2: value-2
                  canDebitBankAccount: true
                default_merchant_profile: MPpWCidKDfKZARSJKCAW3kex
                enabled: true
                processor: DUMMY_V1
                system_config: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APdHjTsAPx81go7ekSMJqQdz/processors/DUMMY_V1
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APdHjTsAPx81go7ekSMJqQdz
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ProcessorsList:
      description: List of Processor objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProcessorsList'
          examples:
            List of Application Processors:
              value:
                _embedded:
                  processors:
                    - id: PRmr3QooJNFuehWTjsJwkWp8
                      created_at: '2022-09-19T01:27:07.86Z'
                      updated_at: '2022-09-19T01:27:07.65Z'
                      application: APmuwPBaW8pVcwb4vCTHQH32
                      application_config:
                        can_debit_bank_account: true
                        enable_pin_debit: true
                        ach_settlement_delay_days: null
                        allow_custom_billing: false
                        allow_partial_auth: false
                        allow_split_payouts: false
                        allow_create_credentials: false
                        amex_acquired: false
                        merchant_fraud_enabled: false
                        allow_debit_online: false
                        boarding_id: VGPG
                        business_type: Retail
                        vantiv_sftp_username: VGPGSFTP
                        vantiv_sftp_password: ca7Abrug
                        vantiv_chain_number: 0X6600
                        vantiv_license: VANTIV license="6ad47..."
                        check_for_duplicate_transactions: 'Yes'
                        username: FINIXNEW
                        password: cert1234
                        chargebacks_username: null
                        chargebacks_password: null
                        payfac_merchant_id: '01185553'
                        payfac_username: FINIXNEWMP
                        payfac_password: cert12mp
                        reports_sftp_username: username
                        reports_sftp_password: password
                        ach_immediate_destination_name: null
                        sftp_username: finixv12txn
                        sftp_password: 4J7Lp9Xq
                        tp_application_name: express.chris
                        tp_application_id: null
                        tp_application_version: '1.0'
                        tp_authorization: Version=2.0
                        tp_base_url: https://triposcert.vantiv.com/
                        ep_transaction_url: null
                        ep_reporting_url: null
                        ep_services_url: null
                        ep_application_id: null
                        ep_application_name: null
                        ep_application_version: null
                        settlement_payment_type: regular
                        card_sale_submission_method: null
                        default_currencies:
                          - USD
                        vantiv_trace_id_option: null
                        acquiring_bin: null
                        default_level_two_level_three_data_enabled: false
                        template_countries_available: []
                        alert_on_unknown_merchants: false
                      config:
                        key1: value-1
                        key2: value-2
                        canDebitBankAccount: true
                      default_merchant_profile: MP53dza14XzW4VYqRTnQ8Bpw
                      enabled: true
                      processor: VANTIV_V1
                      system_config: null
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/VANTIV_V1
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
                    - id: PRrH5Cy9ZYFUZDha4cuDgipv
                      created_at: '2022-04-01T20:45:28.22Z'
                      updated_at: '2022-04-01T20:45:28.11Z'
                      application: APmuwPBaW8pVcwb4vCTHQH32
                      application_config:
                        default_sender_account_number: '1415888508012'
                        default_sender_address_line1: 21 Broadway
                        default_sender_address_line2: null
                        default_sender_city: OFallon
                        default_sender_country: CRI
                        default_sender_country_code: CRI
                        default_sender_postal_code: '63368'
                        default_sender_first_name: Michael
                        default_sender_last_name: Serna
                        default_sender_full_name: Michael Serna
                        sanction_screening_override: true
                        card_acceptor_id: null
                        statement_descriptor: null
                        default_payment_type: P2P
                        default_currencies:
                          - CRC
                        configuration_templates: null
                        ach_settlement_delay_days: null
                        default_level_two_level_three_data_enabled: false
                        allow_split_payouts: false
                        alert_on_unknown_merchants: false
                      config: {}
                      default_merchant_profile: MP53dza14XzW4VYqRTnQ8Bpw
                      enabled: true
                      processor: MASTERCARD_V1
                      system_config: null
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/MASTERCARD_V1
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
                    - id: PR686aPfkq2cyHGtKfsxtoib
                      created_at: '2021-10-04T17:46:10.09Z'
                      updated_at: '2021-10-04T17:46:10.00Z'
                      application: APmuwPBaW8pVcwb4vCTHQH32
                      application_config:
                        key1: value-1
                        key2: value-2
                        can_debit_bank_account: true
                        allow_split_payouts: false
                        ach_immediate_destination_name: null
                        default_currencies:
                          - USD
                        ach_settlement_delay_days: null
                        default_level_two_level_three_data_enabled: false
                        template_countries_available: []
                        alert_on_unknown_merchants: false
                      config:
                        key1: value-1
                        key2: value-2
                        canDebitBankAccount: true
                      default_merchant_profile: MPf31wi1tKdVqtrT8PFyPFSg
                      enabled: true
                      processor: DUMMY_V1
                      system_config: null
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/DUMMY_V1
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 3
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    CloseSettlementResponse:
      description: Closed `Settlement` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Settlement'
          examples:
            Close Settlement:
              value:
                id: STdjQCfwwra8QBVZQhrfqdUt
                created_at: '2024-12-04T08:52:01.18Z'
                updated_at: '2024-12-04T12:00:15.83Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                funds_flow: null
                identity: IDjvxGeXBLKH1V9YnWm1CS4n
                is_exception: false
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                net_amount: 131854
                payment_type: null
                payout_profile_id: POcWbEcDftaX474HhUgDS4pC
                processor: DUMMY_V1
                status: AWAITING_APPROVAL
                tags: {}
                total_amount: 131854
                total_fee: 0
                total_fees: 0
                type: MERCHANT_REVENUE
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/AP8Hb3WvAFQ2DUdqKJYszMo5
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDj6kvMbVaeSzxQK6g1eoKKo
                  funding_transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/funding_transfers
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=fee
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=reverse
                  credits:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=credit
                  debits:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=debit
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=dispute
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Settlement:
      description: '`Settlement` object.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Settlement'
          examples:
            Settlement:
              value:
                id: STftJPELA3uTnx6hwKrJEYA7
                created_at: '2024-12-16T08:33:42.83Z'
                updated_at: '2024-12-17T12:00:21.81Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                funds_flow: null
                identity: ID6UfSm1d4WPiWgLYmbyeo3H
                is_exception: false
                merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                net_amount: 15057
                payment_type: null
                payout_profile_id: PO7oz3zVcGFrxPWZoRAy9oXd
                processor: DUMMY_V1
                status: APPROVED
                tags: {}
                total_amount: 15600
                total_fee: 543
                total_fees: 543
                type: MERCHANT_REVENUE
                window_end_time: '2024-12-17T05:00:00.00Z'
                window_start_time: '2024-12-16T05:00:00.00Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                  funding_transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/funding_transfers
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=fee
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=reverse
                  credits:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=credit
                  debits:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=debit
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=dispute
    SettlementsList:
      description: List of `Settlement` objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SettlementsList'
          examples:
            List of Settlements:
              value:
                _embedded:
                  settlements:
                    - id: STftJPELA3uTnx6hwKrJEYA7
                      created_at: '2024-12-16T08:33:42.83Z'
                      updated_at: '2024-12-17T12:00:21.81Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      currency: USD
                      destination: null
                      funds_flow: null
                      identity: ID6UfSm1d4WPiWgLYmbyeo3H
                      is_exception: false
                      merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                      net_amount: 15057
                      payment_type: null
                      payout_profile_id: PO7oz3zVcGFrxPWZoRAy9oXd
                      processor: DUMMY_V1
                      status: APPROVED
                      tags: {}
                      total_amount: 15600
                      total_fee: 543
                      total_fees: 543
                      type: MERCHANT_REVENUE
                      window_end_time: '2024-12-17T05:00:00.00Z'
                      window_start_time: '2024-12-16T05:00:00.00Z'
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                        funding_transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/funding_transfers
                        transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers
                        fees:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=fee
                        reversals:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=reverse
                        credits:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=credit
                        debits:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=debit
                        disputes:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=dispute
                    - id: SThdrv9oKNhPCz9piU4Smp5t
                      created_at: '2024-12-04T10:50:01.75Z'
                      updated_at: '2024-12-06T08:00:18.54Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      currency: USD
                      destination: null
                      funds_flow: null
                      identity: IDjvxGeXBLKH1V9YnWm1CS4n
                      is_exception: false
                      merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                      net_amount: 268
                      payment_type: null
                      payout_profile_id: POcWbEcDftaX474HhUgDS4pC
                      processor: DUMMY_V1
                      status: APPROVED
                      tags: {}
                      total_amount: 400
                      total_fee: 132
                      total_fees: 132
                      type: MERCHANT_REVENUE
                      window_end_time: '2024-12-05T05:00:00.00Z'
                      window_start_time: '2024-12-04T05:00:00.00Z'
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                        funding_transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/funding_transfers
                        transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/transfers
                        fees:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/transfers?type=fee
                        reversals:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/transfers?type=reverse
                        credits:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/transfers?type=credit
                        debits:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/transfers?type=debit
                        disputes:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/transfers?type=dispute
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/settlements
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements?after_cursor=STRQWumUFMWzRAuGL91BUtg
                page:
                  limit: 100
                  next_cursor: STsdvwKDyZq3gwZi5upuAETj
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FundingTransferAttempt:
      description: '`Funding Transfer Attempt` object.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FundingTransferAttempt'
          examples:
            FundingTransferAttempt:
              value:
                id: funding_transfer_attempt_wSodeznBbYmvGCHizgaH8f
                created_at: '2025-01-30T01:01:00.47Z'
                updated_at: '2025-01-30T01:01:00.47Z'
                amount: 101059
                application: APsi2UkE1BgD1aq839yKrwRh
                currency: USD
                funding_transfer_id: TRmjGDHpt53BPhbx2vb5WAhn
                instrument_id: PItzrwXcHBsEC9TLL1JHAB2Z
                failure_code: null
                failure_message: null
                merchant_id: MUngypKf1SE1M1v6tFH8WVe4
                state: SUCCEEDED
                settlement_id: STm8JM3AzYBEw8iBetmCAZut
                tags: {}
                _links:
                  self:
                    href: >-
                      /settlements/funding_transfer_attempt_wSodeznBbYmvGCHizgaH8f
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ListSettlementFundingTransfersResponse:
      description: List of `Transfer` objects belonging to a `Settlement`.
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  transfers:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/transfer'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Settlement Funding Transfers:
              value:
                _embedded:
                  transfers:
                    - id: TRd9eKzD2ErnYLzzkocyke5d
                      created_at: '2024-12-04T12:00:17.46Z'
                      updated_at: '2024-12-04T12:01:28.81Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      additional_purchase_data: null
                      address_verification: null
                      amount: 67
                      amount_requested: 67
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      currency: USD
                      destination: PImXAVgkKVshKWWHUk4xXbve
                      externally_funded: UNKNOWN
                      failure_code: null
                      failure_message: null
                      fee: 0
                      fee_profile: null
                      idempotency_id: null
                      merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                      messages: []
                      operation_key: null
                      parent_transfer: null
                      parent_transfer_trace_id: null
                      raw: null
                      ready_to_settle_at: null
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: null
                      split_transfers: []
                      state: SUCCEEDED
                      statement_descriptor: null
                      subtype: SETTLEMENT_MERCHANT
                      tags: {}
                      tip_amount: null
                      trace_id: 6c62d902-22bc-471c-8f89-df65be72a6dc
                      type: CREDIT
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRd9eKzD2ErnYLzzkocyke5d
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRd9eKzD2ErnYLzzkocyke5d/payment_instruments
                        reversals:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRd9eKzD2ErnYLzzkocyke5d/reversals
                        fees:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRd9eKzD2ErnYLzzkocyke5d/fees
                        disputes:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRd9eKzD2ErnYLzzkocyke5d/disputes
                        destination:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PImXAVgkKVshKWWHUk4xXbve
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
                    - id: TRtxYyGJXZ5h1kENd2aMeqjK
                      created_at: '2024-12-04T12:00:16.90Z'
                      updated_at: '2024-12-04T12:01:25.35Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      additional_purchase_data: null
                      address_verification: null
                      amount: 33
                      amount_requested: 33
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      currency: USD
                      destination: PIn21JMoPv7ETVUsX2veerqz
                      externally_funded: UNKNOWN
                      failure_code: null
                      failure_message: null
                      fee: 0
                      fee_profile: null
                      idempotency_id: null
                      merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                      messages: []
                      operation_key: null
                      parent_transfer: null
                      parent_transfer_trace_id: null
                      raw: null
                      ready_to_settle_at: null
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: null
                      split_transfers: []
                      state: SUCCEEDED
                      statement_descriptor: null
                      subtype: SETTLEMENT_PLATFORM
                      tags: {}
                      tip_amount: null
                      trace_id: 99564345-35ef-4a0e-a95a-87b254ddc32f
                      type: CREDIT
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRtxYyGJXZ5h1kENd2aMeqjK
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRtxYyGJXZ5h1kENd2aMeqjK/payment_instruments
                        reversals:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRtxYyGJXZ5h1kENd2aMeqjK/reversals
                        fees:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRtxYyGJXZ5h1kENd2aMeqjK/fees
                        disputes:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRtxYyGJXZ5h1kENd2aMeqjK/disputes
                        destination:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PIn21JMoPv7ETVUsX2veerqz
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers?after_cursor=TRtxYyGJXZ5h1kENd2aMeqjK
                page:
                  limit: 100
                  next_cursor: TRtxYyGJXZ5h1kENd2aMeqjK
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ListSettlementTransfersResponse:
      description: List of `Transfer` objects belonging to a `Settlement`.
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  transfers:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/transfer'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Settlement Transfers:
              value:
                _embedded:
                  transfers:
                    - id: TRoEQY7rcV8yg9ivXHXc6u1V
                      created_at: '2024-12-04T11:04:11.30Z'
                      updated_at: '2024-12-04T11:05:00.74Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      additional_purchase_data:
                        customer_reference_number: 321xyz
                        customs_duty_amount: 10
                        destination_country_code: null
                        destination_postal_code: null
                        discount_amount: 100
                        invoice_reference_number: null
                        order_date: null
                        sales_tax: null
                        sales_tax_finix_generated: 200
                        ship_from_postal_code: null
                        shipping_amount: 100
                        tax_exempt: false
                        item_data:
                          - cost_per_unit: 500
                            item_description: printing paper
                            item_discount_amount: 100
                            merchant_product_code: '1149611'
                            quantity: 1
                            amount_excluding_sales_tax: 400
                            amount_including_sales_tax: 500
                            unit_of_measure: BX
                            commodity_code: 175-62-20
                            sales_tax_amount: 100
                            sales_tax_rate: 0.25
                          - cost_per_unit: 500
                            item_description: printing ink
                            item_discount_amount: 0
                            merchant_product_code: '2149612'
                            quantity: 1
                            amount_excluding_sales_tax: 400
                            amount_including_sales_tax: 500
                            unit_of_measure: CTN
                            commodity_code: 207-72-54
                            sales_tax_amount: 100
                            sales_tax_rate: 0.25
                      address_verification: null
                      amount: 100
                      amount_requested: 100
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      currency: USD
                      destination: null
                      externally_funded: 'FALSE'
                      failure_code: null
                      failure_message: null
                      fee: 0
                      idempotency_id: null
                      merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                      messages: []
                      operation_key: CARD_NOT_PRESENT_CAPTURE
                      parent_transfer: null
                      parent_transfer_trace_id: null
                      raw: null
                      ready_to_settle_at: '2024-12-05T11:05:00.81Z'
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: PIkxmtueemLD6dN9ZoWGHT44
                      split_transfers: []
                      state: SUCCEEDED
                      statement_descriptor: FLX*FLEX
                      subtype: API
                      tags: {}
                      tip_amount: null
                      trace_id: 2f4eb0e7-0f05-47a6-9dde-0b482c0b49b7
                      type: DEBIT
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRoEQY7rcV8yg9ivXHXc6u1V
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRoEQY7rcV8yg9ivXHXc6u1V/payment_instruments
                        reversals:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRoEQY7rcV8yg9ivXHXc6u1V/reversals
                        fees:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRoEQY7rcV8yg9ivXHXc6u1V/fees
                        disputes:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRoEQY7rcV8yg9ivXHXc6u1V/disputes
                        source:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
                    - id: TR5UztJYtSUTtVWNWgMaqLMo
                      created_at: '2024-12-04T11:05:00.53Z'
                      updated_at: '2024-12-04T11:05:00.53Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      additional_purchase_data: null
                      address_verification: null
                      amount: 30
                      amount_requested: 30
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      currency: USD
                      destination: null
                      externally_funded: 'FALSE'
                      failure_code: null
                      failure_message: null
                      fee: 0
                      fee_type: CARD_FIXED
                      idempotency_id: null
                      merchant: MU7noQ1wdgdAeAfymw2rfBMq
                      merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                      messages: []
                      operation_key: null
                      parent_transfer: TRoEQY7rcV8yg9ivXHXc6u1V
                      parent_transfer_trace_id: 2f4eb0e7-0f05-47a6-9dde-0b482c0b49b7
                      raw: null
                      ready_to_settle_at: '2024-12-05T11:05:00.81Z'
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: null
                      split_transfers: []
                      state: SUCCEEDED
                      statement_descriptor: null
                      subtype: PLATFORM_FEE
                      tags: {}
                      tip_amount: null
                      trace_id: 7d027afd-288b-4be7-8487-6a6d09ffdd17
                      type: FEE
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TR5UztJYtSUTtVWNWgMaqLMo
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TR5UztJYtSUTtVWNWgMaqLMo/payment_instruments
                        parent:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRoEQY7rcV8yg9ivXHXc6u1V
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/transfers
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/SThdrv9oKNhPCz9piU4Smp5t/transfers?after_cursor=TRhzVLqF1TKjtMZsMJwA7P9j
                page:
                  limit: 100
                  next_cursor: TRhzVLqF1TKjtMZsMJwA7P9j
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ListSplitTransferFeesResponse:
      description: List of fees belonging to a `Split Transfer`.
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  transfers:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/transfer'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Split Transfer Fees:
              value:
                _embedded:
                  transfers:
                    - id: TRf75ZVCM1M4eVojmVYGUnuQ
                      created_at: '2023-07-19T02:30:17.43Z'
                      updated_at: '2023-07-19T02:30:17.43Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      address_verification: null
                      amount: 30
                      amount_requested: 30
                      application: APgPDQrLD52TYvqazjHJJchM
                      currency: USD
                      destination: null
                      externally_funded: 'FALSE'
                      failure_code: null
                      failure_message: null
                      fee: 0
                      fee_type: CARD_FIXED
                      idempotency_id: null
                      merchant: MU4jpoNGRkAyjBxumZhGa6Hc
                      merchant_identity: IDhCtMvcteDx37eD9m4rmdKd
                      messages: []
                      raw: null
                      ready_to_settle_at: '2023-07-19T07:30:01.27Z'
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: null
                      split_transfers: null
                      state: SUCCEEDED
                      statement_descriptor: null
                      subtype: PLATFORM_FEE
                      tags: {}
                      trace_id: 2c56f4f0-1f48-451c-9498-199daaff2e39
                      type: FEE
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRf75ZVCM1M4eVojmVYGUnuQ
                        parent:
                          href: >-
                            https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDhCtMvcteDx37eD9m4rmdKd
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRf75ZVCM1M4eVojmVYGUnuQ/payment_instruments
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPbDSnEPtaT8Nttxj9NJk7eC
                    - id: TR4AyjeiKwML2rZ6fWyVaQST
                      created_at: '2023-07-19T02:30:17.43Z'
                      updated_at: '2023-07-19T02:30:17.43Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      address_verification: null
                      amount: 17
                      amount_requested: 17
                      application: APgPDQrLD52TYvqazjHJJchM
                      currency: USD
                      destination: null
                      externally_funded: 'FALSE'
                      failure_code: null
                      failure_message: null
                      fee: 0
                      fee_type: CARD_BASIS_POINTS
                      idempotency_id: null
                      merchant: MU4jpoNGRkAyjBxumZhGa6Hc
                      merchant_identity: IDhCtMvcteDx37eD9m4rmdKd
                      messages: []
                      raw: null
                      ready_to_settle_at: '2023-07-19T07:30:01.27Z'
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: null
                      split_transfers: null
                      state: SUCCEEDED
                      statement_descriptor: null
                      subtype: PLATFORM_FEE
                      tags: {}
                      trace_id: 48a6fa39-5639-4e2c-b316-fad2db170954
                      type: FEE
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TR4AyjeiKwML2rZ6fWyVaQST
                        parent:
                          href: >-
                            https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDhCtMvcteDx37eD9m4rmdKd
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TR4AyjeiKwML2rZ6fWyVaQST/payment_instruments
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPbDSnEPtaT8Nttxj9NJk7eC
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q/fees
                page:
                  limit: 100
                  next_cursor: TR4AyjeiKwML2rZ6fWyVaQST
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FundingTransferAttemptsList:
      description: List of Funding Transfer Attempts objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FundingTransferAttemptsList'
          examples:
            List of Funding Transfer Attempts:
              value:
                _embedded:
                  funding_transfer_attempts:
                    - id: funding_transfer_attempt_wSodeznBbYmvGCHizgaH8f
                      created_at: '2025-01-30T01:01:00.47Z'
                      updated_at: '2025-01-30T01:01:00.47Z'
                      amount: 101059
                      application: APsi2UkE1BgD1aq839yKrwRh
                      currency: USD
                      funding_transfer_id: TRmjGDHpt53BPhbx2vb5WAhn
                      instrument_id: PItzrwXcHBsEC9TLL1JHAB2Z
                      failure_code: null
                      failure_message: null
                      merchant_id: MUngypKf1SE1M1v6tFH8WVe4
                      state: SUCCEEDED
                      settlement_id: STm8JM3AzYBEw8iBetmCAZut
                      tags: {}
                      _links:
                        self:
                          href: >-
                            /settlements/funding_transfer_attempt_wSodeznBbYmvGCHizgaH8f
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STm8JM3AzYBEw8iBetmCAZut/funding_transfer_attempts
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_profiles?after_cursor=funding_transfer_attempt_wSodeznBbYmvGCHizgaH8f
                page:
                  limit: 100
                  next_cursor: null
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    User:
      description: Single `User` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/user'
          examples:
            User:
              value:
                id: USgYN9GjHUUvQ6gWed2bSX8E
                created_at: '2024-12-24T09:43:18.47Z'
                updated_at: '2024-12-24T09:43:18.47Z'
                created_by: USfdccsr1Z5iVbXDyYt7hjZZ
                email: null
                enabled: true
                identity: IDjvxGeXBLKH1V9YnWm1CS4n
                last_used_date: null
                password: ff350382-5a5e-456d-be9f-78b1084358cf
                role: ROLE_PARTNER
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/users/USgYN9GjHUUvQ6gWed2bSX8E
                  applications:
                    href: https://finix.sandbox-payments-api.com/applications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    UsersList:
      description: List of `User` objects.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UsersList'
          examples:
            List of Users:
              value:
                _embedded:
                  users:
                    - id: UScxTTYxJNAmRsZiWGCaDhNU
                      created_at: '2024-12-03T15:43:38.95Z'
                      updated_at: '2024-12-23T15:37:09.60Z'
                      created_by: USyCRfdUqbCexG2epWVJkuK
                      email: contractor.mark.w@finix.com
                      enabled: true
                      identity: IDjvxGeXBLKH1V9YnWm1CS4n
                      last_used_date: '2024-12-23'
                      password: null
                      role: ROLE_PARTNER
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/users/UScxTTYxJNAmRsZiWGCaDhNU
                        applications:
                          href: https://finix.sandbox-payments-api.com/applications
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                    - id: USfdccsr1Z5iVbXDyYt7hjZZ
                      created_at: '2024-12-03T15:44:15.09Z'
                      updated_at: '2024-12-24T04:50:05.52Z'
                      created_by: USyCRfdUqbCexG2epWVJkuK
                      email: null
                      enabled: true
                      identity: IDjvxGeXBLKH1V9YnWm1CS4n
                      last_used_date: '2024-12-24'
                      password: null
                      role: ROLE_PARTNER
                      tags:
                        name: Finix Docs API Keys
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/users/USfdccsr1Z5iVbXDyYt7hjZZ
                        applications:
                          href: https://finix.sandbox-payments-api.com/applications
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/users?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 6
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    VerificationResponse:
      description: >-
        Single `Verification` object representing either a `Payment Instrument`
        or `Merchant verification`.
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/merchant-verification'
              - $ref: '#/components/schemas/payment-instrument-verification'
          examples:
            Verification - Payment Instrument:
              value:
                id: VIifZsRbV1uPHWNyd7ePXtN5
                created_at: '2024-12-27T06:34:21.21Z'
                updated_at: '2024-12-27T06:35:01.56Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                identity: null
                merchant: null
                merchant_identity: null
                messages: []
                outcome_summary: null
                outcomes: null
                payment_instrument: PIiYHJ6dDykz1fihySDWzxd4
                payment_instrument_verification_details:
                  push_to_card_domestic: null
                  push_to_card_cross_border: null
                  card_type: null
                  billing_currency: null
                  issuer_country: UNKNOWN
                processor: DUMMY_V1
                raw: RawDummyInstrumentVerificationResult
                state: SUCCEEDED
                tags: {}
                trace_id: 2764b9b0-dbec-4b21-a3b6-c2693015761e
                type: PAYMENT_INSTRUMENT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/verifications/VIifZsRbV1uPHWNyd7ePXtN5
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  payment_instrument:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIiYHJ6dDykz1fihySDWzxd4
            Verification - Merchant:
              value:
                id: VI5pMpAg6e5bRaMREhrYjwQW
                created_at: '2024-12-04T07:56:00.03Z'
                updated_at: '2024-12-04T07:57:01.95Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                identity: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                outcome_summary: null
                outcomes: null
                payment_instrument: null
                payment_instrument_verification_details:
                  push_to_card_domestic: null
                  push_to_card_cross_border: null
                  card_type: null
                  billing_currency: null
                  issuer_country: null
                processor: DUMMY_V1
                raw: RawDummyMerchantUnderwriteResult
                state: SUCCEEDED
                tags: {}
                trace_id: 26577eee-2db9-4707-85f6-5b8f9c1e5376
                type: MERCHANT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/verifications/VI5pMpAg6e5bRaMREhrYjwQW
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm
    VerificationsList:
      description: A list of `Merchant` and `Payment Instrument` `Verification` objects.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VerificationsList'
          examples:
            Verifications:
              value:
                _embedded:
                  verifications:
                    - id: VIifZsRbV1uPHWNyd7ePXtN5
                      created_at: '2024-12-27T06:34:21.21Z'
                      updated_at: '2024-12-27T06:35:01.56Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      identity: null
                      merchant: null
                      merchant_identity: null
                      messages: []
                      outcome_summary: null
                      outcomes: null
                      payment_instrument: PIiYHJ6dDykz1fihySDWzxd4
                      payment_instrument_verification_details:
                        push_to_card_domestic: null
                        push_to_card_cross_border: null
                        card_type: null
                        billing_currency: null
                        issuer_country: UNKNOWN
                      processor: DUMMY_V1
                      raw: RawDummyInstrumentVerificationResult
                      state: SUCCEEDED
                      tags: {}
                      trace_id: 2764b9b0-dbec-4b21-a3b6-c2693015761e
                      type: PAYMENT_INSTRUMENT
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/verifications/VIifZsRbV1uPHWNyd7ePXtN5
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        payment_instrument:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PIiYHJ6dDykz1fihySDWzxd4
                    - id: VI5pMpAg6e5bRaMREhrYjwQW
                      created_at: '2024-12-04T07:56:00.03Z'
                      updated_at: '2024-12-04T07:57:01.95Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      identity: null
                      merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                      messages: []
                      outcome_summary: null
                      outcomes: null
                      payment_instrument: null
                      payment_instrument_verification_details:
                        push_to_card_domestic: null
                        push_to_card_cross_border: null
                        card_type: null
                        billing_currency: null
                        issuer_country: null
                      processor: DUMMY_V1
                      raw: RawDummyMerchantUnderwriteResult
                      state: SUCCEEDED
                      tags: {}
                      trace_id: 26577eee-2db9-4707-85f6-5b8f9c1e5376
                      type: MERCHANT
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/verifications/VI5pMpAg6e5bRaMREhrYjwQW
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        merchant:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications?after_cursor=VIdS8qSW3kZbnK9AsFHJZ81U
                page:
                  limit: 100
                  next_cursor: VIdS8qSW3kZbnK9AsFHJZ81U
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Webhook:
      description: Single Webhook object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Webhook'
          examples:
            Webhook - No Authentication:
              value:
                id: WHD6pSgL4jd2USZbQP3SfjD
                created_at: '2024-12-25T04:59:28.53Z'
                updated_at: '2024-12-25T04:59:28.53Z'
                application: APgPDQrLD52TYvqazjHJJchM
                authentication:
                  type: NONE
                enabled: true
                enabled_events: []
                is_accepting_events: true
                nickname: null
                previous_secret_expires_at: null
                secret_signing_key: >-
                  941db8f5972d0191229fc53f6bd9095eaee6896e9d8b1039d5893cda66164fc9
                url: https://httpbin.org/post
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/webhooks/WHD6pSgL4jd2USZbQP3SfjD
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
            Webhook - Basic Authentication:
              value:
                id: WHD6pSgL4jd2USZbQP3SfjD
                created_at: '2024-12-25T04:59:28.53Z'
                updated_at: '2024-12-25T04:59:28.53Z'
                application: APgPDQrLD52TYvqazjHJJchM
                authentication:
                  type: BASIC
                enabled: true
                enabled_events: []
                is_accepting_events: true
                nickname: null
                previous_secret_expires_at: null
                secret_signing_key: >-
                  941db8f5972d0191229fc53f6bd9095eaee6896e9d8b1039d5893cda66164fc9
                url: https://httpbin.org/post
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/webhooks/WHD6pSgL4jd2USZbQP3SfjD
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
            Webhook - Bearer Token Authentication:
              value:
                id: WHD6pSgL4jd2USZbQP3SfjD
                created_at: '2024-12-25T04:59:28.53Z'
                updated_at: '2024-12-25T04:59:28.53Z'
                application: APgPDQrLD52TYvqazjHJJchM
                authentication:
                  type: BEARER
                enabled: true
                enabled_events: []
                is_accepting_events: true
                nickname: null
                previous_secret_expires_at: null
                secret_signing_key: >-
                  941db8f5972d0191229fc53f6bd9095eaee6896e9d8b1039d5893cda66164fc9
                url: https://httpbin.org/post
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/webhooks/WHD6pSgL4jd2USZbQP3SfjD
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
            Webhook - Enable Event Filtering:
              value:
                id: WHtPXJnAjmusyobzpmQZeHvJ
                created_at: '2022-06-05T23:29:07.99Z'
                updated_at: '2024-12-25T05:29:10.62Z'
                application: APgPDQrLD52TYvqazjHJJchM
                authentication:
                  type: NONE
                enabled: false
                enabled_events:
                  - entity: transfer
                    types:
                      - created
                  - entity: merchant
                    types:
                      - created
                      - underwritten
                is_accepting_events: false
                nickname: null
                previous_secret_expires_at: '2022-11-02T21:26:21.757477Z'
                url: https://eohzjuj2prziycz.m.pipedream.net
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/webhooks/WHtPXJnAjmusyobzpmQZeHvJ
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    CreateBalanceAdjustmentResponse:
      description: Response examples for a request to create a `Balance Adjustment`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BalanceAdjustment'
          examples:
            Balance Adjustment:
              value:
                id: balance_adjustment_kkYD8Hen6Ri8bkPErceifY
                created_at: '2025-11-14T17:30:28.172363Z'
                updated_at: '2025-11-14T17:30:28.545956Z'
                amount: 19
                balance_entry_id: balance_entry_kno3XJ9vbymJCw15eCdSpJ
                currency: USD
                description: Sample balance adjustment
                failure_code: null
                failure_message: null
                instrument_id: PI4Ppf8rxWYapuEqQr3u6efi
                rail: ACH
                state: SUCCEEDED
                tags:
                  name: Sample balance adjustment
                top_up_config_id: null
                trace_id: 9ce69925-8dfa-431a-8c7f-f846d4d33340
                type: TOP_UP
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/balance_adjustments/balance_adjustment_kkYD8Hen6Ri8bkPErceifY
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    BalanceAdjustmentList:
      description: List of `Balance Adjustment` objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BalanceAdjustmentList'
          examples:
            List of Balance Adjustments:
              value:
                _embedded:
                  balance_adjustments:
                    - id: balance_adjustment_jfR7V18CMWaGBmRYAto8Lw
                      created_at: '2024-05-22T17:13:15.810963Z'
                      updated_at: '2024-05-22T17:13:16.05664Z'
                      amount: 66
                      balance_entry_id: balance_entry_4Zsrw3ccS64vjpzZmNMdUi
                      currency: USD
                      failure_code: null
                      failure_message: null
                      description: balance_adjustment testing
                      rail: ACH
                      instrument_id: PIwyL8J2KRu8qnvGF7EDeviQ
                      state: SUCCEEDED
                      type: TOP_UP
                      tags:
                        name: Sample Balance Adjustment
                      trace_id: 872d2e13-2e56-47b6-94a3-64ec06a1f982
                      _links:
                        self:
                          href: >-
                            https://finix.qa-payments-api.com/balance_adjustments/balance_adjustment_jfR7V18CMWaGBmRYAto8Lw
                    - id: balance_adjustment_nvc873btpDtA7KbPySdCny
                      created_at: '2024-05-22T17:13:15.810963Z'
                      updated_at: '2024-05-22T17:13:16.05664Z'
                      amount: 66
                      balance_entry_id: balance_entry_4Zsrw3ccS64vjpzZmNMdUi
                      currency: USD
                      failure_code: null
                      failure_message: null
                      description: balance_adjustment testing
                      rail: ACH
                      instrument_id: PIwyL8J2KRu8qnvGF7EDeviQ
                      state: SUCCEEDED
                      type: TOP_UP
                      tags:
                        name: Sample Balance Adjustment
                      trace_id: 872d2e13-2e56-47b6-94a3-64ec06a1f982
                      _links:
                        self:
                          href: >-
                            https://finix.qa-payments-api.com/balance_adjustments/balance_adjustment_nvc873btpDtA7KbPySdCny
                _links:
                  self:
                    href: https://finix.qa-payments-api.com/balance_adjustments
                page:
                  limit: 100
                  next_cursor: balance_adjustment_nvc873btpDtA7KbPySdCny
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    WebhooksList:
      description: List of Webhook objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WebhooksList'
          examples:
            List of Webhooks:
              value:
                _embedded:
                  webhooks:
                    - id: WHD6pSgL4jd2USZbQP3SfjD
                      created_at: '2024-12-25T04:59:28.53Z'
                      updated_at: '2024-12-25T04:59:28.53Z'
                      application: APgPDQrLD52TYvqazjHJJchM
                      authentication:
                        type: BASIC
                      enabled: true
                      enabled_events: []
                      is_accepting_events: true
                      nickname: null
                      previous_secret_expires_at: null
                      url: https://httpbin.org/post
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/webhooks/WHD6pSgL4jd2USZbQP3SfjD
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                    - id: WHnDiFVYfg91tqy43Q25evHw
                      created_at: '2024-07-14T04:58:17.80Z'
                      updated_at: '2024-07-14T04:58:18.80Z'
                      application: APgPDQrLD52TYvqazjHJJchM
                      authentication:
                        type: NONE
                      enabled: false
                      enabled_events: []
                      is_accepting_events: false
                      nickname: null
                      previous_secret_expires_at: null
                      url: https://example.com/
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/webhooks/WHnDiFVYfg91tqy43Q25evHw
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/notification/webhooks?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/notification/webhooks?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: >-
                      https://finix.sandbox-payments-api.com/notification/webhooks?offset=3440&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 3451
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    BalanceList:
      description: List of `Balance` objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BalanceList'
          examples:
            List of Balances:
              value:
                _embedded:
                  balances:
                    - id: balance_dyz5APsJebDef9oTW9J2Hc
                      created_at: '2024-11-14T22:25:48.01Z'
                      updated_at: '2024-11-14T22:25:48.01Z'
                      available_amount: 9970019
                      currency: USD
                      linked_to: APc9vhYcPsRuTSpKD9KpMtPe
                      linked_type: APPLICATION
                      pending_amount: 9970019
                      posted_amount: 9970019
                      tags:
                        created_via: SYSTEM
                        description: BrainTree
                      type: DISBURSEMENT
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/balances?linked_to=APc9vhYcPsRuTSpKD9KpMtPe
                page:
                  limit: 100
                  next_cursor: balance_dyz5APsJebDef9oTW9J2Hc
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    BalanceTransfer:
      description: Single balance_transfer object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BalanceTransfer'
          examples:
            Balance Transfer:
              value:
                id: BT_4YdC9qnydbtWEDi88quEmC
                created_at: '2025-02-10T21:29:35.90Z'
                updated_at: '2025-02-10T21:29:37.07Z'
                amount: 4000
                currency: USD
                description: >-
                  Need to increase buffer given the high number of NSFs on
                  merchant fee debits
                destination: FOR_BENEFIT_OF_ACCOUNT
                external_reference_id: '83996111534053357'
                processor_type: LITLE_V1
                reference_id: FNXdY7HS91NQZryp8SgVFBwMR
                source: OPERATING_ACCOUNT
                state: SUCCEEDED
                tags:
                  example: documentation tag
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/balance_transfers/BT_4YdC9qnydbtWEDi88quEmC
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    BalanceTransferList:
      description: List of balance_transfer objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BalanceTransferList'
          examples:
            List of Balance Transfers:
              value:
                _embedded:
                  balance_transfers:
                    - id: BT_4YdC9qnydbtWEDi88quEmC
                      created_at: '2025-02-10T21:29:35.90Z'
                      updated_at: '2025-02-10T21:29:37.07Z'
                      amount: 4000
                      currency: USD
                      description: >-
                        Need to increase buffer given the high number of NSFs on
                        merchant fee debits
                      destination: FOR_BENEFIT_OF_ACCOUNT
                      external_reference_id: '83996111534053357'
                      processor_type: LITLE_V1
                      reference_id: FNXdY7HS91NQZryp8SgVFBwMR
                      source: OPERATING_ACCOUNT
                      state: SUCCEEDED
                      tags:
                        example: documentation tag
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/balance_transfers/BT_4YdC9qnydbtWEDi88quEmC
                    - id: BT_g3x4REBbV7yoe8N92CH8eP
                      created_at: '2025-02-08T18:49:50.25Z'
                      updated_at: '2025-02-08T18:49:51.42Z'
                      amount: 4000
                      currency: USD
                      description: >-
                        Need to increase buffer given the high number of NSFs on
                        merchant fee debits
                      destination: FOR_BENEFIT_OF_ACCOUNT
                      external_reference_id: '84084058155587752'
                      processor_type: LITLE_V1
                      reference_id: FNXjktdjssp6N9edfMW6agYax
                      source: OPERATING_ACCOUNT
                      state: SUCCEEDED
                      tags:
                        example: documentation tag
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/balance_transfers/BT_g3x4REBbV7yoe8N92CH8eP
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/balance_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/balance_transfers?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: >-
                      https://finix.sandbox-payments-api.com/balance_transfers?offset=3200&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 3200
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FileResponse:
      description: Single File object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/File'
          examples:
            File:
              value:
                id: FILE_qBwNnDHrpHv6xc1yQwLjNx
                status: UPLOADED
                created_at: '2025-12-05T16:45:16.953723Z'
                updated_at: '2025-12-05T16:46:06.017533Z'
                linked_type: MERCHANT
                linked_to: MUvWVhLpLj9w7kV1EXA7yvzc
                extension: csv
                display_name: bank_statement
                type: BANK_STATEMENT_ONE_MONTH
                platform_id: PLoMxXWbqwEMT5N1upSaNUbJ
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                tags: {}
                identity_id: IDnT3ff71VShf6dB2ShcPozq
                entity_id: null
                entity_type: null
                size_in_bytes: 312
                file_name: bank_statement_11052025.csv
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    UploadFileResponse:
      description: Single File object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/File'
          examples:
            File - Uploading:
              value:
                id: FILE_qBwNnDHrpHv6xc1yQwLjNx
                status: PENDING
                created_at: '2025-12-05T16:45:16.953723Z'
                updated_at: '2025-12-05T16:46:06.017533Z'
                linked_type: MERCHANT
                linked_to: MUvWVhLpLj9w7kV1EXA7yvzc
                extension: csv
                display_name: bank_statement
                type: BANK_STATEMENT_ONE_MONTH
                platform_id: PLoMxXWbqwEMT5N1upSaNUbJ
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                tags: {}
                identity_id: IDnT3ff71VShf6dB2ShcPozq
                entity_id: null
                entity_type: null
                size_in_bytes: 312
                file_name: bank_statement_11052025.csv
            File - Uploaded:
              value:
                id: FILE_qBwNnDHrpHv6xc1yQwLjNx
                status: UPLOADED
                created_at: '2025-12-05T16:45:16.953723Z'
                updated_at: '2025-12-05T16:46:06.017533Z'
                linked_type: MERCHANT
                linked_to: MUvWVhLpLj9w7kV1EXA7yvzc
                extension: csv
                display_name: bank_statement
                type: BANK_STATEMENT_ONE_MONTH
                platform_id: PLoMxXWbqwEMT5N1upSaNUbJ
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                tags: {}
                identity_id: IDnT3ff71VShf6dB2ShcPozq
                entity_id: null
                entity_type: null
                size_in_bytes: 312
                file_name: bank_statement_11052025.csv
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FilesList:
      description: List of File objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FilesList'
          examples:
            List of Files:
              value:
                _embedded:
                  files:
                    - id: FILE_qBwNnDHrpHv6xc1yQwLjNx
                      status: UPLOADED
                      created_at: '2025-12-05T16:45:16.953723Z'
                      updated_at: '2025-12-05T16:46:06.017533Z'
                      linked_type: MERCHANT
                      linked_to: MUvWVhLpLj9w7kV1EXA7yvzc
                      extension: csv
                      display_name: bank_statement
                      type: BANK_STATEMENT_ONE_MONTH
                      platform_id: PLoMxXWbqwEMT5N1upSaNUbJ
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      tags: {}
                      identity_id: IDnT3ff71VShf6dB2ShcPozq
                      entity_id: null
                      entity_type: null
                      size_in_bytes: 312
                      file_name: null
                    - id: FILE_aw97EbTRshpyiCjdHXhd3t
                      status: REQUIRES_UPLOAD
                      created_at: '2025-12-05T16:27:32.899574Z'
                      updated_at: '2025-12-05T16:27:32.917596Z'
                      linked_type: MERCHANT
                      linked_to: MUtaVJ3X6DFXfEox6fUSyqxt
                      extension: null
                      display_name: Bank Statement (January 2024)
                      type: BANK_STATEMENT
                      platform_id: PLoMxXWbqwEMT5N1upSaNUbJ
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      tags: {}
                      identity_id: ID47veZZgBXfRGv9ZkFdgCLt
                      entity_id: null
                      entity_type: null
                      size_in_bytes: null
                      file_name: null
                page:
                  limit: 2
                  next_cursor: FILE_aw97EbTRshpyiCjdHXhd3t
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ExternalLink:
      description: Single external_link object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExternalLink'
          examples:
            External Link:
              value:
                id: EL_nAvCa3WXze4pXGJxbGaxCh
                created_at: '2024-12-17T10:35:49.859547Z'
                url: >-
                  https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUmfEGv5bMpSJ9k5TFRUjkmm/DRIVERS_LICENSE_FRONT/FILE_o2TcURQeU3mjAGtPoWpRLr/file
                type: UPLOAD
                expires_at: '2024-12-24T10:35:49.808453Z'
                user_id: USfdccsr1Z5iVbXDyYt7hjZZ
                file_id: FILE_o2TcURQeU3mjAGtPoWpRLr
                duration: null
                tags: {}
                expired: false
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    CreateExternalLinkResponse:
      description: Single external_link object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExternalLink'
          examples:
            External Link - Upload:
              value:
                id: EL_nAvCa3WXze4pXGJxbGaxCh
                created_at: '2024-12-17T10:35:49.859547Z'
                url: >-
                  https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUmfEGv5bMpSJ9k5TFRUjkmm/DRIVERS_LICENSE_FRONT/FILE_o2TcURQeU3mjAGtPoWpRLr/file
                type: UPLOAD
                expires_at: '2024-12-24T10:35:49.808453Z'
                user_id: USfdccsr1Z5iVbXDyYt7hjZZ
                file_id: FILE_o2TcURQeU3mjAGtPoWpRLr
                duration: null
                tags: {}
                expired: false
            External Link - Download:
              value:
                id: EL_nAvCa3WXze4pXGJxbGaxCh
                created_at: '2024-12-17T10:35:49.859547Z'
                url: >-
                  https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUmfEGv5bMpSJ9k5TFRUjkmm/DRIVERS_LICENSE_FRONT/FILE_o2TcURQeU3mjAGtPoWpRLr/file
                type: DOWNLOAD
                expires_at: '2024-12-24T10:35:49.808453Z'
                user_id: USfdccsr1Z5iVbXDyYt7hjZZ
                file_id: FILE_o2TcURQeU3mjAGtPoWpRLr
                duration: null
                tags: {}
                expired: false
            External Link - View:
              value:
                id: EL_nAvCa3WXze4pXGJxbGaxCh
                created_at: '2024-12-17T10:35:49.859547Z'
                url: >-
                  https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUmfEGv5bMpSJ9k5TFRUjkmm/DRIVERS_LICENSE_FRONT/FILE_o2TcURQeU3mjAGtPoWpRLr/file
                type: VIEW
                expires_at: '2024-12-24T10:35:49.808453Z'
                user_id: USfdccsr1Z5iVbXDyYt7hjZZ
                file_id: FILE_o2TcURQeU3mjAGtPoWpRLr
                duration: null
                tags: {}
                expired: false
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ExternalLinksList:
      description: List of external_link objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExternalLinksList'
          examples:
            List of External Links:
              value:
                _embedded:
                  external_links:
                    - id: EL_nAvCa3WXze4pXGJxbGaxCh
                      created_at: '2024-12-17T10:35:49.859547Z'
                      url: >-
                        https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUmfEGv5bMpSJ9k5TFRUjkmm/DRIVERS_LICENSE_FRONT/FILE_o2TcURQeU3mjAGtPoWpRLr/file   
                      type: UPLOAD
                      expires_at: '2024-12-24T10:35:49.808453Z'
                      user_id: USfdccsr1Z5iVbXDyYt7hjZZ
                      file_id: FILE_o2TcURQeU3mjAGtPoWpRLr
                      duration: null
                      tags: {}
                      expired: false
                page:
                  limit: 10
                  next_cursor: EL_nAvCa3WXze4pXGJxbGaxCh
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    AdjustmentTransfersList:
      description: List of adjustment_transfer objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AdjustmentTransfersList'
          examples:
            List of Adjustment Transfers in a Dispute:
              value:
                _embedded:
                  transfers:
                    - id: TRv7QRfEZ6UPqkfJjkV4UJdW
                      created_at: '2023-11-24T13:04:33.22Z'
                      updated_at: '2024-12-18T05:22:09.39Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      additional_purchase_data: null
                      address_verification: null
                      amount: 888888
                      amount_requested: 888888
                      application: APgPDQrLD52TYvqazjHJJchM
                      currency: USD
                      destination: null
                      externally_funded: 'FALSE'
                      failure_code: null
                      failure_message: null
                      fee: 0
                      idempotency_id: null
                      merchant: MUcvYR7tboSRejbVzHJSjXct
                      merchant_identity: ID4sanuCPqjmkmP4Q3Shkvww
                      messages: []
                      operation_key: null
                      parent_transfer: null
                      parent_transfer_trace_id: null
                      raw: null
                      ready_to_settle_at: '2023-11-24T13:04:33.75Z'
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: null
                      split_transfers: []
                      state: SUCCEEDED
                      statement_descriptor: null
                      subtype: PLATFORM_CREDIT
                      tags: {}
                      tip_amount: null
                      trace_id: 89fb3e71-3f8b-4a39-ae4a-4ac021580c84
                      type: DISPUTE
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRv7QRfEZ6UPqkfJjkV4UJdW
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID4sanuCPqjmkmP4Q3Shkvww
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRv7QRfEZ6UPqkfJjkV4UJdW/payment_instruments
                        disputed_transfer:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRv7QRfEZ6UPqkfJjkV4UJdW/disputed_transfer
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                    - id: TR6354QZvL8DVZ5QTeKFhKEB
                      created_at: '2023-11-24T13:04:33.22Z'
                      updated_at: '2024-12-18T05:22:09.39Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      additional_purchase_data: null
                      address_verification: null
                      amount: 888888
                      amount_requested: 888888
                      application: APgPDQrLD52TYvqazjHJJchM
                      currency: USD
                      destination: PIdrjH4c7CceuhjnmjjVxRwx
                      externally_funded: 'FALSE'
                      failure_code: null
                      failure_message: null
                      fee: 0
                      idempotency_id: null
                      merchant: MUcvYR7tboSRejbVzHJSjXct
                      merchant_identity: ID4sanuCPqjmkmP4Q3Shkvww
                      messages: []
                      operation_key: null
                      parent_transfer: null
                      parent_transfer_trace_id: null
                      raw: null
                      ready_to_settle_at: '2023-11-24T13:04:33.67Z'
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: null
                      split_transfers: []
                      state: SUCCEEDED
                      statement_descriptor: null
                      subtype: MERCHANT_DEBIT
                      tags: {}
                      tip_amount: null
                      trace_id: 00fc0100-419b-4469-bb7f-61c4b3b48fe9
                      type: DISPUTE
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TR6354QZvL8DVZ5QTeKFhKEB
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID4sanuCPqjmkmP4Q3Shkvww
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TR6354QZvL8DVZ5QTeKFhKEB/payment_instruments
                        disputed_transfer:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TR6354QZvL8DVZ5QTeKFhKEB/disputed_transfer
                        destination:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PIdrjH4c7CceuhjnmjjVxRwx
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/adjustment_transfers
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/disputes/DIkigGVrJPjDyAXejvvKXv9e/adjustment_transfers?after_cursor=TR6354QZvL8DVZ5QTeKFhKEB
                page:
                  limit: 100
                  next_cursor: TR6354QZvL8DVZ5QTeKFhKEB
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FileDownload:
      description: Example response
      content:
        application/octet-stream:
          schema:
            $ref: '#/components/schemas/FileDownload'
          examples:
            Download Begins:
              value: {}
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ComplianceForm:
      description: A single `Compliance Form` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/compliance_form'
          examples:
            Unsigned Compliance Form:
              value:
                id: cf_uwErNm23TKYNEiqrEdJK59
                created_at: '2025-07-07T18:05:01.96471Z'
                updated_at: '2025-07-07T18:22:37.436366Z'
                linked_to: MUwfZPNW3r4EqLMzwgr6txw4
                linked_type: MERCHANT
                application: APc9vhYcPsRuTSpKD9KpMtPe
                type: PCI_SAQ_A
                version: '2018.10'
                valid_from: '2025-07-07T18:22:37.43317Z'
                valid_until: '2026-07-07T18:22:37.433171Z'
                tags: {}
                pci_saq_a:
                  name: John Smith
                  signed_at: '2022-03-18T16:42:55Z'
                  user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
                  ip_address: 42.1.1.113
                  is_accepted: true
                  title: CTO
                due_at: '2025-10-05T18:05:01.94105Z'
                compliance_form_template: cft_n6BfvWBVe4iK1HC4n9qN2t
                files:
                  unsigned_file: FILE_uyntoF5Y4LDrMDJtA9ujd6
                  signed_file: null
                state: INCOMPLETE
            Signed Compliance Form:
              value:
                id: cf_uwErNm23TKYNEiqrEdJK59
                created_at: '2025-07-07T18:05:01.96471Z'
                updated_at: '2025-07-07T18:22:37.436366Z'
                linked_to: MUwfZPNW3r4EqLMzwgr6txw4
                linked_type: MERCHANT
                application: APc9vhYcPsRuTSpKD9KpMtPe
                type: PCI_SAQ_A
                version: '2018.10'
                valid_from: '2025-07-07T18:22:37.43317Z'
                valid_until: '2026-07-07T18:22:37.433171Z'
                tags: {}
                pci_saq_a:
                  name: John Smith
                  signed_at: '2022-03-18T16:42:55Z'
                  user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
                  ip_address: 42.1.1.113
                  is_accepted: true
                  title: CTO
                due_at: '2025-10-05T18:05:01.94105Z'
                compliance_form_template: cft_n6BfvWBVe4iK1HC4n9qN2t
                files:
                  unsigned_file: FILE_uyntoF5Y4LDrMDJtA9ujd6
                  signed_file: FILE_cmVwdHn1Mu6myvhwvLhotv
                state: COMPLETE
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    CompleteComplianceFormResponse:
      description: A single `Compliance Form` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/compliance_form'
          examples:
            Signed Compliance Form:
              value:
                id: cf_uwErNm23TKYNEiqrEdJK59
                created_at: '2025-07-07T18:05:01.96471Z'
                updated_at: '2025-07-07T18:22:37.436366Z'
                linked_to: MUwfZPNW3r4EqLMzwgr6txw4
                linked_type: MERCHANT
                application: APc9vhYcPsRuTSpKD9KpMtPe
                type: PCI_SAQ_A
                version: '2018.10'
                valid_from: '2025-07-07T18:22:37.43317Z'
                valid_until: '2026-07-07T18:22:37.433171Z'
                tags: {}
                pci_saq_a:
                  name: John Smith
                  signed_at: '2022-03-18T16:42:55Z'
                  user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
                  ip_address: 42.1.1.113
                  is_accepted: true
                  title: CTO
                due_at: '2025-10-05T18:05:01.94105Z'
                compliance_form_template: cft_n6BfvWBVe4iK1HC4n9qN2t
                files:
                  unsigned_file: FILE_uyntoF5Y4LDrMDJtA9ujd6
                  signed_file: FILE_cmVwdHn1Mu6myvhwvLhotv
                state: COMPLETE
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    InstrumentUpdateDownload:
      description: "The updated `Payment Instruments` will be returned in the following comma seperated format:\n\npayment\\_instrument\\_original,\t| payment\\_instrument_new, |result\n--------------------------- | ---------------------- | -----\nPIlkNdfZibF8a7Prd2teGB1 | PI3aQGaCM5nDMjqyTXcbUJzR| CARD\\_EXPIRATION_UPDATED\nPIJPXW0HZ9lpO1nb6sog5DiX  | PIdBHpy7BBSxd2z81VdKpVbT | CARD\\_NOT\\_FOUND\nPI0ovZAS9yfEtgDrZnMaiLvi   | PIhXS0jXNTmklyVk91EsohuZ | CONTACT\\_CARDHOLDER\nPInOrrKY3G1U33hGYTQJ8cIY |  | CLOSED\\_ACCOUNT\nPIlkAOt5kTVhuuxxbmOi9qn |  | INVALID\\_CARD\nPIiRLbbG4i5daypWNzIrq2xD   |  | NO\\_CHANGE\\_FOUND\nPIy5llZGt6VxlDqbcTgATqeH     | \t  | UNKNOWN"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FileDownload'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    PayoutProfile:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayoutProfile'
          examples:
            Payout Profile - Gross:
              value:
                id: POmhJeq1AsfwetG8LwhA4S9U
                created_at: '2022-10-25T16:54:08.20Z'
                updated_at: '2022-10-25T16:54:08.20Z'
                linked_id: MU6TXYpA37uM9H4GwitQr8E3
                linked_type: MERCHANT
                gross:
                  payouts:
                    frequency: DAILY
                    submission_delay_days: 1
                    payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                    rail: SAME_DAY_ACH
                  fees:
                    frequency: MONTHLY
                    day_of_month: 1
                    submission_delay_days: 3
                    payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                    rail: SAME_DAY_ACH
                tags: {}
                type: GROSS
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_profiles/POmhJeq1AsfwetG8LwhA4S9U
            Payout Profile - Net:
              value:
                id: POhiPobG6PoUteNVKpUauWVP
                created_at: '2022-10-25T07:20:34.37Z'
                updated_at: '2022-10-25T07:20:34.37Z'
                linked_id: MU6TXYpA37uM9H4GwitQr8E3
                linked_type: MERCHANT
                net:
                  frequency: CONTINUOUS
                  submission_delay_days: 1
                  payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                  rail: STANDARD
                tags: {}
                type: NET
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_profiles/POhiPobG6PoUteNVKpUauWVP
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    PayoutProfilesList:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayoutProfilesList'
          examples:
            List of Payout Profiles:
              value:
                _embedded:
                  payout_profiles:
                    - id: PO6UbajkQrbFd5nAvs57dwyn
                      created_at: '2022-10-24T21:38:23.72Z'
                      updated_at: '2022-10-24T21:38:23.72Z'
                      tags: {}
                      linked_id: MU6TXYpA37uM9H4GwitQr8E3
                      linked_type: MERCHANT
                      type: GROSS
                      gross:
                        payouts:
                          frequency: DAILY
                          submission_delay_days: 1
                          payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                          rail: SAME_DAY_ACH
                        fees:
                          frequency: MONTHLY
                          day_of_month: 1
                          submission_delay_days: 3
                          payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                          rail: NEXT_DAY_ACH
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/payout_profiles/PO6UbajkQrbFd5nAvs57dwyn
                    - id: POf5rP3c3XyRX7M6PuCvmgxf
                      created_at: '2022-10-20T19:43:18.02Z'
                      updated_at: '2022-10-20T19:43:18.02Z'
                      tags: {}
                      linked_id: MUfbbKm7vRmBX2bP92pKw9zZ
                      linked_type: MERCHANT
                      type: CUSTOM
                      custom: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/payout_profiles
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_profiles?after_cursor=POf5rP3c3XyRX7M6PuCvmgxf
                page:
                  limit: 100
                  next_cursor: POf5rP3c3XyRX7M6PuCvmgxf
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ComplianceFormList:
      description: List of `Compliance Form` objects.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ComplianceFormList'
          examples:
            List of Compliance Forms:
              value:
                _embedded:
                  compliance_forms:
                    - id: cf_uwErNm23TKYNEiqrEdJK59
                      created_at: '2025-07-07T18:05:01.96471Z'
                      updated_at: '2025-07-07T18:22:37.436366Z'
                      linked_to: MUwfZPNW3r4EqLMzwgr6txw4
                      linked_type: MERCHANT
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      type: PCI_SAQ_A
                      version: '2018.10'
                      valid_from: '2025-07-07T18:22:37.43317Z'
                      valid_until: '2026-07-07T18:22:37.433171Z'
                      tags: {}
                      pci_saq_a:
                        name: John Smith
                        signed_at: '2022-03-18T16:42:55Z'
                        user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
                        ip_address: 42.1.1.113
                        is_accepted: true
                        title: CTO
                      due_at: '2025-10-05T18:05:01.94105Z'
                      compliance_form_template: cft_n6BfvWBVe4iK1HC4n9qN2t
                      files:
                        unsigned_file: FILE_uyntoF5Y4LDrMDJtA9ujd6
                        signed_file: null
                      state: INCOMPLETE
                page:
                  next_cursor: null
                  limit: 10
    SettlementEntry:
      description: >-
        The `Settlement Entry` resource that represents the item in a
        settlement.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SettlementEntry'
          examples:
            Settlement Entry:
              value:
                id: SEivAwLLW6c62Nbvvj7TcDAN
                created_at: '2024-02-21T12:35:02.16Z'
                updated_at: '2024-02-21T12:35:02.16Z'
                amount: 100
                currency: USD
                entity_id: TRm9ppvqX43CbwmNzhckf2gb
                entity_details: {}
                entity_type: TRANSFER
                ready_to_settle_at: '2024-02-22T12:35:02.16Z'
                subtype: DEBIT
                should_fund: true
                _links: {}
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    SettlementEntriesList:
      description: 'List of `Settlement Entries` '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SettlementEntriesList'
          examples:
            Settlement Entries:
              value:
                _embedded:
                  settlement_entries:
                    - id: SETjqMfu55krwWBEKPLgSUV
                      created_at: '2024-12-04T08:52:01.53Z'
                      updated_at: '2024-12-04T08:52:01.53Z'
                      amount: 3
                      currency: USD
                      entity_details:
                        fee_category: PROCESSOR
                      entity_id: TRjWyNpY8KxJYBnqzTHoatze
                      entity_type: TRANSFER
                      parent_entity_id: TRnErBfrHLgdAi3BqAkWLN27
                      parent_entity_type: TRANSFER
                      ready_to_settle_at: '2024-12-05T08:52:00.81Z'
                      should_fund: true
                      subtype: FEE
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/STRQWumUFMWzRAuGL91BUtg/entries/SETjqMfu55krwWBEKPLgSUV
                        entries:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlement_engine/settlement/STRQWumUFMWzRAuGL91BUtg
                    - id: SESJcPgWbbYPZgnZUXFcRQJ
                      created_at: '2024-12-04T08:52:01.39Z'
                      updated_at: '2024-12-04T08:52:01.39Z'
                      amount: 30
                      currency: USD
                      entity_details:
                        fee_category: PROCESSOR
                      entity_id: TRbkjYx4nJLRAJpRjib3wsg1
                      entity_type: TRANSFER
                      parent_entity_id: TRnErBfrHLgdAi3BqAkWLN27
                      parent_entity_type: TRANSFER
                      ready_to_settle_at: '2024-12-05T08:52:00.81Z'
                      should_fund: true
                      subtype: FEE
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/STRQWumUFMWzRAuGL91BUtg/entries/SESJcPgWbbYPZgnZUXFcRQJ
                        entries:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlement_engine/settlement/STRQWumUFMWzRAuGL91BUtg
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries?after_cursor=SES3mw1tex35wqhh7fUQTPv
                page:
                  limit: 100
                  next_cursor: SES3mw1tex35wqhh7fUQTPv
    SplitTransfer:
      description: The `split_transfer` resource that was created from a split transacion.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SplitTransfer'
          examples:
            Split Transfer:
              value:
                id: split_transfer_duVsX6CRTjZah9eKWCKRak
                created_at: '2024-12-20T08:42:50.21Z'
                updated_at: '2024-12-20T08:42:50.21Z'
                amount: 400
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                fee: 100
                fee_profile_id: FPmtT4MYmiAs1qjLjneQmk4d
                identity_id: IDjvxGeXBLKH1V9YnWm1CS4n
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                parent_transfer_id: TRduovg23noL72QBjpDNiiK8
                ready_to_settle_at: '2024-12-23T08:43:03.05Z'
                tags: {}
                type: DEBIT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/split_transfers/split_transfer_duVsX6CRTjZah9eKWCKRak
            Split Transfer - Refund:
              value:
                id: split_transfer_duVsX6CRTjZah9eKWCKRak
                created_at: '2024-12-20T08:42:50.21Z'
                updated_at: '2024-12-20T08:42:50.21Z'
                amount: 400
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                fee: 100
                fee_profile_id: FPmtT4MYmiAs1qjLjneQmk4d
                identity_id: IDjvxGeXBLKH1V9YnWm1CS4n
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                parent_transfer_id: TRduovg23noL72QBjpDNiiK8
                ready_to_settle_at: '2024-12-23T08:43:03.05Z'
                tags: {}
                type: DEBIT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/split_transfers/split_transfer_duVsX6CRTjZah9eKWCKRak
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    SplitTransfersList:
      description: List of `split_transfers` created for a split `Transfer`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SplitTransfersList'
          examples:
            List of Split Transfers:
              value:
                _embedded:
                  split_transfers:
                    - id: split_transfer_DQrLD52TYvqazjHJJchM
                      created_at: '2022-10-11T03:25:04.79Z'
                      updated_at: '2022-10-11T03:25:04.79Z'
                      amount: 600
                      application_id: APgPDQrLD52TYvqazjHJJchM
                      currency: USD
                      identity_id: IDxxx"
                      merchant_id: MUxxxx1
                      parent_transfer_id: TRvQN3v5mhA2Ttc78hzjLV3j
                      ready_to_settle_at: '2022-10-11T03:25:05.32Z'
                      type: DEBIT
                      fee: null
                    - id: split_transfer_4MdY6eagpEqhtTaP8EBCR
                      created_at: '2022-10-11T03:25:04.79Z'
                      updated_at: '2022-10-11T03:25:04.79Z'
                      amount: 300
                      application_id: APgPDQrLD52TYvqazjHJJchM
                      currency: USD
                      identity_id: IDxxx"
                      merchant_id: MUxxxx1
                      parent_transfer_id: TRvQN3v5mhA2Ttc78hzjLV3j
                      ready_to_settle_at: '2022-10-11T03:25:05.32Z'
                      type: DEBIT
                      fee: null
                    - id: split_transfer_4MdY6eagpEqhtTaP8EBCR
                      created_at: '2022-10-11T03:25:04.79Z'
                      updated_at: '2022-10-11T03:25:04.79Z'
                      amount: 100
                      application_id: APgPDQrLD52TYvqazjHJJchM
                      currency: USD
                      identity_id: IDxxx"
                      merchant_id: MUxxxx1
                      parent_transfer_id: TRvQN3v5mhA2Ttc78hzjLV3j
                      ready_to_settle_at: '2022-10-11T03:25:05.32Z'
                      type: DEBIT
                      fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/split_transfers?parent_transfer_id=TRvQN3v5mhA2Ttc78hzjLV3j
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers?limit=3&after_cursor=split_transfer_xxx
                page:
                  limit: 3
                  next_cursor: split_transfer_xxx
    SubscriptionBalanceEntryResponse:
      description: A single `Subscription Balance Entry` object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionBalanceEntry'
          examples:
            Subscription Balance Entry:
              value:
                id: subscription_balance_entry_9Hom3R92btyMXKqh4JFyEw
                type: CREDIT
                subscription_id: subscription_abcxxxsadasdasd
                amount: 1000
                currency: USD
                description: Credit because I accidentally overcharged this subscription
                created_at: '2024-11-01T01:01:30'
                updated_at: '2024-11-01T01:01:30'
                tags:
                  internal_code: 1234E
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    SettlementQueueEntry:
      description: A single `Settlement Queue Entry` object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SettlementQueueEntry'
          examples:
            Settlement Queue Entry:
              value:
                id: settlement_queue_entry_3cNtvPQKg7r7grojhRNeGZ
                created_at: '2024-09-03T12:07:19.93Z'
                updated_at: '2024-09-03T12:07:19.93Z'
                application_id: APqVS885ihR1aipjfz6AxDs8
                entity_id: TRu2QArmUeRYfcZNZq6aSNwP
                entity_type: FEE
                merchant_id: MUhbEyQ1h2CZFqwYVVkxeXpX
                platform_id: PLvqJ9L76HBJKCetEpzd5fJq
                ready_to_settle_after: '2024-09-09T12:07:19.36Z'
                state: PENDING
                _links:
                  self:
                    href: >-
                      https://finix.qa-payments-api.com/settlement_engine/settlement_queue_entries/settlement_queue_entry_3cNtvPQKg7r7grojhRNeGZ
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    SettlementQueueEntries:
      description: List of `Settlement Queue Entry` objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SettlementQueueEntries'
          examples:
            List of Settlement Queue Entries:
              value:
                _embedded:
                  settlement_queue_entries:
                    - id: settlement_queue_entry_3cNtvPQKg7r7grojhRNeGZ
                      created_at: '2024-09-03T12:07:19.93Z'
                      updated_at: '2024-09-03T12:07:19.93Z'
                      application_id: APqVS885ihR1aipjfz6AxDs8
                      entity_id: TRu2QArmUeRYfcZNZq6aSNwP
                      entity_type: FEE
                      merchant_id: MUhbEyQ1h2CZFqwYVVkxeXpX
                      platform_id: PLvqJ9L76HBJKCetEpzd5fJq
                      ready_to_settle_after: '2024-09-09T12:07:19.36Z'
                      state: PENDING
                      _links:
                        self:
                          href: >-
                            https://finix.qa-payments-api.com/settlement_engine/settlement_queue_entries/settlement_queue_entry_3cNtvPQKg7r7grojhRNeGZ
                _links:
                  self:
                    href: >-
                      https://finix.qa-payments-api.com/settlement_engine/settlement_queue_entries?state=PENDING
                  next:
                    href: >-
                      https://finix.qa-payments-api.com/settlement_engine/settlement_queue_entries?state=PENDING&after_cursor=settlement_queue_entry_ny9JVgNH6j2hegaXkpuaHf
                page:
                  limit: 100
                  next_cursor: settlement_queue_entry_ny9JVgNH6j2hegaXkpuaHf
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    UpdateSubscriptionPlanResponse:
      description: A single `Subscription Plan` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionPlan'
          examples:
            Update Subscription Plan:
              value:
                id: subscription_plan_ciLn19pSKDTFoehtH7ETg
                created_at: '2025-01-01T09:13:18.70Z'
                updated_at: '2025-01-02T06:01:31.41Z'
                linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                linked_type: MERCHANT
                billing_interval: MONTHLY
                nickname: API portal - Basic plan
                plan_name: API portal - Basic
                description: A starter plan with minimal features
                amount: 19900
                currency: USD
                billing_defaults:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                trial_defaults: null
                state: ACTIVE
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg
            Archive Subscription Plan:
              value:
                id: subscription_plan_ciMZKcqAJQyZBgJ1krzU5
                created_at: '2025-01-02T05:55:43.96Z'
                updated_at: '2025-01-02T06:35:40.60Z'
                linked_to: MU7noQ1wdgdAeAfymw2rfBMq
                linked_type: MERCHANT
                billing_interval: MONTHLY
                nickname: API portal - Basic plan
                plan_name: API portal - Basic
                description: A starter plan with minimal features
                amount: 19900
                currency: USD
                billing_defaults:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                trial_defaults:
                  interval_type: DAY
                  interval_count: 30
                state: INACTIVE
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciMZKcqAJQyZBgJ1krzU5
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    SubscriptionPlan:
      description: A single `Subscription Plan` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionPlan'
          examples:
            Subscription Plan:
              value:
                id: subscription_plan_ciLn19pSKDTFoehtH7ETg
                created_at: '2025-01-01T09:13:18.70Z'
                updated_at: '2025-01-01T09:13:18.70Z'
                amount: 19900
                billing_defaults:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                billing_interval: MONTHLY
                currency: USD
                description: A basic API portal account with the least features.
                linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                nickname: null
                plan_name: API portal - Basic
                state: ACTIVE
                tags: {}
                trial_defaults: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg
            Subscription Plan - With Trial Period:
              value:
                id: subscription_plan_ciMZKcqAJQyZBgJ1krzU5
                created_at: '2025-01-02T05:55:43.96Z'
                updated_at: '2025-01-02T05:55:43.96Z'
                amount: 19900
                billing_defaults:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                billing_interval: MONTHLY
                currency: USD
                description: A basic API portal account with the least features.
                linked_to: MU7noQ1wdgdAeAfymw2rfBMq
                nickname: null
                plan_name: API portal - Basic
                state: ACTIVE
                tags: {}
                trial_defaults:
                  interval_type: DAY
                  interval_count: 30
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciMZKcqAJQyZBgJ1krzU5
            Subscription Plan - With Discount Phase:
              value:
                id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                created_at: '2025-03-24T21:21:14.29Z'
                updated_at: '2025-03-24T21:21:14.29Z'
                linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                linked_type: MERCHANT
                billing_interval: MONTHLY
                nickname: null
                plan_name: API portal - Basic
                description: A basic API portal account with the least features.
                amount: 19900
                currency: USD
                billing_defaults:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                trial_defaults: null
                discount_phase_defaults: null
                state: ACTIVE
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    SubscriptionPlanList:
      description: A list of `Subscription Plans` objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionPlanList'
          examples:
            List of Subscription Plans:
              value:
                _embedded:
                  subscription_plans:
                    - id: subscription_plan_ciN148MyTuQwYZbG9F4v1
                      created_at: '2025-01-02T05:59:47.30Z'
                      updated_at: '2025-01-02T05:59:47.30Z'
                      amount: 19900
                      billing_defaults:
                        collection_method: BILL_AUTOMATICALLY
                        send_invoice: false
                        send_receipt: false
                      billing_interval: MONTHLY
                      currency: USD
                      description: A basic API portal account with the least features.
                      linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                      nickname: null
                      plan_name: API portal - Basic
                      state: ACTIVE
                      tags: {}
                      trial_defaults: null
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciN148MyTuQwYZbG9F4v1
                    - id: subscription_plan_ciN13T34mgeJSEEPSHGch
                      created_at: '2025-01-02T05:59:43.85Z'
                      updated_at: '2025-01-02T05:59:43.85Z'
                      amount: 19900
                      billing_defaults:
                        collection_method: BILL_AUTOMATICALLY
                        send_invoice: false
                        send_receipt: false
                      billing_interval: MONTHLY
                      currency: USD
                      description: A basic API portal account with the least features.
                      linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                      nickname: null
                      plan_name: API portal - Basic
                      state: ACTIVE
                      tags: {}
                      trial_defaults: null
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciN13T34mgeJSEEPSHGch
                    - id: subscription_plan_ciMZKcqAJQyZBgJ1krzU5
                      created_at: '2025-01-02T05:55:43.96Z'
                      updated_at: '2025-01-02T05:55:43.96Z'
                      amount: 19900
                      billing_defaults:
                        collection_method: BILL_AUTOMATICALLY
                        send_invoice: false
                        send_receipt: false
                      billing_interval: MONTHLY
                      currency: USD
                      description: A basic API portal account with the least features.
                      linked_to: MU7noQ1wdgdAeAfymw2rfBMq
                      nickname: null
                      plan_name: API portal - Basic
                      state: ACTIVE
                      tags: {}
                      trial_defaults:
                        interval_type: DAY
                        interval_count: 30
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciMZKcqAJQyZBgJ1krzU5
                    - id: subscription_plan_ciLn19pSKDTFoehtH7ETg
                      created_at: '2025-01-01T09:13:18.70Z'
                      updated_at: '2025-01-01T09:13:18.70Z'
                      amount: 19900
                      billing_defaults:
                        collection_method: BILL_AUTOMATICALLY
                        send_invoice: false
                        send_receipt: false
                      billing_interval: MONTHLY
                      currency: USD
                      description: A basic API portal account with the least features.
                      linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                      nickname: null
                      plan_name: API portal - Basic
                      state: ACTIVE
                      tags: {}
                      trial_defaults: null
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription_plans
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_plans?after_cursor=subscription_plan_ciLn19pSKDTFoehtH7ETg
                page:
                  limit: 100
                  next_cursor: subscription_plan_ciLn19pSKDTFoehtH7ETg
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    SubscriptionBalanceEntryList:
      description: List of `Subscription Balance Entry` objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionBalanceEntryList'
          examples:
            List of Subscription Balance Entries:
              value:
                _embedded:
                  subscription_balance_entries:
                    - id: subscription_balance_entry_9Hom3R92btyMXKqh4JFyEw
                      type: CREDIT
                      subscription_id: subscription_9Hom3R92btyMXKqh4JFyEw
                      amount: 1000
                      currency: USD
                      description: >-
                        Credit because I accidentally overcharged this
                        subscription
                      created_at: '2024-11-01T01:01:30'
                      updated_at: '2024-11-01T01:01:30'
                      tags: {}
                    - id: subscription_balance_entry_9Hom3R92btyMXKqh4JFyrea
                      type: CREDIT
                      subscription_id: subscription_9Hom3R92btyMXKqh4JFyEw
                      amount: 2000
                      currency: USD
                      description: I did it again
                      created_at: '2024-11-01T01:01:30'
                      updated_at: '2024-11-01T01:01:30'
                      tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.qa-payments-api.com/subscriptions/subscription_9Hom3R92btyMXKqh4JFyEw/subscription_balance_entries
                  next:
                    href: >-
                      https://finix.qa-payments-api.com/subscriptions/subscription_9Hom3R92btyMXKqh4JFyEw/subscription_balance_entries?after_cursor=subscription_balance_entry_9Hom3R92btyMXKqh4JFyrea
                page:
                  limit: 100
                  next_cursor: subscription_balance_entry_9Hom3R92btyMXKqh4JFyrea
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Receipt:
      description: A single `Receipt` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Receipt'
          examples:
            Receipt - Basic Details:
              value:
                id: receipt_cdGdu7mHL2DaEHHYf8PPg
                created_at: '2024-07-30T00:26:55.87Z'
                updated_at: '2024-07-30T00:26:55.87Z'
                amount: 22300
                currency: USD
                amount_breakdown: null
                send_receipt_to_buyer: true
                device_id: null
                entity_details:
                  id: TRraKDGt53y1XeTbeCkXYMkn
                  created_at: '2024-07-30T00:22:25.28Z'
                  type: TRANSFER
                type: BUYER
                items: []
                merchant_details:
                  id: MUeDVrf2ahuKc9Eg5TeZugvs
                  business_name: Dunder Mifflin
                  doing_business_as: Dunder Mifflin
                  business_address:
                    city: San Mateo
                    country: USA
                    line1: 741 Douglass St
                    line2: Apartment 8
                    postal_code: '94114'
                    region: CA
                payment_instrument_details:
                  id: PIe2YvpcjvoVJ6PzoRPBK137
                  type: PAYMENT_CARD
                  billing_address:
                    city: San Francisco
                    country: USA
                    line1: 900 Metro Center Blv
                    line2: null
                    postal_code: '94404'
                    region: CA
                  bin: '489514'
                  brand: VISA
                  card_type: UNKNOWN
                  last_four: '0006'
                  name: Amy White
                network_details: null
                requested_delivery_methods:
                  - type: EMAIL
                    destinations:
                      - johndoe@gmail.com
                  - type: SMS
                    destinations:
                      - '3346497818'
                  - type: PRINT
                    destinations:
                      - DV12343234
                receipt_url: https://receipt.sandbox-payments-checkout.com/TYPQp7
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/receipts/receipt_cdGdu7mHL2DaEHHYf8PPg
            Receipt - Additional Details:
              value:
                id: receipt_cdGdu7mHL2DaEHHYf8PPg
                created_at: '2024-07-30T00:26:55.87Z'
                updated_at: '2024-07-30T00:26:55.87Z'
                amount: 22300
                currency: USD
                amount_breakdown:
                  subtotal_amount: 20300
                  shipping_amount: 2000
                  estimated_tax_amount: null
                  additional_buyer_charges: null
                  discount_amount: null
                  tip_amount: null
                send_receipt_to_buyer: true
                device_id: null
                entity_details:
                  id: TRraKDGt53y1XeTbeCkXYMkn
                  created_at: '2024-07-30T00:22:25.28Z'
                  type: TRANSFER
                type: BUYER
                items:
                  - image_details:
                      primary_image_url: https://www.fineleather.com/leather-couch.jpg
                      alternative_image_urls: []
                    description: A fine-leather couch.
                    price_details:
                      sale_amount: 15000
                      currency: USD
                      price_type: REGULAR
                      regular_amount: 5300
                    name: Leather couch
                    quantity: '1'
                  - image_details:
                      primary_image_url: https://www.fineleather.com/end-table.jpg
                      alternative_image_urls:
                        - https://www.fineleather.com/end-table-alt1.jpg
                        - https://www.fineleather.com/end-table-alt2.jpg
                    description: A wooden end table.
                    price_details:
                      sale_amount: 5300
                      currency: USD
                      price_type: REGULAR
                      regular_amount: 5300
                    name: Antique end table
                    quantity: '1'
                additional_details:
                  - name: Invoice Number
                    value: '123456789'
                  - name: VIN
                    value: '44455556666'
                merchant_details:
                  id: MUeDVrf2ahuKc9Eg5TeZugvs
                  business_name: Dunder Mifflin
                  doing_business_as: Dunder Mifflin
                  business_address:
                    city: San Mateo
                    country: USA
                    line1: 741 Douglass St
                    line2: Apartment 8
                    postal_code: '94114'
                    region: CA
                payment_instrument_details:
                  id: PIe2YvpcjvoVJ6PzoRPBK137
                  type: PAYMENT_CARD
                  billing_address:
                    city: San Francisco
                    country: USA
                    line1: 900 Metro Center Blv
                    line2: null
                    postal_code: '94404'
                    region: CA
                  bin: '489514'
                  brand: VISA
                  card_type: UNKNOWN
                  last_four: '0006'
                  name: Amy White
                network_details: null
                requested_delivery_methods:
                  - type: EMAIL
                    destinations:
                      - johndoe@gmail.com
                  - type: SMS
                    destinations:
                      - '3346497818'
                  - type: PRINT
                    destinations:
                      - DV12343234
                receipt_url: https://receipt.sandbox-payments-checkout.com/TYPQp7
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/receipts/receipt_cdGdu7mHL2DaEHHYf8PPg
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ListDeliveryAttemptsResponse:
      description: List of `Delivery Attempt` objects.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeliveryAttemptList'
          examples:
            List of Delivery Attempts:
              value:
                _embedded:
                  delivery_attempts:
                    - id: delivery_attempt_cdGdueuAcxs62QBXzURdx
                      created_at: '2024-07-30T00:26:57.54Z'
                      updated_at: '2024-07-30T00:26:57.54Z'
                      destination: DV12343234
                      receipt_id: receipt_cdGdu7mHL2DaEHHYf8PPg
                      state: FAILED
                      type: PRINT
                    - id: delivery_attempt_cdGduaphbiUkMLjUPwUMu
                      created_at: '2024-07-30T00:26:56.58Z'
                      updated_at: '2024-07-30T00:26:56.58Z'
                      destination: '3346497818'
                      receipt_id: receipt_cdGdu7mHL2DaEHHYf8PPg
                      state: SUCCEEDED
                      type: SMS
                    - id: delivery_attempt_cdGdu8Jjep34tRvietyok
                      created_at: '2024-07-30T00:26:56.19Z'
                      updated_at: '2024-07-30T00:26:56.19Z'
                      destination: johndoe@gmail.com
                      receipt_id: receipt_cdGdu7mHL2DaEHHYf8PPg
                      state: SUCCEEDED
                      type: EMAIL
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/receipts/receipt_cdGdu7mHL2DaEHHYf8PPg/delivery_attempts
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/receipts/receipt_cdGdu7mHL2DaEHHYf8PPg/delivery_attempts?after_cursor=delivery_attempt_cdGdu8Jjep34tRvietyok
                page:
                  limit: 100
                  next_cursor: delivery_attempt_cdGdu8Jjep34tRvietyok
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FetchTransferAttemptResponse:
      description: A single `Transfer Attempt` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TransferAttempt'
          examples:
            Transfer Attempt - Checkout Form:
              value:
                id: transfer_attempt_ciADTi3MFTjJdrCuvoNZk
                created_at: '2024-12-27T06:08:45.23Z'
                updated_at: '2024-12-27T06:08:45.23Z'
                amount: 5418
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                buyer_details:
                  first_name: John
                  last_name: Smith
                  email: johnsmith@gmail.com
                  identity_id: IDkw7UhEWpBXpzSkwi3GtzeB
                  phone: null
                  billing_address: null
                  shipping_address:
                    city: San Francisco
                    country: USA
                    line1: 741 Douglass Street
                    line2: null
                    postal_code: '94114'
                    region: CA
                currency: USD
                entity_id: checkout_form_ciADaDNMFAHdyNbDPuByS
                entity_type: CHECKOUT_FORM
                failure_code: null
                failure_message: null
                merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                operation_key: SALE
                payment_frequency: ONE_TIME
                payment_instrument_id: PI7m5SAdXgkLYRDKmjiYfDgy
                receipt_requested_delivery_methods: []
                recipient_details: null
                recipient_merchant_id: null
                state: SUCCEEDED
                tags: {}
                transfer_id: TRRM1Gf9q8iXB22yZNviNPZ
                type: DEBIT
            Transfer Attempt - Payment Link:
              value:
                id: transfer_attempt_ciACBK59kDhfx2Mi4Vy81
                created_at: '2024-12-27T05:52:07.44Z'
                updated_at: '2024-12-27T05:52:07.44Z'
                amount: 200
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                buyer_details:
                  first_name: ''
                  last_name: ''
                  email: test@gmail.com
                  identity_id: IDew6Bkcj1AwEP2aWhjjfdqS
                  phone: null
                  billing_address: null
                  shipping_address:
                    city: null
                    country: USA
                    line1: null
                    line2: null
                    postal_code: null
                    region: null
                currency: USD
                entity_id: payment_link_ciACu5E9CqjqTmPq4k5WT
                entity_type: PAYMENT_LINK
                failure_code: null
                failure_message: null
                merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                operation_key: SALE
                payment_frequency: ONE_TIME
                payment_instrument_id: PI7AS61AmsnJQ5Y7sL7dM1Ux
                receipt_requested_delivery_methods:
                  - type: EMAIL
                    destinations:
                      - test@gmail.com
                recipient_details: null
                recipient_merchant_id: null
                state: SUCCEEDED
                tags: {}
                transfer_id: TRodANv8j3CVRUQz4sgZa8sK
                type: DEBIT
            Transfer Attempt - Payout Link:
              value:
                id: transfer_attempt_ciAFQyjswrHwctwuXPBRs
                created_at: '2024-12-27T06:34:21.75Z'
                updated_at: '2024-12-27T06:35:03.14Z'
                amount: 100000
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                buyer_details: null
                currency: USD
                entity_id: payout_link_ciAFzb3QvDyNUfZN6Hqwe
                entity_type: PAYOUT_LINK
                failure_code: null
                failure_message: null
                merchant_id: null
                operation_key: PUSH_TO_CARD
                payment_frequency: null
                payment_instrument_id: PIiYHJ6dDykz1fihySDWzxd4
                receipt_requested_delivery_methods: []
                recipient_details:
                  type: PERSONAL
                  business_name: null
                  doing_business_as: null
                  first_name: Bernie
                  last_name: Bingbob
                  email: null
                  phone: null
                  personal_address:
                    city: Portland
                    country: USA
                    line1: 783 Southeast 185th Avenue
                    line2: null
                    postal_code: '97233'
                    region: OR
                  business_address:
                    city: null
                    country: USA
                    line1: null
                    line2: null
                    postal_code: null
                    region: null
                recipient_merchant_id: MUt6kBb22rxUvWNxUf8XriB2
                state: SUCCEEDED
                tags: {}
                transfer_id: TRo9MsQ6Li9NYbYXuHrhY4kC
                type: CREDIT
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ListTransferAttemptsResponse:
      description: List of `Transfer Attempt` objects.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TransferAttemptList'
          examples:
            List All Transfer Attempts:
              value:
                _embedded:
                  transfer_attempts:
                    - id: transfer_attempt_cn8WhBvjSvNKq5wH1zTFz
                      created_at: '2025-04-14T16:25:38.51Z'
                      updated_at: '2025-04-14T16:25:38.51Z'
                      amount: 7500
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      buyer_details:
                        first_name: john
                        last_name: ''
                        email: aaaaaine@gmail.com
                        identity_id: IDfuYw2q2vCrpFzoe2M7BQHN
                        phone: null
                        billing_address: null
                        shipping_address:
                          city: null
                          country: USA
                          line1: null
                          line2: null
                          postal_code: null
                          region: null
                      currency: USD
                      entity_id: payment_link_cn8W97dtBwbNCvzdEqtoB
                      entity_type: PAYMENT_LINK
                      failure_code: null
                      failure_message: null
                      merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                      operation_key: SALE
                      payment_frequency: ONE_TIME
                      payment_instrument_id: PIr2wHRTNiRFVeYZEJCLwsjG
                      receipt_requested_delivery_methods:
                        - type: EMAIL
                          destinations:
                            - aaaaaine@gmail.com
                      recipient_details: null
                      recipient_merchant_id: null
                      state: SUCCEEDED
                      tags: {}
                      transfer_id: TR488Xo7Mq7CF75447hjG3EF
                      type: DEBIT
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/transfer_attempts
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfer_attempts?after_cursor=transfer_attempt_ciACBK59kDhfx2Mi4Vy81
                page:
                  limit: 100
                  next_cursor: transfer_attempt_ciACBK59kDhfx2Mi4Vy81
            Filter Transfer Attempts for a Checkout Form:
              value:
                _embedded:
                  transfer_attempts:
                    - id: transfer_attempt_ciADTi3MFTjJdrCuvoNZk
                      created_at: '2024-12-27T06:08:45.23Z'
                      updated_at: '2024-12-27T06:08:45.23Z'
                      amount: 5418
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      buyer_details:
                        first_name: John
                        last_name: Smith
                        email: johnsmith@gmail.com
                        identity_id: IDkw7UhEWpBXpzSkwi3GtzeB
                        phone: null
                        billing_address: null
                        shipping_address:
                          city: San Francisco
                          country: USA
                          line1: 741 Douglass Street
                          line2: null
                          postal_code: '94114'
                          region: CA
                      currency: USD
                      entity_id: checkout_form_ciADaDNMFAHdyNbDPuByS
                      entity_type: CHECKOUT_FORM
                      failure_code: null
                      failure_message: null
                      merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                      operation_key: SALE
                      payment_frequency: ONE_TIME
                      payment_instrument_id: PI7m5SAdXgkLYRDKmjiYfDgy
                      recipient_details: null
                      recipient_merchant_id: null
                      state: SUCCEEDED
                      tags: {}
                      transfer_id: TRRM1Gf9q8iXB22yZNviNPZ
                      type: DEBIT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfer_attempts?entity_id=checkout_form_ciADaDNMFAHdyNbDPuByS
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfer_attempts?entity_id=checkout_form_ciADaDNMFAHdyNbDPuByS&after_cursor=transfer_attempt_ciADTi3MFTjJdrCuvoNZk
                page:
                  limit: 100
                  next_cursor: transfer_attempt_ciADTi3MFTjJdrCuvoNZk
            Filter Transfer Attempts for a Payment Link:
              value:
                _embedded:
                  transfer_attempts:
                    - id: transfer_attempt_ciAEDMSBFbKCfB6iso39o
                      created_at: '2024-12-27T06:18:48.88Z'
                      updated_at: '2024-12-27T06:18:48.88Z'
                      amount: 7500
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      buyer_details:
                        first_name: Jim
                        last_name: Northan
                        email: jimnorthan@gmail.com
                        identity_id: IDsHeeNHNn9uVmaFUQ9wqBRm
                        phone: null
                        billing_address: null
                        shipping_address:
                          city: null
                          country: USA
                          line1: null
                          line2: null
                          postal_code: null
                          region: null
                      currency: USD
                      entity_id: payment_link_ciAEjYy1Wf1ut1fZ27QKv
                      entity_type: PAYMENT_LINK
                      failure_code: null
                      failure_message: null
                      merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                      operation_key: SALE
                      payment_frequency: ONE_TIME
                      payment_instrument_id: PI2wttj9ASQ1Fx5rosQTQmq3
                      recipient_details: null
                      recipient_merchant_id: null
                      state: SUCCEEDED
                      tags: {}
                      transfer_id: TReDhzZatnupBBc21FZp5k4X
                      type: DEBIT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfer_attempts?entity_id=payment_link_ciAEjYy1Wf1ut1fZ27QKv
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfer_attempts?entity_id=payment_link_ciAEjYy1Wf1ut1fZ27QKv&after_cursor=transfer_attempt_ciAEDMSBFbKCfB6iso39o
                page:
                  limit: 100
                  next_cursor: transfer_attempt_ciAEDMSBFbKCfB6iso39o
            Filter Transfer Attempts for a Payout Link:
              value:
                _embedded:
                  transfer_attempts:
                    - id: transfer_attempt_ciAFQyjswrHwctwuXPBRs
                      created_at: '2024-12-27T06:34:21.75Z'
                      updated_at: '2024-12-27T06:35:03.14Z'
                      amount: 100000
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      buyer_details: null
                      currency: USD
                      entity_id: payout_link_ciAFzb3QvDyNUfZN6Hqwe
                      entity_type: PAYOUT_LINK
                      failure_code: null
                      failure_message: null
                      merchant_id: null
                      operation_key: PUSH_TO_CARD
                      payment_frequency: null
                      payment_instrument_id: PIiYHJ6dDykz1fihySDWzxd4
                      recipient_details:
                        type: PERSONAL
                        business_name: null
                        doing_business_as: null
                        first_name: Bernie
                        last_name: Bingbob
                        email: null
                        phone: null
                        personal_address:
                          city: Portland
                          country: USA
                          line1: 783 Southeast 185th Avenue
                          line2: null
                          postal_code: '97233'
                          region: OR
                        business_address:
                          city: null
                          country: USA
                          line1: null
                          line2: null
                          postal_code: null
                          region: null
                      recipient_merchant_id: MUt6kBb22rxUvWNxUf8XriB2
                      state: SUCCEEDED
                      tags: {}
                      transfer_id: TRo9MsQ6Li9NYbYXuHrhY4kC
                      type: CREDIT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfer_attempts?entity_id=payout_link_ciAFzb3QvDyNUfZN6Hqwe
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfer_attempts?entity_id=payout_link_ciAFzb3QvDyNUfZN6Hqwe&after_cursor=transfer_attempt_ciAFQyjswrHwctwuXPBRs
                page:
                  limit: 100
                  next_cursor: transfer_attempt_ciAFQyjswrHwctwuXPBRs
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ReviewQueueItemResponse:
      description: A single `Review Queue Item` object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ReviewQueueItem'
          examples:
            Review Queue Item:
              value:
                id: RKf8WeNhCKbjPv5Kc8ehc19R
                created_at: '2024-12-29T07:00:07.72Z'
                updated_at: '2024-12-29T08:00:23.61Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                completed_at: '2024-12-29T08:00:23.60Z'
                entity_id: STokmZACWzh97EN2vJCtSazH
                entity_type: SETTLEMENT_V2
                outcome: ACCEPTED
                outcome_reason: []
                processor_type: DUMMY_V1
                review_type: CREATED
                reviewed_by: USqBL7AUVKc4bsaPo6GwRkVr
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/review_queue/RKf8WeNhCKbjPv5Kc8ehc19R
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  settlement:
                    href: >-
                      https://finix.sandbox-payments-api.com/settlements/STokmZACWzh97EN2vJCtSazH
                  review_by:
                    href: >-
                      https://finix.sandbox-payments-api.com/users/USqBL7AUVKc4bsaPo6GwRkVr
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ReviewQueueItemsResponse:
      description: List of `Review Queue Item` objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ReviewQueueItems'
          examples:
            List of Review Queue Items:
              value:
                _embedded:
                  review_queue_items:
                    - id: RKePGrTPUtDuKyvydsWYinY2
                      created_at: '2025-01-27T07:15:58.07Z'
                      updated_at: '2025-01-27T08:00:17.14Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      completed_at: '2025-01-27T08:00:17.12Z'
                      entity_id: STcst8iT3NxovYiqwnTxFmUE
                      entity_type: SETTLEMENT_V2
                      outcome: ACCEPTED
                      outcome_reason: []
                      processor_type: DUMMY_V1
                      review_type: CREATED
                      reviewed_by: USqBL7AUVKc4bsaPo6GwRkVr
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/review_queue/RKePGrTPUtDuKyvydsWYinY2
                        settlement:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STcst8iT3NxovYiqwnTxFmUE
                        review_by:
                          href: >-
                            https://finix.sandbox-payments-api.com/users/USqBL7AUVKc4bsaPo6GwRkVr
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                    - id: RKf8WeNhCKbjPv5Kc8ehc19R
                      created_at: '2024-12-29T07:00:07.72Z'
                      updated_at: '2024-12-29T08:00:23.61Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      completed_at: '2024-12-29T08:00:23.60Z'
                      entity_id: STokmZACWzh97EN2vJCtSazH
                      entity_type: SETTLEMENT_V2
                      outcome: ACCEPTED
                      outcome_reason: []
                      processor_type: DUMMY_V1
                      review_type: CREATED
                      reviewed_by: USqBL7AUVKc4bsaPo6GwRkVr
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/review_queue/RKf8WeNhCKbjPv5Kc8ehc19R
                        settlement:
                          href: >-
                            https://finix.sandbox-payments-api.com/settlements/STokmZACWzh97EN2vJCtSazH
                        review_by:
                          href: >-
                            https://finix.sandbox-payments-api.com/users/USqBL7AUVKc4bsaPo6GwRkVr
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/review_queue
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/review_queue?after_cursor=RKiYM5rzYBXgryHL3vjEXXcV
                page:
                  limit: 100
                  next_cursor: RKiYM5rzYBXgryHL3vjEXXcV
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listApplications:
      description: List of `Application` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  Application:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/application'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Applications:
              value:
                _embedded:
                  applications:
                    - id: APc9vhYcPsRuTSpKD9KpMtPe
                      created_at: '2024-11-14T22:25:06.54Z'
                      updated_at: '2025-02-18T23:40:49.31Z'
                      account_updater_enabled: false
                      card_cvv_required: false
                      card_expiration_date_required: true
                      creating_transfer_from_report_enabled: false
                      disbursements_ach_pull_enabled: true
                      disbursements_ach_push_enabled: true
                      disbursements_card_pull_enabled: true
                      disbursements_card_push_enabled: true
                      disbursements_same_day_ach_pull_enabled: false
                      disbursements_same_day_ach_push_enabled: false
                      enabled: true
                      fee_ready_to_settle_upon: PROCESSOR_WINDOW
                      instant_payouts_card_push_enabled: false
                      name: Finix Documentation 2025
                      network_token_enabled: false
                      owner: IDjvxGeXBLKH1V9YnWm1CS4n
                      processing_enabled: true
                      ready_to_settle_upon: PROCESSOR_WINDOW
                      ready_to_settle_upon_delay_alignment: NONE
                      refunds_disabled: false
                      settlement_approval_enabled: false
                      settlement_enabled: true
                      settlement_funding_identifier: UNSET
                      settlement_queue_mode: UNSET
                      tags: {}
                      unreferenced_refund_manual_entry_enabled: false
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        processors:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/processors
                        users:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/users
                        owner_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                        transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/transfers
                        disputes:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/disputes
                        authorizations:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/authorizations
                        settlements:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/settlements
                        merchants:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/merchants
                        identities:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/identities
                        webhooks:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/webhooks
                        reversals:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/reversals
                        tokens:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/tokens
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/payment_instruments
                        application_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/application_profile
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/applications
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications?after_cursor=APc9vhYcPsRuTSpKD9KpMtPe
                page:
                  limit: 100
                  next_cursor: APc9vhYcPsRuTSpKD9KpMtPe
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    401Unauthorized:
      description: >-
        Unauthorized. Authentication is required and has failed or has not been
        provided.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
    403Forbidden:
      description: >-
        Forbidden. The client is authenticated but does not have permission to
        access the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
    404NotFound:
      description: Not Found. The requested resource could not be found on the server.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
    406NotAcceptable:
      description: >-
        Not Acceptable. The server could accept the submitted request. Confirm
        how the request was formatted and submitted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
    createApplication:
      description: A single Application
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/application'
          examples:
            Application:
              value:
                id: APc9vhYcPsRuTSpKD9KpMtPe
                created_at: '2024-11-14T22:25:06.54Z'
                updated_at: '2025-02-18T23:40:49.31Z'
                account_updater_enabled: false
                card_cvv_required: false
                card_expiration_date_required: true
                creating_transfer_from_report_enabled: false
                disbursements_ach_pull_enabled: true
                disbursements_ach_push_enabled: true
                disbursements_card_pull_enabled: true
                disbursements_card_push_enabled: true
                disbursements_same_day_ach_pull_enabled: false
                disbursements_same_day_ach_push_enabled: false
                enabled: true
                fee_ready_to_settle_upon: PROCESSOR_WINDOW
                instant_payouts_card_push_enabled: false
                name: Finix Documentation 2025
                network_token_enabled: false
                owner: IDjvxGeXBLKH1V9YnWm1CS4n
                processing_enabled: true
                ready_to_settle_upon: PROCESSOR_WINDOW
                ready_to_settle_upon_delay_alignment: NONE
                refunds_disabled: false
                settlement_approval_enabled: false
                settlement_enabled: true
                settlement_funding_identifier: UNSET
                settlement_queue_mode: UNSET
                tags: {}
                unreferenced_refund_manual_entry_enabled: false
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  processors:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/processors
                  users:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/users
                  owner_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/transfers
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/disputes
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/authorizations
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/settlements
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/merchants
                  identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/identities
                  webhooks:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/webhooks
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/reversals
                  tokens:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/tokens
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/payment_instruments
                  application_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/application_profile
            Application - Enable Account Updater:
              value:
                id: APc9vhYcPsRuTSpKD9KpMtPe
                created_at: '2024-11-14T22:25:06.54Z'
                updated_at: '2025-02-18T23:40:49.31Z'
                account_updater_enabled: false
                card_cvv_required: false
                card_expiration_date_required: true
                creating_transfer_from_report_enabled: false
                disbursements_ach_pull_enabled: true
                disbursements_ach_push_enabled: true
                disbursements_card_pull_enabled: true
                disbursements_card_push_enabled: true
                disbursements_same_day_ach_pull_enabled: false
                disbursements_same_day_ach_push_enabled: false
                enabled: true
                fee_ready_to_settle_upon: PROCESSOR_WINDOW
                instant_payouts_card_push_enabled: false
                name: Finix Documentation 2025
                network_token_enabled: false
                owner: IDjvxGeXBLKH1V9YnWm1CS4n
                processing_enabled: true
                ready_to_settle_upon: PROCESSOR_WINDOW
                ready_to_settle_upon_delay_alignment: NONE
                refunds_disabled: true
                settlement_approval_enabled: false
                settlement_enabled: true
                settlement_funding_identifier: UNSET
                settlement_queue_mode: UNSET
                tags: {}
                unreferenced_refund_manual_entry_enabled: false
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  processors:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/processors
                  users:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/users
                  owner_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/transfers
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/disputes
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/authorizations
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/settlements
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/merchants
                  identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/identities
                  webhooks:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/webhooks
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/reversals
                  tokens:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/tokens
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/payment_instruments
                  application_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/application_profile
            Application - Enable Network Tokens:
              value:
                id: APc9vhYcPsRuTSpKD9KpMtPe
                created_at: '2024-11-14T22:25:06.54Z'
                updated_at: '2025-02-18T23:40:49.31Z'
                account_updater_enabled: true
                card_cvv_required: false
                card_expiration_date_required: true
                creating_transfer_from_report_enabled: false
                disbursements_ach_pull_enabled: true
                disbursements_ach_push_enabled: true
                disbursements_card_pull_enabled: true
                disbursements_card_push_enabled: true
                disbursements_same_day_ach_pull_enabled: false
                disbursements_same_day_ach_push_enabled: false
                enabled: true
                fee_ready_to_settle_upon: PROCESSOR_WINDOW
                instant_payouts_card_push_enabled: false
                name: Finix Documentation 2025
                network_token_enabled: false
                owner: IDjvxGeXBLKH1V9YnWm1CS4n
                processing_enabled: true
                ready_to_settle_upon: PROCESSOR_WINDOW
                ready_to_settle_upon_delay_alignment: NONE
                refunds_disabled: false
                settlement_approval_enabled: false
                settlement_enabled: true
                settlement_funding_identifier: UNSET
                settlement_queue_mode: UNSET
                tags: {}
                unreferenced_refund_manual_entry_enabled: false
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  processors:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/processors
                  users:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/users
                  owner_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/transfers
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/disputes
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/authorizations
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/settlements
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/merchants
                  identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/identities
                  webhooks:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/webhooks
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/reversals
                  tokens:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/tokens
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/payment_instruments
                  application_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/application_profile
            Application - Disable Refunds:
              value:
                id: APc9vhYcPsRuTSpKD9KpMtPe
                created_at: '2024-11-14T22:25:06.54Z'
                updated_at: '2025-02-18T23:40:49.31Z'
                account_updater_enabled: false
                card_cvv_required: false
                card_expiration_date_required: true
                creating_transfer_from_report_enabled: false
                disbursements_ach_pull_enabled: true
                disbursements_ach_push_enabled: true
                disbursements_card_pull_enabled: true
                disbursements_card_push_enabled: true
                disbursements_same_day_ach_pull_enabled: false
                disbursements_same_day_ach_push_enabled: false
                enabled: true
                fee_ready_to_settle_upon: PROCESSOR_WINDOW
                instant_payouts_card_push_enabled: false
                name: Finix Documentation 2025
                network_token_enabled: true
                owner: IDjvxGeXBLKH1V9YnWm1CS4n
                processing_enabled: true
                ready_to_settle_upon: PROCESSOR_WINDOW
                ready_to_settle_upon_delay_alignment: NONE
                refunds_disabled: false
                settlement_approval_enabled: false
                settlement_enabled: true
                settlement_funding_identifier: UNSET
                settlement_queue_mode: UNSET
                tags: {}
                unreferenced_refund_manual_entry_enabled: false
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  processors:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/processors
                  users:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/users
                  owner_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/transfers
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/disputes
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/authorizations
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/settlements
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/merchants
                  identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/identities
                  webhooks:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/webhooks
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/reversals
                  tokens:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/tokens
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/payment_instruments
                  application_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe/application_profile
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    400BadRequest:
      description: >-
        Bad Request. The server cannot process the request due to malformed
        syntax or invalid data.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
    listAuthorizations:
      description: List of Authorization objects
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                description: List of `Authroization` objects.
                properties:
                  authorizations:
                    type: array
                    minItems: 0
                    uniqueItems: true
                    description: '`Authorization` objects.'
                    items:
                      $ref: '#/components/schemas/authorization'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Authorizations:
              value:
                _embedded:
                  authorizations:
                    - id: AUoCse3evsJWctBbh6hSEsZj
                      created_at: '2022-10-10T06:14:57.84Z'
                      updated_at: '2022-10-10T06:14:58.28Z'
                      3ds_redirect_url: null
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      address_verification: null
                      amount: 150
                      amount_requested: 150
                      application: APeUbTUjvYb1CdPXvNcwW1wP
                      card_present_details:
                        emv_data: null
                        masked_account_number: null
                        name: null
                        brand: null
                        entry_mode: null
                        payment_type: NONE
                        approval_code: null
                      currency: USD
                      device: DVsEanpBtsAVvCHbNXkFaH6f
                      expires_at: '2022-10-17T06:14:57.84Z'
                      failure_code: null
                      failure_message: null
                      idempotency_id: null
                      is_void: false
                      merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                      messages:
                        - LaneID 1 does not exist.
                        - >-
                          Authorization AUoCse3evsJWctBbh6hSEsZj could not be
                          submitted. Cause: LaneID 1 does not exist.
                        - DECLINED
                      raw:
                        approved_amount: 0
                        convenience_fee_amount: 0
                        currency_code: None
                        is_approved: false
                        is_offline: false
                        payment_type: None
                        pin_verified: false
                        status_code: None
                        sub_total_amount: 0
                        tip_amount: 0
                        total_amount: 0
                        order_id: FNXhDjLCPDzR33zk8jjTicZv2
                        lane_id: 1
                        _errors:
                          - developer_message: "ERROR:POST error\r\nEXCEPTION: LaneID 1 does not exist.\r\n"
                            error_type: ''
                            exception_message: LaneID 1 does not exist.
                            exception_type_full_name: TriPos.Shared.Exceptions.PinPadNotFoundException
                            exception_type_short_name: PinPadNotFoundException
                            user_message: ''
                        _links: []
                        _processor:
                          logs:
                            - LaneID 1 does not exist.
                          processor_logs:
                            - LaneID 1 does not exist.
                          processor_request_failed: false
                          processor_request_was_approved: false
                          processor_response_code: Unknown
                        _type: authorizationResponse
                        _warnings: []
                      security_code_verification: null
                      source: PIg2q5tVAPcHpUpbJBNe4Vus
                      state: FAILED
                      tags:
                        order_number: chris123transfer
                      trace_id: FNXhDjLCPDzR33zk8jjTicZv2
                      transfer: null
                      void_state: UNATTEMPTED
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/authorizations/AUoCse3evsJWctBbh6hSEsZj
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                        device:
                          href: >-
                            https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
                    - id: AUuRnfhaBm84RhHyonkHAUrt
                      created_at: '2022-08-01T22:14:13.31Z'
                      updated_at: '2022-08-01T22:14:13.44Z'
                      3ds_redirect_url: null
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      address_verification: POSTAL_CODE_AND_STREET_MATCH
                      amount: 100
                      amount_requested: 100
                      application: AP3AB2itAWrrrPVS6spvrGYp
                      currency: USD
                      expires_at: '2022-08-08T22:14:13.31Z'
                      failure_code: null
                      failure_message: null
                      idempotency_id: null
                      is_void: false
                      merchant_identity: IDsArLxCm9QGbi2QfhaFrTED
                      messages: []
                      raw:
                        additional_large_number: 9223372036854776000
                        value: 100
                        order_id: e770db75-fbf6-4efb-afe7-57aedd7ac40d
                      security_code_verification: MATCHED
                      source: PIbDnouV59En1yKfYUNLTpG9
                      state: SUCCEEDED
                      tags: {}
                      trace_id: e770db75-fbf6-4efb-afe7-57aedd7ac40d
                      transfer: null
                      void_state: UNATTEMPTED
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/authorizations/AUuRnfhaBm84RhHyonkHAUrt
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDsArLxCm9QGbi2QfhaFrTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations?offset=633380&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 633397
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createAuthorization:
      description: Response schema to a request to create a single `Authorization` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/authorization'
          examples:
            Authorization - Minimal Fields:
              value:
                id: AUsJgTPyNKUKbkTk4mzq2aoM
                created_at: '2025-10-27T15:55:36.29Z'
                updated_at: '2025-10-27T15:55:36.29Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2025-11-03T15:55:36.29Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                ip_address_details: null
                is_void: false
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                supplemental_fee: null
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 0504c0cc-7665-4555-90c3-c460330acf2e
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUsJgTPyNKUKbkTk4mzq2aoM
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
            Authorization - All Fields:
              value:
                id: AUfqb6x5gz8bcC4dAFoyvYo8
                created_at: '2025-10-27T15:50:16.97Z'
                updated_at: '2025-10-27T15:50:16.97Z'
                3ds_redirect_url: null
                additional_buyer_charges:
                  convenience_amount: 10
                  surcharge_amount: 0
                  rent_surcharge_amount: 0
                additional_healthcare_data:
                  clinic_amount: 50
                  dental_amount: 200
                  prescription_amount: 300
                  vision_amount: 300
                additional_purchase_data:
                  customer_reference_number: 321xyz
                  customs_duty_amount: 10
                  destination_country_code: null
                  destination_postal_code: null
                  discount_amount: 100
                  invoice_reference_number: null
                  order_date: null
                  sales_tax: null
                  sales_tax_finix_generated: 200
                  ship_from_postal_code: null
                  shipping_amount: 100
                  tax_exempt: false
                  item_data:
                    - cost_per_unit: 500
                      item_description: printing paper
                      item_discount_amount: 100
                      merchant_product_code: '1149611'
                      quantity: 1
                      amount_excluding_sales_tax: 400
                      amount_including_sales_tax: 500
                      unit_of_measure: BX
                      commodity_code: 175-62-20
                      sales_tax_amount: 100
                      sales_tax_rate: 0.25
                    - cost_per_unit: 500
                      item_description: printing ink
                      item_discount_amount: 0
                      merchant_product_code: '2149612'
                      quantity: 1
                      amount_excluding_sales_tax: 400
                      amount_including_sales_tax: 500
                      unit_of_measure: CTN
                      commodity_code: 207-72-54
                      sales_tax_amount: 100
                      sales_tax_rate: 0.25
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2025-11-03T15:50:16.97Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                ip_address_details: null
                is_void: false
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                supplemental_fee: null
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 92ef9b19-741a-4047-ac0a-b4e88b988743
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUfqb6x5gz8bcC4dAFoyvYo8
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
            Authorization - Canada:
              value:
                id: AUe7ArjVFfC8kM3QGzb8zCnL
                created_at: '2025-10-27T15:35:33.97Z'
                updated_at: '2025-10-27T15:35:33.97Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: CAD
                expires_at: '2025-11-03T15:35:33.97Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                ip_address_details: null
                is_void: false
                merchant: MUoG7LpUyPFT8XTrEFPvwvyJ
                merchant_identity: ID25DKjXGUcD6Lr6A4cUndYw
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                supplemental_fee: null
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: c6001ff3-ea14-4fa0-b8f6-4f1be090ad72
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUe7ArjVFfC8kM3QGzb8zCnL
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID25DKjXGUcD6Lr6A4cUndYw
            Authorization - 3D Secure:
              value:
                id: AUeUPCWmhsWP1TEPkNsVUnzE
                created_at: '2024-12-04T09:07:28.44Z'
                updated_at: '2024-12-04T09:07:28.44Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2024-12-11T09:07:28.44Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 42043356-8b9f-4dad-98ba-15a3706522c9
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUeUPCWmhsWP1TEPkNsVUnzE
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
            Authorization - Authorization with CVV:
              value:
                id: AU9sSkvsH9rVWSr7MB3jpL94
                created_at: '2024-12-04T09:15:10.14Z'
                updated_at: '2024-12-04T09:15:10.14Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2024-12-11T09:15:10.14Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                tags: {}
                trace_id: 516550d5-aa28-4990-bc29-6d01cd290ada
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AU9sSkvsH9rVWSr7MB3jpL94
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
            Authorization - Buyer Charges:
              value:
                id: AU9UpmG6zexPm3a5LFyVkmAC
                created_at: '2024-12-04T09:32:33.77Z'
                updated_at: '2024-12-04T09:32:33.77Z'
                3ds_redirect_url: null
                additional_buyer_charges:
                  convenience_amount: 150
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 5200
                amount_requested: 5200
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2024-12-11T09:32:33.77Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                tags:
                  test: sale
                trace_id: ddc494e6-2c44-4955-93dd-28c0ebddc562
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AU9UpmG6zexPm3a5LFyVkmAC
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
            Authorization - Card Present:
              value:
                id: AUarp7Pz21Low4u2Urw5Ub4W
                created_at: '2019-04-29T20:44:00.13Z'
                updated_at: '2024-08-19T10:26:05.00Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 150
                amount_requested: 150
                application: APeUbTUjvYb1CdPXvNcwW1wP
                card_present_details:
                  emv_data:
                    application_identifier: A0000001523010
                    application_label: DISCOVER
                    application_preferred_name: null
                    application_transaction_counter: '0005'
                    cryptogram: ARCQ F666F8891F870D33
                    issuer_code_table_index: null
                    pin_verified: false
                    tags: null
                  masked_account_number: '************0059'
                  name: Test Card 05
                  brand: DISCOVER
                  entry_mode: CHIP_ENTRY
                  payment_type: CREDIT
                  approval_code: '004839'
                currency: USD
                device: DVfKLD9GZtsjcJxLtc2yCcfd
                expires_at: '2019-05-06T20:44:00.13Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU4LYrniAvqVKUBqcATb7Y7p
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: null
                source: PImTHaz7XVPx4M7mhu9x8gkU
                state: SUCCEEDED
                tags:
                  TicketNumber: '45878'
                trace_id: FNX35FSuraeKKJr65wkGVFJni
                transfer: TRqQCAX7nYHUnkE5YPFTknqd
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  transfer:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd
                  device:
                    href: >-
                      https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
            Authorization - Fraud Detection:
              value:
                id: AUqgPbbLhAJQPse4QpHh82fS
                created_at: '2025-07-22T15:22:31.11Z'
                updated_at: '2025-07-22T15:22:31.11Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2025-07-29T15:22:31.11Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                supplemental_fee: null
                tags: {}
                trace_id: 54bf6765-c3a5-400d-a62c-1544c3b677b8
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUqgPbbLhAJQPse4QpHh82fS
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
            Authorization - Gaming:
              value:
                id: AUi5bprhjN5MryZDkq3ERiPP
                created_at: '2025-11-07T19:47:05.43Z'
                updated_at: '2025-11-07T19:47:05.43Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2025-11-14T19:47:05.43Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                ip_address_details: null
                is_void: false
                merchant: MUmKTKuetVV1MQ5Cq6rjWA5j
                merchant_identity: IDsuVDUYpUS2pzqQVsuUZzNH
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                supplemental_fee: null
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 9f3d9253-e5da-4303-b20f-4d0fe261e35d
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUi5bprhjN5MryZDkq3ERiPP
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDsuVDUYpUS2pzqQVsuUZzNH
            Authorization - HSA or FSA Card for Non-Healthcare MCC:
              value:
                id: AU2J7hDBvWSBEnis5BHGhBCR
                created_at: '2024-12-04T10:12:59.44Z'
                updated_at: '2024-12-04T10:12:59.44Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data:
                  clinic_amount: 50
                  dental_amount: 200
                  prescription_amount: 300
                  vision_amount: 300
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 950
                amount_requested: 950
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2024-12-11T10:12:59.44Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: f834fd36-6978-48e7-b0fc-a40cc208bdde
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AU2J7hDBvWSBEnis5BHGhBCR
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
            Authorization - Level 2 Processing:
              value:
                id: AUaPBSrWLtitRePdRCCPMHJe
                created_at: '2024-12-04T10:53:48.72Z'
                updated_at: '2024-12-04T10:55:04.88Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data:
                  customer_reference_number: 321xyz
                  customs_duty_amount: null
                  destination_country_code: null
                  destination_postal_code: null
                  discount_amount: null
                  invoice_reference_number: null
                  order_date: null
                  sales_tax: 200
                  sales_tax_finix_generated: null
                  ship_from_postal_code: null
                  shipping_amount: null
                  tax_exempt: false
                  item_data: []
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 1000
                amount_requested: 1000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2024-12-11T10:53:48.72Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 244a6dc2-f566-4b2a-867a-bbccaad98f4c
                transfer: TRtz9gWDwXk3pHveUvdQXugf
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUaPBSrWLtitRePdRCCPMHJe
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  transfer:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRtz9gWDwXk3pHveUvdQXugf
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
            Authorization - Level 3 Processing:
              value:
                id: AUheZrfSLJVgk3tGfJGDU3Xi
                created_at: '2024-12-04T09:56:37.56Z'
                updated_at: '2024-12-04T11:04:11.37Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data:
                  customer_reference_number: 321xyz
                  customs_duty_amount: 10
                  destination_country_code: null
                  destination_postal_code: null
                  discount_amount: 100
                  invoice_reference_number: null
                  order_date: null
                  sales_tax: null
                  sales_tax_finix_generated: 200
                  ship_from_postal_code: null
                  shipping_amount: 100
                  tax_exempt: false
                  item_data:
                    - cost_per_unit: 500
                      item_description: printing paper
                      item_discount_amount: 100
                      merchant_product_code: '1149611'
                      quantity: 1
                      amount_excluding_sales_tax: 400
                      amount_including_sales_tax: 500
                      unit_of_measure: BX
                      commodity_code: 175-62-20
                      sales_tax_amount: 100
                      sales_tax_rate: 0.25
                    - cost_per_unit: 500
                      item_description: printing ink
                      item_discount_amount: 0
                      merchant_product_code: '2149612'
                      quantity: 1
                      amount_excluding_sales_tax: 400
                      amount_including_sales_tax: 500
                      unit_of_measure: CTN
                      commodity_code: 207-72-54
                      sales_tax_amount: 100
                      sales_tax_rate: 0.25
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 1000
                amount_requested: 1000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2024-12-11T09:56:37.56Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: 2f4eb0e7-0f05-47a6-9dde-0b482c0b49b7
                transfer: TRoEQY7rcV8yg9ivXHXc6u1V
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUheZrfSLJVgk3tGfJGDU3Xi
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  transfer:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRoEQY7rcV8yg9ivXHXc6u1V
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
            Authorization - Partial Authorization:
              value:
                id: AUbrf1SsNwSoLyYWS6YNqAhW
                created_at: '2024-12-04T09:59:21.36Z'
                updated_at: '2024-12-04T09:59:21.36Z'
                3ds_redirect_url: null
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                expires_at: '2024-12-11T09:59:21.36Z'
                failure_code: null
                failure_message: null
                idempotency_id: null
                is_void: false
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                merchant_identity: IDjvxGeXBLKH1V9YnWm1CS4n
                messages: []
                raw: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                state: SUCCEEDED
                tags:
                  order_number: 21DFASJSAKAS
                trace_id: f62c19b0-6040-4dfd-9f9e-73835e544cdd
                transfer: null
                void_state: UNATTEMPTED
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/authorizations/AUbrf1SsNwSoLyYWS6YNqAhW
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    402PaymentRequired:
      description: Payment Required.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
    422InvalidField:
      description: Invalid Field. The provided value for a field is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
    listDevices:
      description: List of `Device` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  devices:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/device'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Devices:
              value:
                _embedded:
                  devices:
                    - id: DVsEanpBtsAVvCHbNXkFaH6f
                      created_at: '2023-04-13T01:20:52.209507Z'
                      updated_at: '2023-04-13T01:20:52.209507Z'
                      configuration_details:
                        allow_debit: true
                        check_for_duplicate_transactions: true
                        prompt_amount_confirmation: true
                        prompt_manual_entry: false
                        prompt_for_signature: ALWAYS
                        signature_threshold_amount: 0
                        bypass_device_on_capture: true
                        prompt_receipt_confirmation: null
                        display_tip_on_receipt: null
                        prompt_tip_on_screen: null
                        allow_standalone_authorizations: null
                        allow_standalone_sales: null
                        allow_standalone_refunds: null
                        tipping_details: null
                        idle_message: null
                        idle_image_file_id: null
                        automatic_receipt_delivery_methods: null
                        available_receipt_methods: null
                      description: setup testing
                      enabled: true
                      idle_message: null
                      merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                      model: MX915
                      payment_app_version: 3.2.1
                      name: pytest_device01
                      serial_number: null
                      tags:
                        test_key_101: test_val_101
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
                        merchant:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                        transfers:
                          href: https://finix.sandbox-payments-api.com/transfers
                        authorizations:
                          href: >-
                            https://finix.sandbox-payments-api.com/authorizations
                _links:
                  self:
                    href: http://finix.sandbox-payments-api.com/devices
                page:
                  limit: 100
                  next_cursor: DVsEanpBtsAVvCHbNXkFaH6f
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listDisbursementRules:
      description: List of `Disbursement Rule` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  disbursement_rules:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/disbursement_rule'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Disbursement Rules:
              value:
                _embedded:
                  disbursement_rules:
                    - id: disbursement_rule_fxhfAsS68Vf4zjoVXDTQYL
                      created_at: '2024-11-14T22:26:14.88Z'
                      updated_at: '2024-11-14T22:27:07.67Z'
                      application_details:
                        ach_rules:
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: DAILY
                            start_time: 11
                            time_zone: America/New_York
                            rules:
                              - volume_limit: 1000001
                                count_limit: 2001
                                enabled: true
                                day: ALL
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: MONTHLY
                            start_time: 11
                            time_zone: America/New_York
                            start_date: 15
                            rules:
                              - volume_limit: 1000002
                                count_limit: 2002
                                enabled: true
                          - type: GLOBAL
                            currency: USD
                            max_transaction_amount: 5000001
                        card_rules:
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: DAILY
                            start_time: 11
                            time_zone: America/New_York
                            rules:
                              - volume_limit: 1000003
                                count_limit: 2003
                                enabled: true
                                day: ALL
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: MONTHLY
                            start_time: 11
                            time_zone: America/New_York
                            start_date: 15
                            rules:
                              - volume_limit: 1000004
                                count_limit: 2004
                                enabled: true
                          - type: GLOBAL
                            currency: USD
                            max_transaction_amount: 5000002
                        balance_adjustment_rules:
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: DAILY
                            start_time: 1
                            time_zone: America/New_York
                            rules:
                              - volume_limit: 10000000
                                count_limit: 10000
                                enabled: true
                                day: ALL
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: MONTHLY
                            start_time: 1
                            time_zone: America/New_York
                            start_date: 1
                            rules:
                              - volume_limit: 10000000
                                count_limit: 100000
                                enabled: true
                          - type: GLOBAL
                            currency: USD
                            max_transaction_amount: 10000000
                      linked_to: APc9vhYcPsRuTSpKD9KpMtPe
                      linked_type: APPLICATION
                      recipient_details:
                        ach_rules:
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: DAILY
                            start_time: 11
                            time_zone: America/New_York
                            rules:
                              - volume_limit: 1000005
                                count_limit: 2005
                                enabled: true
                                day: ALL
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: MONTHLY
                            start_time: 11
                            time_zone: America/New_York
                            start_date: 15
                            rules:
                              - volume_limit: 1000006
                                count_limit: 2006
                                enabled: true
                          - type: GLOBAL
                            currency: USD
                            max_transaction_amount: 5000003
                        card_rules:
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: DAILY
                            start_time: 11
                            time_zone: America/New_York
                            rules:
                              - volume_limit: 1000007
                                count_limit: 2007
                                enabled: true
                                day: ALL
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: MONTHLY
                            start_time: 11
                            time_zone: America/New_York
                            start_date: 15
                            rules:
                              - volume_limit: 1000008
                                count_limit: 2008
                                enabled: true
                          - type: GLOBAL
                            currency: USD
                            max_transaction_amount: 5000004
                      sender_details:
                        ach_rules:
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: DAILY
                            start_time: 11
                            time_zone: America/New_York
                            rules:
                              - volume_limit: 1000009
                                count_limit: 2009
                                enabled: true
                                day: ALL
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: MONTHLY
                            start_time: 11
                            time_zone: America/New_York
                            start_date: 15
                            rules:
                              - volume_limit: 1000010
                                count_limit: 2010
                                enabled: true
                          - type: GLOBAL
                            currency: USD
                            max_transaction_amount: 5000005
                        card_rules:
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: DAILY
                            start_time: 11
                            time_zone: America/New_York
                            rules:
                              - volume_limit: 1000011
                                count_limit: 2011
                                enabled: true
                                day: ALL
                          - type: TIME_RANGE
                            currency: USD
                            time_frame: MONTHLY
                            start_time: 11
                            time_zone: America/New_York
                            start_date: 15
                            rules:
                              - volume_limit: 1000012
                                count_limit: 2012
                                enabled: true
                          - type: GLOBAL
                            currency: USD
                            max_transaction_amount: 5000006
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/disbursement_rules/disbursement_rule_fxhfAsS68Vf4zjoVXDTQYL
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disbursement_rules?linked_to=APc9vhYcPsRuTSpKD9KpMtPe
                page:
                  limit: 100
                  next_cursor: disbursement_rule_fxhfAsS68Vf4zjoVXDTQYL
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    422UnprocessableEntity:
      description: >-
        Unprocessable Entity. The parameters were valid, but the request failed.
        Usually, the error involves misunderstanding of how to perform the
        request (e.g., creating a transfer with a seller that is
        not-yet-approved).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
    listCurrentUsages:
      description: List of `Disbursement Rule` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  current_usages:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/current_usage'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Disbursement Rules:
              value:
                _embedded:
                  current_usages:
                    - linked_to: APc9vhYcPsRuTSpKD9KpMtPe
                      linked_type: APPLICATION
                      type: TOTAL
                      currency: USD
                      ach_velocity:
                        daily_velocity:
                          current_volume: 0
                          current_count: 0
                          volume_limit: 1000001
                          count_limit: 2001
                          window_reset: '2025-12-20T16:00:00Z'
                        monthly_velocity:
                          current_volume: 0
                          current_count: 0
                          volume_limit: 1000002
                          count_limit: 2002
                          window_reset: '2026-01-15T16:00:00Z'
                      card_velocity:
                        daily_velocity:
                          current_volume: 0
                          current_count: 0
                          volume_limit: 1000003
                          count_limit: 2003
                          window_reset: '2025-12-20T16:00:00Z'
                        monthly_velocity:
                          current_volume: 0
                          current_count: 0
                          volume_limit: 1000004
                          count_limit: 2004
                          window_reset: '2026-01-15T16:00:00Z'
                      balance_adjustment_velocity:
                        daily_velocity:
                          current_volume: 0
                          current_count: 0
                          volume_limit: 10000000
                          count_limit: 10000
                          window_reset: '2025-12-20T06:00:00Z'
                        monthly_velocity:
                          current_volume: 0
                          current_count: 0
                          volume_limit: 10000000
                          count_limit: 100000
                          window_reset: '2026-01-01T06:00:00Z'
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/disbursement_rules/current_usages
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/disbursement_rules/current_usages?linked_to=APc9vhYcPsRuTSpKD9KpMtPe
                page:
                  limit: 100
                  next_cursor: null
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listFeeProfiles:
      description: List of `Fee Profile` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  Fee Profile:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/fee_profile'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Fee Profiles:
              value:
                $ref: ../../examples/fee_profiles/responses/listFeeProfiles.yaml
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createFeeProfile:
      description: A single Fee Profile
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/fee_profile'
          examples:
            Minimal Fields:
              value:
                id: FPpMzVi1uprQTszafZeqQit1
                created_at: '2025-11-13T18:25:30.19Z'
                updated_at: '2025-11-13T18:25:30.19Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 30
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 30
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPpMzVi1uprQTszafZeqQit1
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            All Fields:
              value:
                id: FPryaDMUDq9Tcc5epVpro1Jj
                created_at: '2025-11-18T17:28:49.56Z'
                updated_at: '2025-11-18T17:28:49.56Z'
                ach_basis_points: 30
                ach_basis_points_fee_limit: 50
                ach_credit_return_fixed_fee: 25
                ach_debit_return_fixed_fee: 30
                ach_fixed_fee: 40
                ach_notice_of_change_credit_fixed_fee: 12
                ach_notice_of_change_debit_fixed_fee: 25
                american_express_assessment_basis_points: 20
                american_express_basis_points: 10
                american_express_charge_dues_assessments: true
                american_express_charge_interchange: true
                american_express_externally_funded_basis_points: 50
                american_express_externally_funded_fixed_fee: 25
                american_express_fixed_fee: 15
                ancillary_fixed_fee_primary: 32
                ancillary_fixed_fee_secondary: 80
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 20
                card_cross_border_basis_points: 15
                card_cross_border_fixed_fee: 30
                charge_dues_assessments: true
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: 20
                diners_club_basis_points: 90
                diners_club_charge_interchange: true
                diners_club_fixed_fee: 25
                discover_assessments_basis_points: 50
                discover_basis_points: 12
                discover_charge_dues_assessments: true
                discover_charge_interchange: true
                discover_data_usage_fixed_fee: 15
                discover_externally_funded_basis_points: 60
                discover_externally_funded_fixed_fee: 20
                discover_fixed_fee: 35
                discover_network_authorization_fixed_fee: 30
                dispute_fixed_fee: 1500
                dispute_inquiry_fixed_fee: 1500
                eft_basis_points: 25
                eft_basis_points_fee_limit: 20
                eft_credit_return_fixed_fee: 35
                eft_debit_return_fixed_fee: 30
                eft_fixed_fee: 15
                externally_funded_basis_points: 15
                externally_funded_fixed_fee: 20
                fixed_fee: 20
                gross_monthly_fees_ach_basis_points: 15
                gross_monthly_fees_ach_fixed_fee: 15
                gross_monthly_fees_card_basis_points: 15
                gross_monthly_fees_card_fixed_fee: 15
                gross_monthly_fees_eft_basis_points: 15
                gross_monthly_fees_eft_fixed_fee: 15
                interac_basis_points: 20
                interac_fixed_fee: 25
                jcb_basis_points: 11
                jcb_charge_interchange: true
                jcb_fixed_fee: 20
                mastercard_acquirer_fees_basis_points: 20
                mastercard_assessments_over1k_basis_points: 20
                mastercard_assessments_under1k_basis_points: 25
                mastercard_basis_points: 30
                mastercard_charge_dues_assessments: true
                mastercard_charge_interchange: true
                mastercard_fixed_fee: 18
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: 10
                settlement_funding_transfer_ach_basis_points_fee_limit: 15
                settlement_funding_transfer_ach_credit_return_fixed_fee: 10
                settlement_funding_transfer_ach_debit_return_fixed_fee: 12
                settlement_funding_transfer_ach_fixed_fee: 10
                settlement_funding_transfer_eft_basis_points: 20
                settlement_funding_transfer_eft_basis_points_fee_limit: 40
                settlement_funding_transfer_eft_credit_return_fixed_fee: 20
                settlement_funding_transfer_eft_debit_return_fixed_fee: 18
                settlement_funding_transfer_eft_fixed_fee: 15
                settlement_funding_transfer_instant_payout_card_basis_points: 30
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: 70
                settlement_funding_transfer_instant_payout_card_fixed_fee: 45
                settlement_funding_transfer_noc_credit_fixed_fee: 50
                settlement_funding_transfer_noc_debit_fixed_fee: 55
                settlement_funding_transfer_same_day_ach_basis_points: 20
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: 50
                settlement_funding_transfer_same_day_ach_fixed_fee: 35
                subscription_ach_basis_points: 12
                subscription_ach_basis_points_fee_limit: 12
                subscription_ach_fixed_fee: 12
                subscription_card_basis_points: 12
                subscription_card_fixed_fee: 12
                subscription_eft_basis_points: 12
                subscription_eft_basis_points_fee_limit: 12
                subscription_eft_fixed_fee: 12
                tags: {}
                visa_acquirer_processing_fixed_fee: 80
                visa_assessments_basis_points: 40
                visa_base_II_credit_voucher_fixed_fee: 50
                visa_base_II_system_file_transmission_fixed_fee: 100
                visa_basis_points: 10
                visa_charge_dues_assessments: true
                visa_charge_interchange: true
                visa_credit_voucher_fixed_fee: 40
                visa_fixed_fee: 20
                visa_kilobyte_access_fixed_fee: 25
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPryaDMUDq9Tcc5epVpro1Jj
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Card Fees:
              value:
                id: FPvwMgKoNHM7sf5rsTwbuFFf
                created_at: '2025-11-18T19:21:07.53Z'
                updated_at: '2025-11-18T19:21:07.53Z'
                ach_basis_points: null
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: null
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: 32
                ancillary_fixed_fee_secondary: 80
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 30
                card_cross_border_basis_points: 15
                card_cross_border_fixed_fee: 30
                charge_dues_assessments: null
                charge_interchange: true
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 30
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPvwMgKoNHM7sf5rsTwbuFFf
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            ACH Fees:
              value:
                id: FPbAPNCJcAMqmDxki5Fh5PuM
                created_at: '2025-11-13T18:44:16.15Z'
                updated_at: '2025-11-13T18:44:16.15Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: 50
                ach_credit_return_fixed_fee: 25
                ach_debit_return_fixed_fee: 30
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: 12
                ach_notice_of_change_debit_fixed_fee: 25
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPbAPNCJcAMqmDxki5Fh5PuM
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Card Brand-Specific Fees - American Express:
              value:
                id: FPbUcdwGJYRkTYBqkoRVW4Wg
                created_at: '2025-11-13T18:29:05.05Z'
                updated_at: '2025-11-13T18:29:05.05Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: 20
                american_express_basis_points: 10
                american_express_charge_dues_assessments: true
                american_express_charge_interchange: true
                american_express_externally_funded_basis_points: 50
                american_express_externally_funded_fixed_fee: 25
                american_express_fixed_fee: 15
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPbUcdwGJYRkTYBqkoRVW4Wg
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Card Brand-Specific Fees - Diner's Club:
              value:
                id: FPiJ5VVun6oA3zcUvEXYpNC3
                created_at: '2025-11-13T18:29:44.62Z'
                updated_at: '2025-11-13T18:29:44.62Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: 90
                diners_club_charge_interchange: true
                diners_club_fixed_fee: 25
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPiJ5VVun6oA3zcUvEXYpNC3
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Card Brand-Specific Fees - Discover:
              value:
                id: FPhNNAPL4XGqfjJVu19YD29Y
                created_at: '2025-11-13T18:30:55.40Z'
                updated_at: '2025-11-13T18:30:55.40Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: 50
                discover_basis_points: 12
                discover_charge_dues_assessments: true
                discover_charge_interchange: true
                discover_data_usage_fixed_fee: 15
                discover_externally_funded_basis_points: 60
                discover_externally_funded_fixed_fee: 20
                discover_fixed_fee: 35
                discover_network_authorization_fixed_fee: 30
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPhNNAPL4XGqfjJVu19YD29Y
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Card Brand-Specific Fees - Interac:
              value:
                id: FPjBaN3ALXikiMLEN2MpwVJo
                created_at: '2025-11-13T18:31:26.36Z'
                updated_at: '2025-11-13T18:31:26.36Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: 20
                interac_fixed_fee: 25
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPjBaN3ALXikiMLEN2MpwVJo
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Card Brand-Specific Fees - JCB:
              value:
                id: FPKrtmCu3hHb6weVpgcrUmY
                created_at: '2025-11-13T18:32:07.02Z'
                updated_at: '2025-11-13T18:32:07.02Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: 11
                jcb_charge_interchange: true
                jcb_fixed_fee: 20
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPKrtmCu3hHb6weVpgcrUmY
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Card Brand-Specific Fees - Mastercard:
              value:
                id: FPjBaN3ALXikiMLEN2MpwVJo
                created_at: '2025-11-13T18:31:26.36Z'
                updated_at: '2025-11-13T18:31:26.36Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: 20
                mastercard_assessments_over1k_basis_points: 20
                mastercard_assessments_under1k_basis_points: 25
                mastercard_basis_points: 30
                mastercard_charge_dues_assessments: 15
                mastercard_charge_interchange: 22
                mastercard_fixed_fee: 18
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPjBaN3ALXikiMLEN2MpwVJo
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Card Brand-Specific Fees - Visa:
              value:
                id: FPjBaN3ALXikiMLEN2MpwVJo
                created_at: '2025-11-13T18:31:26.36Z'
                updated_at: '2025-11-13T18:31:26.36Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: 80
                visa_assessments_basis_points: 40
                visa_base_II_credit_voucher_fixed_fee: 50
                visa_base_II_system_file_transmission_fixed_fee: 100
                visa_basis_points: 10
                visa_charge_dues_assessments: 50
                visa_charge_interchange: 30
                visa_credit_voucher_fixed_fee: 40
                visa_fixed_fee: 20
                visa_kilobyte_access_fixed_fee: 25
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPjBaN3ALXikiMLEN2MpwVJo
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Compliance Form Overdue Fee:
              value:
                id: FPku37QZBHayyqyLVnZFsAJy
                created_at: '2025-11-13T18:45:04.06Z'
                updated_at: '2025-11-13T18:45:04.06Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 30
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: 20
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 30
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPku37QZBHayyqyLVnZFsAJy
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Dispute Fees:
              value:
                id: FPwi2SAwpvuU5j7Ghs6SzYaK
                created_at: '2025-11-13T18:45:52.73Z'
                updated_at: '2025-11-13T18:45:52.73Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: 1500
                dispute_inquiry_fixed_fee: 1500
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPwi2SAwpvuU5j7Ghs6SzYaK
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Dues Assessments:
              value:
                id: FPwpctGAa272fweeQ5Fkz55N
                created_at: '2025-11-13T18:46:40.99Z'
                updated_at: '2025-11-13T18:46:40.99Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 30
                charge_dues_assessments: true
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 30
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPwpctGAa272fweeQ5Fkz55N
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            EFT Fees:
              value:
                id: FPvRM147MkwfEiTWwxbxgBXT
                created_at: '2025-11-13T18:47:10.55Z'
                updated_at: '2025-11-13T18:47:10.55Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: 25
                eft_basis_points_fee_limit: 20
                eft_credit_return_fixed_fee: 35
                eft_debit_return_fixed_fee: 30
                eft_fixed_fee: 15
                externally_funded_basis_points: 15
                externally_funded_fixed_fee: 20
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPvRM147MkwfEiTWwxbxgBXT
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Gross Monthly Fees:
              value:
                id: FPa289iW1MTpEndb6HR8TApW
                created_at: '2025-11-13T18:47:44.57Z'
                updated_at: '2025-11-13T18:47:44.57Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 30
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 30
                gross_monthly_fees_ach_basis_points: 15
                gross_monthly_fees_ach_fixed_fee: 15
                gross_monthly_fees_card_basis_points: 15
                gross_monthly_fees_card_fixed_fee: 15
                gross_monthly_fees_eft_basis_points: 15
                gross_monthly_fees_eft_fixed_fee: 15
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPa289iW1MTpEndb6HR8TApW
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Settlement Funding Transfer Fees - ACH:
              value:
                id: FPjBaN3ALXikiMLEN2MpwVJo
                created_at: '2025-11-13T18:31:26.36Z'
                updated_at: '2025-11-13T18:31:26.36Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: 10
                settlement_funding_transfer_ach_basis_points_fee_limit: 15
                settlement_funding_transfer_ach_credit_return_fixed_fee: 10
                settlement_funding_transfer_ach_debit_return_fixed_fee: 12
                settlement_funding_transfer_ach_fixed_fee: 10
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPjBaN3ALXikiMLEN2MpwVJo
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Settlement Funding Transfer Fees - EFT:
              value:
                id: FPjBaN3ALXikiMLEN2MpwVJo
                created_at: '2025-11-13T18:31:26.36Z'
                updated_at: '2025-11-13T18:31:26.36Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points_fee_limit: 40
                settlement_funding_transfer_eft_basis_points: 20
                settlement_funding_transfer_eft_credit_return_fixed_fee: 20
                settlement_funding_transfer_eft_debit_return_fixed_fee: 18
                settlement_funding_transfer_eft_fixed_fee: 15
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPjBaN3ALXikiMLEN2MpwVJo
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Settlement Funding Transfer Fees - Instant Payout Cards:
              value:
                id: FPjBaN3ALXikiMLEN2MpwVJo
                created_at: '2025-11-13T18:31:26.36Z'
                updated_at: '2025-11-13T18:31:26.36Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: 70
                settlement_funding_transfer_instant_payout_card_basis_points: 30
                settlement_funding_transfer_instant_payout_card_fixed_fee: 45
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPjBaN3ALXikiMLEN2MpwVJo
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Settlement Funding Transfer Fees - NOC:
              value:
                id: FPjBaN3ALXikiMLEN2MpwVJo
                created_at: '2025-11-13T18:31:26.36Z'
                updated_at: '2025-11-13T18:31:26.36Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payou320t_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: 50
                settlement_funding_transfer_noc_debit_fixed_fee: 55
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPjBaN3ALXikiMLEN2MpwVJo
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Settlement Funding Transfer Fees - Same-Day ACH Fees:
              value:
                id: FPjBaN3ALXikiMLEN2MpwVJo
                created_at: '2025-11-13T18:31:26.36Z'
                updated_at: '2025-11-13T18:31:26.36Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: 20
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: 50
                settlement_funding_transfer_same_day_ach_fixed_fee: 35
                subscription_ach_basis_points: null
                subscription_ach_basis_points_fee_limit: null
                subscription_ach_fixed_fee: null
                subscription_card_basis_points: null
                subscription_card_fixed_fee: null
                subscription_eft_basis_points: null
                subscription_eft_basis_points_fee_limit: null
                subscription_eft_fixed_fee: null
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPjBaN3ALXikiMLEN2MpwVJo
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Subscription Fees:
              value:
                id: FPjBaN3ALXikiMLEN2MpwVJo
                created_at: '2025-11-13T18:31:26.36Z'
                updated_at: '2025-11-13T18:31:26.36Z'
                ach_basis_points: 20
                ach_basis_points_fee_limit: null
                ach_credit_return_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_fixed_fee: 30
                ach_notice_of_change_credit_fixed_fee: null
                ach_notice_of_change_debit_fixed_fee: null
                american_express_assessment_basis_points: null
                american_express_basis_points: null
                american_express_charge_dues_assessments: null
                american_express_charge_interchange: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_fixed_fee: null
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                application: APc9vhYcPsRuTSpKD9KpMtPe
                basis_points: 80
                charge_dues_assessments: null
                charge_interchange: false
                compliance_forms_overdue_fixed_fee: null
                diners_club_basis_points: null
                diners_club_charge_interchange: null
                diners_club_fixed_fee: null
                discover_assessments_basis_points: null
                discover_basis_points: null
                discover_charge_dues_assessments: null
                discover_charge_interchange: null
                discover_data_usage_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                dispute_fixed_fee: null
                dispute_inquiry_fixed_fee: null
                eft_basis_points: null
                eft_basis_points_fee_limit: null
                eft_credit_return_fixed_fee: null
                eft_debit_return_fixed_fee: null
                eft_fixed_fee: null
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                fixed_fee: 3
                gross_monthly_fees_ach_basis_points: null
                gross_monthly_fees_ach_fixed_fee: null
                gross_monthly_fees_card_basis_points: null
                gross_monthly_fees_card_fixed_fee: null
                gross_monthly_fees_eft_basis_points: null
                gross_monthly_fees_eft_fixed_fee: null
                interac_basis_points: null
                interac_fixed_fee: null
                jcb_basis_points: null
                jcb_charge_interchange: null
                jcb_fixed_fee: null
                mastercard_acquirer_fees_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_basis_points: null
                mastercard_charge_dues_assessments: null
                mastercard_charge_interchange: null
                mastercard_fixed_fee: null
                qualified_tiers: null
                rounding_mode: AGGREGATE
                settlement_funding_transfer_ach_basis_points: null
                settlement_funding_transfer_ach_basis_points_fee_limit: null
                settlement_funding_transfer_ach_credit_return_fixed_fee: null
                settlement_funding_transfer_ach_debit_return_fixed_fee: null
                settlement_funding_transfer_ach_fixed_fee: null
                settlement_funding_transfer_eft_basis_points: null
                settlement_funding_transfer_eft_basis_points_fee_limit: null
                settlement_funding_transfer_eft_credit_return_fixed_fee: null
                settlement_funding_transfer_eft_debit_return_fixed_fee: null
                settlement_funding_transfer_eft_fixed_fee: null
                settlement_funding_transfer_instant_payout_card_basis_points: null
                settlement_funding_transfer_instant_payout_card_basis_points_fee_limit: null
                settlement_funding_transfer_instant_payout_card_fixed_fee: null
                settlement_funding_transfer_noc_credit_fixed_fee: null
                settlement_funding_transfer_noc_debit_fixed_fee: null
                settlement_funding_transfer_same_day_ach_basis_points: null
                settlement_funding_transfer_same_day_ach_basis_points_fee_limit: null
                settlement_funding_transfer_same_day_ach_fixed_fee: null
                subscription_ach_basis_points: 12
                subscription_ach_basis_points_fee_limit: 12
                subscription_ach_fixed_fee: 12
                subscription_card_basis_points: 12
                subscription_card_fixed_fee: 12
                subscription_eft_basis_points: 12
                subscription_eft_basis_points_fee_limit: 12
                subscription_eft_fixed_fee: 12
                tags: {}
                visa_acquirer_processing_fixed_fee: null
                visa_assessments_basis_points: null
                visa_base_II_credit_voucher_fixed_fee: null
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_basis_points: null
                visa_charge_dues_assessments: null
                visa_charge_interchange: null
                visa_credit_voucher_fixed_fee: null
                visa_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPjBaN3ALXikiMLEN2MpwVJo
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listIdentities:
      description: List of Identity objects
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                description: List of `Identity` resources.
                properties:
                  identities:
                    type: array
                    uniqueItems: true
                    description: >-
                      An `Identity` resource represents either a person or
                      business in Finix.
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/identitySellerUSA'
                        - $ref: '#/components/schemas/identitySellerCAN'
                        - $ref: '#/components/schemas/identityRecipientBusiness'
                        - $ref: '#/components/schemas/identityRecipientPersonal'
                        - $ref: '#/components/schemas/identityBuyer'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Identities:
              value:
                _embedded:
                  identities:
                    - id: IDrtMUGe62tQfxHpgu9mSHuy
                      created_at: '2024-12-18T08:19:34.82Z'
                      updated_at: '2024-12-18T08:19:34.82Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      entity:
                        ach_max_transaction_amount: 0
                        amex_mid: null
                        annual_card_volume: 0
                        business_address: null
                        business_name: null
                        business_phone: null
                        business_tax_id_provided: false
                        business_type: null
                        default_statement_descriptor: null
                        discover_mid: null
                        dob:
                          day: 1
                          month: 1
                          year: 2013
                        doing_business_as: null
                        email: john.smith@company1.com
                        first_name: John
                        has_accepted_credit_cards_previously: false
                        incorporation_date: null
                        last_name: Smith
                        max_transaction_amount: 0
                        mcc: null
                        ownership_type: null
                        personal_address:
                          line1: 123 Main Street
                          line2: null
                          city: San Francisco
                          region: CA
                          postal_code: '90650'
                          country: USA
                        phone: '14158885080'
                        principal_percentage_ownership: 25
                        short_business_name: null
                        tax_authority: null
                        tax_id_provided: true
                        title: Founder
                        url: null
                      identity_roles:
                        - BENEFICIAL_OWNER
                      tags: {}
                      type: PERSONAL
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtMUGe62tQfxHpgu9mSHuy
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        verifications:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtMUGe62tQfxHpgu9mSHuy/verifications
                        merchants:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtMUGe62tQfxHpgu9mSHuy/merchants
                        settlements:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtMUGe62tQfxHpgu9mSHuy/settlements
                        authorizations:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtMUGe62tQfxHpgu9mSHuy/authorizations
                        transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtMUGe62tQfxHpgu9mSHuy/transfers
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtMUGe62tQfxHpgu9mSHuy/payment_instruments
                        associated_identities:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtMUGe62tQfxHpgu9mSHuy/associated_identities
                        disputes:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtMUGe62tQfxHpgu9mSHuy/disputes
                    - id: ID6YeRojM2ppNkPt4mP8ExNH
                      created_at: '2024-12-18T07:03:33.75Z'
                      updated_at: '2024-12-18T07:03:33.75Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      entity:
                        ach_max_transaction_amount: 1000000
                        amex_mid: null
                        annual_card_volume: 12000000
                        business_address:
                          line1: 741 Douglass St
                          line2: Apartment 8
                          city: San Mateo
                          region: CA
                          postal_code: '94114'
                          country: USA
                        business_name: Finix Flowers
                        business_phone: +1 (408) 756-4497
                        business_tax_id_provided: true
                        business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
                        default_statement_descriptor: Finix Flowers
                        discover_mid: null
                        dob:
                          day: 27
                          month: 6
                          year: 1978
                        doing_business_as: Finix Flowers
                        email: user@example.org
                        first_name: John
                        has_accepted_credit_cards_previously: true
                        incorporation_date:
                          day: 27
                          month: 6
                          year: 1978
                        last_name: Smith
                        max_transaction_amount: 1000000
                        mcc: '4900'
                        ownership_type: PRIVATE
                        personal_address:
                          line1: 741 Douglass St
                          line2: Apartment 7
                          city: San Mateo
                          region: CA
                          postal_code: '94114'
                          country: USA
                        phone: '14158885080'
                        principal_percentage_ownership: 50
                        short_business_name: null
                        tax_authority: null
                        tax_id_provided: true
                        title: CEO
                        url: https://www.finix.com
                      identity_roles:
                        - SELLER
                      tags:
                        Studio Rating: '4.7'
                      type: BUSINESS
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6YeRojM2ppNkPt4mP8ExNH
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        verifications:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6YeRojM2ppNkPt4mP8ExNH/verifications
                        merchants:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6YeRojM2ppNkPt4mP8ExNH/merchants
                        settlements:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6YeRojM2ppNkPt4mP8ExNH/settlements
                        authorizations:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6YeRojM2ppNkPt4mP8ExNH/authorizations
                        transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6YeRojM2ppNkPt4mP8ExNH/transfers
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6YeRojM2ppNkPt4mP8ExNH/payment_instruments
                        associated_identities:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6YeRojM2ppNkPt4mP8ExNH/associated_identities
                        disputes:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6YeRojM2ppNkPt4mP8ExNH/disputes
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/identities
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities?after_cursor=IDjvxGeXBLKH1V9YnWm1CS4n
                page:
                  limit: 100
                  next_cursor: IDjvxGeXBLKH1V9YnWm1CS4n
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createIdentity:
      description: Single Identity object
      content:
        application/json:
          schema:
            type: object
            anyOf:
              - $ref: '#/components/schemas/identitySellerUSA'
              - $ref: '#/components/schemas/identitySellerCAN'
              - $ref: '#/components/schemas/identityRecipientBusiness'
              - $ref: '#/components/schemas/identityRecipientPersonal'
              - $ref: '#/components/schemas/identityBuyer'
              - $ref: '#/components/schemas/identityBuyerBlank'
              - $ref: '#/components/schemas/user'
          examples:
            Seller (USA):
              value:
                id: IDcV3F1FzHB5cT9DoGZLJ39Q
                created_at: '2024-08-09T09:32:02.64Z'
                updated_at: '2024-08-09T09:32:02.64Z'
                additional_underwriting_data:
                  refund_policy: MERCHANDISE_EXCHANGE_ONLY
                  credit_check_ip_address: 42.1.1.112
                  card_volume_distribution:
                    card_present_percentage: 30
                    mail_order_telephone_order_percentage: 10
                    ecommerce_percentage: 60
                  average_ach_transfer_amount: 200000
                  average_card_transfer_amount: 200000
                  merchant_agreement_accepted: true
                  merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)
                  merchant_agreement_ip_address: 42.1.1.113
                  annual_ach_volume: 200000
                  credit_check_allowed: true
                  business_description: SB3 vegan cafe
                  credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
                  volume_distribution_by_business_type:
                    other_volume_percentage: 0
                    consumer_to_consumer_volume_percentage: 0
                    business_to_consumer_volume_percentage: 0
                    business_to_business_volume_percentage: 100
                    person_to_person_volume_percentage: 0
                  credit_check_timestamp: '2021-04-28T16:42:55Z'
                  merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
                application: APgPDQrLD52TYvqazjHJJchM
                entity:
                  ach_max_transaction_amount: 1000000
                  amex_mid: null
                  annual_card_volume: 12000000
                  business_address:
                    line1: 741 Douglass St
                    line2: Apartment 8
                    city: San Mateo
                    region: CA
                    postal_code: '94114'
                    country: USA
                  business_name: Finix Flowers
                  business_phone: +1 (408) 756-4497
                  business_tax_id_provided: true
                  business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
                  default_statement_descriptor: Finix Flowers
                  discover_mid: null
                  dob:
                    day: 27
                    month: 6
                    year: 1978
                  doing_business_as: Finix Flowers
                  email: user@example.org
                  first_name: John
                  has_accepted_credit_cards_previously: true
                  incorporation_date:
                    day: 27
                    month: 6
                    year: 1978
                  last_name: Smith
                  max_transaction_amount: 1000000
                  mcc: '4900'
                  ownership_type: PRIVATE
                  personal_address:
                    line1: 741 Douglass St
                    line2: Apartment 7
                    city: San Mateo
                    region: CA
                    postal_code: '94114'
                    country: USA
                  phone: '14158885080'
                  principal_percentage_ownership: 50
                  short_business_name: null
                  tax_authority: null
                  tax_id_provided: true
                  title: CEO
                  url: https://www.finix.com
                identity_roles:
                  - SELLER
                tags:
                  Studio Rating: '4.7'
                type: BUSINESS
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcV3F1FzHB5cT9DoGZLJ39Q
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcV3F1FzHB5cT9DoGZLJ39Q/verifications
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcV3F1FzHB5cT9DoGZLJ39Q/merchants
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcV3F1FzHB5cT9DoGZLJ39Q/settlements
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcV3F1FzHB5cT9DoGZLJ39Q/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcV3F1FzHB5cT9DoGZLJ39Q/transfers
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcV3F1FzHB5cT9DoGZLJ39Q/payment_instruments
                  associated_identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcV3F1FzHB5cT9DoGZLJ39Q/associated_identities
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcV3F1FzHB5cT9DoGZLJ39Q/disputes
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
            Seller (CAN):
              value:
                id: ID2gKzJLXGBevszzh3GRSShB
                created_at: '2024-08-09T07:19:25.34Z'
                updated_at: '2024-08-09T07:19:25.34Z'
                additional_underwriting_data:
                  refund_policy: MERCHANDISE_EXCHANGE_ONLY
                  credit_check_ip_address: 42.1.1.112
                  card_volume_distribution:
                    card_present_percentage: 30
                    mail_order_telephone_order_percentage: 10
                    ecommerce_percentage: 60
                  average_ach_transfer_amount: 200000
                  average_card_transfer_amount: 200000
                  merchant_agreement_accepted: true
                  merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)
                  merchant_agreement_ip_address: 42.1.1.113
                  annual_ach_volume: 200000
                  credit_check_allowed: true
                  business_description: Business offering video editing services.
                  credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
                  volume_distribution_by_business_type:
                    other_volume_percentage: 0
                    consumer_to_consumer_volume_percentage: 0
                    business_to_consumer_volume_percentage: 0
                    business_to_business_volume_percentage: 100
                    person_to_person_volume_percentage: 0
                  credit_check_timestamp: '2021-04-28T16:42:55Z'
                  merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
                application: APgPDQrLD52TYvqazjHJJchM
                entity:
                  ach_max_transaction_amount: 1000000
                  amex_mid: null
                  annual_card_volume: 12000000
                  business_address:
                    line1: 456 Elm Avenue
                    line2: null
                    city: Vancouver
                    region: BC
                    postal_code: V6B 2L2
                    country: CAN
                  business_name: Video Editing Services
                  business_phone: +1 (416) 555-7890
                  business_tax_id_provided: true
                  business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
                  default_statement_descriptor: Video Services
                  discover_mid: null
                  dob:
                    day: 27
                    month: 6
                    year: 1978
                  doing_business_as: Video Editing Services
                  email: info@video-editing-services.com
                  first_name: Jerry
                  has_accepted_credit_cards_previously: true
                  incorporation_date:
                    day: 27
                    month: 6
                    year: 1978
                  last_name: Dunhill
                  max_transaction_amount: 1000000
                  mcc: '4900'
                  ownership_type: PRIVATE
                  personal_address:
                    line1: 987 Milo Street
                    line2: null
                    city: Vancouver
                    region: BC
                    postal_code: V5K 1Z5
                    country: CAN
                  phone: '14158885080'
                  principal_percentage_ownership: 50
                  short_business_name: null
                  tax_authority: null
                  tax_id_provided: true
                  title: CEO
                  url: https://www.video-editing-services.com
                identity_roles:
                  - SELLER
                tags:
                  Studio Rating: '4.7'
                type: BUSINESS
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID2gKzJLXGBevszzh3GRSShB
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID2gKzJLXGBevszzh3GRSShB/verifications
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID2gKzJLXGBevszzh3GRSShB/merchants
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID2gKzJLXGBevszzh3GRSShB/settlements
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID2gKzJLXGBevszzh3GRSShB/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID2gKzJLXGBevszzh3GRSShB/transfers
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID2gKzJLXGBevszzh3GRSShB/payment_instruments
                  associated_identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID2gKzJLXGBevszzh3GRSShB/associated_identities
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID2gKzJLXGBevszzh3GRSShB/disputes
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
            Recipient (Business):
              value:
                id: IDjYHnn5kKQjpxh4gaFBih1n
                created_at: '2024-08-08T09:26:15.85Z'
                updated_at: '2024-08-08T09:26:15.85Z'
                application: APgPDQrLD52TYvqazjHJJchM
                entity:
                  ach_max_transaction_amount: 0
                  amex_mid: null
                  annual_card_volume: 0
                  business_address:
                    line1: 7890 Oak Drive
                    line2: Suite 101
                    city: Smalltown
                    region: TX
                    postal_code: '75432'
                    country: USA
                  business_name: Blue Horizon Technologies
                  business_phone: null
                  business_tax_id_provided: false
                  business_type: null
                  default_statement_descriptor: null
                  discover_mid: null
                  dob: null
                  doing_business_as: B.H. Technologies
                  email: null
                  first_name: John
                  has_accepted_credit_cards_previously: false
                  incorporation_date: null
                  last_name: Jeremy
                  max_transaction_amount: 0
                  mcc: null
                  ownership_type: null
                  personal_address:
                    line1: 741 Douglass St
                    line2: Apartment 7
                    city: San Mateo
                    region: CA
                    postal_code: '94114'
                    country: USA
                  phone: null
                  principal_percentage_ownership: null
                  short_business_name: null
                  tax_authority: null
                  tax_id_provided: false
                  title: null
                  url: null
                identity_roles:
                  - RECIPIENT
                tags: {}
                type: BUSINESS
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/verifications
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/merchants
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/settlements
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/transfers
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/payment_instruments
                  associated_identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/associated_identities
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/disputes
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
            Recipient (Personal):
              value:
                id: IDdRDX7H6hNcm4HexJBeZVUV
                created_at: '2024-08-08T09:36:10.26Z'
                updated_at: '2024-08-08T09:36:10.26Z'
                application: APgPDQrLD52TYvqazjHJJchM
                entity:
                  ach_max_transaction_amount: 0
                  amex_mid: null
                  annual_card_volume: 0
                  business_address: null
                  business_name: null
                  business_phone: null
                  business_tax_id_provided: false
                  business_type: null
                  default_statement_descriptor: null
                  discover_mid: null
                  dob: null
                  doing_business_as: null
                  email: null
                  first_name: Michael
                  has_accepted_credit_cards_previously: false
                  incorporation_date: null
                  last_name: Johnson
                  max_transaction_amount: 0
                  mcc: null
                  ownership_type: null
                  personal_address:
                    line1: 789 Oak Drive
                    line2: null
                    city: Springfield
                    region: IL
                    postal_code: '62704'
                    country: USA
                  phone: null
                  principal_percentage_ownership: null
                  short_business_name: null
                  tax_authority: null
                  tax_id_provided: false
                  title: null
                  url: null
                identity_roles:
                  - RECIPIENT
                tags: {}
                type: PERSONAL
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/verifications
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/merchants
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/settlements
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/transfers
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/payment_instruments
                  associated_identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/associated_identities
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/disputes
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
            Buyer:
              value:
                id: IDgjFNYNraTBiKUyTXB4GFNe
                created_at: '2025-08-12T19:56:51.90Z'
                updated_at: '2025-08-12T19:56:51.90Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                entity:
                  ach_max_transaction_amount: 0
                  amex_mid: null
                  annual_card_volume: 0
                  business_address: null
                  business_name: null
                  business_phone: null
                  business_tax_id_fingerprint: null
                  business_tax_id_provided: false
                  business_type: null
                  default_statement_descriptor: null
                  discover_mid: null
                  dob: null
                  doing_business_as: null
                  email: finix_example@finix.com
                  first_name: John
                  has_accepted_credit_cards_previously: false
                  incorporation_date: null
                  last_name: Smith
                  max_transaction_amount: 0
                  mcc: null
                  ownership_type: null
                  personal_address:
                    line1: 741 Douglass St
                    line2: Apartment 7
                    city: San Mateo
                    region: CA
                    postal_code: '94114'
                    country: USA
                  phone: '7145677613'
                  principal_percentage_ownership: null
                  short_business_name: null
                  tax_authority: null
                  tax_id_fingerprint: null
                  tax_id_provided: false
                  title: null
                  url: null
                identity_roles:
                  - BUYER
                tags:
                  key: value
                type: PERSONAL
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgjFNYNraTBiKUyTXB4GFNe
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgjFNYNraTBiKUyTXB4GFNe/verifications
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgjFNYNraTBiKUyTXB4GFNe/merchants
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgjFNYNraTBiKUyTXB4GFNe/settlements
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgjFNYNraTBiKUyTXB4GFNe/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgjFNYNraTBiKUyTXB4GFNe/transfers
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgjFNYNraTBiKUyTXB4GFNe/payment_instruments
                  associated_identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgjFNYNraTBiKUyTXB4GFNe/associated_identities
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgjFNYNraTBiKUyTXB4GFNe/disputes
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            Buyer - Blank:
              value:
                id: IDcjL3Jv7S63B859Uwmnek25
                created_at: '2025-12-08T17:12:03.33Z'
                updated_at: '2025-12-08T17:12:03.33Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                entity:
                  ach_max_transaction_amount: 0
                  amex_mid: null
                  annual_card_volume: 0
                  business_address: null
                  business_name: null
                  business_phone: null
                  business_tax_id_fingerprint: null
                  business_tax_id_provided: false
                  business_type: null
                  default_statement_descriptor: null
                  discover_mid: null
                  dob: null
                  doing_business_as: null
                  email: null
                  first_name: null
                  has_accepted_credit_cards_previously: false
                  incorporation_date: null
                  last_name: null
                  max_transaction_amount: 0
                  mcc: null
                  ownership_type: null
                  personal_address:
                    line1: null
                    line2: null
                    city: null
                    region: null
                    postal_code: null
                    country: null
                  phone: null
                  principal_percentage_ownership: null
                  short_business_name: null
                  tax_authority: null
                  tax_id_fingerprint: null
                  tax_id_provided: false
                  title: null
                  url: null
                identity_roles:
                  - BUYER
                tags: {}
                type: PERSONAL
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcjL3Jv7S63B859Uwmnek25
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcjL3Jv7S63B859Uwmnek25/verifications
                  merchants:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcjL3Jv7S63B859Uwmnek25/merchants
                  settlements:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcjL3Jv7S63B859Uwmnek25/settlements
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcjL3Jv7S63B859Uwmnek25/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcjL3Jv7S63B859Uwmnek25/transfers
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcjL3Jv7S63B859Uwmnek25/payment_instruments
                  associated_identities:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcjL3Jv7S63B859Uwmnek25/associated_identities
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDcjL3Jv7S63B859Uwmnek25/disputes
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
            User - ROLE_MERCHANT:
              value:
                id: USoR21bF52KLZpbQCptrexpH
                created_at: '2025-12-08T18:35:51.41Z'
                updated_at: '2025-12-08T18:35:51.41Z'
                created_by: USfdccsr1Z5iVbXDyYt7hjZZ
                email: null
                enabled: true
                first_name: null
                identity: IDjvxGeXBLKH1V9YnWm1CS4n
                last_name: null
                last_used_date: null
                password: f2fd7118-66c3-495c-8942-8178e0ea9d0c
                role: ROLE_MERCHANT
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/users/USoR21bF52KLZpbQCptrexpH
                  applications:
                    href: https://finix.sandbox-payments-api.com/applications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listMerchants:
      description: List of `Merchant` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  List of Merchants:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/merchant'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Merchants:
              value:
                _embedded:
                  merchants:
                    - id: MUt6kBb22rxUvWNxUf8XriB2
                      created_at: '2024-12-27T06:34:21.36Z'
                      updated_at: '2024-12-27T06:35:01.29Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      card_cvv_required: false
                      card_expiration_date_required: true
                      card_network_details: null
                      convenience_charges_enabled: false
                      country: USA
                      creating_transfer_from_report_enabled: false
                      currencies:
                        - USD
                      default_partial_authorization_enabled: false
                      disbursements_ach_pull_enabled: true
                      disbursements_ach_push_enabled: true
                      disbursements_card_pull_enabled: true
                      disbursements_card_push_enabled: true
                      disbursements_same_day_ach_pull_enabled: false
                      disbursements_same_day_ach_push_enabled: false
                      fee_ready_to_settle_upon: PROCESSOR_WINDOW
                      gateway: null
                      gross_settlement_enabled: false
                      identity: IDrtcMe7sjiMmhZrumi45UBp
                      instant_payouts_card_push_enabled: false
                      level_two_level_three_data_enabled: false
                      loan_repayment: null
                      mcc: null
                      merchant_name: Bernie Bingbob
                      merchant_profile: MPo2FsjMoEV2xjq81cMWEjJ4
                      mid: FNX8nWDpRv12htpNo1ZMiDYEQ
                      onboarding_state: APPROVED
                      processing_enabled: true
                      processor: DUMMY_V1
                      processor_details:
                        mid: FNX8nWDpRv12htpNo1ZMiDYEQ
                        api_key: secretValue
                      ready_to_settle_upon: PROCESSOR_WINDOW
                      ready_to_settle_upon_delay_alignment: NONE
                      rent_surcharges_enabled: false
                      settlement_enabled: true
                      settlement_funding_identifier: UNSET
                      settlement_queue_mode: UNSET
                      surcharges_enabled: false
                      tags: {}
                      unreferenced_refund_manual_entry_enabled: false
                      verification: VIjDWQq2Skk13ob91ERHDsnh
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchants/MUt6kBb22rxUvWNxUf8XriB2
                        identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDrtcMe7sjiMmhZrumi45UBp
                        verifications:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchants/MUt6kBb22rxUvWNxUf8XriB2/verifications
                        merchant_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchant_profiles/MPo2FsjMoEV2xjq81cMWEjJ4
                        verification:
                          href: >-
                            https://finix.sandbox-payments-api.com/verifications/VIjDWQq2Skk13ob91ERHDsnh
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchants
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants?after_cursor=MU7noQ1wdgdAeAfymw2rfBMq
                page:
                  limit: 100
                  next_cursor: MU7noQ1wdgdAeAfymw2rfBMq
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createMerchantDevice:
      description: Request to create a device under a merchant.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/device'
          examples:
            Create a Device - Model PAX_A800:
              value:
                id: DVoDo7F6yYCnX2d6Fj9hvsd
                created_at: '2025-11-14T19:01:04.638451Z'
                updated_at: '2025-11-14T19:01:04.638451Z'
                configuration_details:
                  allow_debit: true
                  check_for_duplicate_transactions: true
                  prompt_amount_confirmation: true
                  prompt_manual_entry: false
                  signature_threshold_amount: 10000
                  bypass_device_on_capture: true
                  prompt_receipt_confirmation: true
                  display_tip_on_receipt: false
                  prompt_tip_on_screen: false
                  allow_standalone_authorizations: false
                  allow_standalone_sales: false
                  allow_standalone_refunds: false
                  tipping_details:
                    percent_tipping_threshold: 0
                    percent_options:
                      - 18
                      - 20
                      - 22
                    fixed_options:
                      - 100
                      - 150
                      - 200
                  idle_message: null
                  idle_image_file_id: null
                  automatic_receipt_delivery_methods: null
                  available_receipt_methods: null
                  prompt_for_signature: NEVER
                  surcharge_basis_points: null
                description: Cashier One
                enabled: false
                idle_message: null
                merchant: MUsMvN47nRtdgUkE23SRHDC6
                model: PAX_A800
                name: My PAX_A800 Finix Device
                serial_number: '2210172205'
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd
                  merchant:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MUsMvN47nRtdgUkE23SRHDC6
                  transfers:
                    href: https://finix.sandbox-payments-api.com/transfers
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/authorizations
            Create a Device - Model PAX_A920PRO:
              value:
                id: DV5znKhAQZs6J7rfXqYnr86F
                created_at: '2025-05-21T19:02:11.141785Z'
                updated_at: '2025-05-21T19:02:11.141785Z'
                configuration_details:
                  allow_debit: true
                  check_for_duplicate_transactions: true
                  prompt_amount_confirmation: true
                  prompt_manual_entry: false
                  signature_threshold_amount: 10000
                  bypass_device_on_capture: true
                  prompt_receipt_confirmation: true
                  display_tip_on_receipt: false
                  prompt_tip_on_screen: false
                  allow_standalone_authorizations: false
                  allow_standalone_sales: false
                  allow_standalone_refunds: false
                  tipping_details:
                    percent_tipping_threshold: 0
                    percent_options:
                      - 18
                      - 20
                      - 22
                    fixed_options:
                      - 100
                      - 150
                      - 200
                  idle_message: null
                  idle_image_file_id: null
                  automatic_receipt_delivery_methods: null
                  available_receipt_methods: null
                  prompt_for_signature: NEVER
                  surcharge_basis_points: null
                description: Cashier Two
                enabled: false
                idle_message: null
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                model: PAX_A920PRO
                name: My PAX_A920PRO Finix Device
                serial_number: '19046260946'
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/devices/DV5znKhAQZs6J7rfXqYnr86F
                  merchant:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq
                  transfers:
                    href: https://finix.sandbox-payments-api.com/transfers
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/authorizations
            Create a Device - Model PAX_D135:
              value:
                id: DVxcL2fiBdt9frYCKAbZikZK
                created_at: '2025-05-21T19:01:32.000581Z'
                updated_at: '2025-05-21T19:01:32.000581Z'
                configuration_details:
                  allow_debit: true
                  check_for_duplicate_transactions: true
                  prompt_amount_confirmation: true
                  prompt_manual_entry: false
                  signature_threshold_amount: 10000
                  bypass_device_on_capture: true
                  prompt_receipt_confirmation: true
                  display_tip_on_receipt: false
                  prompt_tip_on_screen: false
                  allow_standalone_authorizations: false
                  allow_standalone_sales: false
                  allow_standalone_refunds: false
                  tipping_details:
                    percent_tipping_threshold: 0
                    percent_options:
                      - 18
                      - 20
                      - 22
                    fixed_options:
                      - 100
                      - 150
                      - 200
                  idle_message: null
                  idle_image_file_id: null
                  automatic_receipt_delivery_methods: null
                  available_receipt_methods: null
                  prompt_for_signature: NEVER
                  surcharge_basis_points: null
                description: Cashier Three
                enabled: false
                idle_message: null
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                model: PAX_D135
                name: My PAX_D135 Finix Device
                serial_number: '19046260947'
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/devices/DVxcL2fiBdt9frYCKAbZikZK
                  merchant:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq
                  transfers:
                    href: https://finix.sandbox-payments-api.com/transfers
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/authorizations
            Create a Device - Surcharges - Standalone Mode:
              value:
                id: DVtqvNrZYGrct4izwJgYikAM
                created_at: '2025-05-21T19:02:56.559365Z'
                updated_at: '2025-05-21T19:02:56.559365Z'
                configuration_details:
                  allow_debit: true
                  check_for_duplicate_transactions: true
                  prompt_amount_confirmation: true
                  prompt_manual_entry: false
                  signature_threshold_amount: 10000
                  bypass_device_on_capture: true
                  prompt_receipt_confirmation: true
                  display_tip_on_receipt: false
                  prompt_tip_on_screen: false
                  allow_standalone_authorizations: false
                  allow_standalone_sales: false
                  allow_standalone_refunds: false
                  tipping_details:
                    percent_tipping_threshold: 0
                    percent_options:
                      - 18
                      - 20
                      - 22
                    fixed_options:
                      - 100
                      - 150
                      - 200
                  idle_message: null
                  idle_image_file_id: null
                  automatic_receipt_delivery_methods: null
                  available_receipt_methods: null
                  prompt_for_signature: NEVER
                  surcharge_basis_points: 300
                description: Cashier One
                enabled: false
                idle_message: null
                merchant: MU7noQ1wdgdAeAfymw2rfBMq
                model: PAX_A800
                name: My PAX_A800 Finix Device
                serial_number: '19046260945'
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/devices/DVtqvNrZYGrct4izwJgYikAM
                  merchant:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq
                  transfers:
                    href: https://finix.sandbox-payments-api.com/transfers
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/authorizations
    listMerchantVerifications:
      description: List of Merchant Verifications
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  Merchant Verifications:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/merchant-verification'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            Merchant Verifications List:
              value:
                _embedded:
                  verifications:
                    - id: VI5pMpAg6e5bRaMREhrYjwQW
                      created_at: '2024-12-04T07:56:00.03Z'
                      updated_at: '2024-12-04T07:57:01.95Z'
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      identity: null
                      merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                      messages: []
                      outcome_summary: null
                      outcomes: null
                      payment_instrument: null
                      payment_instrument_verification_details:
                        push_to_card_domestic: null
                        push_to_card_cross_border: null
                        card_type: null
                        billing_currency: null
                        issuer_country: null
                      processor: DUMMY_V1
                      raw: RawDummyMerchantUnderwriteResult
                      state: SUCCEEDED
                      tags: {}
                      trace_id: 26577eee-2db9-4707-85f6-5b8f9c1e5376
                      type: MERCHANT
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/verifications/VI5pMpAg6e5bRaMREhrYjwQW
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        merchant:
                          href: >-
                            https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications?after_cursor=VIdS8qSW3kZbnK9AsFHJZ81U
                page:
                  limit: 100
                  next_cursor: VIdS8qSW3kZbnK9AsFHJZ81U
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createMerchantVerification:
      description: A Merchant Verification
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/merchant-verification'
          examples:
            Pending Merchant Verification:
              value:
                id: VItpnRDSS7eMXEgbPFMKEmD3
                created_at: '2024-09-20T20:46:18.84Z'
                updated_at: '2024-09-20T20:46:18.91Z'
                application: APgFebyumW1TVZK9sbZwAvbx
                identity: null
                merchant: MU7F6JcADa47CT1cwoZAgLFM
                merchant_identity: IDfqVY8AcjQCSdyZSFL4thMn
                messages: []
                outcome_summary: null
                outcomes: null
                payment_instrument: null
                payment_instrument_verification_details:
                  push_to_card_domestic: null
                  push_to_card_cross_border: null
                  card_type: null
                  billing_currency: null
                  issuer_country: null
                processor: LITLE_V1
                raw: null
                state: PENDING
                tags: {}
                trace_id: FNXmjmpf1PXHa52KDwFVEEPDy
                type: MERCHANT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/verifications/VItpnRDSS7eMXEgbPFMKEmD3
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgFebyumW1TVZK9sbZwAvbx
                  merchant:
                    href: >-
                      https://finix.sandbox-payments-api.com/merchants/MU7F6JcADa47CT1cwoZAgLFM
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listPaymentInstruments:
      description: List of `Payment Instrument` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  payment_instruments:
                    type: array
                    uniqueItems: true
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/payment_instrument_card'
                        - $ref: '#/components/schemas/payment_instrument_bank'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Payment Instruments:
              value:
                _embedded:
                  payment_instruments:
                    - id: PI3AbkuRR1JbT5kPiGQCXvD9
                      created_at: '2022-10-11T01:42:53.29Z'
                      updated_at: '2022-10-11T01:42:53.29Z'
                      application: APgPDQrLD52TYvqazjHJJchM
                      created_via: API
                      currency: USD
                      enabled: true
                      fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
                      identity: IDpYDM7J9n57q849o9E9yNrG
                      instrument_type: BANK_ACCOUNT
                      account_type: SAVINGS
                      bank_account_validation_check: NOT_ATTEMPTED
                      bank_code: '123123123'
                      country: USA
                      masked_account_number: XXXXX3123
                      name: John
                      tags:
                        Bank Account: Company Account
                      type: BANK_ACCOUNT
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9
                        authorizations:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/authorizations
                        transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/transfers
                        verifications:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/verifications
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
                    - id: PIrb1DcGz1qjThotDJ5KURpv
                      created_at: '2022-10-06T20:23:38.74Z'
                      updated_at: '2022-10-06T20:23:38.74Z'
                      application: APgPDQrLD52TYvqazjHJJchM
                      created_via: API
                      currency: USD
                      enabled: true
                      fingerprint: FPRtvYkgcwLUdjq7B4AgxKfmr
                      identity: IDpYDM7J9n57q849o9E9yNrG
                      instrument_type: BANK_ACCOUNT
                      account_type: SAVINGS
                      bank_account_validation_check: NOT_ATTEMPTED
                      bank_code: '666666666'
                      country: USA
                      masked_account_number: XXXXX3123
                      name: test_python
                      tags:
                        bank_account: Test Python Account
                      type: BANK_ACCOUNT
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv
                        authorizations:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/authorizations
                        transfers:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/transfers
                        verifications:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/verifications
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments?offset=14660&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 14679
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createPaymentInstrument:
      description: A single Payment Instrument
      content:
        application/json:
          schema:
            oneOf:
              - title: Payment Instrument - Card
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_card'
              - title: Payment Instrument - Card - Enable Account Updater
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_card'
              - title: Payment Instrument - Card - Enable Network Tokens
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_card'
              - title: Payment Instrument - Bank Account
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_bank'
              - title: Payment Instrument - Plaid Bank Account
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_bank'
              - title: Payment Instrument - Canadian Bank Account
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_bank'
              - title: Payment Instrument - Token - Enable Account Updater
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_card'
              - title: Payment Instrument - Token - Bank Account
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_bank'
              - title: Payment Instrument - Token - Card
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_card'
              - title: Payment Instrument - Token - Enable Network Tokens
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_card'
              - title: Payment Instrument - Apple Pay
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_card'
              - title: Payment Instrument - Google Pay
                allOf:
                  - $ref: '#/components/schemas/payment_instrument_card'
          examples:
            Payment Instrument - Card:
              value:
                id: PI6F5kkcCB3dtGhFy1t8Aua5
                created_at: '2024-11-15T09:42:33.42Z'
                updated_at: '2024-11-15T09:42:33.42Z'
                account_updater_enabled: false
                application: APgPDQrLD52TYvqazjHJJchM
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                instrument_type: PAYMENT_CARD
                address:
                  line1: 900 Metro Center Blv
                  line2: null
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  country: USA
                address_verification: UNKNOWN
                bin: '520082'
                brand: MASTERCARD
                card_type: DEBIT
                expiration_month: 12
                expiration_year: 2029
                issuer_country: NON_USA
                last_four: '8210'
                name: John Smith
                network_token_enabled: false
                network_token_state: NOT_ENABLED
                security_code_verification: UNKNOWN
                tags: {}
                third_party: null
                third_party_token: null
                type: PAYMENT_CARD
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                  updates:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/updates
            Payment Instrument - Card - Enable Account Updater:
              value:
                id: PI6F5kkcCB3dtGhFy1t8Aua5
                created_at: '2024-11-15T09:42:33.42Z'
                updated_at: '2024-11-15T09:42:33.42Z'
                account_updater_enabled: true
                application: APgPDQrLD52TYvqazjHJJchM
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                instrument_type: PAYMENT_CARD
                address:
                  line1: 900 Metro Center Blv
                  line2: null
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  country: USA
                address_verification: UNKNOWN
                bin: '520082'
                brand: MASTERCARD
                card_type: DEBIT
                expiration_month: 12
                expiration_year: 2029
                issuer_country: NON_USA
                last_four: '8210'
                name: John Smith
                network_token_enabled: false
                network_token_state: NOT_ENABLED
                security_code_verification: UNKNOWN
                tags: {}
                third_party: null
                third_party_token: null
                type: PAYMENT_CARD
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                  updates:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/updates
            Payment Instrument - Card - Enable Network Tokens:
              value:
                id: PI6F5kkcCB3dtGhFy1t8Aua5
                created_at: '2024-11-15T09:42:33.42Z'
                updated_at: '2024-11-15T09:42:33.42Z'
                account_updater_enabled: false
                application: APgPDQrLD52TYvqazjHJJchM
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                instrument_type: PAYMENT_CARD
                address:
                  line1: 900 Metro Center Blv
                  line2: null
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  country: USA
                address_verification: UNKNOWN
                bin: '520082'
                brand: MASTERCARD
                card_type: DEBIT
                expiration_month: 12
                expiration_year: 2029
                issuer_country: NON_USA
                last_four: '8210'
                name: John Smith
                network_token_enabled: true
                network_token_state: ENABLED
                security_code_verification: UNKNOWN
                tags: {}
                third_party: null
                third_party_token: null
                type: PAYMENT_CARD
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                  updates:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/updates
            Payment Instrument - Bank Account:
              value:
                id: PIkfiTDWYhQ4VbtQkC1U1ceJ
                created_at: '2024-06-21T04:09:03.77Z'
                updated_at: '2024-06-21T04:09:03.77Z'
                application: APgPDQrLD52TYvqazjHJJchM
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPRxpMNPZbZqVQfcHzRUJnzkR
                identity: IDpYDM7J9n57q849o9E9yNrG
                instrument_type: BANK_ACCOUNT
                account_type: BUSINESS_CHECKING
                bank_account_validation_check: NOT_ATTEMPTED
                bank_code: '122105278'
                country: USA
                institution_number: null
                masked_account_number: XXXXXX0019
                name: Smith & Associates Consulting
                transit_number: null
                tags: {}
                third_party: null
                third_party_token: null
                type: BANK_ACCOUNT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
            Payment Instrument - Plaid Bank Account:
              value:
                id: PItvWj6QGrLbDcdLoovPhD8y
                created_at: '2024-08-02T04:41:32.36Z'
                updated_at: '2024-08-02T04:41:32.36Z'
                application: APrMqXwT4CE9sRjtGaHcYJN7
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPRxAutj19xH1AH6ykGx2dwa7
                identity: IDeA9DMHJooeBhA5YotF7g1u
                instrument_type: BANK_ACCOUNT
                account_type: BUSINESS_CHECKING
                bank_account_validation_check: VALID
                bank_code: '011401533'
                country: USA
                institution_number: null
                masked_account_number: XXXXXXXXXXX0000
                name: Alberta Bobbeth Charleson
                transit_number: null
                tags: {}
                third_party: PLAID
                third_party_token: processor-sandbox-1487e3ec-fd86-40e2-b8d3-c8f260b4340c
                type: BANK_ACCOUNT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PItvWj6QGrLbDcdLoovPhD8y
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PItvWj6QGrLbDcdLoovPhD8y/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PItvWj6QGrLbDcdLoovPhD8y/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PItvWj6QGrLbDcdLoovPhD8y/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APrMqXwT4CE9sRjtGaHcYJN7
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDeA9DMHJooeBhA5YotF7g1u
            Payment Instrument - Canadian Bank Account:
              value:
                id: PI2m36rwpCn5nyDbHkYJ4XUL
                created_at: '2024-08-02T05:32:44.31Z'
                updated_at: '2024-08-02T05:32:44.31Z'
                application: APgPDQrLD52TYvqazjHJJchM
                created_via: API
                currency: CAD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPR8RAHfXm1BMYYVJyHWHhw4J
                identity: IDx2ZETjYiWkbitkYdFt1yLF
                instrument_type: BANK_ACCOUNT
                account_type: PERSONAL_CHECKING
                bank_account_validation_check: NOT_ATTEMPTED
                bank_code: null
                country: CAN
                institution_number: '123'
                masked_account_number: XXXXX3123
                name: John Smith
                transit_number: '12345'
                tags:
                  Bank Account: Company Account
                third_party: null
                third_party_token: null
                type: BANK_ACCOUNT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI2m36rwpCn5nyDbHkYJ4XUL
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI2m36rwpCn5nyDbHkYJ4XUL/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI2m36rwpCn5nyDbHkYJ4XUL/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI2m36rwpCn5nyDbHkYJ4XUL/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDx2ZETjYiWkbitkYdFt1yLF
            Payment Instrument - Token - Enable Account Updater:
              value:
                id: PI6F5kkcCB3dtGhFy1t8Aua5
                created_at: '2024-11-15T09:42:33.42Z'
                updated_at: '2024-11-15T09:42:33.42Z'
                account_updater_enabled: true
                application: APgPDQrLD52TYvqazjHJJchM
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                instrument_type: PAYMENT_CARD
                address:
                  line1: 900 Metro Center Blv
                  line2: null
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  country: USA
                address_verification: UNKNOWN
                bin: '520082'
                brand: MASTERCARD
                card_type: DEBIT
                expiration_month: 12
                expiration_year: 2029
                issuer_country: NON_USA
                last_four: '8210'
                name: John Smith
                network_token_enabled: false
                network_token_state: NOT_ENABLED
                security_code_verification: UNKNOWN
                tags: {}
                third_party: null
                third_party_token: null
                type: PAYMENT_CARD
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                  updates:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/updates
            Payment Instrument - Token - Bank Account:
              value:
                id: PIkfiTDWYhQ4VbtQkC1U1ceJ
                created_at: '2024-06-21T04:09:03.77Z'
                updated_at: '2024-06-21T04:09:03.77Z'
                application: APgPDQrLD52TYvqazjHJJchM
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPRxpMNPZbZqVQfcHzRUJnzkR
                identity: IDpYDM7J9n57q849o9E9yNrG
                instrument_type: BANK_ACCOUNT
                account_type: BUSINESS_CHECKING
                bank_account_validation_check: VALID
                bank_code: '122105278'
                country: USA
                institution_number: null
                masked_account_number: XXXXXX0019
                name: Smith & Associates Consulting
                transit_number: null
                tags: {}
                third_party: null
                third_party_token: null
                type: BANK_ACCOUNT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
            Payment Instrument - Token - Card:
              value:
                id: PImmCg3Po7oNi7jaZcXhfkEu
                created_at: '2022-10-10T05:32:17.78Z'
                updated_at: '2022-10-10T05:32:17.78Z'
                account_updater_enabled: false
                application: APgPDQrLD52TYvqazjHJJchM
                created_via: API
                currency: USD
                enabled: true
                fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                instrument_type: PAYMENT_CARD
                address:
                  line1: 900 Metro Center Blv
                  line2: null
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  country: USA
                address_verification: UNKNOWN
                bin: '520082'
                brand: MASTERCARD
                card_type: DEBIT
                expiration_month: 12
                expiration_year: 2029
                issuer_country: NON_USA
                last_four: '8210'
                name: Amy White
                network_token_enabled: false
                network_token_state: NOT_ENABLED
                security_code_verification: UNKNOWN
                tags:
                  card_name: Business Card
                type: PAYMENT_CARD
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                  updates:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/updates
            Payment Instrument - Token - Enable Network Tokens:
              value:
                id: PI6F5kkcCB3dtGhFy1t8Aua5
                created_at: '2024-11-15T09:42:33.42Z'
                updated_at: '2024-11-15T09:42:33.42Z'
                account_updater_enabled: false
                application: APgPDQrLD52TYvqazjHJJchM
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                instrument_type: PAYMENT_CARD
                address:
                  line1: 900 Metro Center Blv
                  line2: null
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  country: USA
                address_verification: UNKNOWN
                bin: '520082'
                brand: MASTERCARD
                card_type: DEBIT
                expiration_month: 12
                expiration_year: 2029
                issuer_country: NON_USA
                last_four: '8210'
                name: John Smith
                network_token_enabled: true
                network_token_state: ENABLED
                security_code_verification: UNKNOWN
                tags: {}
                third_party: null
                third_party_token: null
                type: PAYMENT_CARD
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                  updates:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/updates
            Payment Instrument - Apple Pay:
              value:
                id: PIwpqpJZCharsZAt6WKVopPS
                created_at: '2025-05-08T18:44:58.56Z'
                updated_at: '2025-05-08T18:44:58.56Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPR88YBDbK4TqYMUNU8t8fbeQ
                identity: IDmj1yA97RS4rMjiQgvK3Vio
                instrument_type: APPLE_PAY
                address:
                  line1: 900 Metro Center Blv
                  line2: APT 200
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  country: USA
                bin: '370382'
                brand: AMERICAN_EXPRESS
                card_type: CREDIT
                expiration_month: 11
                expiration_year: 2024
                issuer_country: USA
                last_four: '8576'
                name: John Smith
                tags: {}
                third_party: null
                third_party_token: null
                type: APPLE_PAY
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIwpqpJZCharsZAt6WKVopPS
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIwpqpJZCharsZAt6WKVopPS/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIwpqpJZCharsZAt6WKVopPS/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIwpqpJZCharsZAt6WKVopPS/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio
            Payment Instrument - Google Pay:
              value:
                id: PIwpqpJZCharsZAt6WKVopPS
                created_at: '2025-05-08T18:44:58.56Z'
                updated_at: '2025-05-08T18:44:58.56Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                created_via: API
                currency: USD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPR88YBDbK4TqYMUNU8t8fbeQ
                identity: IDmj1yA97RS4rMjiQgvK3Vio
                instrument_type: APPLE_PAY
                address:
                  line1: 900 Metro Center Blv
                  line2: APT 200
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  country: USA
                bin: '370382'
                brand: AMERICAN_EXPRESS
                card_type: CREDIT
                expiration_month: 11
                expiration_year: 2024
                issuer_country: USA
                last_four: '8576'
                name: John Smith
                tags: {}
                third_party: null
                third_party_token: null
                type: GOOGLE_PAY
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIwpqpJZCharsZAt6WKVopPS
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIwpqpJZCharsZAt6WKVopPS/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIwpqpJZCharsZAt6WKVopPS/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIwpqpJZCharsZAt6WKVopPS/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listInstrumentHistoryEntries:
      description: List of `Instrument History Entry` objects.
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  instrument_history_entries:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/instrument_history_entry'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Instrument History Entries:
              value:
                _embedded:
                  instrument_history_entries:
                    - id: instrument_history_nAzun1LYhSAJ6rvLeyVAfj
                      created_at: '2025-06-28T00:34:03.17Z'
                      type: NUMBER_AND_EXPIRATION_UPDATED
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      payment_instrument_id: PInVUXZLswZi6pdcK1T41MuE
                      payment_instrument_type: PAYMENT_CARD
                      old_instrument_details:
                        bin: '449677'
                        brand: VISA
                        expiration_month: '1'
                        expiration_year: '2030'
                        last_four: '5767'
                        fingerprint: FPRonNPcX7ifi8SXBgcZs7a52
                      new_instrument_details:
                        bin: '488700'
                        brand: VISA
                        expiration_month: '3'
                        expiration_year: '2040'
                        last_four: '6919'
                        fingerprint: FPRnpe4F5RfPbyKaATT5Udjif
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history?limit=10
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history?limit=10&after_cursor=instrument_history_nAzun1LYhSAJ6rvLeyVAfj
                page:
                  limit: 10
                  next_cursor: instrument_history_nAzun1LYhSAJ6rvLeyVAfj
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listTransfers:
      description: List of `Transfer` objects.
      content:
        application/json:
          schema:
            type: object
            properties:
              _embedded:
                type: object
                properties:
                  transfers:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/transfer'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
              page:
                $ref: '#/components/schemas/page'
          examples:
            List of Transfers:
              value:
                _embedded:
                  transfers:
                    - id: TR8K7zFd9wvEwAG7AvCMLShg
                      created_at: '2025-07-29T17:19:11.26Z'
                      updated_at: '2025-07-29T17:20:02.68Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      additional_purchase_data: null
                      address_verification: null
                      amount: 662154
                      amount_requested: 662154
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      currency: USD
                      destination: PI6iQcTtJNCS8GZAVKYi5Ueb
                      externally_funded: UNKNOWN
                      failure_code: null
                      failure_message: null
                      fee: 0
                      fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                      idempotency_id: null
                      merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                      messages: []
                      operation_key: CARD_NOT_PRESENT_REFUND
                      parent_transfer: TRvU2qRMSYGnJY6dcAXehJqd
                      parent_transfer_trace_id: 1364ccb4-7fb1-4960-9a43-26255d3ed911
                      raw: null
                      ready_to_settle_at: '2025-07-30T17:20:02.74Z'
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: null
                      split_transfers: null
                      state: SUCCEEDED
                      statement_descriptor: FLX*FINIX FLOWERS
                      subtype: API
                      supplemental_fee: null
                      tags:
                        test: Refund
                      tip_amount: null
                      trace_id: 2cdfa359-b9d5-4185-aa66-252a00001ea5
                      type: REVERSAL
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TR8K7zFd9wvEwAG7AvCMLShg
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TR8K7zFd9wvEwAG7AvCMLShg/payment_instruments
                        parent:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRvU2qRMSYGnJY6dcAXehJqd
                        destination:
                          href: >-
                            https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
                    - id: TRbr5dsfHJ7j1s3gkz7gi7vD
                      created_at: '2025-07-29T17:17:50.04Z'
                      updated_at: '2025-07-29T17:17:50.04Z'
                      additional_buyer_charges: null
                      additional_healthcare_data: null
                      additional_purchase_data: null
                      address_verification: null
                      amount: 30
                      amount_requested: 30
                      application: APc9vhYcPsRuTSpKD9KpMtPe
                      currency: USD
                      destination: null
                      externally_funded: 'FALSE'
                      failure_code: null
                      failure_message: null
                      fee: 0
                      fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                      fee_type: CARD_FIXED
                      idempotency_id: null
                      merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                      merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                      messages: []
                      operation_key: null
                      parent_transfer: TRvU2qRMSYGnJY6dcAXehJqd
                      parent_transfer_trace_id: 1364ccb4-7fb1-4960-9a43-26255d3ed911
                      raw: null
                      ready_to_settle_at: '2025-07-30T17:17:50.06Z'
                      receipt_last_printed_at: null
                      security_code_verification: null
                      source: null
                      split_transfers: null
                      state: SUCCEEDED
                      statement_descriptor: null
                      subtype: PLATFORM_FEE
                      supplemental_fee: null
                      tags: {}
                      tip_amount: null
                      trace_id: a6b8af48-8e27-478d-be42-9c4ee9ae893d
                      type: FEE
                      _links:
                        application:
                          href: >-
                            https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRbr5dsfHJ7j1s3gkz7gi7vD
                        merchant_identity:
                          href: >-
                            https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                        payment_instruments:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRbr5dsfHJ7j1s3gkz7gi7vD/payment_instruments
                        parent:
                          href: >-
                            https://finix.sandbox-payments-api.com/transfers/TRvU2qRMSYGnJY6dcAXehJqd
                        fee_profile:
                          href: >-
                            https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers?offset=0&limit=2&sort=created_at,desc&sort=id,desc
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers?offset=2&limit=2&sort=created_at,desc&sort=id,desc
                  last:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers?offset=1254&limit=2&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 2
                  count: 1255
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createTransfer:
      description: A single `Transfer` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/transfer'
          examples:
            Transfer - Minimal Fields:
              value:
                id: TRjiQJ5gRfuVtccFmtn2HYuT
                created_at: '2025-09-26T16:05:10.85Z'
                updated_at: '2025-09-26T16:05:10.85Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 662154
                amount_requested: 662154
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPmtT4MYmiAs1qjLjneQmk4d
                idempotency_id: null
                merchant: MUwfZPNW3r4EqLMzwgr6txw4
                merchant_identity: IDhC29dXMAkbmr1aBpS91Hpx
                messages: []
                network_details:
                  brand: VISA
                  authorization_code: '840735'
                  acquirer_reference_number: null
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-09-27T16:05:11.42Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  test: Sale
                tip_amount: null
                trace_id: a6c5835b-d855-4961-8070-caeaa8e89cbb
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRjiQJ5gRfuVtccFmtn2HYuT
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRjiQJ5gRfuVtccFmtn2HYuT/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRjiQJ5gRfuVtccFmtn2HYuT/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRjiQJ5gRfuVtccFmtn2HYuT/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRjiQJ5gRfuVtccFmtn2HYuT/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
            Transfer - All Fields:
              value:
                id: TR8fezr4xCMFJvH5rzCqrUkF
                created_at: '2025-10-24T17:38:19.09Z'
                updated_at: '2025-10-24T17:38:19.09Z'
                additional_buyer_charges:
                  convenience_amount: 150
                  surcharge_amount: 0
                  rent_surcharge_amount: 0
                additional_healthcare_data: null
                additional_purchase_data:
                  customer_reference_number: 321xyz
                  customs_duty_amount: 10
                  destination_country_code: null
                  destination_postal_code: null
                  discount_amount: 100
                  invoice_reference_number: null
                  order_date: null
                  sales_tax: null
                  sales_tax_finix_generated: 200
                  ship_from_postal_code: null
                  shipping_amount: 100
                  tax_exempt: false
                  item_data:
                    - cost_per_unit: 500
                      item_description: printing paper
                      item_discount_amount: 100
                      merchant_product_code: '1149611'
                      quantity: 1
                      amount_excluding_sales_tax: 400
                      amount_including_sales_tax: 500
                      unit_of_measure: BX
                      commodity_code: 175-62-20
                      sales_tax_amount: 100
                      sales_tax_rate: 0.25
                    - cost_per_unit: 500
                      item_description: printing ink
                      item_discount_amount: 0
                      merchant_product_code: '2149612'
                      quantity: 1
                      amount_excluding_sales_tax: 400
                      amount_including_sales_tax: 500
                      unit_of_measure: CTN
                      commodity_code: 207-72-54
                      sales_tax_amount: 100
                      sales_tax_rate: 0.25
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 1000
                amount_requested: 1000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FP9F2KEnY4wt1XjFvhLBJVjb
                idempotency_id: '1234567890'
                ip_address_details: null
                merchant: MUe17jKSrfPetoeiJQzzjmA2
                merchant_identity: ID6NvZy42D7PChZL8GKKD87F
                messages: []
                network_details:
                  brand: VISA
                  authorization_code: '252819'
                  acquirer_reference_number: null
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: null
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                split_transfers:
                  - split_transfer_8fv2kE5eWtCvru1NG5gyRL
                  - split_transfer_8fvi9GJdhMbpWWJwKkHzct
                state: SUCCEEDED
                statement_descriptor: FLX*FLEX GYM
                subtype: API
                supplemental_fee: null
                tags:
                  tip: '50'
                tip_amount: null
                trace_id: 0db5b7cf-6fe3-4508-ac52-15b26b9b5e0a
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID6NvZy42D7PChZL8GKKD87F
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR8fezr4xCMFJvH5rzCqrUkF/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FP9F2KEnY4wt1XjFvhLBJVjb
            Transfer - Canada - EFT:
              value:
                id: PIrHuevkDx1FwLSy4ADkPiCz
                created_at: '2025-10-20T16:15:41.10Z'
                updated_at: '2025-10-20T16:15:41.10Z'
                application: APc9vhYcPsRuTSpKD9KpMtPe
                created_via: API
                currency: CAD
                disabled_code: null
                disabled_message: null
                enabled: true
                fingerprint: FPR8RAHfXm1BMYYVJyHWHhw4J
                identity: ID6UfSm1d4WPiWgLYmbyeo3H
                instrument_type: BANK_ACCOUNT
                account_type: PERSONAL_CHECKING
                bank_account_validation_check: NOT_ATTEMPTED
                bank_code: null
                country: CAN
                institution_number: '123'
                masked_account_number: XXXXX3123
                name: John Smith
                transit_number: '12345'
                tags: {}
                third_party: null
                third_party_token: null
                type: BANK_ACCOUNT
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIrHuevkDx1FwLSy4ADkPiCz
                  authorizations:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIrHuevkDx1FwLSy4ADkPiCz/authorizations
                  transfers:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIrHuevkDx1FwLSy4ADkPiCz/transfers
                  verifications:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIrHuevkDx1FwLSy4ADkPiCz/verifications
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
            Transfer - 3D Secure:
              value:
                id: TRXiBHF86S1swrF8BvtpDkz
                created_at: '2025-07-25T17:44:35.97Z'
                updated_at: '2025-07-25T17:44:35.97Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 92169
                amount_requested: 92169
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-07-26T17:44:36.37Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  test: Sale
                tip_amount: null
                trace_id: 49083850-cd42-4ca7-80aa-893cca670b12
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRXiBHF86S1swrF8BvtpDkz
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRXiBHF86S1swrF8BvtpDkz/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRXiBHF86S1swrF8BvtpDkz/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRXiBHF86S1swrF8BvtpDkz/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRXiBHF86S1swrF8BvtpDkz/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Bank Payout:
              value:
                id: TRhwTNwDQYAe25or8f3ahw17
                created_at: '2025-08-14T20:59:09.39Z'
                updated_at: '2025-08-14T20:59:09.39Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 15000
                amount_requested: 15000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: PI95jTbyzcdjhWsgFEK6vqSU
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPmtT4MYmiAs1qjLjneQmk4d
                idempotency_id: null
                merchant: MU2bESfmfedhA2SjcymNvSAX
                merchant_identity: IDA3M8ueFuXaJex7N6jcAR9
                messages: []
                network_details: {}
                operation_key: PUSH_TO_ACH
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: null
                receipt_last_printed_at: null
                security_code_verification: null
                source: null
                split_transfers: []
                state: PENDING
                statement_descriptor: null
                subtype: API
                supplemental_fee: null
                tags: {}
                tip_amount: null
                trace_id: 340c933b-309c-43fd-b2a4-de6b6f9bd246
                type: CREDIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRhwTNwDQYAe25or8f3ahw17
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRhwTNwDQYAe25or8f3ahw17/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRhwTNwDQYAe25or8f3ahw17/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRhwTNwDQYAe25or8f3ahw17/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRhwTNwDQYAe25or8f3ahw17/disputes
                  destination:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
            Transfer - Bank Payout - Same Day:
              value:
                id: TRxjGTvFYSESwnAjGUD5TM1U
                created_at: '2025-08-15T13:37:30.38Z'
                updated_at: '2025-08-15T13:37:30.38Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 15000
                amount_requested: 15000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: PI95jTbyzcdjhWsgFEK6vqSU
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPmtT4MYmiAs1qjLjneQmk4d
                idempotency_id: null
                merchant: MU2bESfmfedhA2SjcymNvSAX
                merchant_identity: IDA3M8ueFuXaJex7N6jcAR9
                messages: []
                network_details: null
                operation_key: PUSH_TO_SAME_DAY_ACH
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: null
                receipt_last_printed_at: null
                security_code_verification: null
                source: null
                split_transfers: []
                state: PENDING
                statement_descriptor: null
                subtype: API
                supplemental_fee: null
                tags: {}
                tip_amount: null
                trace_id: d7f9404e-38ea-4c88-8901-808fd2cf7aad
                type: CREDIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRxjGTvFYSESwnAjGUD5TM1U
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRxjGTvFYSESwnAjGUD5TM1U/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRxjGTvFYSESwnAjGUD5TM1U/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRxjGTvFYSESwnAjGUD5TM1U/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRxjGTvFYSESwnAjGUD5TM1U/disputes
                  destination:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
            Transfer - Convenience Fee:
              value:
                id: TRgzK3t5Shiwbk5evzPKD7La
                created_at: '2025-07-25T17:47:54.72Z'
                updated_at: '2025-07-25T17:47:54.72Z'
                additional_buyer_charges:
                  convenience_amount: 150
                  surcharge_amount: 0
                  rent_surcharge_amount: 0
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 5200
                amount_requested: 5200
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-07-26T17:47:55.17Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  test: Sale
                tip_amount: null
                trace_id: 1267a025-efb5-4256-956f-c94cef820451
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Card Payout:
              value:
                id: TRwgvfcXeVKrPsVbFYn6FNUm
                created_at: '2025-08-14T21:45:12.98Z'
                updated_at: '2025-08-14T21:45:12.98Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 15000
                amount_requested: 15000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: PIveyqg2bVkKo6SHsstxBSDc
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPmtT4MYmiAs1qjLjneQmk4d
                idempotency_id: null
                merchant: MUuNdhs7uVYcjocWugeBbpRo
                merchant_identity: IDbPrApp2adDVqG4QQzoo58E
                messages: []
                network_details: {}
                operation_key: PUSH_TO_CARD
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: null
                receipt_last_printed_at: null
                security_code_verification: null
                source: null
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: null
                subtype: API
                supplemental_fee: null
                tags: {}
                tip_amount: null
                trace_id: 73638df5-1907-4094-a3ff-f573d7f3e347
                type: CREDIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRwgvfcXeVKrPsVbFYn6FNUm
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDbPrApp2adDVqG4QQzoo58E
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRwgvfcXeVKrPsVbFYn6FNUm/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRwgvfcXeVKrPsVbFYn6FNUm/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRwgvfcXeVKrPsVbFYn6FNUm/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRwgvfcXeVKrPsVbFYn6FNUm/disputes
                  destination:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIveyqg2bVkKo6SHsstxBSDc
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
            Transfer - Card Present:
              value:
                id: TRuuwYpzXQsxNRY77CVvcJJp
                created_at: '2025-07-25T18:19:28.11Z'
                updated_at: '2025-07-25T18:19:28.11Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 150
                amount_requested: 150
                application: APc9vhYcPsRuTSpKD9KpMtPe
                card_present_details:
                  emv_data:
                    application_identifier: null
                    application_label: null
                    application_preferred_name: null
                    application_transaction_counter: null
                    cryptogram: null
                    issuer_code_table_index: null
                    network_emv_response: null
                    pin_verified: false
                    tags: null
                  masked_account_number: null
                  name: null
                  brand: null
                  entry_mode: UNKNOWN
                  payment_type: null
                  approval_code: null
                  digital_signature_file_id: null
                currency: USD
                destination: null
                device: DVhXqP9onzhA7sxheKXoBc3J
                externally_funded: UNKNOWN
                failure_code: DEVICE_UNREACHABLE
                failure_message: >-
                  The API request could not communicate with the device. Please
                  try again.
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages:
                  - RAW MESSAGE
                operation_key: CARD_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: null
                receipt_last_printed_at: null
                security_code_verification: null
                source: PI9hTsZF8ms387bxNv5FmPyU
                split_transfers: []
                state: FAILED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags: {}
                tip_amount: null
                trace_id: 70bbc88e-83db-4efe-a4ab-eb54cd6da5fe
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRuuwYpzXQsxNRY77CVvcJJp
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  device:
                    href: >-
                      https://finix.sandbox-payments-api.com/devices/DVhXqP9onzhA7sxheKXoBc3J
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRuuwYpzXQsxNRY77CVvcJJp/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRuuwYpzXQsxNRY77CVvcJJp/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRuuwYpzXQsxNRY77CVvcJJp/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRuuwYpzXQsxNRY77CVvcJJp/disputes
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Card Present - Unreferenced Refund:
              value:
                id: TRo5JpCqMY26ufvRdTJ8715j
                created_at: '2025-11-19T20:31:16.48Z'
                updated_at: '2025-11-19T20:31:16.48Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 150
                amount_requested: 150
                application: APc9vhYcPsRuTSpKD9KpMtPe
                card_present_details:
                  emv_data:
                    application_identifier: A0000000041010
                    application_label: Mastercard Debit
                    application_preferred_name: null
                    application_transaction_counter: 01D2
                    cryptogram: ARQC 579B6893AADF6245
                    issuer_code_table_index: null
                    network_emv_response: null
                    pin_verified: false
                    tags: null
                  masked_account_number: 523499******4130
                  name: null
                  brand: UNKNOWN
                  entry_mode: CONTACTLESS
                  payment_type: CREDIT
                  approval_code: '674313'
                  digital_signature_file_id: null
                currency: USD
                destination: PInqirmUHFh1FmPNa8reirAb
                device: DVoDo7F6yYCnX2d6Fj9hvsd
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPmtT4MYmiAs1qjLjneQmk4d
                idempotency_id: null
                ip_address_details: null
                merchant: MUsMvN47nRtdgUkE23SRHDC6
                merchant_identity: IDgu8uaRpVnfSEcRcZFXqpjK
                messages: []
                network_details: null
                operation_key: CARD_PRESENT_UNREFERENCED_REFUND
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-11-20T20:32:38.76Z'
                receipt_last_printed_at: null
                security_code_verification: null
                source: null
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags: {}
                third_party_details: null
                tip_amount: null
                trace_id: 23f1fdf9-2783-4bbe-8de2-afd7a7502aad
                type: CREDIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRo5JpCqMY26ufvRdTJ8715j
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDgu8uaRpVnfSEcRcZFXqpjK
                  device:
                    href: >-
                      https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRo5JpCqMY26ufvRdTJ8715j/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRo5JpCqMY26ufvRdTJ8715j/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRo5JpCqMY26ufvRdTJ8715j/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRo5JpCqMY26ufvRdTJ8715j/disputes
                  destination:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PInqirmUHFh1FmPNa8reirAb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
            Transfer - Card Verification Checks:
              value:
                id: TR5DDk2jDBPwyASBR7m5WraS
                created_at: '2025-07-25T17:59:45.18Z'
                updated_at: '2025-07-25T17:59:45.18Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 92169
                amount_requested: 92169
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-07-26T17:59:45.52Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  order_number: 21DFASJSAKAS
                tip_amount: null
                trace_id: 4b899b87-781e-40a5-be7c-051b75eb5d5e
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5DDk2jDBPwyASBR7m5WraS
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5DDk2jDBPwyASBR7m5WraS/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5DDk2jDBPwyASBR7m5WraS/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5DDk2jDBPwyASBR7m5WraS/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5DDk2jDBPwyASBR7m5WraS/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Debit Bank Account:
              value:
                id: TRbJcpXFnNnwcdzWTQX1wnYr
                created_at: '2025-07-25T18:01:07.76Z'
                updated_at: '2025-07-25T18:01:07.76Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 6031
                amount_requested: 6031
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: null
                receipt_last_printed_at: null
                security_code_verification: null
                source: PI9XuhFdFzJ5V9aGYUm6XtH
                split_transfers: []
                state: PENDING
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  order_number: 21DFASJSAKAS
                tip_amount: null
                trace_id: cc45e290-8c5c-4a76-9546-17d242964206
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRbJcpXFnNnwcdzWTQX1wnYr
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRbJcpXFnNnwcdzWTQX1wnYr/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRbJcpXFnNnwcdzWTQX1wnYr/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRbJcpXFnNnwcdzWTQX1wnYr/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRbJcpXFnNnwcdzWTQX1wnYr/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI9XuhFdFzJ5V9aGYUm6XtH
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Fee Profile:
              value:
                id: TRVNNyaEoNAAAZPx23sGfou
                created_at: '2025-08-18T22:45:24.69Z'
                updated_at: '2025-08-18T22:45:24.69Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 662154
                amount_requested: 662154
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FP9F2KEnY4wt1XjFvhLBJVjb
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                network_details:
                  brand: VISA
                  authorization_code: '060103'
                  acquirer_reference_number: null
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-08-19T22:45:25.19Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags: {}
                tip_amount: null
                trace_id: 6fcee4cc-1700-4bd8-bed2-3293ef89530b
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRVNNyaEoNAAAZPx23sGfou
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRVNNyaEoNAAAZPx23sGfou/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRVNNyaEoNAAAZPx23sGfou/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRVNNyaEoNAAAZPx23sGfou/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRVNNyaEoNAAAZPx23sGfou/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FP9F2KEnY4wt1XjFvhLBJVjb
            Transfer - Fraud Detection:
              value:
                id: TR3BbbNGZCEzsnNkskXrthYM
                created_at: '2025-08-14T17:42:43.77Z'
                updated_at: '2025-08-14T17:42:43.77Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 662154
                amount_requested: 662154
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                network_details:
                  brand: VISA
                  authorization_code: '787315'
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-08-15T17:42:44.19Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  test: Sale
                tip_amount: null
                trace_id: 88fc0138-6b7e-42f5-a752-37641090d96b
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR3BbbNGZCEzsnNkskXrthYM
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR3BbbNGZCEzsnNkskXrthYM/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR3BbbNGZCEzsnNkskXrthYM/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR3BbbNGZCEzsnNkskXrthYM/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR3BbbNGZCEzsnNkskXrthYM/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Gaming:
              value:
                id: TR5CopDRpcDZWigugCV5eVhQ
                created_at: '2025-11-07T20:05:45.74Z'
                updated_at: '2025-11-07T20:05:45.74Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 100
                amount_requested: 100
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPmtT4MYmiAs1qjLjneQmk4d
                idempotency_id: null
                ip_address_details: null
                merchant: MUmKTKuetVV1MQ5Cq6rjWA5j
                merchant_identity: IDsuVDUYpUS2pzqQVsuUZzNH
                messages: []
                network_details:
                  brand: VISA
                  authorization_code: '911285'
                  acquirer_reference_number: null
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-11-08T20:05:46.24Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  order_number: 21DFASJSAKAS
                tip_amount: null
                trace_id: 805be8ef-a04d-4068-9cca-4c0d998e4484
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5CopDRpcDZWigugCV5eVhQ
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDsuVDUYpUS2pzqQVsuUZzNH
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5CopDRpcDZWigugCV5eVhQ/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5CopDRpcDZWigugCV5eVhQ/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5CopDRpcDZWigugCV5eVhQ/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR5CopDRpcDZWigugCV5eVhQ/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
            Transfer - HSA or FSA Card for Non-Healthcare MCC:
              value:
                id: TRt1zYnvR1CfWgcFwo4RADAw
                created_at: '2025-07-25T17:43:20.49Z'
                updated_at: '2025-07-25T17:43:20.49Z'
                additional_buyer_charges: null
                additional_healthcare_data:
                  clinic_amount: 50
                  dental_amount: 200
                  prescription_amount: 300
                  vision_amount: 300
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 662154
                amount_requested: 662154
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-07-26T17:43:20.97Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  test: Sale
                tip_amount: null
                trace_id: 036fad58-1708-4e43-a67c-fcbdf8213b0e
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRt1zYnvR1CfWgcFwo4RADAw
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRt1zYnvR1CfWgcFwo4RADAw/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRt1zYnvR1CfWgcFwo4RADAw/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRt1zYnvR1CfWgcFwo4RADAw/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRt1zYnvR1CfWgcFwo4RADAw/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Level 2 Processing:
              value:
                id: TR96bu4Szu8dEKUMs1wDUW5z
                created_at: '2025-07-25T18:07:41.41Z'
                updated_at: '2025-07-25T18:07:41.41Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data:
                  customer_reference_number: 321xyz
                  customs_duty_amount: null
                  destination_country_code: null
                  destination_postal_code: null
                  discount_amount: null
                  invoice_reference_number: null
                  order_date: null
                  sales_tax: 200
                  sales_tax_finix_generated: null
                  ship_from_postal_code: null
                  shipping_amount: null
                  tax_exempt: false
                  item_data: []
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 1000
                amount_requested: 1000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-07-26T18:07:41.87Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  test: Sale
                tip_amount: null
                trace_id: b0c469c5-21a4-43a1-915d-df72a297d039
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR96bu4Szu8dEKUMs1wDUW5z
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR96bu4Szu8dEKUMs1wDUW5z/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR96bu4Szu8dEKUMs1wDUW5z/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR96bu4Szu8dEKUMs1wDUW5z/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR96bu4Szu8dEKUMs1wDUW5z/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Level 3 Processing:
              value:
                id: TRgnpzmp9nqLiVUfVzLAXkuU
                created_at: '2025-07-25T18:09:20.32Z'
                updated_at: '2025-07-25T18:09:20.32Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data:
                  customer_reference_number: 321xyz
                  customs_duty_amount: 10
                  destination_country_code: null
                  destination_postal_code: null
                  discount_amount: 100
                  invoice_reference_number: null
                  order_date: null
                  sales_tax: null
                  sales_tax_finix_generated: 200
                  ship_from_postal_code: null
                  shipping_amount: 100
                  tax_exempt: false
                  item_data:
                    - cost_per_unit: 500
                      item_description: printing paper
                      item_discount_amount: 100
                      merchant_product_code: '1149611'
                      quantity: 1
                      amount_excluding_sales_tax: 400
                      amount_including_sales_tax: 500
                      unit_of_measure: BX
                      commodity_code: 175-62-20
                      sales_tax_amount: 100
                      sales_tax_rate: 0.25
                    - cost_per_unit: 500
                      item_description: printing ink
                      item_discount_amount: 0
                      merchant_product_code: '2149612'
                      quantity: 1
                      amount_excluding_sales_tax: 400
                      amount_including_sales_tax: 500
                      unit_of_measure: CTN
                      commodity_code: 207-72-54
                      sales_tax_amount: 100
                      sales_tax_rate: 0.25
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 1000
                amount_requested: 1000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-07-26T18:09:20.74Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  test: Sale
                tip_amount: null
                trace_id: a50cc8db-80f9-4164-95a2-7c1ae97d1de8
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgnpzmp9nqLiVUfVzLAXkuU
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgnpzmp9nqLiVUfVzLAXkuU/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgnpzmp9nqLiVUfVzLAXkuU/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgnpzmp9nqLiVUfVzLAXkuU/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgnpzmp9nqLiVUfVzLAXkuU/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Partial Authorization:
              value:
                id: TR6HUQSPWLrmk5tYgCn24nwi
                created_at: '2024-12-23T09:13:32.29Z'
                updated_at: '2024-12-23T09:13:32.29Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 662154
                amount_requested: 662154
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2024-12-24T09:13:32.90Z'
                receipt_last_printed_at: null
                security_code_verification: null
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: 0
                tags:
                  test: Sale
                tip_amount: null
                trace_id: 77ff190a-3080-4a37-8bbe-2dd592d62615
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR6HUQSPWLrmk5tYgCn24nwi
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR6HUQSPWLrmk5tYgCn24nwi/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR6HUQSPWLrmk5tYgCn24nwi/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR6HUQSPWLrmk5tYgCn24nwi/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TR6HUQSPWLrmk5tYgCn24nwi/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d
            Transfer - Rent Surcharge:
              value:
                id: TRgzK3t5Shiwbk5evzPKD7La
                created_at: '2025-07-25T17:47:54.72Z'
                updated_at: '2025-07-25T17:47:54.72Z'
                additional_buyer_charges:
                  convenience_amount: 0
                  surcharge_amount: 1000
                  rent_surcharge_amount: 0
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: POSTAL_CODE_AND_STREET_MATCH
                amount: 1001000
                amount_requested: 1001000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: '2025-07-26T17:47:55.17Z'
                receipt_last_printed_at: null
                security_code_verification: MATCHED
                source: PIkxmtueemLD6dN9ZoWGHT44
                split_transfers: []
                state: SUCCEEDED
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  test: Sale
                tip_amount: null
                trace_id: 1267a025-efb5-4256-956f-c94cef820451
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRgzK3t5Shiwbk5evzPKD7La/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Split Transaction:
              value:
                id: TRg3hFJA7ehUUdL3ESPcmVoK
                created_at: '2025-07-25T18:23:34.84Z'
                updated_at: '2025-07-25T18:23:34.84Z'
                additional_buyer_charges: null
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 1000
                amount_requested: 1000
                application: APc9vhYcPsRuTSpKD9KpMtPe
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPuizPqrhzYLbmJm88u7aqfj
                idempotency_id: null
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                merchant_identity: ID6UfSm1d4WPiWgLYmbyeo3H
                messages: []
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: null
                receipt_last_printed_at: null
                security_code_verification: null
                source: PI5benj4eVhCL4ALMv6SFxJG
                split_transfers:
                  - split_transfer_g3u5u78CtARkwhmhGGPuxo
                  - split_transfer_g3ufcahLMDJ1pbrydnRHy1
                state: PENDING
                statement_descriptor: FLX*FINIX FLOWERS
                subtype: API
                supplemental_fee: null
                tags:
                  test: Sale
                tip_amount: null
                trace_id: bb498bff-7c92-454e-8999-3d024b89b012
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRg3hFJA7ehUUdL3ESPcmVoK
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/ID6UfSm1d4WPiWgLYmbyeo3H
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRg3hFJA7ehUUdL3ESPcmVoK/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRg3hFJA7ehUUdL3ESPcmVoK/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRg3hFJA7ehUUdL3ESPcmVoK/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRg3hFJA7ehUUdL3ESPcmVoK/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PI5benj4eVhCL4ALMv6SFxJG
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj
            Transfer - Surcharge:
              value:
                id: TRrdTfkfvBAxWC7dCRfgKETT
                created_at: '2025-11-10T16:32:07.18Z'
                updated_at: '2025-11-10T16:32:07.18Z'
                additional_buyer_charges:
                  convenience_amount: 0
                  surcharge_amount: 700
                  rent_surcharge_amount: 0
                additional_healthcare_data: null
                additional_purchase_data: null
                address_verification: null
                amount: 10000
                amount_requested: 10000
                application: APgPDQrLD52TYvqazjHJJchM
                currency: USD
                destination: null
                externally_funded: UNKNOWN
                failure_code: null
                failure_message: null
                fee: 0
                fee_profile: FPvCQUcnsueN3Bc3zR1qCBG8
                idempotency_id: null
                ip_address_details: null
                merchant: MU3PLsrxmHcKRKhSoHDJ2FPP
                merchant_identity: IDjGTCVZzVCksPLtj63EJmSZ
                messages: []
                network_details: null
                operation_key: CARD_NOT_PRESENT_SALE
                parent_transfer: null
                parent_transfer_trace_id: null
                raw: null
                ready_to_settle_at: null
                receipt_last_printed_at: null
                security_code_verification: null
                source: PImn9EAtceoUcBoXG2n73LY9
                split_transfers: []
                state: PENDING
                statement_descriptor: FNX*CURRENT-PAYMENT
                subtype: API
                supplemental_fee: null
                tags: {}
                tip_amount: null
                trace_id: 71855e3c-9d7e-44c4-8693-3f0b2c3b9cbf
                type: DEBIT
                _links:
                  application:
                    href: >-
                      https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRrdTfkfvBAxWC7dCRfgKETT
                  merchant_identity:
                    href: >-
                      https://finix.sandbox-payments-api.com/identities/IDjGTCVZzVCksPLtj63EJmSZ
                  payment_instruments:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRrdTfkfvBAxWC7dCRfgKETT/payment_instruments
                  reversals:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRrdTfkfvBAxWC7dCRfgKETT/reversals
                  fees:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRrdTfkfvBAxWC7dCRfgKETT/fees
                  disputes:
                    href: >-
                      https://finix.sandbox-payments-api.com/transfers/TRrdTfkfvBAxWC7dCRfgKETT/disputes
                  source:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_instruments/PImn9EAtceoUcBoXG2n73LY9
                  fee_profile:
                    href: >-
                      https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
            Transfer - Tip:
              value:
                amount: 3000
                currency: USD
                merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                source: PI6iQcTtJNCS8GZAVKYi5Ueb
                tags:
                  tip: 800
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createOnboardingForm:
      description: A single Onboarding Form
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/onboarding_form'
          examples:
            Onboarding Form - Minimal Fields:
              value:
                id: obf_kpi8NNNvWfB2GpxdKALxzb
                onboarding_data:
                  max_transaction_amount: 100000
                  country: USA
                  associated_files: []
                merchant_processors:
                  - processor: DUMMY_V1
                onboarding_link_details:
                  return_url: https://www.democompany.com/home
                  expired_session_url: https://www.democompany.com/login
                  fee_details_url: https://www.democompany.com/fee_details
                  terms_of_service_url: https://www.democompany.com/ToS
                  expiration_in_minutes: 10080
                onboarding_link:
                  expires_at: '2025-12-17T20:48:42.767Z'
                  link_url: >-
                    https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_kpi8NNNvWfB2GpxdKALxzb&applicationId=APc9vhYcPsRuTSpKD9KpMtPe&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfa3BpOE5OTnZXZkIyR3B4ZEtBTHh6YiIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmRlbW9jb21wYW55LmNvbS9mZWVfZGV0YWlscyIsImV4cGlyZWRfc2Vzc2lvbl91cmwiOiJodHRwczovL3d3dy5kZW1vY29tcGFueS5jb20vbG9naW4iLCJtZXJjaGFudF9hY2hfbWF4X3RyYW5zYWN0aW9uX2Ftb3VudCI6bnVsbCwiaXNzIjoiaHR0cHM6Ly93d3cuZmluaXguY29tIiwicmV0dXJuX3VybCI6Imh0dHBzOi8vd3d3LmRlbW9jb21wYW55LmNvbS9ob21lIiwiZXhwIjoxNzY2MDA0NTIyLCJhcHBsaWNhdGlvbl9pZCI6IkFQYzl2aFljUHNSdVRTcEtEOUtwTXRQZSIsImlhdCI6MTc2NTM5OTcyMiwibWVyY2hhbnRfbWF4X3RyYW5zYWN0aW9uX2Ftb3VudCI6MTAwMDAwLCJ0ZXJtc19vZl9zZXJ2aWNlX3VybCI6Imh0dHBzOi8vd3d3LmRlbW9jb21wYW55LmNvbS9Ub1MifQ.454Ll9XsjyKpYHA3n7D6XJH9KB430bG1hf2NEGXXLCaaJYdf6n4FwiFBlLxNcx_6Jr2DnOCBxAykEJX-C4_tGQ
                status: IN_PROGRESS
                identity_id: null
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                created_at: '2025-12-10T20:48:42.754119Z'
                updated_at: '2025-12-10T20:48:42.754119Z'
                tags: {}
            Onboarding Form - All Fields:
              value:
                id: obf_6ifdXromWyVHRVjRx5dRXt
                onboarding_data:
                  entity:
                    title: CEO
                    first_name: John
                    last_name: Smith
                    email: john.smith@finix.com
                    business_name: Finix Flowers
                    business_type: CORPORATION
                    doing_business_as: Finix Flowers
                    phone: '14158885080'
                    business_phone: '14158885080'
                    mcc: '4900'
                    url: https://www.finix.com
                    ownership_type: PRIVATE
                    default_statement_descriptor: DEMOCOMPANY
                    annual_card_volume: '1000000'
                    principal_percentage_ownership: '75'
                    tax_id: '*****6789'
                    business_tax_id: '*****6789'
                    has_accepted_credit_cards_previously: false
                    personal_address:
                      line1: 123 Boren Ave
                      city: Seattle
                      region: WA
                      postal_code: '98040'
                      country: USA
                    business_address:
                      line1: 123 Bellevue Way
                      city: Bellevue
                      region: WA
                      postal_code: '98039'
                      country: USA
                    dob:
                      day: 13
                      month: 4
                      year: 1982
                    incorporation_date:
                      day: 9
                      month: 3
                      year: 2018
                  associated_entities:
                    - title: CFO
                      first_name: Alex
                      last_name: Smith
                      email: alex.smith@finix.com
                      phone: '14158885080'
                      personal_address:
                        line1: 4848 84th St
                        city: Bellevue
                        region: WA
                        postal_code: '98032'
                        country: USA
                      dob:
                        day: 13
                        month: 4
                        year: 1985
                      principal_percentage_ownership: 25
                      tax_id: '*****6789'
                  payment_instruments:
                    name: SARAH BANKER
                    bank_code: '123456789'
                    account_number: '*****6789'
                    account_type: CHECKING
                    type: BANK_ACCOUNT
                    country: USA
                    currency: USD
                  additional_underwriting_data:
                    refund_policy: NO_REFUNDS
                    average_ach_transfer_amount: 200000
                    average_card_transfer_amount: 20000
                    merchant_agreement_ip_address: 42.1.1.113
                    merchant_agreement_accepted: true
                    merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
                    merchant_agreement_user_agent: Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)
                    credit_check_timestamp: null
                    credit_check_user_agent: null
                    annual_ach_volume: 2000000
                    business_description: CONSUMER
                    volume_distribution_by_business_type:
                      other_volume_percentage: 0
                      person_to_person_volume_percentage: 0
                      business_to_business_volume_percentage: 90
                      business_to_consumer_volume_percentage: 10
                      consumer_to_consumer_volume_percentage: 0
                    card_volume_distribution:
                      ecommerce_percentage: 100
                      card_present_percentage: 0
                      mail_order_telephone_order_percentage: 0
                    amex_marketing_consent:
                      accepted: false
                      ip_address: 42.1.1.113
                      user_agent: Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)
                      timestamp: '2021-04-28T16:42:55Z'
                  max_transaction_amount: 100000
                  ach_max_transaction_amount: 100000
                  country: USA
                  associated_files: []
                merchant_processors:
                  - processor: LITLE_V1
                onboarding_link_details:
                  return_url: https://www.democompany.com/home
                  expired_session_url: https://www.democompany.com/login
                  fee_details_url: https://www.democompany.com/fee_details
                  merchant_max_transaction_amount: 100000
                  merchant_ach_max_transaction_amount: 100000
                  terms_of_service_url: https://www.democompany.com/ToS
                  expiration_in_minutes: 10080
                onboarding_link:
                  expires_at: '2025-12-17T20:38:21.642Z'
                  link_url: >-
                    https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_6ifdXromWyVHRVjRx5dRXt&applicationId=APc9vhYcPsRuTSpKD9KpMtPe&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfNmlmZFhyb21XeVZIUlZqUng1ZFJYdCIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmRlbW9jb21wYW55LmNvbS9mZWVfZGV0YWlscyIsImV4cGlyZWRfc2Vzc2lvbl91cmwiOiJodHRwczovL3d3dy5kZW1vY29tcGFueS5jb20vbG9naW4iLCJtZXJjaGFudF9hY2hfbWF4X3RyYW5zYWN0aW9uX2Ftb3VudCI6MTAwMDAwLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZGVtb2NvbXBhbnkuY29tL2hvbWUiLCJleHAiOjE3NjYwMDM5MDEsImFwcGxpY2F0aW9uX2lkIjoiQVBjOXZoWWNQc1J1VFNwS0Q5S3BNdFBlIiwiaWF0IjoxNzY1Mzk5MTAxLCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZGVtb2NvbXBhbnkuY29tL1RvUyJ9.3nL570FQLPj8jRT4wBI959mg1g8dEmj4fEFgaDWAwBBGFRmCv0w-F7R5YxdDmPJfoiNh1uud6fR8UrI1azejWA
                status: IN_PROGRESS
                identity_id: null
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                created_at: '2025-12-10T20:38:21.628367Z'
                updated_at: '2025-12-10T20:38:21.628367Z'
                tags: {}
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createOnboardingLink:
      description: A single Onboarding Link
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/onboarding_link'
          examples:
            Onboarding Link:
              value:
                expires_at: '2022-07-11T22:39:55.469Z'
                link_url: >-
                  https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_bXQj8iSgYwXf432yJcWbKv&applicationId=APgPDQrLD52TYvqazjHJJchM&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfYlhRajhpU2dZd1hmNDMyeUpjV2JLdiIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS9kb2NzIiwiZXhwaXJlZF9zZXNzaW9uX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS8iLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL2RvY3MiLCJleHAiOjE2NTc1NzkxOTUsImFwcGxpY2F0aW9uX2lkIjoiQVBnUERRckxENTJUWXZxYXpqSEpKY2hNIiwiaWF0IjoxNjU3NTc3Mzk1LCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL3Rlcm1zLWFuZC1wb2xpY2llcyJ9.uQvwqhOxSmpX4zMSVn891ClNB_cWHmXhLfyOzRiKRoyn7VAqVOWrO8dJiY-OvN4venPWnPOxM0r3NiIyfgQv6g
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listPaymentLinks:
      description: Payment Links List
      content:
        application/json:
          schema:
            type: object
            properties:
              _embedded:
                type: object
                properties:
                  payment_links:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/payment_link'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
              page:
                $ref: '#/components/schemas/page'
          examples:
            List of Payment Links:
              value:
                _embedded:
                  payment_links:
                    - id: payment_link_ctbnRm2yVJ7nwpBjmSF6k
                      created_at: '2025-10-16T18:48:50.49Z'
                      updated_at: '2025-10-16T18:48:50.75Z'
                      additional_details:
                        collect_billing_address: false
                        collect_email: true
                        collect_name: true
                        collect_phone: false
                        collect_shipping_address: false
                        expiration_in_minutes: 1576800
                        expired_session_url: https://mybasketball-leaguexyz.com/expired
                        receipt_requested_delivery_methods:
                          - type: EMAIL
                            destinations:
                              - abc@test.com
                          - type: SMS
                            destinations:
                              - '2348765431'
                        send_receipt: true
                        success_return_url: https://mybasketball-leaguexyz.com/success
                        terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                        unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                      allowed_payment_methods:
                        - PAYMENT_CARD
                      amount_details:
                        amount_breakdown: null
                        amount_type: FIXED
                        currency: USD
                        max_amount: null
                        min_amount: null
                        total_amount: 7500
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      attempt_level_two_level_three_payment: false
                      branding:
                        accent_color: '#f3eeee'
                        brand_color: '#111823'
                        button_font_color: '#111823'
                        icon: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                        logo: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                        logo_alternative_text: Alternative text
                      buyer_details: null
                      is_authorization: true
                      is_multiple_use: false
                      items:
                        - description: null
                          image_details:
                            primary_image_url: >-
                              https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                            alternative_image_urls: []
                          item_details: null
                          name: Holiday Dinner Contribution
                          price_details:
                            sale_amount: 7500
                            currency: USD
                            price_type: null
                            regular_amount: 0
                            amount_excluding_sales_tax: null
                            item_discount_amount: null
                          quantity: 1
                      link_expires_at: '2028-10-15T18:48:50.465671Z'
                      link_url: https://link.sandbox-payments-checkout.com/ZuDLR5
                      merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                      nickname: Basketball League Holiday Dinner 2
                      payment_frequency: ONE_TIME
                      split_transfers: []
                      state: ACTIVE
                      tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links?limit=1
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links?limit=1&after_cursor=payment_link_ctbnRm2yVJ7nwpBjmSF6k
                page:
                  limit: 1
                  next_cursor: payment_link_ctbnRm2yVJ7nwpBjmSF6k
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createPaymentLink:
      description: Payment Link
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/payment_link'
          examples:
            Payment Link - Minimal Fields:
              value:
                id: payment_link_ctZEYcsJyeodna2JShSgF
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 10080
                  expired_session_url: null
                  receipt_requested_delivery_methods: []
                  send_receipt: false
                  success_return_url: null
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - BANK_ACCOUNT
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 7500
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: false
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: null
                buyer_details: null
                created_at: '2025-11-10T18:21:14.92532Z'
                is_authorization: false
                is_multiple_use: false
                items: []
                link_expires_at: '2025-11-17T18:21:14.894921Z'
                link_url: https://link.sandbox-payments-checkout.com/2K6bjF
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                nickname: null
                payment_frequency: ONE_TIME
                split_transfers: []
                state: ACTIVE
                tags: {}
                updated_at: '2025-11-10T18:21:14.92532Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links/payment_link_ctZEYcsJyeodna2JShSgF
            Payment Link - All Fields:
              value:
                id: payment_link_ctZJskBfragiUJBCdrULc
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 1576800
                  expired_session_url: https://mybasketball-leaguexyz.com/expired
                  receipt_requested_delivery_methods:
                    - type: EMAIL
                      destinations:
                        - abc@test.com
                    - type: SMS
                      destinations:
                        - '2348765431'
                  send_receipt: true
                  success_return_url: https://mybasketball-leaguexyz.com/success
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                allowed_payment_methods:
                  - APPLE_PAY
                  - BANK_ACCOUNT
                  - GOOGLE_PAY
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown:
                    tax_exempt: false
                    subtotal_amount: 3994
                    shipping_amount: 995
                    estimated_tax_amount: 429
                    discount_amount: 1000
                    tip_amount: 1000
                    customs_duty_amount: null
                    additional_buyer_charges:
                      convenience_amount: 1000
                      rent_surcharge_amount: null
                      surcharge_amount: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 6418
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: false
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: Alternative text
                buyer_details:
                  customer_reference_number: null
                  first_name: John
                  identity_id: IDsjnoZb6VcRhGKNP29QFXtc
                  last_name: Adams
                created_at: '2025-11-10T19:06:57.136019Z'
                is_authorization: false
                is_multiple_use: false
                items:
                  - description: Your personal contribution to the holiday dinner.
                    image_details:
                      primary_image_url: >-
                        https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                      alternative_image_urls: []
                    item_details: null
                    name: Holiday Dinner Contribution
                    price_details:
                      sale_amount: 7500
                      currency: USD
                      price_type: PROMOTIONAL
                      regular_amount: 5000
                      amount_excluding_sales_tax: 5000
                      item_discount_amount: 1000
                    quantity: 1
                link_expires_at: '2028-11-09T19:06:57.112666Z'
                link_url: https://link.sandbox-payments-checkout.com/01VKkh
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                nickname: Basketball League Holiday Dinner 2
                payment_frequency: ONE_TIME
                split_transfers:
                  - amount: 3000
                    fee: null
                    merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                    tags:
                      key: value
                  - amount: 3418
                    fee: 100
                    merchant: MU7noQ1wdgdAeAfymw2rfBMq
                    tags: null
                state: ACTIVE
                tags: {}
                updated_at: '2025-11-10T19:06:57.136019Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links/payment_link_ctZJskBfragiUJBCdrULc
            Payment Link - Single-Use:
              value:
                id: payment_link_ctZKsR5TUXLC4NULE95Y6
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 10080
                  expired_session_url: null
                  receipt_requested_delivery_methods: []
                  send_receipt: false
                  success_return_url: null
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - BANK_ACCOUNT
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 7500
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: false
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: null
                buyer_details: null
                created_at: '2025-11-10T19:20:10.851928Z'
                is_authorization: false
                is_multiple_use: false
                items: []
                link_expires_at: '2025-11-17T19:20:10.825665Z'
                link_url: https://link.sandbox-payments-checkout.com/iAh12H
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                nickname: null
                payment_frequency: ONE_TIME
                split_transfers: []
                state: ACTIVE
                tags: {}
                updated_at: '2025-11-10T19:20:10.851928Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links/payment_link_ctZKsR5TUXLC4NULE95Y6
            Payment Link - Multi-Use:
              value:
                id: payment_link_ctZKJBuMdQJRmrbLKtabZ
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 1576800
                  expired_session_url: null
                  receipt_requested_delivery_methods: []
                  send_receipt: false
                  success_return_url: null
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - BANK_ACCOUNT
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 7500
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: false
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: null
                buyer_details: null
                created_at: '2025-11-10T19:23:44.732243Z'
                is_authorization: false
                is_multiple_use: true
                items: []
                link_expires_at: '2028-11-09T19:23:44.70264Z'
                link_url: https://link.sandbox-payments-checkout.com/irHFxX
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                nickname: null
                payment_frequency: ONE_TIME
                split_transfers: []
                state: ACTIVE
                tags: {}
                updated_at: '2025-11-10T19:23:44.732243Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links/payment_link_ctZKJBuMdQJRmrbLKtabZ
            Payment Link - Authorization:
              value:
                id: payment_link_ctbnRm2yVJ7nwpBjmSF6k
                created_at: '2025-10-16T18:48:50.49Z'
                updated_at: '2025-10-16T18:48:50.75Z'
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 1576800
                  expired_session_url: https://mybasketball-leaguexyz.com/expired
                  receipt_requested_delivery_methods:
                    - type: EMAIL
                      destinations:
                        - abc@test.com
                    - type: SMS
                      destinations:
                        - '2348765431'
                  send_receipt: true
                  success_return_url: https://mybasketball-leaguexyz.com/success
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                allowed_payment_methods:
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 7500
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: false
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: Alternative text
                buyer_details: null
                is_authorization: true
                is_multiple_use: false
                items:
                  - description: null
                    image_details:
                      primary_image_url: >-
                        https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                      alternative_image_urls: []
                    item_details: null
                    name: Holiday Dinner Contribution
                    price_details:
                      sale_amount: 7500
                      currency: USD
                      price_type: null
                      regular_amount: 0
                      amount_excluding_sales_tax: null
                      item_discount_amount: null
                    quantity: 1
                link_expires_at: '2028-10-15T18:48:50.465671Z'
                link_url: https://link.sandbox-payments-checkout.com/ZuDLR5
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                nickname: Basketball League Holiday Dinner 2
                payment_frequency: ONE_TIME
                split_transfers: []
                state: ACTIVE
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links/payment_link_ctbnRm2yVJ7nwpBjmSF6k
            Payment Link - Split Transaction:
              value:
                id: payment_link_ctZKLUGWNCQwaMKuEqFTD
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 10080
                  expired_session_url: null
                  receipt_requested_delivery_methods: []
                  send_receipt: false
                  success_return_url: null
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - BANK_ACCOUNT
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 7500
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: false
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: null
                buyer_details: null
                created_at: '2025-11-10T19:24:15.889115Z'
                is_authorization: false
                is_multiple_use: false
                items: []
                link_expires_at: '2025-11-17T19:24:15.858274Z'
                link_url: https://link.sandbox-payments-checkout.com/UIm43W
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                nickname: null
                payment_frequency: ONE_TIME
                split_transfers:
                  - amount: 5000
                    fee: null
                    merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                    tags:
                      key: value
                  - amount: 2500
                    fee: 100
                    merchant: MU7noQ1wdgdAeAfymw2rfBMq
                    tags: null
                state: ACTIVE
                tags: {}
                updated_at: '2025-11-10T19:24:15.889115Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links/payment_link_ctZKLUGWNCQwaMKuEqFTD
            Payment Link - Level 2 Processing:
              value:
                id: payment_link_cvcCVsW6VWVhhZ13DWCLk
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 10080
                  expired_session_url: null
                  receipt_requested_delivery_methods: []
                  send_receipt: false
                  success_return_url: null
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - BANK_ACCOUNT
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown:
                    tax_exempt: true
                    subtotal_amount: null
                    shipping_amount: null
                    estimated_tax_amount: 429
                    discount_amount: null
                    tip_amount: null
                    customs_duty_amount: null
                    additional_buyer_charges: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 429
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: true
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: null
                buyer_details:
                  customer_reference_number: 321xyz
                  first_name: null
                  identity_id: null
                  last_name: null
                created_at: '2025-12-17T17:15:59.631583Z'
                is_authorization: false
                is_multiple_use: false
                items: []
                link_expires_at: '2025-12-24T17:15:59.599071Z'
                link_url: https://link.sandbox-payments-checkout.com/XmXvyY
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                nickname: null
                payment_frequency: ONE_TIME
                split_transfers: []
                state: ACTIVE
                tags: {}
                updated_at: '2025-12-17T17:15:59.631583Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links/payment_link_cvcCVsW6VWVhhZ13DWCLk
            Payment Link - Level 3 Processing:
              value:
                id: payment_link_cvcCyRyxTyURbGLwwxnGh
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 10080
                  expired_session_url: null
                  receipt_requested_delivery_methods: []
                  send_receipt: false
                  success_return_url: null
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - BANK_ACCOUNT
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown:
                    tax_exempt: true
                    subtotal_amount: 3994
                    shipping_amount: 995
                    estimated_tax_amount: null
                    discount_amount: 1000
                    tip_amount: null
                    customs_duty_amount: 10
                    additional_buyer_charges: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 3999
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: true
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: null
                buyer_details:
                  customer_reference_number: 321xyz
                  first_name: null
                  identity_id: null
                  last_name: null
                created_at: '2025-12-17T17:11:20.034555Z'
                is_authorization: false
                is_multiple_use: false
                items:
                  - description: Your personal contribution to the holiday dinner.
                    image_details:
                      primary_image_url: >-
                        https://images.unsplash.com/photo-1608835149345-b4d77bc490ae?q=80&w=3272&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                      alternative_image_urls: []
                    item_details:
                      commodity_code: 175-62-20
                      merchant_product_code: '1149611'
                      unit_of_measure: BX
                      cost_per_unit: 500
                    name: Holiday Dinner Contribution
                    price_details:
                      sale_amount: 7500
                      currency: USD
                      price_type: PROMOTIONAL
                      regular_amount: 5000
                      amount_excluding_sales_tax: 5000
                      item_discount_amount: 1000
                    quantity: 1
                link_expires_at: '2025-12-24T17:11:20.002213Z'
                link_url: https://link.sandbox-payments-checkout.com/mxgK6U
                merchant_id: MU7noQ1wdgdAeAfymw2rfBMq
                nickname: null
                payment_frequency: ONE_TIME
                split_transfers: []
                state: ACTIVE
                tags: {}
                updated_at: '2025-12-17T17:11:20.034555Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payment_links/payment_link_cvcCyRyxTyURbGLwwxnGh
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listCheckoutForms:
      description: List of `Checkout Form` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  checkout_forms:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/checkout_form'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Checkout Forms:
              value:
                _embedded:
                  checkout_forms:
                    - id: checkout_form_cv1HECJQdi1xsEtH2SQX6
                      additional_details:
                        cart_return_url: https://www.sweat.com/my_cart.html
                        collect_billing_address: false
                        collect_email: true
                        collect_name: true
                        collect_phone: false
                        collect_shipping_address: false
                        expiration_in_minutes: 10080
                        expired_session_url: https://sweat.com/error.html
                        receipt_requested_delivery_methods: []
                        send_receipt: false
                        success_return_url: https://www.sweat.com/success/123rw21w.html
                        terms_of_service_url: https://sweat.com/terms_of_service.html
                        unsuccessful_return_url: null
                      allowed_payment_methods:
                        - PAYMENT_CARD
                      amount_details:
                        amount_breakdown:
                          tax_exempt: false
                          subtotal_amount: 3994
                          shipping_amount: 995
                          estimated_tax_amount: 429
                          discount_amount: 1000
                          tip_amount: 1000
                          customs_duty_amount: null
                          additional_buyer_charges: null
                        amount_type: FIXED
                        currency: USD
                        max_amount: null
                        min_amount: null
                        total_amount: 5418
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      attempt_level_two_level_three_payment: false
                      branding:
                        accent_color: '#000000'
                        brand_color: '#FFFFFF'
                        button_font_color: '#111823'
                        icon: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                        logo: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                        logo_alternative_text: Alternative text
                      buyer_details: null
                      created_at: '2025-12-11T22:51:40.40Z'
                      is_authorization: false
                      items:
                        - description: Gym membership deposit
                          image_details:
                            primary_image_url: >-
                              https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                            alternative_image_urls: []
                          item_details: null
                          name: null
                          price_details:
                            sale_amount: 4000
                            currency: USD
                            price_type: PROMOTIONAL
                            regular_amount: 5000
                            amount_excluding_sales_tax: null
                            item_discount_amount: null
                          quantity: 1
                      link_expires_at: '2025-12-18T22:51:40.324434Z'
                      link_url: https://link.sandbox-payments-checkout.com/ZfoLfQ
                      merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                      nickname: Gym Membership Signup Deposit
                      payment_frequency: ONE_TIME
                      split_transfers:
                        - amount: 2709
                          fee: null
                          merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                          tags:
                            key: value
                        - amount: 2709
                          fee: 100
                          merchant: MU7noQ1wdgdAeAfymw2rfBMq
                          tags: null
                      state: ACTIVE
                      tags: {}
                      updated_at: '2025-12-11T22:51:40.75Z'
                    - id: checkout_form_cv1HwwbsKRVENKeyxzN4Y
                      additional_details:
                        cart_return_url: https://www.sweat.com/my_cart.html
                        collect_billing_address: false
                        collect_email: true
                        collect_name: true
                        collect_phone: false
                        collect_shipping_address: false
                        expiration_in_minutes: 10080
                        expired_session_url: https://sweat.com/error.html
                        receipt_requested_delivery_methods: []
                        send_receipt: false
                        success_return_url: https://www.sweat.com/success/123rw21w.html
                        terms_of_service_url: https://sweat.com/terms_of_service.html
                        unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                      allowed_payment_methods:
                        - PAYMENT_CARD
                      amount_details:
                        amount_breakdown:
                          tax_exempt: false
                          subtotal_amount: 3994
                          shipping_amount: 995
                          estimated_tax_amount: 429
                          discount_amount: 1000
                          tip_amount: 1000
                          customs_duty_amount: null
                          additional_buyer_charges: null
                        amount_type: FIXED
                        currency: USD
                        max_amount: null
                        min_amount: null
                        total_amount: 5418
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      attempt_level_two_level_three_payment: false
                      branding:
                        accent_color: '#000000'
                        brand_color: '#FFFFFF'
                        button_font_color: '#111823'
                        icon: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                        logo: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                        logo_alternative_text: Alternative text
                      buyer_details:
                        billing_address: null
                        customer_reference_number: null
                        email: jane.doe@example.com
                        first_name: null
                        identity_id: null
                        last_name: null
                        phone: null
                        shipping_address: null
                      created_at: '2025-12-11T22:49:50.34Z'
                      is_authorization: false
                      items:
                        - description: Gym membership deposit
                          image_details:
                            primary_image_url: >-
                              https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                            alternative_image_urls: []
                          item_details: null
                          name: null
                          price_details:
                            sale_amount: 4000
                            currency: USD
                            price_type: PROMOTIONAL
                            regular_amount: 5000
                            amount_excluding_sales_tax: null
                            item_discount_amount: null
                          quantity: 1
                      link_expires_at: '2025-12-18T22:49:50.308432Z'
                      link_url: https://link.sandbox-payments-checkout.com/Ajssg9
                      merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                      nickname: Gym Membership Signup Deposit
                      payment_frequency: ONE_TIME
                      split_transfers: []
                      state: ACTIVE
                      tags: {}
                      updated_at: '2025-12-11T22:49:50.52Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/checkout_forms?limit=2
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/checkout_forms?limit=2&after_cursor=checkout_form_cv1HwwbsKRVENKeyxzN4Y
                page:
                  limit: 2
                  next_cursor: checkout_form_cv1HwwbsKRVENKeyxzN4Y
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createCheckoutForm:
      description: A single Checkout Form
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/checkout_form'
          examples:
            Checkout Form - Minimal Fields:
              value:
                id: checkout_form_cv1HdsxFeJsDhQ8jHv4wt
                additional_details:
                  cart_return_url: null
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 10
                  expired_session_url: null
                  receipt_requested_delivery_methods: []
                  send_receipt: false
                  success_return_url: null
                  terms_of_service_url: https://sweat.com/terms_of_service.html
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 5418
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: false
                branding:
                  accent_color: '#000000'
                  brand_color: '#FFFFFF'
                  button_font_color: null
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                  logo_alternative_text: null
                buyer_details: null
                created_at: '2025-12-11T22:45:45.306401Z'
                is_authorization: false
                items: []
                link_expires_at: '2025-12-11T22:55:45.27387Z'
                link_url: https://link.sandbox-payments-checkout.com/hjyMRO
                merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                nickname: Gym Membership Signup Deposit
                payment_frequency: ONE_TIME
                split_transfers: []
                state: ACTIVE
                tags: {}
                updated_at: '2025-12-11T22:45:45.306401Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/checkout_forms/checkout_form_cv1HdsxFeJsDhQ8jHv4wt
            Checkout Form - All Fields:
              value:
                id: checkout_form_cv1vZM3wciUyUjjJ4Kxbi
                additional_details:
                  cart_return_url: https://www.sweat.com/my_cart.html
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 10080
                  expired_session_url: https://sweat.com/error.html
                  receipt_requested_delivery_methods: []
                  send_receipt: false
                  success_return_url: https://www.sweat.com/success/123rw21w.html
                  terms_of_service_url: https://sweat.com/terms_of_service.html
                  unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                allowed_payment_methods:
                  - APPLE_PAY
                  - BANK_ACCOUNT
                  - GOOGLE_PAY
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown:
                    tax_exempt: false
                    subtotal_amount: 3994
                    shipping_amount: 995
                    estimated_tax_amount: 429
                    discount_amount: 1000
                    tip_amount: 1000
                    customs_duty_amount: null
                    additional_buyer_charges: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 5418
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: false
                branding:
                  accent_color: '#000000'
                  brand_color: '#FFFFFF'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                  logo_alternative_text: Alternative text
                buyer_details: null
                created_at: '2025-12-11T20:18:38.241501Z'
                is_authorization: false
                items:
                  - description: Gym membership deposit
                    image_details:
                      primary_image_url: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                      alternative_image_urls: []
                    item_details: null
                    name: null
                    price_details:
                      sale_amount: 4000
                      currency: USD
                      price_type: PROMOTIONAL
                      regular_amount: 5000
                      amount_excluding_sales_tax: null
                      item_discount_amount: null
                    quantity: 1
                link_expires_at: '2025-12-18T20:18:38.229569Z'
                link_url: https://link.sandbox-payments-checkout.com/J9WZkk
                merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                nickname: Gym Membership Signup Deposit
                payment_frequency: ONE_TIME
                split_transfers: []
                state: ACTIVE
                tags: {}
                updated_at: '2025-12-11T20:18:38.241501Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/checkout_forms/checkout_form_cv1vZM3wciUyUjjJ4Kxbi
            Checkout Form - Split Transaction:
              value:
                id: checkout_form_cv1HECJQdi1xsEtH2SQX6
                additional_details:
                  cart_return_url: https://www.sweat.com/my_cart.html
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 10080
                  expired_session_url: https://sweat.com/error.html
                  receipt_requested_delivery_methods: []
                  send_receipt: false
                  success_return_url: https://www.sweat.com/success/123rw21w.html
                  terms_of_service_url: https://sweat.com/terms_of_service.html
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - PAYMENT_CARD
                amount_details:
                  amount_breakdown:
                    tax_exempt: false
                    subtotal_amount: 3994
                    shipping_amount: 995
                    estimated_tax_amount: 429
                    discount_amount: 1000
                    tip_amount: 1000
                    customs_duty_amount: null
                    additional_buyer_charges: null
                  amount_type: FIXED
                  currency: USD
                  max_amount: null
                  min_amount: null
                  total_amount: 5418
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                attempt_level_two_level_three_payment: false
                branding:
                  accent_color: '#000000'
                  brand_color: '#FFFFFF'
                  button_font_color: '#111823'
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                  logo_alternative_text: Alternative text
                buyer_details: null
                created_at: '2025-12-11T22:51:40.402034Z'
                is_authorization: false
                items:
                  - description: Gym membership deposit
                    image_details:
                      primary_image_url: >-
                        https://s3.amazonaws.com/customer-uploaded-assets-prod/05-29-2024-09_49_37_Sweat.png_ccb91778-39ec-4cb2-8a13-9f0455acc77b
                      alternative_image_urls: []
                    item_details: null
                    name: null
                    price_details:
                      sale_amount: 4000
                      currency: USD
                      price_type: PROMOTIONAL
                      regular_amount: 5000
                      amount_excluding_sales_tax: null
                      item_discount_amount: null
                    quantity: 1
                link_expires_at: '2025-12-18T22:51:40.324434Z'
                link_url: https://link.sandbox-payments-checkout.com/ZfoLfQ
                merchant_id: MUmfEGv5bMpSJ9k5TFRUjkmm
                nickname: Gym Membership Signup Deposit
                payment_frequency: ONE_TIME
                split_transfers:
                  - amount: 2709
                    fee: null
                    merchant: MUmfEGv5bMpSJ9k5TFRUjkmm
                    tags:
                      key: value
                  - amount: 2709
                    fee: 100
                    merchant: MU7noQ1wdgdAeAfymw2rfBMq
                    tags: null
                state: ACTIVE
                tags: {}
                updated_at: '2025-12-11T22:51:40.402034Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/checkout_forms/checkout_form_cv1HECJQdi1xsEtH2SQX6
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listPayoutLinks:
      description: List of `Payout Link` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  payout_links:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/payout_link'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Payout Links:
              value:
                _embedded:
                  payout_links:
                    - id: payout_link_ciAV6w7FzYw64XBUCcP59
                      additional_details:
                        success_return_url: null
                        unsuccessful_return_url: null
                        expired_session_url: null
                        terms_of_service_url: https://example.com/terms
                        expiration_in_minutes: 10080
                      allowed_payout_operations:
                        - PUSH_TO_CARD
                      amount_details:
                        total_amount: 100000
                        currency: USD
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      branding:
                        brand_color: '#0D121A'
                        accent_color: '#0B5DBC'
                        logo: >-
                          https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png
                        icon: ''
                        logo_alternative_text: null
                        button_font_color: '#FFFFFF'
                      created_at: '2024-12-27T09:28:13.41Z'
                      items:
                        - name: 'Insurance Payout #2552'
                          image_details:
                            primary_image_url: >-
                              https://upload.wikimedia.org/wikipedia/commons/thumb/8/88/Uninsured_cars_seized_by_police_in_Liverpool.JPG/220px-Uninsured_cars_seized_by_police_in_Liverpool.JPG
                            alternative_image_urls: []
                          price_details:
                            amount: 100000
                            currency: USD
                          description: Car Damage
                          quantity: 1
                      link_expires_at: '2025-01-03T09:28:13.398354Z'
                      link_url: https://link.sandbox-payments-checkout.com/airGbX
                      nickname: 'Insurance Claim #2552'
                      recipient_details: null
                      state: ACTIVE
                      tags: {}
                      updated_at: '2024-12-27T09:28:13.66Z'
                    - id: payout_link_ciAFzb3QvDyNUfZN6Hqwe
                      additional_details:
                        success_return_url: null
                        unsuccessful_return_url: null
                        expired_session_url: null
                        terms_of_service_url: https://example.com/terms
                        expiration_in_minutes: 10080
                      allowed_payout_operations:
                        - PUSH_TO_CARD
                      amount_details:
                        total_amount: 100000
                        currency: USD
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      branding:
                        brand_color: '#0D121A'
                        accent_color: '#0B5DBC'
                        logo: >-
                          https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png
                        icon: ''
                        logo_alternative_text: null
                        button_font_color: '#FFFFFF'
                      created_at: '2024-12-27T06:30:53.06Z'
                      items:
                        - name: 'Insurance Payout #2552'
                          image_details:
                            primary_image_url: >-
                              https://upload.wikimedia.org/wikipedia/commons/thumb/8/88/Uninsured_cars_seized_by_police_in_Liverpool.JPG/220px-Uninsured_cars_seized_by_police_in_Liverpool.JPG
                            alternative_image_urls: []
                          price_details:
                            amount: 100000
                            currency: USD
                          description: Car Damage
                          quantity: 1
                      link_expires_at: '2025-01-03T06:30:53.042126Z'
                      link_url: https://link.sandbox-payments-checkout.com/rJf6G1
                      nickname: 'Insurance Claim #2552'
                      recipient_details: null
                      state: COMPLETED
                      tags: {}
                      updated_at: '2024-12-27T06:35:03.14Z'
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/payout_links
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_links?after_cursor=payout_link_ciAFzb3QvDyNUfZN6Hqwe
                page:
                  limit: 100
                  next_cursor: payout_link_ciAFzb3QvDyNUfZN6Hqwe
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createPayoutLink:
      description: A single Payout Link
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/payout_link'
          examples:
            Payout Link - Minimal Fields:
              value:
                id: payout_link_cv9aoEagjLDX3czBsuHip
                additional_details:
                  expiration_in_minutes: 4320
                  expired_session_url: https://www.safeguardinsurance.com/claims/expired
                  success_return_url: https://www.safeguardinsurance.com/claims/success
                  terms_of_service_url: https://www.safeguardinsurance.com/terms
                  unsuccessful_return_url: https://www.safeguardinsurance.com/claims/error
                allowed_payout_operations:
                  - PUSH_TO_ACH
                  - PUSH_TO_CARD
                amount_details:
                  currency: USD
                  total_amount: 850000
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                branding:
                  accent_color: '#3B82F6'
                  brand_color: '#1E3A8A'
                  button_font_color: '#FFFFFF'
                  icon: https://www.safeguardinsurance.com/assets/favicon.ico
                  logo: https://www.safeguardinsurance.com/assets/logo.png
                  logo_alternative_text: Safeguard Insurance Company Logo
                created_at: '2025-12-15T21:13:10.5833Z'
                items:
                  - description: Collision damage repair settlement for 2019 Honda Accord
                    image_details:
                      primary_image_url: >-
                        https://images.unsplash.com/photo-1558618666-fcd25c85cd64?w=400
                      alternative_image_urls: []
                    name: Vehicle Damage Settlement
                    price_details:
                      amount: 850000
                      currency: USD
                    quantity: 1
                link_expires_at: '2025-12-18T21:13:10.576025Z'
                link_url: https://link.sandbox-payments-checkout.com/ijOjsv
                nickname: 'Auto Insurance Claim Settlement #INS-2024-7891'
                recipient_details:
                  business_name: null
                  doing_business_as: null
                  email: sarah.johnson@email.com
                  first_name: Sarah
                  last_name: Johnson
                  merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                state: ACTIVE
                tags:
                  policyNumber: POL-456789
                  collectPhoneNumber: 'true'
                  collectEmail: 'true'
                  claimNumber: INS-2024-7891
                updated_at: '2025-12-15T21:13:10.861153Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_links/payout_link_cv9aoEagjLDX3czBsuHip
            Payout Link - All Fields:
              value:
                id: payout_link_cv9aoEagjLDX3czBsuHip
                additional_details:
                  expiration_in_minutes: 4320
                  expired_session_url: https://www.safeguardinsurance.com/claims/expired
                  success_return_url: https://www.safeguardinsurance.com/claims/success
                  terms_of_service_url: https://www.safeguardinsurance.com/terms
                  unsuccessful_return_url: https://www.safeguardinsurance.com/claims/error
                allowed_payout_operations:
                  - PUSH_TO_ACH
                  - PUSH_TO_CARD
                amount_details:
                  currency: USD
                  total_amount: 850000
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                branding:
                  accent_color: '#3B82F6'
                  brand_color: '#1E3A8A'
                  button_font_color: '#FFFFFF'
                  icon: https://www.safeguardinsurance.com/assets/favicon.ico
                  logo: https://www.safeguardinsurance.com/assets/logo.png
                  logo_alternative_text: Safeguard Insurance Company Logo
                created_at: '2025-12-15T21:13:10.5833Z'
                items:
                  - description: Collision damage repair settlement for 2019 Honda Accord
                    image_details:
                      primary_image_url: >-
                        https://images.unsplash.com/photo-1558618666-fcd25c85cd64?w=400
                      alternative_image_urls: []
                    name: Vehicle Damage Settlement
                    price_details:
                      amount: 850000
                      currency: USD
                    quantity: 1
                link_expires_at: '2025-12-18T21:13:10.576025Z'
                link_url: https://link.sandbox-payments-checkout.com/ijOjsv
                nickname: 'Auto Insurance Claim Settlement #INS-2024-7891'
                recipient_details:
                  business_name: null
                  doing_business_as: null
                  email: sarah.johnson@email.com
                  first_name: Sarah
                  last_name: Johnson
                  merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                state: ACTIVE
                tags:
                  policyNumber: POL-456789
                  collectPhoneNumber: 'true'
                  collectEmail: 'true'
                  claimNumber: INS-2024-7891
                updated_at: '2025-12-15T21:13:10.861153Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_links/payout_link_cv9aoEagjLDX3czBsuHip
            Payout Link - Push to Card:
              value:
                id: payout_link_cv3hdtDKFF5E3iqZ51uGi
                additional_details:
                  expiration_in_minutes: 10080
                  expired_session_url: null
                  success_return_url: null
                  terms_of_service_url: https://example.com/terms
                  unsuccessful_return_url: null
                allowed_payout_operations:
                  - PUSH_TO_CARD
                amount_details:
                  currency: USD
                  total_amount: 100000
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                branding:
                  accent_color: '#0B5DBC'
                  brand_color: '#0D121A'
                  button_font_color: '#FFFFFF'
                  icon: ''
                  logo: >-
                    https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png
                  logo_alternative_text: null
                created_at: '2025-12-12T18:39:06.323137Z'
                items:
                  - description: Car Damage
                    image_details:
                      primary_image_url: >-
                        https://upload.wikimedia.org/wikipedia/commons/thumb/8/88/Uninsured_cars_seized_by_police_in_Liverpool.JPG/220px-Uninsured_cars_seized_by_police_in_Liverpool.JPG
                      alternative_image_urls: []
                    name: 'Insurance Payout #2552'
                    price_details:
                      amount: 100000
                      currency: USD
                    quantity: 1
                link_expires_at: '2025-12-19T18:39:06.313286Z'
                link_url: https://link.sandbox-payments-checkout.com/gsrczI
                nickname: 'Insurance Claim #2552'
                recipient_details:
                  business_name: null
                  doing_business_as: null
                  email: null
                  first_name: null
                  last_name: null
                  merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                state: ACTIVE
                tags:
                  collectPhoneNumber: 'false'
                  collectEmail: 'false'
                updated_at: '2025-12-12T18:39:06.562293Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_links/payout_link_cv3hdtDKFF5E3iqZ51uGi
            Payout Link - Push to ACH:
              value:
                id: payout_link_ches9gZg2WWM7ARM53pmP
                additional_details:
                  success_return_url: null
                  unsuccessful_return_url: null
                  expired_session_url: null
                  terms_of_service_url: https://example.com/terms
                  expiration_in_minutes: 10080
                allowed_payout_operations:
                  - PUSH_TO_ACH
                amount_details:
                  total_amount: 100000
                  currency: USD
                application_id: AP5Tq3MMxKwHYX7soDncrCQ3
                branding:
                  brand_color: '#0D121A'
                  accent_color: '#0B5DBC'
                  logo: >-
                    https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png
                  icon: ''
                  logo_alternative_text: null
                  button_font_color: '#FFFFFF'
                created_at: '2024-11-15T10:07:50.353254Z'
                items:
                  - name: 'Insurance Payout #2552'
                    image_details:
                      primary_image_url: >-
                        https://upload.wikimedia.org/wikipedia/commons/thumb/8/88/Uninsured_cars_seized_by_police_in_Liverpool.JPG/220px-Uninsured_cars_seized_by_police_in_Liverpool.JPG
                      alternative_image_urls: []
                    price_details:
                      amount: 100000
                      currency: USD
                    description: Car Damage
                    quantity: 1
                link_expires_at: '2024-11-22T10:07:50.335572Z'
                link_url: https://link.sandbox-payments-checkout.com/Xjts64
                nickname: 'Insurance Claim #2552'
                recipient_details: null
                state: ACTIVE
                tags:
                  collectPhoneNumber: false
                  collectEmail: false
                updated_at: '2024-11-15T10:07:50.596865Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_links/payout_link_ches9gZg2WWM7ARM53pmP
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listSubscriptions:
      description: List of `Subscription` resources
      content:
        application/json:
          schema:
            type: object
            properties:
              page:
                $ref: '#/components/schemas/page'
              _embedded:
                type: object
                properties:
                  Subscription:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/subscription'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
          examples:
            List of Subscriptions:
              value:
                _embedded:
                  subscriptions:
                    - id: subscription_ciLn4PwcoNUiHLAzLf3y2
                      created_at: '2025-01-01T09:14:08.55Z'
                      updated_at: '2025-01-01T09:14:09.77Z'
                      amount: 19900
                      billing_interval: MONTHLY
                      buyer_details:
                        identity_id: IDe8MHoq9cevVGocJwpAN8tR
                        instrument_id: PIh5syYGDw2SnvFjPVLcV3oD
                        requested_delivery_methods: []
                      currency: USD
                      first_charge_at: '2025-01-01T09:14:08.00Z'
                      linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                      linked_type: MERCHANT
                      nickname: null
                      state: ACTIVE
                      subscription_details:
                        collection_method: BILL_AUTOMATICALLY
                        send_invoice: false
                        send_receipt: false
                        trial_details: null
                      subscription_phase: EVERGREEN
                      subscription_plan_id: subscription_plan_ciLn19pSKDTFoehtH7ETg
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/subscriptions/subscription_ciLn4PwcoNUiHLAzLf3y2
                    - id: subscription_ciLmyAfbiM45NGxzu3YJK
                      created_at: '2025-01-01T09:07:32.03Z'
                      updated_at: '2025-01-01T09:07:32.30Z'
                      amount: 19900
                      billing_interval: MONTHLY
                      buyer_details:
                        identity_id: IDe8MHoq9cevVGocJwpAN8tR
                        instrument_id: PIh5syYGDw2SnvFjPVLcV3oD
                        requested_delivery_methods: []
                      currency: USD
                      first_charge_at: '2025-01-01T09:07:31.00Z'
                      linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                      linked_type: MERCHANT
                      nickname: null
                      state: ACTIVE
                      subscription_details:
                        collection_method: BILL_AUTOMATICALLY
                        send_invoice: false
                        send_receipt: false
                        trial_details: null
                      subscription_phase: EVERGREEN
                      subscription_plan_id: null
                      tags: {}
                      _links:
                        self:
                          href: >-
                            https://finix.sandbox-payments-api.com/subscriptions/subscription_ciLmyAfbiM45NGxzu3YJK
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscriptions
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions?after_cursor=subscription_ciLmyAfbiM45NGxzu3YJK
                page:
                  limit: 100
                  next_cursor: subscription_ciLmyAfbiM45NGxzu3YJK
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createSubscription:
      description: Subscription
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/subscription'
          examples:
            Subscription - Minimal Fields:
              value:
                id: subscription_ctBcbsop5toBqeUWCXtf4
                created_at: '2025-10-29T21:23:45.92Z'
                updated_at: '2025-10-29T21:23:45.92Z'
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                first_charge_at: '2029-05-05T22:42:05.49Z'
                next_billing_date:
                  year: 2029
                  month: 5
                  day: 5
                amount: 19900
                buyer_details:
                  identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                  instrument_id: PImXAVgkKVshKWWHUk4xXbve
                  requested_delivery_methods: []
                  shipping_address: null
                currency: USD
                linked_to: MUxdJCr9xTMnmt1vGUAqV9z4
                linked_type: MERCHANT
                nickname: null
                billing_interval: MONTHLY
                subscription_details:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                  trial_details: null
                  discount_phase_details: null
                  notification_preferences:
                    send_confirmation: false
                subscription_phase: NONE
                state: NOT_STARTED
                subscription_plan_id: subscription_plan_ctBbJ1ihsC8Hpju4RQfZE
                start_subscription_at: '2029-05-05T22:42:05.490Z'
                total_billing_intervals: null
                expires_at: null
                canceled_via: null
                tags: {}
                subscription_link_id: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions/subscription_ctBcbsop5toBqeUWCXtf4
            Subscription - All Fields:
              value:
                id: subscription_ctB8iXsBuQwpSzvyXMmUf
                created_at: '2025-10-29T20:33:00.40Z'
                updated_at: '2025-10-29T20:33:00.40Z'
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                first_charge_at: '2029-07-05T22:42:05.49Z'
                next_billing_date:
                  year: 2029
                  month: 7
                  day: 5
                amount: 19900
                buyer_details:
                  identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                  instrument_id: PImXAVgkKVshKWWHUk4xXbve
                  requested_delivery_methods: []
                  shipping_address: null
                currency: USD
                linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                linked_type: MERCHANT
                nickname: Finflix Gold Package
                billing_interval: MONTHLY
                subscription_details:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                  trial_details:
                    interval_type: MONTH
                    interval_count: 2
                    trial_started_at: null
                    trial_expected_start_at: '2029-05-05T22:42:05.49Z'
                    trial_expected_end_at: '2029-07-05T19:40:17.49Z'
                  discount_phase_details:
                    amount: 1000
                    billing_interval_count: 3
                    discount_phase_started_at: null
                    discount_phase_expected_start_at: '2029-07-05T19:40:17.49Z'
                    discount_phase_expected_end_at: '2029-10-05T19:40:17.49Z'
                  notification_preferences:
                    send_confirmation: false
                subscription_phase: NONE
                state: NOT_STARTED
                subscription_plan_id: null
                start_subscription_at: '2029-05-05T22:42:05.490Z'
                total_billing_intervals: 12
                expires_at: '2030-07-05T19:40:17.490Z'
                canceled_via: null
                tags:
                  order_number: 21DFASJSAKAS
                subscription_link_id: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions/subscription_ctB8iXsBuQwpSzvyXMmUf
            Subscription - Discount Phase:
              value:
                id: subscription_cko73zG5sjgpjiGXxjzgh
                created_at: '2025-02-19T21:33:00.43Z'
                updated_at: '2025-02-19T21:33:00.43Z'
                first_charge_at: '2025-02-19T21:33:00.00Z'
                next_billing_date:
                  year: 2025
                  month: 2
                  day: 19
                amount: 2000
                buyer_details:
                  identity_id: IDeDVrf2ahuKc9Eg5TeZugvz
                  instrument_id: PIeDVrf2ahuKc9Eg5TeZugvb
                  requested_delivery_methods: []
                currency: USD
                linked_to: MUeDVrf2ahuKc9Eg5TeZugvs
                linked_type: MERCHANT
                nickname: Finflix Gold Package
                billing_interval: MONTHLY
                subscription_details:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                  trial_details: null
                  discount_phase_details:
                    amount: 1000
                    billing_interval_count: 3
                subscription_phase: DISCOUNT
                state: ACTIVE
                subscription_plan_id: null
                start_subscription_at: '2025-02-19T00:00:00.000Z'
                total_billing_intervals: null
                expires_at: null
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions/subscription_cko73zG5sjgpjiGXxjzgh
            Subscription - Fixed-Length:
              value:
                id: subscription_cmvX6f7CPp2vt1byGwQWa
                created_at: '2025-03-26T16:14:47.99Z'
                updated_at: '2025-03-26T16:14:47.99Z'
                first_charge_at: '2025-03-26T16:14:47.00Z'
                next_billing_date:
                  year: 2025
                  month: 3
                  day: 26
                amount: 19900
                buyer_details:
                  identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                  instrument_id: PImXAVgkKVshKWWHUk4xXbve
                  requested_delivery_methods: []
                currency: USD
                linked_to: MUcgYZswyRfqSSbvMsxuaHxZ
                linked_type: MERCHANT
                nickname: null
                billing_interval: MONTHLY
                subscription_details:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                  trial_details: null
                  discount_phase_details: null
                subscription_phase: FIXED
                state: ACTIVE
                subscription_plan_id: null
                start_subscription_at: '2025-03-26T00:00:00.000Z'
                total_billing_intervals: 12
                expires_at: '2026-03-26T00:00:00.000Z'
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions/subscription_cmvX6f7CPp2vt1byGwQWa
            Subscription - Future Start Date:
              value:
                id: subscription_cjwmrKRAiHxrKRYhnHqrC
                created_at: '2025-01-24T14:52:07.87Z'
                updated_at: '2025-01-24T14:52:07.87Z'
                first_charge_at: '2025-05-05T22:42:05.49Z'
                amount: 10000
                buyer_details:
                  identity_id: IDe8MHoq9cevVGocJwpAN8tR
                  instrument_id: PIh5syYGDw2SnvFjPVLcV3oD
                  requested_delivery_methods: []
                currency: USD
                linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                linked_type: MERCHANT
                nickname: Monthly Cheese Delivery Club
                billing_interval: MONTHLY
                subscription_details:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                  trial_details: null
                  discount_phase_details: null
                subscription_phase: NONE
                state: NOT_STARTED
                subscription_plan_id: null
                start_subscription_at: '2025-05-05T22:42:05.490Z'
                total_billing_intervals: null
                expires_at: null
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions/subscription_cjwmrKRAiHxrKRYhnHqrC
            Subscription - Trial Period:
              value:
                id: subscription_ciLmPdXV42t2H2YSpwRuK
                created_at: '2025-01-01T09:10:50.54Z'
                updated_at: '2025-01-01T09:10:50.54Z'
                first_charge_at: '2025-03-01T09:10:50.00Z'
                amount: 19900
                buyer_details: null
                identity_id: IDe8MHoq9cevVGocJwpAN8tR
                instrument_id: PIh5syYGDw2SnvFjPVLcV3oD
                requested_delivery_methods: []
                currency: USD
                linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                linked_type: MERCHANT
                nickname: null
                billing_interval: MONTHLY
                subscription_details: null
                collection_method: BILL_AUTOMATICALLY
                send_invoice: false
                send_receipt: false
                trial_details:
                  interval_type: MONTH
                  interval_count: 1
                  trial_started_at: '2025-01-01T00:00:00.00Z'
                  trial_expected_end_at: '2025-03-01T00:00:00.00Z'
                subscription_phase: TRIAL
                state: ACTIVE
                subscription_plan_id: null
                start_subscription_at: '2025-01-01T00:00:00.000Z'
                tags: {}
                _links: null
                self:
                  href: >-
                    https://finix.sandbox-payments-api.com/subscriptions/subscription_cd7VyFticmvMmxJwv2aMB
            Subscription - Subscription Plan - All Fields:
              value:
                id: subscription_ctBbRpys5XhoiDWGJvQRP
                created_at: '2025-10-29T21:19:27.51Z'
                updated_at: '2025-10-29T21:19:27.51Z'
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                first_charge_at: '2029-05-05T22:42:05.49Z'
                next_billing_date:
                  year: 2029
                  month: 5
                  day: 5
                amount: 19900
                buyer_details:
                  identity_id: IDtEnKsZyJNUGK83ZTx4C45S
                  instrument_id: PImXAVgkKVshKWWHUk4xXbve
                  requested_delivery_methods: []
                  shipping_address: null
                currency: USD
                linked_to: MUxdJCr9xTMnmt1vGUAqV9z4
                linked_type: MERCHANT
                nickname: null
                billing_interval: MONTHLY
                subscription_details:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                  trial_details: null
                  discount_phase_details: null
                  notification_preferences:
                    send_confirmation: false
                subscription_phase: NONE
                state: NOT_STARTED
                subscription_plan_id: subscription_plan_ctBbJ1ihsC8Hpju4RQfZE
                start_subscription_at: '2029-05-05T22:42:05.490Z'
                total_billing_intervals: 12
                expires_at: '2030-05-05T22:42:05.490Z'
                canceled_via: null
                tags: {}
                subscription_link_id: null
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions/subscription_ctBbRpys5XhoiDWGJvQRP
            Subscription - Subscription Plan - Minimal Fields:
              value:
                id: subscription_ciLn4PwcoNUiHLAzLf3y2
                created_at: '2025-01-01T09:14:08.55Z'
                updated_at: '2025-01-01T09:14:08.55Z'
                first_charge_at: '2025-01-01T09:14:08.00Z'
                amount: 19900
                buyer_details:
                  identity_id: IDe8MHoq9cevVGocJwpAN8tR
                  instrument_id: PIh5syYGDw2SnvFjPVLcV3oD
                  requested_delivery_methods: []
                currency: USD
                linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                linked_type: MERCHANT
                nickname: null
                billing_interval: MONTHLY
                subscription_details:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                  trial_details: null
                subscription_phase: EVERGREEN
                state: ACTIVE
                subscription_plan_id: subscription_plan_ciLn19pSKDTFoehtH7ETg
                start_subscription_at: '2025-01-01T00:00:00.000Z'
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions/subscription_ciLn4PwcoNUiHLAzLf3y2
            Subscription - Subscription Plan - Fixed-Length:
              value:
                id: subscription_cnQar7i5tJQfJJat1YwfY
                created_at: '2025-05-05T22:21:48.66Z'
                updated_at: '2025-05-05T22:21:48.66Z'
                first_charge_at: '2025-05-05T22:21:48.00Z'
                next_billing_date:
                  year: 2025
                  month: 5
                  day: 5
                amount: 19900
                buyer_details:
                  identity_id: IDmj1yA97RS4rMjiQgvK3Vio
                  instrument_id: PI2vmkL4SPPmxuqkVajbvKkE
                  requested_delivery_methods: []
                currency: USD
                linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                linked_type: MERCHANT
                nickname: null
                billing_interval: MONTHLY
                subscription_details:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                  trial_details: null
                  discount_phase_details: null
                subscription_phase: FIXED
                state: ACTIVE
                subscription_plan_id: subscription_plan_ciLn19pSKDTFoehtH7ETg
                start_subscription_at: '2025-05-05T00:00:00.000Z'
                total_billing_intervals: 12
                expires_at: '2026-05-05T00:00:00.000Z'
                canceled_via: null
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions/subscription_cnQar7i5tJQfJJat1YwfY
            Subscription - Subscription Plan - Future Start Date:
              value:
                id: subscription_cjDY6TyAEJ8do2LyapNUW
                created_at: '2025-01-28T15:23:53.48Z'
                updated_at: '2025-01-28T15:23:53.48Z'
                first_charge_at: '2025-05-05T22:42:05.49Z'
                amount: 19900
                buyer_details:
                  identity_id: IDeDVrf2ahuKc9Eg5TeZugvz
                  instrument_id: PIeDVrf2ahuKc9Eg5TeZugvb
                  requested_delivery_methods: []
                currency: USD
                linked_to: MUaC9hbNvRwBoCJzqrjWk69N
                linked_type: MERCHANT
                nickname: null
                billing_interval: MONTHLY
                subscription_details:
                  collection_method: BILL_AUTOMATICALLY
                  send_invoice: false
                  send_receipt: false
                  trial_details: null
                  discount_phase_details: null
                subscription_phase: NONE
                state: NOT_STARTED
                subscription_plan_id: subscription_plan_cjDXvcWFaKb672s4zknCC
                start_subscription_at: '2025-05-05T22:42:05.490Z'
                total_billing_intervals: null
                expires_at: null
                tags: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscriptions/subscription_cjDY6TyAEJ8do2LyapNUW
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    listSubscriptionLinks:
      description: List of `Subscription Link` resources.
      content:
        application/json:
          schema:
            type: object
            properties:
              _embedded:
                type: object
                properties:
                  subscription_links:
                    type: array
                    uniqueItems: true
                    items:
                      $ref: '#/components/schemas/subscription_link'
              _links:
                type: object
                properties:
                  self:
                    $ref: '#/components/schemas/self'
                  next:
                    $ref: '#/components/schemas/next'
              page:
                $ref: '#/components/schemas/page'
          examples:
            List of Subscription Links:
              value:
                _embedded:
                  subscription_links:
                    - id: subscription_link_cqsYdCRxog2345YdM8TTT
                      additional_details:
                        collect_billing_address: false
                        collect_email: true
                        collect_name: true
                        collect_phone: false
                        collect_shipping_address: false
                        expiration_in_minutes: 1576800
                        expired_session_url: https://mybasketball-leaguexyz.com/expired
                        receipt_requested_delivery_methods:
                          - type: EMAIL
                            destinations:
                              - abc@test.com
                          - type: SMS
                            destinations:
                              - '2348765431'
                        send_receipt: true
                        success_return_url: null
                        terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                        unsuccessful_return_url: null
                      allowed_payment_methods:
                        - BANK_ACCOUNT
                        - PAYMENT_CARD
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      branding:
                        accent_color: '#f3eeee'
                        brand_color: '#111823'
                        button_font_color: '#111823'
                        button_label: Subscribe Now
                        icon: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                        logo: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                        logo_alternative_text: Alternative text
                      created_at: '2025-07-25T15:25:38.70Z'
                      is_multiple_use: true
                      link_expires_at: '2028-07-24T15:25:38.67Z'
                      link_url: https://link.sandbox-payments-checkout.com/4tkvMt
                      merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                      nickname: Subscription Link for John
                      plans:
                        - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                          name: Subscription Plan XYZ
                          image_details:
                            primary_image_url: >-
                              https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                            alternative_image_urls: []
                          url_details:
                            success_return_url: https://mybasketball-leaguexyz.com/success
                            unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                      state: DEACTIVATED
                      tags: {}
                      type: SUBSCRIPTION_PLAN
                      updated_at: '2025-07-25T15:27:36.24Z'
                    - id: subscription_link_cqsXB9i6hMvPmmHhgtg2p
                      additional_details:
                        collect_billing_address: false
                        collect_email: true
                        collect_name: true
                        collect_phone: false
                        collect_shipping_address: false
                        expiration_in_minutes: 1576800
                        expired_session_url: https://mybasketball-leaguexyz.com/expired
                        receipt_requested_delivery_methods:
                          - type: EMAIL
                            destinations:
                              - abc@test.com
                          - type: SMS
                            destinations:
                              - '2348765431'
                        send_receipt: true
                        success_return_url: null
                        terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                        unsuccessful_return_url: null
                      allowed_payment_methods:
                        - BANK_ACCOUNT
                        - PAYMENT_CARD
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      branding:
                        accent_color: '#f3eeee'
                        brand_color: '#111823'
                        button_font_color: '#111823'
                        button_label: null
                        icon: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                        logo: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                        logo_alternative_text: Alternative text
                      created_at: '2025-07-25T15:17:37.22Z'
                      is_multiple_use: true
                      link_expires_at: '2028-07-24T15:17:37.19Z'
                      link_url: https://link.sandbox-payments-checkout.com/j43WBF
                      merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                      nickname: Subscription Link for John
                      plans:
                        - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                          name: Subscription Plan XYZ @ $30 a Month
                          image_details:
                            primary_image_url: >-
                              https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                            alternative_image_urls: []
                          url_details:
                            success_return_url: https://mybasketball-leaguexyz.com/success
                            unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                        - subscription_plan_id: subscription_plan_cqsXxZf3Qd6ieEYEipM9Y
                          name: Subscription Plan XYZ at $300 a Month
                          image_details:
                            primary_image_url: >-
                              https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                            alternative_image_urls: []
                          url_details:
                            success_return_url: https://mybasketball-leaguexyz.com/success
                            unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                      state: ACTIVE
                      tags: {}
                      type: MULTIPLE_SUBSCRIPTION_PLANS
                      updated_at: '2025-07-25T15:17:37.45Z'
                    - id: subscription_link_cqsWVUhT9hwBG89p2XFvF
                      additional_details:
                        collect_billing_address: false
                        collect_email: true
                        collect_name: true
                        collect_phone: false
                        collect_shipping_address: false
                        expiration_in_minutes: 1576800
                        expired_session_url: https://mybasketball-leaguexyz.com/expired
                        receipt_requested_delivery_methods:
                          - type: EMAIL
                            destinations:
                              - abc@test.com
                          - type: SMS
                            destinations:
                              - '2348765431'
                        send_receipt: true
                        success_return_url: null
                        terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                        unsuccessful_return_url: null
                      allowed_payment_methods:
                        - BANK_ACCOUNT
                        - PAYMENT_CARD
                      application_id: APc9vhYcPsRuTSpKD9KpMtPe
                      branding:
                        accent_color: '#f3eeee'
                        brand_color: '#111823'
                        button_font_color: '#111823'
                        button_label: Subscribe Now
                        icon: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                        logo: >-
                          https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                        logo_alternative_text: Alternative text
                      created_at: '2025-07-25T15:08:44.87Z'
                      is_multiple_use: true
                      link_expires_at: '2028-07-24T15:08:44.67Z'
                      link_url: https://link.sandbox-payments-checkout.com/QglaT2
                      merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                      nickname: Subscription Link for John
                      plans:
                        - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                          name: Subscription Plan XYZ
                          image_details:
                            primary_image_url: >-
                              https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                            alternative_image_urls: []
                          url_details:
                            success_return_url: https://mybasketball-leaguexyz.com/success
                            unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                      state: ACTIVE
                      tags: {}
                      type: SUBSCRIPTION_PLAN
                      updated_at: '2025-07-25T15:08:45.11Z'
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription_links
                  next:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_links?after_cursor=subscription_link_cqsWVUhT9hwBG89p2XFvF
                page:
                  limit: 100
                  next_cursor: subscription_link_cqsWVUhT9hwBG89p2XFvF
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    createSubscriptionLink:
      description: A single `Subscription Link` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/subscription_link'
          examples:
            Subscription Link - One Subscription Plan:
              value:
                id: subscription_link_cqsWVUhT9hwBG89p2XFvF
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 1576800
                  expired_session_url: https://mybasketball-leaguexyz.com/expired
                  receipt_requested_delivery_methods:
                    - type: EMAIL
                      destinations:
                        - abc@test.com
                    - type: SMS
                      destinations:
                        - '2348765431'
                  send_receipt: true
                  success_return_url: null
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - BANK_ACCOUNT
                  - PAYMENT_CARD
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  button_label: Subscribe Now
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: Alternative text
                created_at: '2025-07-25T15:08:44.87Z'
                is_multiple_use: true
                link_expires_at: '2028-07-24T15:08:44.67Z'
                link_url: https://link.sandbox-payments-checkout.com/QglaT2
                merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                nickname: Subscription Link for John
                plans:
                  - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                    name: Subscription Plan XYZ
                    image_details:
                      primary_image_url: >-
                        https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                      alternative_image_urls: []
                    url_details:
                      success_return_url: https://mybasketball-leaguexyz.com/success
                      unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                state: ACTIVE
                tags: {}
                type: SUBSCRIPTION_PLAN
                updated_at: '2025-07-25T15:08:45.11Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_links/subscription_link_cqsWVUhT9hwBG89p2XFvF
            Subscription Link - Multiple Subscription Plans:
              value:
                id: subscription_link_cqsXB9i6hMvPmmHhgtg2p
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 1576800
                  expired_session_url: https://mybasketball-leaguexyz.com/expired
                  receipt_requested_delivery_methods:
                    - type: EMAIL
                      destinations:
                        - abc@test.com
                    - type: SMS
                      destinations:
                        - '2348765431'
                  send_receipt: true
                  success_return_url: null
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - BANK_ACCOUNT
                  - PAYMENT_CARD
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  button_label: null
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: Alternative text
                created_at: '2025-07-25T15:17:37.22Z'
                is_multiple_use: true
                link_expires_at: '2028-07-24T15:17:37.19Z'
                link_url: https://link.sandbox-payments-checkout.com/j43WBF
                merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                nickname: Subscription Link for John
                plans:
                  - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                    name: Subscription Plan XYZ @ $30 a Month
                    image_details:
                      primary_image_url: >-
                        https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                      alternative_image_urls: []
                    url_details:
                      success_return_url: https://mybasketball-leaguexyz.com/success
                      unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                  - subscription_plan_id: subscription_plan_cqsXxZf3Qd6ieEYEipM9Y
                    name: Subscription Plan XYZ at $300 a Month
                    image_details:
                      primary_image_url: >-
                        https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                      alternative_image_urls: []
                    url_details:
                      success_return_url: https://mybasketball-leaguexyz.com/success
                      unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                state: ACTIVE
                tags: {}
                type: MULTIPLE_SUBSCRIPTION_PLANS
                updated_at: '2025-07-25T15:17:37.45Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_links/subscription_link_cqsXB9i6hMvPmmHhgtg2p
            Subscription Link - Send Confirmation Email:
              value:
                id: subscription_link_csXbswC5PaomzPJ5hJdcF
                additional_details:
                  collect_billing_address: false
                  collect_email: true
                  collect_name: true
                  collect_phone: false
                  collect_shipping_address: false
                  expiration_in_minutes: 1576800
                  expired_session_url: https://mybasketball-leaguexyz.com/expired
                  receipt_requested_delivery_methods:
                    - type: EMAIL
                      destinations:
                        - abc@test.com
                    - type: SMS
                      destinations:
                        - '2348765431'
                  send_confirmation: true
                  send_receipt: true
                  success_return_url: null
                  terms_of_service_url: https://mybasketball-leaguexyz.com/terms
                  unsuccessful_return_url: null
                allowed_payment_methods:
                  - BANK_ACCOUNT
                  - PAYMENT_CARD
                application_id: APc9vhYcPsRuTSpKD9KpMtPe
                branding:
                  accent_color: '#f3eeee'
                  brand_color: '#111823'
                  button_font_color: '#111823'
                  button_label: Subscribe Now
                  icon: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo: >-
                    https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482
                  logo_alternative_text: Alternative text
                created_at: '2025-10-09T19:31:42.48Z'
                is_multiple_use: true
                link_expires_at: '2028-10-08T19:31:42.29Z'
                link_url: https://link.sandbox-payments-checkout.com/G3TOpz
                merchant_id: MUcgYZswyRfqSSbvMsxuaHxZ
                nickname: Subscription Link for John
                plans:
                  - subscription_plan_id: subscription_plan_cmsyQKfkpSEtUVfvxr9Dc
                    name: Subscription Plan XYZ
                    image_details:
                      primary_image_url: >-
                        https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855
                      alternative_image_urls: []
                    url_details:
                      success_return_url: https://mybasketball-leaguexyz.com/success
                      unsuccessful_return_url: https://mybasketball-leaguexyz.com/failure
                state: ACTIVE
                tags: {}
                type: SUBSCRIPTION_PLAN
                updated_at: '2025-10-09T19:31:42.60Z'
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/subscription_links/subscription_link_csXbswC5PaomzPJ5hJdcF
      headers:
        date:
          $ref: '#/components/headers/date'
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
  schemas:
    SubscriptionBalanceEntry:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Subscription Balance Entry` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          type: string
          description: >-
            ISO 4217 3-letter currency code. Currently, the only `currency`
            supported is `USD`.
          enum:
            - USD
        description:
          type: string
          description: Describes the circumstances for the subscription credit.
        subscription_id:
          type: string
          description: |
            The `Subscription` that was credited.
        type:
          type: string
          description: |
            The value of this field will always be `CREDIT`.
        tags:
          $ref: '#/components/schemas/tags'
    ApplicationProfile:
      type: object
      properties:
        id:
          type: string
          example: PPxxxxxxxxxxxxxxxxxx
          description: ID of the `application_profile` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          description: The ID of the `Application` resource.
        card_present_fee_profile:
          type: string
          description: >-
            The ID of the `Fee Profile` to be used for all card present
            transfers associated with the `Merchant Profile` resource. If not
            set the value in `fee_profile` will be used for card present
            transfers.
          nullable: true
        fee_profile:
          type: string
          example: FPxxxxxxxxxxxxxxxxxx
          description: The ID of the `Fee Profile` associated with the `Application`.
          nullable: true
        risk_profile:
          type: string
          example: RPxxxxxxxxxxxxxxxxxx
          description: The ID of the `risk_profile` that was created during provisioning.
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            application:
              type: object
              description: Link to the `Application` the resource was created under.
              properties:
                href:
                  type: string
            fee_profile:
              type: object
              properties:
                href:
                  type: string
            risk_profile:
              type: object
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    UpdateApplicationProfileRequest:
      type: object
      properties:
        card_present_fee_profile:
          type: string
          description: >-
            The ID of the `Fee Profile` to be used for all card present
            transfers associated with the `Merchant Profile` resource. If not
            set the value in `fee_profile` will be used for card present
            transfers.
          nullable: true
        fee_profile:
          type: string
          description: The ID of the `Fee Profile` associated with the `Application`.
        risk_profile:
          type: string
          description: The ID of the `Risk Profile` associated with the `Application`.
        tags:
          $ref: '#/components/schemas/tags'
    ApplicationProfilesList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `application_profile` resources.
          properties:
            application_profiles:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`application_profile` resources.'
              items:
                $ref: '#/components/schemas/ApplicationProfile'
        _links:
          $ref: '#/components/schemas/ListLinks'
    Dispute:
      type: object
      title: Dispute
      description: A `Dispute` objected created for a chargeback or customer disputes.
      properties:
        id:
          type: string
          example: DIxxxxxxxxxxxxxxxxxx
          description: The ID of the `Dispute` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        action:
          type: string
          description: The next `action` required to move forward with the `Dispute`.
          nullable: true
        amount:
          type: integer
          description: The total amount of the `Dispute` (in cents).
          nullable: true
        application:
          type: string
          description: >-
            The ID of the `Application` resource that the `Dispute` was created
            under.
        dispute_details:
          description: >-
            Details about the `Dispute` received by the `Processor`. Any data
            from the processor can get included.
          type: object
          properties:
            case_id:
              type: string
              description: >-
                The case number the `Processor` has given the dispute in their
                internal database.
              nullable: true
            pin_debit_adjustment_number:
              type: string
              description: >-
                Used by the processor to identify the funds that are getting
                disputed.
              nullable: true
            reason_code:
              type: string
              description: >-
                Used by the processor and card networks to identify why the
                dispute got filed.
              nullable: true
        evidence_submitted:
          type: string
          enum:
            - CHARGEBACK
            - NOT_SUPPORTED
            - NONE
            - UNKNOWN
            - INQUIRY
          description: >-
            The status of the uploaded evidence. [See `Dispute#response_details`
            for the next steps to move the `Dispute`
            forward](#operation/getDispute).
        identity:
          type: string
          description: >-
            - The ID of the seller's `Identity` resource.

            - This is the `Identity` resource that was used to create the
            seller's `Merchant`.
        merchant:
          type: string
          description: |-
            - The ID of the seller's `Merchant` resource. 
            - This is the `Merchant` account the `Dispute` was filed against.
        message:
          type: string
          description: >-
            Message field that provides additional details. This field is
            typically **null**.
          nullable: true
        occurred_at:
          type: string
          description: >-
            Point in time when the `Transfer` that's getting disputed got
            created.
          format: date-time
          nullable: true
        reason:
          type: string
          enum:
            - CLERICAL
            - FRAUD
            - INQUIRY
            - QUALITY
            - TECHNICAL
          description: >-
            The system-defined reason for the `Dispute`. Available values
            include:<ul><li><code>INQUIRY</code></li><li><code>QUALITY</code></li><li><code>FRAUD</code></li></ul>
        respond_by:
          type: string
          format: date-time
          description: Point in time, the `Merchant` needs to respond to the dispute by.
          nullable: true
        response_state:
          type: string
          enum:
            - NEEDS_RESPONSE
            - RESPONDED
            - ACCEPTED
            - NO_RESPONSE_ALLOWED
            - UNKNOWN
          description: >-
            Details the state of the `Dispute` and what action the `Merchant`
            needs to take.

            - **NEEDS_RESPONSE**: The `Merchant` needs to respond to the
            `Dispute` by `Dispute#respond_by`. For details on how to respond to
            a `Dispute`, see [Responding to
            Disputes](/guides/after-the-payment/disputes/responding-to-disputes).

            - **RESPONDED**: The issuing bank has received the evidence and
            actively reviewing it. No action needed from the `Merchant`.

            - **ACCEPTED**: The `Merchant` has accepted the `Dispute`. When a
            `Dispute` is accepted, you concede that the dispute is not worth
            challenging or representing. For details on how to accept a
            `Dispute`, see [Accepting a
            Dispute](/guides/after-the-payment/disputes/accepting-disputes/).

            - **NO_RESPONSE_ALLOWED**: The final `Dispute#response_state` when a
            `Dispute` is either **WON** or **LOST**.

            - **UNKNOWN**: Occurs when testing `Disputes` in the sandbox on the
            `DUMMY_V1` processor or in production on the `VANTIV_V1` processor.
        state:
          type: string
          enum:
            - INQUIRY
            - PENDING
            - WON
            - LOST
          description: The current state of the `Dispute`.
        tags:
          $ref: '#/components/schemas/tags'
        transfer:
          type: string
          description: ID of the `Transfer` resource.
          example: TRxxxxxxxxxxxxxxxxxx
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            adjustment_transfers:
              type: object
              properties:
                href:
                  type: string
            application:
              type: object
              description: Link to the `Application` the resource was created under.
              properties:
                href:
                  type: string
            evidence:
              type: object
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
            transfer:
              type: object
              description: Link to the `Transfers` realted to the `Dispute`.
              properties:
                href:
                  type: string
    DisputeEvidence:
      type: object
      properties:
        id:
          type: string
          example: DFxxxxxxxxxxxxxxxxxx
          description: The ID of the `Dispute` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          example: APgPDQrLD52TYvqazjHJJchM
          description: >-
            The ID of the `Application` resource that the `Dispute` was created
            under.
        dispute:
          type: string
          description: The ID of the `Dispute` associated with the evidence.
        state:
          type: string
          enum:
            - PENDING
            - SUCCEEDED
            - CANCELED
            - FAILED
          description: >-
            Result of the evidence uploaded.

            - **PENDING**: The evidence file has not yet been submitted to the
            Processor. No user action is required.

            - **SUCCEEDED**: The evidence file has been successfully sent to the
            Processor. No further user action is required.

            - **CANCELED**: The evidence file upload was not completed due to
            user action.

            - **FAILED**: An issue occurred. User action is required**. Any of
            the following issues could have occurred:
              - There was an error in the system and the user should retry uploading their evidence file.
              - There is an issue with the file and the user should retry uploading a different file.
              - There is an issue and the user should contact Support.
        identity:
          type: string
          example: IDpYDM7J9n57q849o9E9yNrG
          description: >-
            - The ID of the seller's `Identity` resource. 

            - This is the `Identity` resource that was used to create the
            seller's `Merchant`.
        merchant:
          type: string
          example: MUucec6fHeaWo3VHYoSkUySM
          description: |-
            - The ID of the seller's `Merchant` resource. 
            - This is the `Merchant` account the `Dispute` was filed against.
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    CreateDisputeEvidenceRequest:
      type: object
      properties:
        file:
          type: string
          format: binary
          description: The binary contents of the file.
    DisputeEvidenceList:
      type: object
      title: ''
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `evidence` created for a `Dispute`.
          properties:
            evidences:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Evidence` objects.'
              items:
                $ref: '#/components/schemas/DisputeEvidence'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    DisputesList:
      type: object
      x-stoplight:
        id: y4y38tafla5lc
      properties:
        page:
          $ref: '#/components/schemas/PageOffset'
        _embedded:
          type: object
          description: List of `Dispute` objects.
          properties:
            disputes:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Dispute` objects.'
              items:
                $ref: '#/components/schemas/Dispute'
        _links:
          $ref: '#/components/schemas/ListLinks'
    Error422UnprocessableEntity:
      type: object
      description: Unprocessable Entity
      properties:
        total:
          type: integer
        _embedded:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                properties:
                  logref:
                    $ref: '#/components/schemas/logref'
                  message:
                    type: string
                  code:
                    type: string
                    enum:
                      - UNPROCESSABLE_ENTITY
                  _links:
                    type: object
                    properties:
                      self:
                        type: object
                        properties:
                          href:
                            type: string
    Error401Unauthorized:
      type: object
      properties:
        total:
          type: integer
        _embedded:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                additionalProperties: true
                properties:
                  code:
                    type: string
                    enum:
                      - UNKNOWN
                  logref:
                    $ref: '#/components/schemas/logref'
                  message:
                    type: string
                  _links:
                    type: object
                    additionalProperties: true
                    properties:
                      self:
                        type: object
                        properties:
                          href:
                            type: string
                      source:
                        type: object
                        properties:
                          href:
                            type: string
    Error402PaymentRequired:
      type: object
      properties:
        total:
          type: integer
        _embedded:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                additionalProperties: true
                properties:
                  code:
                    type: string
                    enum:
                      - CALL_ISSUER
                  logref:
                    $ref: '#/components/schemas/logref'
                  message:
                    type: string
                    enum:
                      - Please contact card issuer for more information.
                  _links:
                    type: object
                    properties:
                      source:
                        type: object
                        properties:
                          href:
                            type: string
    Error403ForbiddenList:
      type: object
      properties:
        total:
          type: integer
        _embedded:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                additionalProperties: true
                properties:
                  code:
                    type: string
                    enum:
                      - FORBIDDEN
                  logref:
                    $ref: '#/components/schemas/logref'
                  message:
                    type: string
                  _links:
                    type: object
                    properties:
                      source:
                        type: object
                        properties:
                          href:
                            type: string
      description: ''
      title: ''
    ErrorGeneric:
      type: object
      properties:
        total:
          type: integer
        _embedded:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                additionalProperties: true
                properties:
                  code:
                    type: string
                    enum:
                      - FORBIDDEN
                  logref:
                    $ref: '#/components/schemas/logref'
                  message:
                    type: string
                  _links:
                    type: object
                    properties:
                      source:
                        type: object
                        properties:
                          href:
                            type: string
    Error404NotFoundList:
      type: object
      properties:
        total:
          type: integer
        _embedded:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                additionalProperties: true
                properties:
                  code:
                    type: string
                    enum:
                      - NOT_FOUND
                  logref:
                    $ref: '#/components/schemas/logref'
                  message:
                    type: string
                  _links:
                    type: object
                    properties:
                      source:
                        type: object
                        properties:
                          href:
                            type: string
    Error406NotAcceptable:
      type: object
      properties:
        total:
          type: integer
        _embedded:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                additionalProperties: true
                properties:
                  code:
                    type: string
                    enum:
                      - NOT_FOUND
                  logref:
                    $ref: '#/components/schemas/logref'
                  message:
                    type: string
                  _links:
                    type: object
                    properties:
                      source:
                        type: object
                        properties:
                          href:
                            type: string
      title: ''
    Error422InvalidFieldList:
      type: object
      description: Invalid field
      title: ''
      properties:
        total:
          type: integer
        _embedded:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - INVALID_FIELD
                  field:
                    type: string
                  logref:
                    $ref: '#/components/schemas/logref'
                  message:
                    type: string
                  _links:
                    type: object
                    properties:
                      source:
                        type: object
                        properties:
                          href:
                            type: string
    CreateBalanceAdjustmentRequest:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          type: string
          description: ISO 4217 3 letter currency code.
          enum:
            - USD
        description:
          type: string
          description: A description of the `Balance Adjustment`.
        instrument_id:
          type: string
          description: >-
            The account, card, or bank account that is credited or debited as
            part of the adjustment.
        processor:
          type: string
          description: >-
            The payment processing entity responsible for handling transactions,
            fund movements, etc., between different financial accounts.
          enum:
            - DUMMY_V1
        rail:
          type: string
          enum:
            - ACH
          description: The method of adjustment.
        top_up_config_id:
          type: string
          description: The ID of the top-up configuration that created the adjustment.
          nullable: true
        type:
          type: string
          description: >
            Specifies whether the `Balance Adjustment` increases or decreases
            the account balance.


            - `TOP_UP` - Adds funds to the balance (e.g., a deposit or manual
            funding).  
          enum:
            - TOP_UP
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - amount
        - currency
        - description
        - instrument_id
        - processor
        - rail
    Fee:
      type: object
      title: Fee
      description: A charge levied against a `Merchant`.
      properties:
        id:
          type: string
          description: The ID of the `Fee` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        amount:
          type: number
          format: double
          description: |
            Represents the total amount. The value may be returned as either: 

            - an **integer** (`int32`) in cents (e.g., `100` = $1.00), or  
            - a **double** for fractional amounts (e.g., `2.393`).
          example: 2.393
        application:
          $ref: '#/components/schemas/application_id'
        category:
          type: string
          description: The `Fee` category.
          enum:
            - PROCESSOR
            - INTERCHANGE
            - DUES_AND_ASSESSMENTS
            - THIRD_PARTY_SERVICE_PROVIDER
          nullable: true
        currency:
          $ref: '#/components/schemas/currency'
        display_name:
          type: string
          description: >-
            It is used for subscription fees and allows free-form text to be
            passed from the subscription fee product. Note that this product is
            mostly deprecated.
          nullable: true
        fee_profile:
          type: string
          description: >-
            The ID of the `Fee Profile` used to calculate fees for the
            `Transfer` related to this `Fee`. The specific `Transfer` is
            identified by the `linked_to` field.
        fee_subtype:
          type: string
          enum:
            - CUSTOM
            - APPLICATION_FEE
            - PLATFORM_FEE
          description: The subtype of the `Fee`.
        fee_type:
          type: string
          enum:
            - ACH_BASIS_POINTS
            - ACH_CREDIT_RETURN_FIXED_FEE
            - ACH_DEBIT_RETURN_FIXED_FEE
            - ACH_FIXED
            - ACH_MAX_FIXED
            - ACH_NOTICE_OF_CHANGE_CREDIT_FIXED
            - ACH_NOTICE_OF_CHANGE_DEBIT_FIXED
            - AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS
            - AMERICAN_EXPRESS_BASIS_POINTS
            - AMERICAN_EXPRESS_FIXED
            - AMERICAN_EXPRESS_INTERCHANGE
            - ANCILLARY_FIXED_FEE_PRIMARY
            - ANCILLARY_FIXED_FEE_SECONDARY
            - APPLICATION_FEE
            - CARD_BASIS_POINTS
            - CARD_FIXED
            - CARD_INTERCHANGE
            - CUSTOM
            - DINERS_CLUB_BASIS_POINTS
            - DINERS_CLUB_FIXED
            - DINERS_CLUB_INTERCHANGE
            - DISCOVER_ASSESSMENT_BASIS_POINTS
            - DISCOVER_BASIS_POINTS
            - DISCOVER_DATA_USAGE_FIXED
            - DISCOVER_FIXED
            - DISCOVER_INTERCHANGE
            - DISCOVER_NETWORK_AUTHORIZATION_FIXED
            - DISPUTE_FIXED_FEE
            - DISPUTE_INQUIRY_FIXED_FEE
            - EFT_MAX_FIXED
            - JCB_BASIS_POINTS
            - JCB_FIXED
            - JCB_INTERCHANGE
            - MASTERCARD_ACQUIRER_FEE_BASIS_POINTS
            - MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS
            - MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS
            - MASTERCARD_BASIS_POINTS
            - MASTERCARD_FIXED
            - MASTERCARD_INTERCHANGE
            - QUALIFIED_TIER_BASIS_POINTS_FEE
            - QUALIFIED_TIER_FIXED_FEE
            - SETTLEMENT_FUNDING_TRANSFER_ACH_BASIS_POINTS
            - SETTLEMENT_FUNDING_TRANSFER_ACH_CREDIT_RETURN_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_ACH_DEBIT_RETURN_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_ACH_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_ACH_MAX_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_EFT_BASIS_POINTS
            - SETTLEMENT_FUNDING_TRANSFER_EFT_CREDIT_RETURN_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_EFT_DEBIT_RETURN_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_EFT_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_EFT_MAX_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_BASIS_POINTS
            - SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_MAX_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_NOC_CREDIT_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_NOC_DEBIT_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_BASIS_POINTS
            - SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_MAX_FIXED
            - SETTLEMENT_V2_TRANSFER
            - SUBSCRIPTION_ACH_BASIS_POINTS
            - SUBSCRIPTION_ACH_FIXED
            - SUBSCRIPTION_ACH_MAX_FIXED
            - SUBSCRIPTION_CARD_BASIS_POINTS
            - SUBSCRIPTION_CARD_FIXED
            - SUBSCRIPTION_EFT_BASIS_POINTS
            - SUBSCRIPTION_EFT_FIXED
            - SUBSCRIPTION_EFT_MAX_FIXED
            - SUPPLEMENTAL_FEE_FIXED
            - VISA_ACQUIRER_PROCESSING_FIXED
            - VISA_ASSESSMENT_BASIS_POINTS
            - VISA_BASE_II_CREDIT_VOUCHER_FIXED
            - VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED
            - VISA_BASIS_POINTS
            - VISA_CREDIT_VOUCHER_FIXED
            - VISA_FIXED
            - VISA_INTERCHANGE
            - VISA_KILOBYTE_ACCESS_FIXED
          description: The type of `Fee`.
        label:
          type: string
          description: >-
            It is used for subscription fees and allows free-form text to be
            passed from the subscription fee product. Note that this product is
            mostly deprecated.
          nullable: true
        linked_id:
          type: string
          description: >-
            The ID of the linked resource. Note that this field will be
            deprecated soon, use `linked_to` instead.
        linked_to:
          type: string
          description: The ID of the linked resource.
        linked_type:
          type: string
          enum:
            - TRANSFER
            - AUTHORIZATION
          description: The type of entity the `Fee` is linked to.
        merchant:
          type: string
          description: The ID of the `Merchant` resource that was charged the fee.
        ready_to_settle_at:
          type: string
          format: date-time
          description: >-
            The timestamp indicating when the `Transfer` related to this `Fee`
            is ready to be settled. The specific `Transfer` is identified by the
            `linked_to` field.
          nullable: true
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: The path to the `Fee` resource.
              properties:
                href:
                  type: string
            merchant:
              type: object
              description: A link to the `Merchant` that the fee was debited from.
              properties:
                href:
                  type: string
            transfer:
              type: object
              description: A link to the `Transfer` that generated the `Fee`.
              properties:
                href:
                  type: string
    CreateFeeRequest:
      type: object
      title: ''
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        display_name:
          type: string
          description: >-
            The display name of the `Fee` that can be used for filtering
            purposes.
        fee_subtype:
          type: string
          enum:
            - CUSTOM
          description: |
            Subtype of the fee. Set to **CUSTOM**.
        fee_type:
          type: string
          enum:
            - CUSTOM
          description: The type of the fee. Must be set to **CUSTOM**.
        merchant:
          type: string
          description: The ID of the `Merchant` resource used to create the `Fee`.
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - amount
        - currency
        - fee_subtype
        - fee_type
        - merchant
    UpdateFeeRequest:
      type: object
      description: ''
      properties:
        tags:
          type: object
          description: Key value pair for annotating custom meta data (e.g. order numbers).
          nullable: true
    FeesList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageOffset'
        _embedded:
          type: object
          description: List of `fee` objects.
          properties:
            fees:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`fee` objects.'
              items:
                $ref: '#/components/schemas/Fee'
        _links:
          $ref: '#/components/schemas/ListLinks'
    MerchantProfile:
      type: object
      description: ''
      properties:
        id:
          type: string
          description: The ID of the `Merchant Profile` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          description: The ID of the `Application` associated with the  `Merchant Profile`.
        card_present_fee_profile:
          type: string
          description: >-
            The ID of the `Fee Profile` to be used for all card present
            transfers associated with the `Merchant Profile` resource. If not
            set the value in `fee_profile` will be used for card present
            transfers.
          nullable: true
        fee_profile:
          type: string
          description: >-
            The ID of the `Fee Profile` associated with the `Merchant Profile`
            resource.
          nullable: true
        payout_profile:
          type: string
          description: >-
            The ID of the `Payout Profile` associated with the `Merchant
            Profile` resource.
          nullable: true
        risk_profile:
          type: string
          description: >-
            The ID of the `Risk Profile` associated with the `Merchant Profile`
            resource.
          nullable: true
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            application:
              type: object
              description: Link to the `Application` the resource was created under.
              properties:
                href:
                  type: string
            fee_profile:
              type: object
              properties:
                href:
                  type: string
            owner_identity:
              type: object
              properties:
                href:
                  type: string
            processors:
              type: object
              properties:
                href:
                  type: string
            reserve_profile:
              type: object
              properties:
                href:
                  type: string
            risk_profile:
              type: object
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
            users:
              type: object
              properties:
                href:
                  type: string
    MerchantProfilesList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `merchant_profile` objects.
          properties:
            merchant_profiles:
              type: array
              description: '`merchant_profile` objects.'
              items:
                $ref: '#/components/schemas/MerchantProfile'
        _links:
          $ref: '#/components/schemas/ListLinks'
    MerchantsList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Merchant` objects.
          properties:
            merchants:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Merchant` objects.'
              items:
                $ref: '#/components/schemas/merchant'
        _links:
          $ref: '#/components/schemas/ListLinks'
    PaymentInstrumentUpdatesList:
      type: object
      description: ''
      properties:
        page:
          $ref: '#/components/schemas/PageOffset'
        _embedded:
          type: object
          description: List of `updates` for a `Payment Instrument`.
          properties:
            updates:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Update` objects.'
              items:
                $ref: '#/components/schemas/InstrumentUpdate'
        _links:
          $ref: '#/components/schemas/ListLinks'
    Processor:
      description: ''
      type: object
      properties:
        id:
          type: string
          example: PRxxxxxxxxxxxxxxxxxx
          description: ID of the `Processor` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          description: The ID of the `Application` resource.
        application_config:
          type: object
          description: Details that configure how the `Processor` handles transactions.
          nullable: true
          properties:
            ach_settlement_delay_days:
              type: integer
              minimum: 0
              x-finix-issues:
                - property2
              description: Details how days ACH settlments are delayed by.
              nullable: true
            allow_split_payouts:
              type: boolean
              description: Details if the `Processor` allows split payouts to `Merchants`.
            allowed_business_application_ids:
              type: array
              description: >-
                Identifies the `Processors` business application type for
                VisaNet transaction processing.
              items:
                type: string
                enum:
                  - AA
                  - BB
                  - BI
                  - CP
                  - FD
                  - FT
                  - GD
                  - GP
                  - LO
                  - CI
                  - CO
                  - MP
                  - MD
                  - OG
                  - PD
                  - PP
                  - TU
                  - WT
            card_acceptor_id_code:
              type: string
              description: 'An ID for the card acceptor (e.g Visa). '
            card_acceptor_terminal_id:
              type: string
              description: The ID for the terminal at a card acceptor location.
            configuration_templates:
              type: object
              nullable: true
              properties:
                country:
                  type: object
                  description: 3-Letter Country code.
            default_currencies:
              type: array
              description: ISO 4217 3 letter currency code.
              items:
                $ref: '#/components/schemas/currency'
            default_mcc:
              type: string
              enum:
                - '0742'
                - '0763'
                - '0780'
                - '1520'
                - '1711'
                - '1731'
                - '1740'
                - '1750'
                - '1761'
                - '1771'
                - '1799'
                - '2741'
                - '2791'
                - '2842'
                - '3000'
                - '3001'
                - '3002'
                - '3003'
                - '3004'
                - '3005'
                - '3006'
                - '3007'
                - '3008'
                - '3009'
                - '3010'
                - '3011'
                - '3012'
                - '3013'
                - '3014'
                - '3015'
                - '3016'
                - '3017'
                - '3018'
                - '3019'
                - '3020'
                - '3021'
                - '3022'
                - '3023'
                - '3024'
                - '3025'
                - '3026'
                - '3027'
                - '3028'
                - '3029'
                - '3030'
                - '3031'
                - '3032'
                - '3033'
                - '3034'
                - '3035'
                - '3036'
                - '3037'
                - '3038'
                - '3039'
                - '3040'
                - '3041'
                - '3042'
                - '3043'
                - '3044'
                - '3045'
                - '3046'
                - '3047'
                - '3048'
                - '3049'
                - '3050'
                - '3051'
                - '3052'
                - '3053'
                - '3054'
                - '3055'
                - '3056'
                - '3057'
                - '3058'
                - '3059'
                - '3060'
                - '3061'
                - '3062'
                - '3063'
                - '3064'
                - '3065'
                - '3066'
                - '3067'
                - '3068'
                - '3069'
                - '3070'
                - '3071'
                - '3072'
                - '3073'
                - '3074'
                - '3075'
                - '3076'
                - '3077'
                - '3078'
                - '3079'
                - '3080'
                - '3081'
                - '3082'
                - '3083'
                - '3084'
                - '3085'
                - '3086'
                - '3087'
                - '3088'
                - '3089'
                - '3090'
                - '3091'
                - '3092'
                - '3093'
                - '3094'
                - '3095'
                - '3096'
                - '3097'
                - '3098'
                - '3099'
                - '3100'
                - '3101'
                - '3102'
                - '3103'
                - '3104'
                - '3105'
                - '3106'
                - '3107'
                - '3108'
                - '3109'
                - '3110'
                - '3111'
                - '3112'
                - '3113'
                - '3114'
                - '3115'
                - '3116'
                - '3117'
                - '3118'
                - '3119'
                - '3120'
                - '3121'
                - '3122'
                - '3123'
                - '3124'
                - '3125'
                - '3126'
                - '3127'
                - '3128'
                - '3129'
                - '3130'
                - '3131'
                - '3132'
                - '3133'
                - '3134'
                - '3135'
                - '3136'
                - '3137'
                - '3138'
                - '3139'
                - '3140'
                - '3141'
                - '3142'
                - '3143'
                - '3144'
                - '3145'
                - '3146'
                - '3147'
                - '3148'
                - '3149'
                - '3150'
                - '3151'
                - '3152'
                - '3153'
                - '3154'
                - '3155'
                - '3156'
                - '3157'
                - '3158'
                - '3159'
                - '3160'
                - '3161'
                - '3162'
                - '3163'
                - '3164'
                - '3165'
                - '3166'
                - '3167'
                - '3168'
                - '3169'
                - '3170'
                - '3171'
                - '3172'
                - '3173'
                - '3174'
                - '3175'
                - '3176'
                - '3177'
                - '3178'
                - '3179'
                - '3180'
                - '3181'
                - '3182'
                - '3183'
                - '3184'
                - '3185'
                - '3186'
                - '3187'
                - '3188'
                - '3189'
                - '3190'
                - '3191'
                - '3192'
                - '3193'
                - '3194'
                - '3195'
                - '3196'
                - '3197'
                - '3198'
                - '3199'
                - '3200'
                - '3201'
                - '3202'
                - '3203'
                - '3204'
                - '3205'
                - '3206'
                - '3207'
                - '3208'
                - '3209'
                - '3210'
                - '3211'
                - '3212'
                - '3213'
                - '3214'
                - '3215'
                - '3216'
                - '3217'
                - '3218'
                - '3219'
                - '3220'
                - '3221'
                - '3222'
                - '3223'
                - '3224'
                - '3225'
                - '3226'
                - '3227'
                - '3228'
                - '3229'
                - '3230'
                - '3231'
                - '3232'
                - '3233'
                - '3234'
                - '3235'
                - '3236'
                - '3237'
                - '3238'
                - '3239'
                - '3240'
                - '3241'
                - '3242'
                - '3243'
                - '3244'
                - '3245'
                - '3246'
                - '3247'
                - '3248'
                - '3249'
                - '3250'
                - '3251'
                - '3252'
                - '3253'
                - '3254'
                - '3255'
                - '3256'
                - '3257'
                - '3258'
                - '3259'
                - '3260'
                - '3261'
                - '3262'
                - '3263'
                - '3264'
                - '3265'
                - '3266'
                - '3267'
                - '3268'
                - '3269'
                - '3270'
                - '3271'
                - '3272'
                - '3273'
                - '3274'
                - '3275'
                - '3276'
                - '3277'
                - '3278'
                - '3279'
                - '3280'
                - '3281'
                - '3282'
                - '3283'
                - '3284'
                - '3285'
                - '3286'
                - '3287'
                - '3288'
                - '3289'
                - '3290'
                - '3291'
                - '3292'
                - '3293'
                - '3294'
                - '3295'
                - '3296'
                - '3297'
                - '3298'
                - '3299'
                - '3351'
                - '3352'
                - '3353'
                - '3354'
                - '3355'
                - '3356'
                - '3357'
                - '3358'
                - '3359'
                - '3360'
                - '3361'
                - '3362'
                - '3363'
                - '3364'
                - '3365'
                - '3366'
                - '3367'
                - '3368'
                - '3369'
                - '3370'
                - '3371'
                - '3372'
                - '3373'
                - '3374'
                - '3375'
                - '3376'
                - '3377'
                - '3378'
                - '3379'
                - '3380'
                - '3381'
                - '3382'
                - '3383'
                - '3384'
                - '3385'
                - '3386'
                - '3387'
                - '3388'
                - '3389'
                - '3390'
                - '3391'
                - '3392'
                - '3393'
                - '3394'
                - '3395'
                - '3396'
                - '3397'
                - '3398'
                - '3399'
                - '3400'
                - '3401'
                - '3402'
                - '3403'
                - '3404'
                - '3405'
                - '3406'
                - '3407'
                - '3408'
                - '3409'
                - '3410'
                - '3411'
                - '3412'
                - '3413'
                - '3414'
                - '3415'
                - '3416'
                - '3417'
                - '3418'
                - '3419'
                - '3420'
                - '3421'
                - '3422'
                - '3423'
                - '3424'
                - '3425'
                - '3426'
                - '3427'
                - '3428'
                - '3429'
                - '3430'
                - '3431'
                - '3432'
                - '3433'
                - '3434'
                - '3435'
                - '3436'
                - '3437'
                - '3438'
                - '3439'
                - '3440'
                - '3441'
                - '3501'
                - '3502'
                - '3503'
                - '3504'
                - '3505'
                - '3506'
                - '3507'
                - '3508'
                - '3509'
                - '3510'
                - '3511'
                - '3512'
                - '3513'
                - '3514'
                - '3515'
                - '3516'
                - '3517'
                - '3518'
                - '3519'
                - '3520'
                - '3521'
                - '3522'
                - '3523'
                - '3524'
                - '3525'
                - '3526'
                - '3527'
                - '3528'
                - '3529'
                - '3530'
                - '3531'
                - '3532'
                - '3533'
                - '3534'
                - '3535'
                - '3536'
                - '3537'
                - '3538'
                - '3539'
                - '3540'
                - '3541'
                - '3542'
                - '3543'
                - '3544'
                - '3545'
                - '3546'
                - '3547'
                - '3548'
                - '3549'
                - '3550'
                - '3551'
                - '3552'
                - '3553'
                - '3554'
                - '3555'
                - '3556'
                - '3557'
                - '3558'
                - '3559'
                - '3560'
                - '3561'
                - '3562'
                - '3563'
                - '3564'
                - '3565'
                - '3566'
                - '3567'
                - '3568'
                - '3569'
                - '3570'
                - '3571'
                - '3572'
                - '3573'
                - '3574'
                - '3575'
                - '3576'
                - '3577'
                - '3578'
                - '3579'
                - '3580'
                - '3581'
                - '3582'
                - '3583'
                - '3584'
                - '3585'
                - '3586'
                - '3587'
                - '3588'
                - '3589'
                - '3590'
                - '3591'
                - '3592'
                - '3593'
                - '3594'
                - '3595'
                - '3596'
                - '3597'
                - '3598'
                - '3599'
                - '3600'
                - '3601'
                - '3602'
                - '3603'
                - '3604'
                - '3605'
                - '3606'
                - '3607'
                - '3608'
                - '3609'
                - '3610'
                - '3611'
                - '3612'
                - '3613'
                - '3614'
                - '3615'
                - '3616'
                - '3617'
                - '3618'
                - '3619'
                - '3620'
                - '3621'
                - '3622'
                - '3623'
                - '3624'
                - '3625'
                - '3626'
                - '3627'
                - '3628'
                - '3629'
                - '3630'
                - '3631'
                - '3632'
                - '3633'
                - '3634'
                - '3635'
                - '3636'
                - '3637'
                - '3638'
                - '3639'
                - '3640'
                - '3641'
                - '3642'
                - '3643'
                - '3644'
                - '3645'
                - '3646'
                - '3647'
                - '3648'
                - '3649'
                - '3650'
                - '3651'
                - '3652'
                - '3653'
                - '3654'
                - '3655'
                - '3656'
                - '3657'
                - '3658'
                - '3659'
                - '3660'
                - '3661'
                - '3662'
                - '3663'
                - '3664'
                - '3665'
                - '3666'
                - '3667'
                - '3668'
                - '3669'
                - '3670'
                - '3671'
                - '3672'
                - '3673'
                - '3674'
                - '3675'
                - '3676'
                - '3677'
                - '3678'
                - '3679'
                - '3680'
                - '3681'
                - '3682'
                - '3683'
                - '3684'
                - '3685'
                - '3686'
                - '3687'
                - '3688'
                - '3689'
                - '3690'
                - '3691'
                - '3692'
                - '3693'
                - '3694'
                - '3695'
                - '3696'
                - '3697'
                - '3698'
                - '3699'
                - '3700'
                - '3701'
                - '3702'
                - '3703'
                - '3704'
                - '3705'
                - '3706'
                - '3707'
                - '3708'
                - '3709'
                - '3710'
                - '3711'
                - '3712'
                - '3713'
                - '3714'
                - '3715'
                - '3716'
                - '3717'
                - '3718'
                - '3719'
                - '3720'
                - '3721'
                - '3722'
                - '3723'
                - '3724'
                - '3725'
                - '3726'
                - '3727'
                - '3728'
                - '3729'
                - '3730'
                - '3731'
                - '3732'
                - '3733'
                - '3734'
                - '3735'
                - '3736'
                - '3737'
                - '3738'
                - '3739'
                - '3740'
                - '3741'
                - '3742'
                - '3743'
                - '3744'
                - '3745'
                - '3746'
                - '3747'
                - '3748'
                - '3749'
                - '3750'
                - '3751'
                - '3752'
                - '3753'
                - '3754'
                - '3755'
                - '3756'
                - '3757'
                - '3758'
                - '3759'
                - '3760'
                - '3761'
                - '3762'
                - '3763'
                - '3764'
                - '3765'
                - '3766'
                - '3767'
                - '3768'
                - '3769'
                - '3770'
                - '3771'
                - '3772'
                - '3773'
                - '3774'
                - '3775'
                - '3776'
                - '3777'
                - '3778'
                - '3779'
                - '3780'
                - '3781'
                - '3782'
                - '3783'
                - '3784'
                - '3785'
                - '3786'
                - '3787'
                - '3788'
                - '3789'
                - '3790'
                - '3816'
                - '3835'
                - '4011'
                - '4111'
                - '4112'
                - '4119'
                - '4121'
                - '4131'
                - '4214'
                - '4215'
                - '4225'
                - '4411'
                - '4457'
                - '4468'
                - '4511'
                - '4582'
                - '4722'
                - '4723'
                - '4784'
                - '4789'
                - '4812'
                - '4814'
                - '4815'
                - '4816'
                - '4821'
                - '4829'
                - '4899'
                - '4900'
                - '5013'
                - '5021'
                - '5039'
                - '5044'
                - '5045'
                - '5046'
                - '5047'
                - '5051'
                - '5065'
                - '5072'
                - '5074'
                - '5085'
                - '5094'
                - '5099'
                - '5111'
                - '5122'
                - '5131'
                - '5137'
                - '5139'
                - '5169'
                - '5172'
                - '5192'
                - '5193'
                - '5198'
                - '5199'
                - '5200'
                - '5211'
                - '5231'
                - '5251'
                - '5261'
                - '5271'
                - '5300'
                - '5309'
                - '5310'
                - '5311'
                - '5331'
                - '5399'
                - '5411'
                - '5422'
                - '5441'
                - '5451'
                - '5462'
                - '5499'
                - '5511'
                - '5521'
                - '5531'
                - '5532'
                - '5533'
                - '5541'
                - '5542'
                - '5551'
                - '5561'
                - '5571'
                - '5592'
                - '5598'
                - '5599'
                - '5611'
                - '5621'
                - '5631'
                - '5641'
                - '5651'
                - '5655'
                - '5661'
                - '5681'
                - '5691'
                - '5697'
                - '5698'
                - '5699'
                - '5712'
                - '5713'
                - '5714'
                - '5718'
                - '5719'
                - '5722'
                - '5732'
                - '5733'
                - '5734'
                - '5735'
                - '5811'
                - '5812'
                - '5813'
                - '5814'
                - '5815'
                - '5816'
                - '5817'
                - '5818'
                - '5832'
                - '5912'
                - '5921'
                - '5931'
                - '5932'
                - '5933'
                - '5935'
                - '5937'
                - '5940'
                - '5941'
                - '5942'
                - '5943'
                - '5944'
                - '5945'
                - '5946'
                - '5947'
                - '5948'
                - '5949'
                - '5950'
                - '5960'
                - '5961'
                - '5962'
                - '5963'
                - '5964'
                - '5965'
                - '5966'
                - '5967'
                - '5968'
                - '5969'
                - '5970'
                - '5971'
                - '5972'
                - '5973'
                - '5975'
                - '5976'
                - '5977'
                - '5978'
                - '5983'
                - '5992'
                - '5993'
                - '5994'
                - '5995'
                - '5996'
                - '5997'
                - '5998'
                - '5999'
                - '6010'
                - '6011'
                - '6012'
                - '6051'
                - '6211'
                - '6300'
                - '6381'
                - '6399'
                - '6513'
                - '7011'
                - '7012'
                - '7032'
                - '7033'
                - '7210'
                - '7211'
                - '7216'
                - '7217'
                - '7221'
                - '7230'
                - '7251'
                - '7261'
                - '7273'
                - '7276'
                - '7277'
                - '7278'
                - '7296'
                - '7297'
                - '7298'
                - '7299'
                - '7311'
                - '7321'
                - '7332'
                - '7333'
                - '7338'
                - '7339'
                - '7342'
                - '7349'
                - '7361'
                - '7372'
                - '7375'
                - '7379'
                - '7392'
                - '7393'
                - '7394'
                - '7395'
                - '7399'
                - '7511'
                - '7512'
                - '7513'
                - '7519'
                - '7523'
                - '7531'
                - '7534'
                - '7535'
                - '7538'
                - '7542'
                - '7549'
                - '7622'
                - '7623'
                - '7629'
                - '7631'
                - '7641'
                - '7692'
                - '7699'
                - '7800'
                - '7801'
                - '7802'
                - '7829'
                - '7832'
                - '7841'
                - '7911'
                - '7922'
                - '7929'
                - '7932'
                - '7933'
                - '7941'
                - '7991'
                - '7992'
                - '7993'
                - '7994'
                - '7995'
                - '7996'
                - '7997'
                - '7998'
                - '7999'
                - '8011'
                - '8021'
                - '8031'
                - '8041'
                - '8042'
                - '8043'
                - '8044'
                - '8049'
                - '8050'
                - '8062'
                - '8071'
                - '8099'
                - '8111'
                - '8211'
                - '8220'
                - '8241'
                - '8244'
                - '8249'
                - '8299'
                - '8351'
                - '8398'
                - '8641'
                - '8651'
                - '8661'
                - '8675'
                - '8699'
                - '8734'
                - '8911'
                - '8931'
                - '8999'
                - '9211'
                - '9222'
                - '9223'
                - '9311'
                - '9399'
                - '9402'
                - '9405'
                - '9700'
                - '9701'
                - '9702'
                - '9950'
              x-finix-issues:
                - property2
              description: 'The Merchant Category Code of the `Merchan. '
            default_sender_account_number:
              type: string
              description: The default account of the sender.
              nullable: true
            default_sender_address:
              type: string
              description: The sender’s address.
              nullable: true
            default_sender_city:
              type: string
              description: The city saved in the sender's address.
              nullable: true
            default_sender_country:
              $ref: '#/components/schemas/country'
            default_sender_country_code:
              type: string
              description: The sender's 3 letter ISO 4217 currency code.
              nullable: true
            default_sender_county_code:
              type: string
              description: The sender’s county.
              nullable: true
            default_sender_name:
              type: string
              description: The sender’s name.
              nullable: true
            default_sender_state_code:
              type: string
              description: The sender's 2-letter State code.
              nullable: true
            default_sender_zip_code:
              type: string
              description: The sender’s zip code.
              nullable: true
            include_colombia_data:
              type: boolean
              description: >-
                Must be true if transactions are in Colombia where there are
                different fees.
            moto_eciindicator:
              type: string
              enum:
                - '5'
                - '6'
                - '7'
                - '8'
              x-finix-issues:
                - property2
              description: >-
                Identifies the level of security used in an electronic commerce
                transaction (only applies to card-present transactions).
            pan_entry_mode:
              type: string
              enum:
                - '00'
                - '01'
                - '02'
                - '03'
                - '04'
                - '05'
                - '06'
                - '07'
                - '08'
                - '09'
                - '10'
                - '80'
                - '82'
                - '83'
                - '90'
                - '91'
                - '95'
              x-finix-issues:
                - property2
              description: >-
                A 2-digit code that identifies the method used to enter the
                cardholder account number and card expiration date (only applies
                to card-present transactions).
            pos_condition_code:
              type: string
              enum:
                - '00'
                - '01'
                - '02'
                - '03'
                - '05'
                - '06'
                - '08'
                - '10'
                - '51'
                - '59'
                - '71'
                - '73'
              x-finix-issues:
                - property2
              description: >-
                Contains a code identifying transaction conditions at the point
                of sale or point of service (only applies to card-present
                transactions).
        config:
          type: object
          description: >-
            Configure how the `Processor` handles transaction details, specific
            to the processor.
          nullable: true
          properties:
            canDebitBankAccount:
              type: boolean
              description: >-
                Details if the `Application` can debit bank accounts using the
                `Processor`.
        default_merchant_profile:
          type: string
          description: >-
            The ID of the `Merchant Profile` resource used to create the
            `Processor`.
        enabled:
          type: boolean
          description: >-
            Details if the `Processor` resource is enabled. Set to **false** to
            disable the `Processor`.
        processor:
          type: string
          description: The name of the processor.
        system_config:
          type: object
          description: >-
            Details that configure how the `Processor` handles transactions with
            the processor.
          nullable: true
          properties:
            acquirer_country_code:
              type: string
              enum:
                - '004'
                - '008'
                - '010'
                - '012'
                - '016'
                - '020'
                - '024'
                - '028'
                - '031'
                - '032'
                - '036'
                - '040'
                - '044'
                - '048'
                - '050'
                - '051'
                - '052'
                - '056'
                - '060'
                - '064'
                - '068'
                - '070'
                - '072'
                - '074'
                - '076'
                - '084'
                - '086'
                - '090'
                - '092'
                - '096'
                - '100'
                - '104'
                - '108'
                - '112'
                - '116'
                - '120'
                - '124'
                - '132'
                - '136'
                - '140'
                - '144'
                - '148'
                - '152'
                - '156'
                - '158'
                - '162'
                - '166'
                - '170'
                - '174'
                - '175'
                - '178'
                - '180'
                - '184'
                - '188'
                - '191'
                - '192'
                - '196'
                - '203'
                - '204'
                - '208'
                - '212'
                - '214'
                - '218'
                - '222'
                - '226'
                - '231'
                - '232'
                - '233'
                - '234'
                - '238'
                - '239'
                - '242'
                - '246'
                - '248'
                - '250'
                - '254'
                - '258'
                - '260'
                - '262'
                - '266'
                - '268'
                - '270'
                - '275'
                - '276'
                - '288'
                - '292'
                - '296'
                - '300'
                - '304'
                - '308'
                - '312'
                - '316'
                - '320'
                - '324'
                - '328'
                - '332'
                - '334'
                - '336'
                - '340'
                - '344'
                - '348'
                - '352'
                - '356'
                - '360'
                - '364'
                - '368'
                - '372'
                - '376'
                - '380'
                - '384'
                - '388'
                - '392'
                - '398'
                - '400'
                - '404'
                - '408'
                - '410'
                - '414'
                - '417'
                - '418'
                - '422'
                - '426'
                - '428'
                - '430'
                - '434'
                - '438'
                - '440'
                - '442'
                - '446'
                - '450'
                - '454'
                - '458'
                - '462'
                - '466'
                - '470'
                - '474'
                - '478'
                - '480'
                - '484'
                - '492'
                - '496'
                - '498'
                - '499'
                - '500'
                - '504'
                - '508'
                - '512'
                - '516'
                - '520'
                - '524'
                - '528'
                - '531'
                - '533'
                - '534'
                - '535'
                - '540'
                - '548'
                - '554'
                - '558'
                - '562'
                - '566'
                - '570'
                - '574'
                - '578'
                - '580'
                - '581'
                - '583'
                - '584'
                - '585'
                - '586'
                - '591'
                - '598'
                - '600'
                - '604'
                - '608'
                - '612'
                - '616'
                - '620'
                - '624'
                - '626'
                - '630'
                - '634'
                - '638'
                - '642'
                - '643'
                - '646'
                - '652'
                - '654'
                - '659'
                - '660'
                - '662'
                - '663'
                - '666'
                - '670'
                - '674'
                - '678'
                - '682'
                - '686'
                - '688'
                - '690'
                - '694'
                - '702'
                - '703'
                - '704'
                - '705'
                - '706'
                - '710'
                - '716'
                - '724'
                - '728'
                - '729'
                - '732'
                - '740'
                - '744'
                - '748'
                - '752'
                - '756'
                - '760'
                - '762'
                - '764'
                - '768'
                - '772'
                - '776'
                - '780'
                - '784'
                - '788'
                - '792'
                - '795'
                - '796'
                - '798'
                - '800'
                - '804'
                - '807'
                - '818'
                - '826'
                - '831'
                - '832'
                - '833'
                - '834'
                - '840'
                - '850'
                - '854'
                - '858'
                - '860'
                - '862'
                - '876'
                - '882'
                - '887'
                - '894'
              description: >-
                The 3 letter ISO 4217 country code for the country transactions
                are originating from.
            acquiring_bin:
              type: string
              description: >-
                The Bank Identification Number (BIN) the `Processor` is
                registered under with Visa Direct.
            allow_credit_for_partner:
              type: boolean
              description: Field used by Finix and processor to handle transactions.
            available_countries:
              type: array
              description: Details the countries the `Processor` is available in.
              items:
                $ref: '#/components/schemas/country'
            business_application_id:
              type: string
              description: The ID of the `Application` linked to the `Processor`.
            class_key_identifier:
              type: string
              enum:
                - io.finix.visa.direct.client.VisaSystemConfig
              description: Field used by processor to communicate with Finix.
            config:
              type: object
              description: Configure how the `Processor` handles `Payment Instruments`.
              properties:
                canDebitBankAccount:
                  type: object
                  additionalProperties:
                    type: object
                    properties: {}
                  description: >-
                    Set to true to allow the `Processor` to debit `Payment
                    instrument with type **BANK_ACCOUNT** (i.e. eCheck).
            default_currencies:
              type: array
              description: ISO 4217 3 letter currency code.
              items:
                $ref: '#/components/schemas/currency'
            disable_ppgs:
              type: boolean
              description: >-
                Set to **true** to enables the option to push payments to other
                U.S. debit networks using our Visa Direct integration.
            fee_program_indicator:
              type: string
              description: Details the price of a Visa Direct payout.
            gateway_proxy_certificate:
              type: string
              description: >-
                Used if the Gateway needs a proxy. Not applicable to Visa
                Direct.
              nullable: true
            gateway_proxy_host:
              type: string
              description: >-
                Used if the Gateway needs a proxy. Not applicable to Visa
                Direct.
              nullable: true
            gateway_proxy_password:
              type: string
              description: >-
                Used if the Gateway needs a proxy. Not applicable to Visa
                Direct.
              nullable: true
            gateway_proxy_port:
              type: string
              description: >-
                Used if the Gateway needs a proxy. Not applicable to Visa
                Direct.
              nullable: true
            gateway_proxy_username:
              type: string
              description: >-
                Used if the Gateway needs a proxy. Not applicable to Visa
                Direct.
              nullable: true
            key_store_password:
              type: string
              description: >-
                The password for the Java Keystore that stores the private keys
                and cert.pem files needed to process transactions using Visa
                Direct.
            key_store_path:
              type: string
              description: >-
                The path in AWS where the Java Keystore that stores the private
                keys and cert.pem files are and use to transact using Visa
                Direct.
            merchant_pseudo_aba_number:
              type: string
              description: >-
                A unique ID that's provided when a `Processor` signs up for Push
                Payment Gateway transactions (PPGS). PPGS allows you to push
                payments to other U.S. debit networks using our Visa Direct
                integration.
              nullable: true
            online_credit_processing:
              type: boolean
              description: >-
                Details if the `Processor` can handle online credit
                transactions.
            online_debit_processing:
              type: boolean
              description: Details if the `Processor` can handle online debit transactions.
            password:
              type: string
              description: >-
                The password found in the credentials section of the Visa
                Developer Portal (VDP) project. This is needed to connect to
                Visa Direct.
            private_key_password:
              type: string
              description: >-
                The password that was used to encrypt the private key that is
                contained in the Java Keystore.
            processor_sequence_limit:
              type: integer
              description: Field used by Finix and processor to handle transactions.
            pseudo_batch_push:
              type: boolean
              description: Field used by Finix and processor to handle transactions.
            source_of_funds:
              type: string
              enum:
                - '01'
                - '02'
                - '03'
                - '04'
                - '05'
                - '06'
              description: >-
                Specific code that reflects the use case (e.g. funds
                disbursement, money transfer, etc.). For a full list of codes,
                see the following [list from
                Visa](https://developer.visa.com/request_response_codes#source_of_funds).
            user_id:
              type: string
              description: >-
                The user ID found in the credentials section of the Visa
                Developer Portal (VDP) project. This is needed to connect to
                Visa Direct.
            visa_acceptance_cloud_key_store_path:
              type: string
              description: Field used by Finix and processor to handle transactions.
              nullable: true
            visa_acceptance_cloud_password:
              type: string
              description: Field used by Finix and processor to handle transactions.
              nullable: true
            visa_acceptance_cloud_url:
              type: string
              description: Field used by Finix and processor to handle transactions.
              nullable: true
            visa_acceptance_cloud_user_id:
              type: string
              description: Field used by Finix and processor to handle transactions.
              nullable: true
            visa_url:
              type: string
              description: The URL that is used to connect to Visa.
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            application:
              type: object
              description: Link to the `Application` the resource was created under.
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    ProcessorsList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Processors` objects.
          properties:
            processors:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Processors` objects.'
              items:
                $ref: '#/components/schemas/Processor'
        _links:
          $ref: '#/components/schemas/ListLinks'
    Settlement:
      type: object
      description: ''
      properties:
        id:
          type: string
          description: The ID of the `Settlement` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          description: >-
            The ID of the `Application` resource the `Settlement` was created
            under.
        currency:
          $ref: '#/components/schemas/currency'
        destination:
          type: string
          example: PIxxxxxxxxxxxxxxxxxx
          description: ID of the `Payment Instrument` where funds will be sent.
          nullable: true
        funds_flow:
          type: string
          description: >-
            Details how funds will be dispersed in the `Funding Transfer`
            (usually **null**).
          nullable: true
        identity:
          type: string
          description: The ID of the `Identity` used to create the `Settlement` resource.
        is_exception:
          type: boolean
          description: >-
            Returns true if settlement contains items that were removed from a
            previous settlement resource.
        merchant_id:
          type: string
          description: The ID of the `Merchant` used to create the `Settlement` resource.
        net_amount:
          type: integer
          description: >-
            The amount in cents that will be deposited into the merchant's bank
            account.
        payment_type:
          type: string
          description: >-
            The type of `Payment Instrument` used in the `Funding Transfer` (or
            the original payment).
          nullable: true
        payout_profile_id:
          type: string
          description: >-
            The id of the `Payout Profile` that was used to generate the
            settlement.
        processor:
          type: string
          description: Name of the `Settlement` processor.
        status:
          type: string
          enum:
            - APPROVED
            - AWAITING_APPROVAL
            - PENDING
          description: >-
            The status of the `Settlement`. Available values
            include:<ul><li>**APPROVED**<li>**AWAITING_APPROVAL**<li>**PENDING**</ul>
            Merchants only receive payouts when `Settlements` are **APPROVED**
            and receive the resulting funding `Transfer` . For more information,
            see [Payouts](/guides/payouts/).
        tags:
          $ref: '#/components/schemas/tags'
        total_amount:
          type: integer
          description: Total amount of the `Settlement` (in cents).
        total_fee:
          type: integer
          description: Sum of the fees in the `Settlement`.
        total_fees:
          type: integer
          description: |-
            Sum of the fees 
            (including Subcription Billing) in the `Settlement`.
        type:
          type: string
          nullable: false
          enum:
            - MERCHANT_REVENUE
            - PLATFORM_FEE
            - PARTNER_FEE
            - NOOP
            - MERCHANT
            - APPLICATION
            - PLATFORM
          description: Type of `Settlement`.
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            application:
              type: object
              description: Link to the `Application` the resource was created under.
              properties:
                href:
                  type: string
            credits:
              type: object
              properties:
                href:
                  type: string
            debits:
              type: object
              properties:
                href:
                  type: string
            disputes:
              type: object
              properties:
                href:
                  type: string
            fees:
              type: object
              properties:
                href:
                  type: string
            funding_transfers:
              type: object
              properties:
                href:
                  type: string
            identity:
              type: object
              properties:
                href:
                  type: string
            reversals:
              type: object
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
            transfers:
              type: object
              properties:
                href:
                  type: string
    SettlementsList:
      type: object
      description: ''
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Settlement` objects.
          properties:
            settlements:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Settlements` resource.'
              items:
                $ref: '#/components/schemas/Settlement'
        _links:
          $ref: '#/components/schemas/ListLinks'
    TransferAttempt:
      oneOf:
        - title: Transfer Attempt - Checkout Form
          description: Schema for a `Transfer Attempt` originating from a `Checkout Form`.
          type: object
          properties:
            id:
              type: string
              description: The ID of the `Transfer Attempt` resource.
            created_at:
              $ref: '#/components/schemas/created_at'
            updated_at:
              $ref: '#/components/schemas/updated_at'
            amount:
              $ref: '#/components/schemas/amount'
            application_id:
              type: string
              description: The `Application` associated with the `Transfer`.
              example: APfwZU6VSXNGRZi3ouEyLjAW
            buyer_details:
              type: object
              description: Object containing details about the buyer.
              properties:
                first_name:
                  type: string
                  description: First name of the buyer.
                last_name:
                  type: string
                  description: Last name of the buyer.
                email:
                  description: Email address of the buyer.
                  type: string
                identity_id:
                  type: string
                  description: The `Identity` `id` of the buyer.
                phone:
                  description: Phone number of the buyer.
                  type: string
                billing_address:
                  type: object
                  description: >-
                    The primary address associated with the `Payment
                    Instrument`.
                  properties:
                    city:
                      type: string
                      minLength: 1
                      maxLength: 20
                      description: City.
                      nullable: true
                    country:
                      $ref: '#/components/schemas/country'
                    line1:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The first line of the address.
                      nullable: true
                    line2:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The second line of the address.
                      nullable: true
                    postal_code:
                      type: string
                      minLength: 1
                      maxLength: 7
                      description: The zip or postal code.
                      nullable: true
                    region:
                      type: string
                      minLength: 1
                      description: 2-letter state code.
                      nullable: true
                shipping_address:
                  description: Shipping or mailing address of the buyer.
                  type: string
                  properties:
                    city:
                      type: string
                      minLength: 1
                      maxLength: 20
                      description: City.
                      nullable: true
                    country:
                      $ref: '#/components/schemas/country'
                    line1:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The first line of the address.
                      nullable: true
                    line2:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The second line of the address.
                      nullable: true
                    postal_code:
                      type: string
                      minLength: 1
                      maxLength: 7
                      description: The zip or postal code.
                      nullable: true
                    region:
                      type: string
                      minLength: 1
                      description: 2-letter state code.
                      nullable: true
            currency:
              $ref: '#/components/schemas/currency'
            entity_id:
              type: string
              description: The `Checkout Form` that initiated the `Transfer Attempt`.
            entity_type:
              type: string
              description: The type of entity that initiated the `Transfer Attempt`.
              enum:
                - CHECKOUT_FORM
            failure_code:
              $ref: '#/components/schemas/failure_code'
            failure_message:
              $ref: '#/components/schemas/failure_message'
            merchant_id:
              type: string
              description: >-
                The ID of the Merchant linked to the `Checkout Form` that
                initiated the `Transfer Attempt`.
              example: MUmfEGv5bMpSJ9k5TFRUjkmm
            operation_key:
              $ref: '#/components/schemas/operation_key'
            payment_frequency:
              type: string
              description: >-
                This field does not apply to `Transfer Attempt` resources
                originating from a `Checkout Form` and will always return
                `null`.
              nullable: true
            payment_instrument_id:
              type: string
              description: >-
                The `Payment Instrument` to be debited upon success of the
                `Transfer Attempt`.
            receipt_requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
            state:
              type: string
              description: The state of the `Transfer Attempt`.
              enum:
                - PENDING
                - FAILED
                - SUCCEEDED
            tags:
              $ref: '#/components/schemas/tags'
            transfer_id:
              type: string
              description: |
                The  `Transfer` associated with the `Transfer Attempt`.
              example: TR4XqdopsgBJmeVZznfFr9LZ
              pattern: TRxxxxxxxxxxxxxxxxxxxxxx
            type:
              type: string
              enum:
                - DEBIT
                - CREDIT
              description: Type of `Transfer`.
        - title: Transfer Attempt - Payment Link
          description: Schema for a `Transfer Attempt` originating from a `Payment Link`.
          type: object
          properties:
            id:
              type: string
              description: The ID of the `Transfer Attempt` resource.
            created_at:
              $ref: '#/components/schemas/created_at'
            updated_at:
              $ref: '#/components/schemas/updated_at'
            amount:
              $ref: '#/components/schemas/amount'
            application_id:
              type: string
              description: The `Application` associated with the `Transfer`.
              example: APfwZU6VSXNGRZi3ouEyLjAW
            buyer_details:
              type: object
              description: >-
                Object containing details about the buyer. This object is only
                used for `SINGLE_USE` payment links.
              properties:
                first_name:
                  type: string
                  description: First name of the buyer.
                last_name:
                  type: string
                  description: Last name of the buyer.
                email:
                  description: Email address of the buyer.
                  type: string
                identity_id:
                  type: string
                  description: The `Identity` `id` of the buyer.
                phone:
                  description: Phone number of the buyer.
                  type: string
                billing_address:
                  type: object
                  description: >-
                    The primary address associated with the `Payment
                    Instrument`.
                  properties:
                    city:
                      type: string
                      minLength: 1
                      maxLength: 20
                      description: City.
                      nullable: true
                    country:
                      $ref: '#/components/schemas/country'
                    line1:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The first line of the address.
                      nullable: true
                    line2:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The second line of the address.
                      nullable: true
                    postal_code:
                      type: string
                      minLength: 1
                      maxLength: 7
                      description: The zip or postal code.
                      nullable: true
                    region:
                      type: string
                      minLength: 1
                      description: 2-letter state code.
                      nullable: true
                shipping_address:
                  description: Shipping or mailing address of the buyer.
                  type: string
                  properties:
                    city:
                      type: string
                      minLength: 1
                      maxLength: 20
                      description: City.
                      nullable: true
                    country:
                      $ref: '#/components/schemas/country'
                    line1:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The first line of the address.
                      nullable: true
                    line2:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The second line of the address.
                      nullable: true
                    postal_code:
                      type: string
                      minLength: 1
                      maxLength: 7
                      description: The zip or postal code.
                      nullable: true
                    region:
                      type: string
                      minLength: 1
                      description: 2-letter state code.
                      nullable: true
            currency:
              $ref: '#/components/schemas/currency'
            entity_id:
              type: string
              description: The `Payment Link` that initiated the `Transfer Attempt`.
            entity_type:
              type: string
              description: The type of entity that initiated the `Transfer Attempt`.
              enum:
                - PAYMENT_LINK
            failure_code:
              $ref: '#/components/schemas/failure_code'
            failure_message:
              $ref: '#/components/schemas/failure_message'
            merchant_id:
              type: string
              description: >-
                The ID of the `Merchant` resource associated with the `Payment
                Link` that initiated the `Transfer Attempt`.
              example: MUmfEGv5bMpSJ9k5TFRUjkmm
            operation_key:
              $ref: '#/components/schemas/operation_key'
            payment_frequency:
              type: string
              description: >-
                Whether the `Payment Link` associated with the `Transfer
                Attempt` is single-use or recurring.
              default: ONE_TIME
              enum:
                - ONE_TIME
                - RECURRING
            payment_instrument_id:
              type: string
              description: >-
                The `Payment Instrument` to be debited upon success of the
                `Transfer Attempt`.
            receipt_requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
            state:
              type: string
              description: The state of the `Transfer Attempt`.
              enum:
                - PENDING
                - FAILED
                - SUCCEEDED
            tags:
              $ref: '#/components/schemas/tags'
            transfer_id:
              type: string
              description: |
                The  `Transfer` associated with the `Transfer Attempt`.
              example: TR4XqdopsgBJmeVZznfFr9LZ
              pattern: TRxxxxxxxxxxxxxxxxxxxxxx
            type:
              type: string
              enum:
                - DEBIT
                - CREDIT
              description: Type of `Transfer`.
        - title: Transfer Attempt - Payout Link
          description: Schema for a `Transfer Attempt` originating from a `Payout Link`.
          type: object
          properties:
            id:
              type: string
              description: The ID of the `Transfer Attempt` resource.
            created_at:
              $ref: '#/components/schemas/created_at'
            updated_at:
              $ref: '#/components/schemas/updated_at'
            amount:
              $ref: '#/components/schemas/amount'
            application_id:
              type: string
              description: The `Application` associated with the `Transfer`.
              example: APfwZU6VSXNGRZi3ouEyLjAW
            buyer_details:
              type: object
              description: >-
                This field does not apply to `Transfer Attempt` resources
                originating from a `Payout Link` and will always return `null`.
              properties:
                first_name:
                  type: string
                  description: First name of the buyer.
                last_name:
                  type: string
                  description: Last name of the buyer.
                email:
                  description: Email address of the buyer.
                  type: string
                identity_id:
                  type: string
                  description: The `Identity` `id` of the buyer.
                phone:
                  description: Phone number of the buyer.
                  type: string
                billing_address:
                  type: object
                  description: >-
                    The primary address associated with the `Payment
                    Instrument`.
                  properties:
                    city:
                      type: string
                      minLength: 1
                      maxLength: 20
                      description: City.
                      nullable: true
                    country:
                      $ref: '#/components/schemas/country'
                    line1:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The first line of the address.
                      nullable: true
                    line2:
                      type: string
                      minLength: 1
                      maxLength: 35
                      description: The second line of the address.
                      nullable: true
                    postal_code:
                      type: string
                      minLength: 1
                      maxLength: 7
                      description: The zip or postal code.
                      nullable: true
                    region:
                      type: string
                      minLength: 1
                      description: 2-letter state code.
                      nullable: true
              nullable: true
            currency:
              $ref: '#/components/schemas/currency'
            entity_id:
              type: string
              description: The `Payout Link` that initiated the `Transfer Attempt`.
            entity_type:
              type: string
              description: The type of entity that initiated the `Transfer Attempt`.
              enum:
                - PAYOUT_LINK
            failure_code:
              $ref: '#/components/schemas/failure_code'
            failure_message:
              $ref: '#/components/schemas/failure_message'
            merchant_id:
              type: string
              description: >-
                The ID of the `Merchant` resource associated with the `Payout
                Link` that initiated the `Transfer Attempt`.
              example: MUmfEGv5bMpSJ9k5TFRUjkmm
            operation_key:
              $ref: '#/components/schemas/operation_key'
            payment_frequency:
              type: string
              description: >-
                This field does not apply to `Transfer Attempt` resources
                originating from a `Payout Link` and will always return `null`.
              nullable: true
            payment_instrument_id:
              type: string
              description: >-
                The `Payment Instrument` to be debited upon success of the
                `Transfer Attempt`.
            receipt_requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
            recipient_details:
              type: object
              description: Details of the recipient of the payout.
              properties:
                business_address:
                  type: object
                  description: The primary address for the legal entity.
                  nullable: true
                  properties:
                    city:
                      type: string
                      description: City (max 20 characters).
                      minLength: 1
                    country:
                      type: string
                      minLength: 1
                    region:
                      type: string
                      minLength: 1
                      description: 2-letter state code.
                    line2:
                      type: string
                      minLength: 1
                      description: Second line of the address (max 35 characters).
                    line1:
                      type: string
                      minLength: 1
                      description: First line of the address (max 35 characters).
                    postal_code:
                      type: string
                      minLength: 1
                      description: Zip or Postal code (max 7 characters).
                business_name:
                  type: string
                  minLength: 1
                  description: >-
                    Abbreviated names of the business. If there are no
                    abbreviated name, leave this field blank.
                  nullable: true
                doing_business_as:
                  type: string
                  minLength: 1
                  description: >-
                    Alternate names of the business. If there are no other
                    names, pass the same value used for `business_name` (max 60
                    characters).
                email:
                  type: string
                  minLength: 1
                  description: >-
                    The email address of the principal control owner (max 100
                    characters).
                first_name:
                  type: string
                  minLength: 1
                  description: >-
                    The legal first name of the control owner (max 20
                    characters).
                last_name:
                  type: string
                  minLength: 1
                  description: The `Identity` owner's legal last name.
                personal_address:
                  type: object
                  description: >-
                    The home address of the principal control owner. This field
                    is used for identity verification purposes.
                  properties:
                    city:
                      type: string
                      minLength: 1
                      description: City (max 20 characters).
                    country:
                      type: string
                      minLength: 1
                      description: 3-Letter country code (e.g. USA).
                    region:
                      type: string
                      minLength: 1
                      description: 2-letter State code.
                    line2:
                      type: string
                      minLength: 1
                      description: Second line of the address (max 35 characters).
                    line1:
                      type: string
                      minLength: 1
                      description: First line of the address (max 35 characters).
                    postal_code:
                      type: string
                      minLength: 1
                      description: Zip or Postal code (max 7 characters).
                personal_tax_id_provided:
                  type: boolean
                  description: Whether a personal tax ID was provided by the recipient.
                business_tax_id_provided:
                  type: boolean
                  description: Whether a business tax ID was provided by the recipient.
                phone:
                  type: string
                  minLength: 1
                  description: >-
                    The principal control owner's phone number (max 10
                    characters).
                type:
                  type: string
                  description: >-
                    Whether the recipient is considered "PERSONAL" or a
                    "BUSINESS".
                  enum:
                    - PERSONAL
                    - BUSINESS
            recipient_merchant_id:
              type: string
              description: >-
                The `Merchant` resource linked to the recipient targeted by the
                `Payout Link`.
              example: MUs6gqsciLh1vRtKMuw6MR8B
            state:
              type: string
              description: The state of the `Transfer Attempt`.
              enum:
                - PENDING
                - FAILED
                - SUCCEEDED
            tags:
              $ref: '#/components/schemas/tags'
            transfer_id:
              type: string
              description: |
                The  `Transfer` associated with the `Transfer Attempt`.
              example: TR4XqdopsgBJmeVZznfFr9LZ
              pattern: TRxxxxxxxxxxxxxxxxxxxxxx
            type:
              type: string
              enum:
                - DEBIT
                - CREDIT
              description: Type of `Transfer`.
    TransferAttemptList:
      type: object
      description: A schema for a list of `Transfer Attempts`.
      properties:
        _embedded:
          type: object
          description: List of `Transfer Attempt` objects.
          properties:
            transfer_attempts:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Transfer Attempt` objects.'
              items:
                $ref: '#/components/schemas/TransferAttempt'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    FundingTransferAttemptsList:
      type: object
      x-stoplight:
        id: 2a7dd19001ec6
      description: ''
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Funding Transfer Attempt` objects.
          properties:
            funding_transfer_attempts:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Transfer` objects.'
              items:
                $ref: '#/components/schemas/FundingTransferAttempt'
        _links:
          $ref: '#/components/schemas/ListLinks'
    FundingTransferAttempt:
      type: object
      x-examples: {}
      properties:
        id:
          type: string
          description: The ID of the `Funding Transfer Attempt` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        amount:
          $ref: '#/components/schemas/amount'
        application_id:
          type: string
          description: The ID of the application.
          nullable: true
        currency:
          $ref: '#/components/schemas/currency'
        funding_transfer_id:
          type: string
          description: The ID of the `Transfer` used to track the payout.
        instrument_id:
          type: string
          description: The ID of the instrument to use for the instant payout.
          nullable: true
        merchant_id:
          type: string
          description: The ID of the `Merchant` resource for the Funding Transfer Attempt.
          example: MUxxxxxxxxxxxxxxxxxxxxxxx
        failure_code:
          $ref: '#/components/schemas/failure_code'
        failure_message:
          $ref: '#/components/schemas/failure_message'
        state:
          type: string
          enum:
            - PENDING
            - FAILED
            - SUCCEEDED
          description: The status of the `Funding Transfer Attempt`.
        settlement_id:
          description: >-
            The ID of the `Settlement` resource used for this Funding Transfer
            Attempt.
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    CreateUserRequest:
      type: object
      description: ''
      x-examples:
        example-1:
          tags:
            card_name: New Employee
      properties:
        enabled:
          type: boolean
          description: >-
            Details if the `user` is enabled and active. Set to **false** to
            disable the `user`.
        tags:
          $ref: '#/components/schemas/tags'
    UpdateUserRequest:
      type: object
      properties:
        enabled:
          type: boolean
          description: >-
            Details if the `user` is enabled and active. Set to **false** to
            disable the user.
        tags:
          $ref: '#/components/schemas/tags'
    UsersList:
      type: object
      properties:
        page:
          type: object
          description: Details the page that's returned.
          properties:
            count:
              type: integer
              description: The number of entries returned.
            limit:
              type: integer
              description: The number of entries to return.
            offset:
              type: integer
              description: >-
                The number of items to skip before starting to collect the
                result set.
        _embedded:
          type: object
          description: List of `User` objects.
          properties:
            users:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`User` objects.'
              items:
                $ref: '#/components/schemas/user'
        _links:
          $ref: '#/components/schemas/ListLinks'
    PaymentInstrumentVerificationRequest:
      oneOf:
        - title: Payment Instrument - Verify a Card’s CVV
          type: object
          properties:
            merchant:
              type: string
              description: >-
                - The ID of the `Merchant`.

                - Must be included when `verify_payment_card` is set to
                **true**.
            processor:
              type: string
              enum:
                - DUMMY_V1
                - MASTERCARD_V1
                - VISA_V1
              default: DUMMY_V1
              description: >
                Set the acquiring processor. Available values include:
                  - `DUMMY_V1`
                  - `FINIX_V1`
                  - `MASTERCARD_V1`
                  - `VISA_V1`

                Use `DUMMY_V1` or `null` to use your sandbox. For more details
                on which processor to use, reach out to your Finix point of
                contact or email [Finix
                Support](/guides/getting-started/support-at-finix/).
            security_code:
              type: string
              description: The 3-4 digit security code of the card (i.e. CVV code).
            verify_payment_card:
              type: boolean
              description: >-
                - Set to **true** to verify card details with the card issuer.

                - Must be set to **true** to update the CVV or security code of
                a card.

                - When set to **true**, `merchant` must also be included with
                your request.
            tags:
              $ref: '#/components/schemas/tags'
          required:
            - merchant
            - security_code
            - verify_payment_card
        - title: Payment Instrument - Verify a Card’s Address
          type: object
          properties:
            address:
              $ref: '#/components/schemas/address'
            merchant:
              type: string
              description: The ID of the `Merchant`.
            verify_payment_card:
              type: boolean
              description: >-
                - Set to **true** to verify card details with the card issuer.

                - Must be set to **true** to update the CVV or security code of
                a card.

                - When set to **true**, `merchant` must also be included with
                your request.
            tags:
              $ref: '#/components/schemas/tags'
          required:
            - address
            - merchant
            - verify_payment_card
        - title: Payment Instrument - Verify Push-to-Card Eligibility
          type: object
          properties:
            processor:
              type: string
              description: >
                Set the acquiring processor. Available values include:
                  - `DUMMY_V1`
                  - `FINIX_V1`
                  - `MASTERCARD_V1`
                  - `VISA_V1`

                Use `DUMMY_V1` or `null` to use your sandbox. For more details
                on which processor to use, reach out to your Finix point of
                contact or email [Finix
                Support](/guides/getting-started/support-at-finix/).
            tags:
              $ref: '#/components/schemas/tags'
          required:
            - processor
    VerificationsList:
      type: object
      properties:
        _embedded:
          type: object
          description: List of `Verifications`.
          properties:
            verifications:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Verification` resources.'
              items:
                oneOf:
                  - $ref: '#/components/schemas/merchant-verification'
                  - $ref: '#/components/schemas/payment-instrument-verification'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    Webhook:
      type: object
      properties:
        id:
          type: string
          example: WHxxxxxxxxxxxxxxxxxx
          description: The ID of the `Webhook` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          description: >-
            The ID of the `Application` resource the `Webhook` was created
            under.
        authentication:
          type: object
          description: >-
            The [authentication
            settings](/additional-resources/developers/webhooks/integrating-into-webhooks#authenticating-webhooks)
            that are used to send webhook events.
          properties:
            type:
              type: string
              enum:
                - NONE
                - BASIC
                - BEARER
              description: |-
                The type of authentication the webhook will use:
                - NONE: No authentication will be used.
                - BASIC: Basic authentication.
                - BEARER: Oauth2's Bearer Token.
        enabled:
          type: boolean
          description: >-
            Details if the `Webhook` is enabled:<ul><li><code>true</code>:
            Events are being sent to the `url`.</li><li><code>false</code>:
            Events are not being sent.</li></ul>
        enabled_events:
          $ref: '#/components/schemas/WebhookEnabledEvents'
        is_accepting_events:
          type: boolean
          description: Whether the webhook is accepting events.
        nickname:
          type: string
          description: A human-readable name for the webhook.
        previous_secret_expires_at:
          type: string
          description: >-
            The time when the previous `secret_signing_key` will expire. This is
            **null** when the webhook is initially created.
          nullable: true
        secret_signing_key:
          type: string
          description: The secret signing key that gets used to verify webhook events.
          nullable: true
        url:
          type: string
          description: >-
            The HTTP or HTTPS URL where callbacks (i.e. events) will be sent via
            POST request (max 120 characters).
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            application:
              type: object
              description: Link to the `Application` the resource was created under.
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    WebhooksList:
      type: object
      description: '`Webhook` resource.'
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Webhook` objects.
          properties:
            webhooks:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Webhook` objects.'
              items:
                $ref: '#/components/schemas/Webhook'
        _links:
          $ref: '#/components/schemas/ListLinks'
    CreateWebhookRequest:
      title: WebhookCreate
      type: object
      properties:
        authentication:
          type: object
          description: >-
            The [authentication
            settings](/additional-resources/developers/webhooks/integrating-into-webhooks#authenticating-webhooks)
            that are used to send webhook events.
          properties:
            basic:
              type: object
              description: >-
                The basic authentication configuration. Null if basic is not
                being used.
              properties:
                username:
                  type: string
                  description: The username that will be used for basic authentication
                password:
                  type: string
                  description: The password to be used for basic authentication.
            bearer:
              type: object
              description: The bearer authentication configuration.
              properties:
                token:
                  type: string
                  description: The string that Finix will send as the bearer token.
            type:
              type: string
              enum:
                - NONE
                - BASIC
                - BEARER
              description: |-
                The type of authentication the webhook will use:
                - **NONE**: No authentication will be used.
                - **BASIC**: Basic authentication.
                - **BEARER**: Oauth2's Bearer Token.
        enabled:
          type: boolean
          description: >-
            Set to false to disable Webhooks. Default value when created is
            true.
        enabled_events:
          $ref: '#/components/schemas/WebhookEnabledEvents'
        url:
          type: string
          description: >-
            The HTTP or HTTPS URL where callbacks (i.e. events) will be sent via
            POST request (max 120 characters).
          maxLength: 120
          example: https://example.com/event_handler
      required:
        - url
    CreateSettlementRequest:
      title: SettlementCreate
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/currency'
        merchant_id:
          type: string
          description: >-
            If the `Application` has more than one associated `processor`, this
            field is required.
        processor:
          type: string
          description: >-
            If the `Application` has more than one associated `processor`, it's
            required when creating `settlements` to include the `processor`
            (e.g. **DUMMY_V1**).
        tags:
          $ref: '#/components/schemas/tags'
    UpdateSettlementRequest:
      title: SettlementUpdate
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/tags'
    CreateProcessorRequest:
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          minLength: 1
          description: The type of processor. Use **DUMMY_V1** for sandbox.
      required:
        - type
    ListLinks:
      title: ListLinks
      additionalProperties: true
      type: object
      description: >-
        For your convenience, every response includes several URLs which link to
        resources relevant to the request. You can use these `_links` to make
        your follow-up requests and quickly access relevant IDs.
      properties:
        next:
          type: object
          description: Link to the next page of entries.
          properties:
            href:
              type: string
        self:
          type: object
          description: Link to the resource that was used in the request.
          properties:
            href:
              type: string
    EntityId:
      title: EntityId
      x-stoplight:
        id: dwq7pjfmv9l1n
      type: string
      description: The ID of the related resource.
      x-examples:
        example-1: string
    AmountNumberResponse:
      type: number
      x-stoplight:
        id: 442ac1192d805
      title: Amount
      description: |
        The total amount in cents of the resource. 
        **Note:** For fees fractional amounts (`2.393`) can be returned.
      format: double
    FeeType:
      title: FeeType
      type: string
      enum:
        - ACH_BASIS_POINTS
        - ACH_CREDIT_RETURN_FIXED_FEE
        - ACH_DEBIT_RETURN_FIXED_FEE
        - ACH_FIXED
        - ACH_MAX_FIXED
        - ACH_NOTICE_OF_CHANGE_CREDIT_FIXED
        - ACH_NOTICE_OF_CHANGE_DEBIT_FIXED
        - AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS
        - AMERICAN_EXPRESS_BASIS_POINTS
        - AMERICAN_EXPRESS_FIXED
        - AMERICAN_EXPRESS_INTERCHANGE
        - ANCILLARY_FIXED_FEE_PRIMARY
        - ANCILLARY_FIXED_FEE_SECONDARY
        - APPLICATION_FEE
        - CARD_BASIS_POINTS
        - CARD_FIXED
        - CARD_INTERCHANGE
        - CUSTOM
        - DINERS_CLUB_BASIS_POINTS
        - DINERS_CLUB_FIXED
        - DINERS_CLUB_INTERCHANGE
        - DISCOVER_ASSESSMENT_BASIS_POINTS
        - DISCOVER_BASIS_POINTS
        - DISCOVER_DATA_USAGE_FIXED
        - DISCOVER_FIXED
        - DISCOVER_INTERCHANGE
        - DISCOVER_NETWORK_AUTHORIZATION_FIXED
        - DISPUTE_FIXED_FEE
        - DISPUTE_INQUIRY_FIXED_FEE
        - EFT_MAX_FIXED
        - JCB_BASIS_POINTS
        - JCB_FIXED
        - JCB_INTERCHANGE
        - MASTERCARD_ACQUIRER_FEE_BASIS_POINTS
        - MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS
        - MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS
        - MASTERCARD_BASIS_POINTS
        - MASTERCARD_FIXED
        - MASTERCARD_INTERCHANGE
        - QUALIFIED_TIER_BASIS_POINTS_FEE
        - QUALIFIED_TIER_FIXED_FEE
        - SETTLEMENT_FUNDING_TRANSFER_ACH_BASIS_POINTS
        - SETTLEMENT_FUNDING_TRANSFER_ACH_CREDIT_RETURN_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_ACH_DEBIT_RETURN_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_ACH_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_ACH_MAX_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_EFT_BASIS_POINTS
        - SETTLEMENT_FUNDING_TRANSFER_EFT_CREDIT_RETURN_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_EFT_DEBIT_RETURN_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_EFT_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_EFT_MAX_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_BASIS_POINTS
        - SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_MAX_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_NOC_CREDIT_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_NOC_DEBIT_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_BASIS_POINTS
        - SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_FIXED
        - SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_MAX_FIXED
        - SETTLEMENT_V2_TRANSFER
        - SUBSCRIPTION_ACH_BASIS_POINTS
        - SUBSCRIPTION_ACH_FIXED
        - SUBSCRIPTION_ACH_MAX_FIXED
        - SUBSCRIPTION_CARD_BASIS_POINTS
        - SUBSCRIPTION_CARD_FIXED
        - SUBSCRIPTION_EFT_BASIS_POINTS
        - SUBSCRIPTION_EFT_FIXED
        - SUBSCRIPTION_EFT_MAX_FIXED
        - SUPPLEMENTAL_FEE_FIXED
        - VISA_ACQUIRER_PROCESSING_FIXED
        - VISA_ASSESSMENT_BASIS_POINTS
        - VISA_BASE_II_CREDIT_VOUCHER_FIXED
        - VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED
        - VISA_BASIS_POINTS
        - VISA_CREDIT_VOUCHER_FIXED
        - VISA_FIXED
        - VISA_INTERCHANGE
        - VISA_KILOBYTE_ACCESS_FIXED
      description: Details the type of fee if the `Transfer` includes a `fee`.
    Messages:
      title: Messages
      type: array
      description: Message field that provides additional details.
      default: []
      items:
        type: string
    Balance:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Balance` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        available_amount:
          type: integer
          description: >
            The amount of funds currently available in the balance for use.


            Example: If you process $1,000 but $200 is pending, the
            `available_amount` is $800.
        currency:
          $ref: '#/components/schemas/currency'
        linked_to:
          type: string
          description: >
            The ID of the resource (e.g., an [`Application`](#Application)) that
            the `Balance` is linked to.
        linked_type:
          type: string
          description: |
            Specifies the type of resource identified in `linked_to`.
          enum:
            - APPLICATION
        pending_amount:
          type: integer
          description: >
            The amount of funds that have been processed but are not yet
            available for use.
        posted_amount:
          type: integer
          description: >
            The total amount posted to the `Balance`, which includes available
            and pending funds. 


            Example: If $1,000 is processed, the `posted_amount` reflects the
            total balance, even if parts are pending.
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: |
            The type of transactions stored/ledgered on the `Balance`.
          enum:
            - DISBURSEMENT
        _links:
          type: object
          description: >-
            An object containing link(s) relevant to the request. You can store
            these links for follow-up requests.
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The path to the new `Balance` resource.
    BalanceList:
      type: object
      properties:
        _embedded:
          type: object
          description: List of `Balance` objects.
          properties:
            balances:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Balance` objects.'
              items:
                $ref: '#/components/schemas/Balance'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    BalanceEntry:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Balance Entry` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        amount:
          $ref: '#/components/schemas/amount'
        created_by:
          type: string
          description: >-
            The ID of the application user that created this `Balance
            Adjustment`.
        currency:
          $ref: '#/components/schemas/currency'
        description:
          type: string
          description: A description of the `Balance Entry`.
        entity_id:
          type: string
          description: >-
            The ID of the resource that caused the change to the `Balance`,
            either a `Balance Adjustment` (i.e., "top-up") or a `Transfer`.
        entity_type:
          type: string
          description: The resource type that caused the change to the `Balance`.
          enum:
            - BALANCE_ADJUSTMENT
            - TRANSFER
        estimated_posted_date:
          type: string
          format: date-time
          description: >-
            Timestamp estimating when the `Balance Entry` will be posted (i.e.,
            the `state` is set to `SUCCEEDED`).
        linked_to:
          type: string
          description: >
            The ID of the resource (e.g., an [`Application`](#Application)) that
            the `Balance Entry` is linked to.
        linked_type:
          type: string
          description: |
            Specifies the type of resource identified in `linked_to`.
          enum:
            - APPLICATION
        parent_balance_entry_id:
          type: string
          description: >
            The `parent_balance_entry_id` refers to the ID of the original
            `Balance Entry`. This is only applicable for transactions that have
            been reversed after being posted (i.e., the `state` is set to
            `RETURNED`). For instance, if a transaction with the ID
            `balance_entry_xyz` is reversed, the newly created reversal entry
            will have a `parent_balance_entry_id` that matches the ID of the
            original transaction, `balance_entry_xyz`.
        posted_at:
          type: string
          format: date-time
          description: >-
            Timestamp of when the `Balance Entry` was posted and finalized on
            the `Balance` (i.e., state changed to `SUCCEEDED`). This field is
            `null` if the entry has not been posted.
          nullable: true
        state:
          description: >
            The current state of the `Balance Entry`.

            - `SUCCEEDED`: The balance entry has been successfully posted and
            affects the account balance.

            - `PENDING`: The balance entry is awaiting confirmation and has not
            yet affected the account balance.

            - `FAILED`: The balance entry failed and did not affect the account
            balance.

            - `RETURNED`: The balance entry was returned (e.g., due to an ACH
            return) and has been reversed.
          type: string
          enum:
            - SUCCEEDED
            - PENDING
            - FAILED
            - RETURNED
        tags:
          $ref: '#/components/schemas/tags'
        transaction_date:
          type: string
          format: date-time
          description: The date of the transaction.
        type:
          type: string
          description: |
            The transaction type that caused a change to the `Balance`.
          enum:
            - BALANCE_TOP_UP_ACH
            - BALANCE_WITHDRAWAL_ACH
            - MANUAL_BALANCE_ADJUSTMENT_DECREASE
            - MANUAL_BALANCE_ADJUSTMENT_INCREASE
            - PULL_FROM_ACH
            - PULL_FROM_CARD
            - PUSH_TO_ACH
            - PUSH_TO_CARD
            - PULL_FROM_SAME_DAY_ACH
            - PUSH_TO_SAME_DAY_ACH
        wire_details:
          type: object
          description: Wire transfer details, if applicable.
          properties:
            external_reference_number:
              type: string
              description: External reference number for the wire transfer.
            _links:
              type: object
              description: >-
                An object containing link(s) relevant to the request. You can
                store these links for follow-up requests.
              properties:
                self:
                  type: object
                  properties:
                    href:
                      type: string
                      description: The path to the `Balance Entry` resource.
    BalanceEntryList:
      type: object
      properties:
        _embedded:
          type: object
          description: List of `Balance Entry` objects.
          properties:
            balance_entries:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Balance Entry` objects.'
              items:
                $ref: '#/components/schemas/BalanceEntry'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    CreateBalanceTransferRequest:
      type: object
      description: Create a `Balance Transfer` resource.
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        description:
          type: string
          description: >-
            Additional information about the `balance_transfer` (e.g.
            **Transferring funds for Holidays**).
        destination:
          type: string
          enum:
            - FOR_BENEFIT_OF_ACCOUNT
            - OPERATING_ACCOUNT
          description: >-
            The account where funds get credited. For balance transfers, this is
            an aliased ID and will have the value of `FOR_BENEFIT_OF_ACCOUNT` or
            `OPERATING_ACCOUNT`.
          nullable: true
        processor_type:
          type: string
          example: LITLE_V1
          description: >-
            Pass **LITLE_V1**; `balance_transfers` are only available for
            platforms with **LITLE_V1** credentials.
        source:
          type: string
          description: >-
            The account where funds get debited. For balance transfers, this is
            an aliased ID and will have the value of `FOR_BENEFIT_OF_ACCOUNT` or
            `OPERATING_ACCOUNT`.
          enum:
            - FOR_BENEFIT_OF_ACCOUNT
            - OPERATING_ACCOUNT
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - amount
        - currency
        - description
        - destination
        - processor_type
        - source
    BalanceTransfer:
      type: object
      x-examples: {}
      description: A `balance_transfer` object.
      title: Balance Transfer
      properties:
        id:
          type: string
          description: ID of the `balance_transfer` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        description:
          type: string
          description: >-
            Additional information about the `balance_transfer` (e.g.
            **Transferring funds for Holidays**).
        destination:
          type: string
          description: >-
            The account where funds get credited. For balance transfers, this is
            an aliased ID and will have the value of `FOR_BENEFIT_OF_ACCOUNT` or
            `OPERATING_ACCOUNT`.
        external_reference_id:
          type: string
          description: ID generated by partner and returned to Finix.
        processor_type:
          type: string
          description: >-
            Pass **LITLE_V1**; `balance_transfers` are only avalible for
            platforms with **LITLE_V1** credentials.
        reference_id:
          type: string
          description: ID generated by Finix and sent to the partner.
        source:
          type: string
          description: >-
            The account where funds get debited. For balance transfers, this is
            an aliased ID and will have the value of `FOR_BENEFIT_OF_ACCOUNT` or
            `OPERATING_ACCOUNT`.
        state:
          type: string
          description: The `state` of the `balance_transfer`.
          enum:
            - CREATED
            - SUBMITTING
            - SUBMITTED
            - SUCCEEDED
            - FAILED
            - RETURNED
            - UNKNOWM
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          $ref: '#/components/schemas/ListLinks'
    BalanceTransferList:
      title: BalanceTransfersList
      x-stoplight:
        id: 0pxsokuo2ricq
      type: object
      description: List of `balance_transfer` resources.
      properties:
        page:
          type: object
          description: Details the page that's returned.
          properties:
            count:
              type: integer
              description: The number of entries returned.
            limit:
              type: integer
              description: The number of entries to return.
            offset:
              type: integer
              description: >-
                The number of items to skip before starting to collect the
                result set.
        _embedded:
          type: object
          description: List of `balance_transfer` objects.
          properties:
            balance_transfers:
              type: array
              description: '`balance_transfer` objects.'
              items:
                $ref: '#/components/schemas/BalanceTransferList'
        _links:
          $ref: '#/components/schemas/ListLinks'
    CreateInstrumentUpdateRequest:
      type: object
      x-examples: {}
      title: ''
      properties:
        file:
          type: string
          description: The binary contents of the file.
          format: binary
        request:
          type: string
          description: >-
            A JSON string of your request. The JSON object needs to contain the
            following two fields:

            - `merchant`: ID of the `Merchant` object that you want to associate
            with the Account Updater batch for your own accounting purposes. You
            can only associate one `Merchant` to each.

            - `idemopotency_id`: A randomly generated value that will be
            associated with this `instrument_update` resource.
          example: '{"merchant":"MUucec6fHeaWo3VHYoSkUySM",  "idempotency_id":"123xyz" }'
    InstrumentUpdate:
      title: InstrumentUpdates
      x-stoplight:
        id: si3taxhzmp9fu
      type: object
      properties:
        id:
          type: string
          description: The ID of the `instrument_updates` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        idempotency_id:
          type: string
          description: >-
            A randomly generated value that will be associated with this
            `instrument_update` resource.
        merchant:
          type: string
          description: The `Merchant` ID associated with the `instrument_updates`.
        state:
          type: string
          description: The status of the `instrument_updates` resource and update request.
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
            payment_instrument:
              type: object
              description: Link to the payment instrument.
              properties:
                href:
                  type: string
            application:
              type: object
              description: Link to the application.
              properties:
                href:
                  type: string
    InstrumentHistoryEntryList:
      type: object
      properties:
        _embedded:
          type: object
          description: >-
            Schema for a request to list `Instrument History Entry` objects for
            a `Payment Instrument`.
          properties:
            instrument_history_entries:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Instrument History Entry` objects.'
              items:
                $ref: '#/components/schemas/instrument_history_entry'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    CreateFileRequest:
      type: object
      x-examples: {}
      properties:
        display_name:
          type: string
          description: >-
            The human-readable name to use for the `File` (e.g., `Bank Statement
            (January 2024)`).
        linked_to:
          type: string
          description: >-
            The ID of the resource the `File` will be linked to. This can be
            either a Merchant ID or Identity ID.
          example: MU2n7BSovtwYsWYZF6rBnnzk
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: The type of document
          enum:
            - BANK_STATEMENT
            - BANK_STATEMENT_ONE_MONTH
            - BANK_STATEMENT_THREE_MONTHS
            - BUSINESS_ADDRESS_DOCUMENT
            - BUSINESS_ADDRESS_VERIFICATION
            - BUSINESS_INCORPORATION_DOCUMENT
            - BUSINESS_OWNERSHIP_STRUCTURE
            - BUSINESS_REGISTRATION
            - BUSINESS_REGISTRATION_DOCUMENT
            - BUSINESS_TAX_EXEMPTION_STATUS_DOCUMENT
            - BUSINESS_TAX_ID_DOCUMENT
            - DEVICE_IDLE_IMAGE
            - DIGITAL_SIGNATURE
            - DRIVERS_LICENSE_BACK
            - DRIVERS_LICENSE_FRONT
            - ENHANCED_DUE_DILIGENCE_DOCUMENT
            - IDENTIFICATION_CARD_BACK
            - IDENTIFICATION_CARD_FRONT
            - OTHER
            - OWNER_GOVERNMENT_ISSUED_PHOTO_ID
            - OWNER_TAX_ID_DOCUMENT
            - PASSPORT
            - PCI_DOCUMENT
            - PROCESSING_STATEMENT
            - TAX_DOCUMENT
      required:
        - linked_to
        - type
    File:
      type: object
      x-examples: {}
      title: File
      properties:
        id:
          type: string
          description: The ID of the `File` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application_id:
          type: string
          description: The ID of the `Application` that the `File` was created under.
        display_name:
          type: string
          description: >-
            The human-readable name of the `File`. The file name format is
            `<type>_<id>` by default.
        extension:
          description: The extension of the file (e.g., `png`).
          type: string
          nullable: true
        file_name:
          description: >-
            The name of the uploaded File. It is `null` when the File resource
            is first created and is automatically updated to the uploaded file's
            name. You cannot change this field.
          type: string
          example: bank_statement_01_2024.png
          nullable: true
        identity_id:
          type: string
          description: The ID of the `Application` that the `File` was created under.
          nullable: true
        linked_to:
          type: string
          description: >-
            The ID of the resource the `File` is linked to. This can be either a
            Merchant ID or Identity ID.
          example: MU2n7BSovtwYsWYZF6rBnnzk
        linked_type:
          type: string
          description: The type of the resource that the `File` is linked to.
        platform_id:
          type: string
          description: The ID of the `Platform` that the `File` was created under.
        size_in_bytes:
          type: integer
          description: >-
            The size of the uploaded file. It is set to `null` when the File
            resource is first created and updates automatically after a File is
            uploaded.
          nullable: true
        status:
          type: string
          description: The file's upload status.
          enum:
            - REQUIRES_UPLOAD
            - PENDING
            - UPLOADED
            - INVALID
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: The type of document.
          enum:
            - BANK_STATEMENT
            - BANK_STATEMENT_ONE_MONTH
            - BANK_STATEMENT_THREE_MONTHS
            - BUSINESS_ADDRESS_DOCUMENT
            - BUSINESS_ADDRESS_VERIFICATION
            - BUSINESS_INCORPORATION_DOCUMENT
            - BUSINESS_OWNERSHIP_STRUCTURE
            - BUSINESS_REGISTRATION
            - BUSINESS_REGISTRATION_DOCUMENT
            - BUSINESS_TAX_EXEMPTION_STATUS_DOCUMENT
            - BUSINESS_TAX_ID_DOCUMENT
            - DEVICE_IDLE_IMAGE
            - DIGITAL_SIGNATURE
            - DRIVERS_LICENSE_BACK
            - DRIVERS_LICENSE_FRONT
            - ENHANCED_DUE_DILIGENCE_DOCUMENT
            - IDENTIFICATION_CARD_BACK
            - IDENTIFICATION_CARD_FRONT
            - OTHER
            - OWNER_GOVERNMENT_ISSUED_PHOTO_ID
            - OWNER_TAX_ID_DOCUMENT
            - PASSPORT
            - PCI_DOCUMENT
            - PROCESSING_STATEMENT
            - TAX_DOCUMENT
    FilesList:
      title: FilesList
      x-stoplight:
        id: qg15mhihxira6
      type: object
      x-examples: {}
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `File` objects.
          properties:
            files:
              type: array
              description: '`File` objects.'
              items:
                $ref: '#/components/schemas/File'
        _links:
          $ref: '#/components/schemas/ListLinks'
    CreateExternalLinkRequest:
      type: object
      x-examples: {}
      title: CreateExternalLinkRequest
      properties:
        duration:
          type: integer
          description: >-
            Set how long (in minutes) the external link is valid for. The link
            can be valid for up to 10080 minutes (7 days).
          maximum: 10080
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: >-
            <ul><li>Set to <code>UPLOAD</code> to create a link that can be used
            to upload files to Finix.</li><li>Set to <code>DOWNLOAD</code> to
            create a link where the uploaded file can be downloaded
            from.</li><li>Set to <code>VIEW</code> to create a link that
            displays the file in browser.</li></ul>
          enum:
            - UPLOAD
            - DOWNLOAD
            - VIEW
      required:
        - type
    ExternalLink:
      type: object
      x-examples: {}
      properties:
        id:
          type: string
          description: The ID of the `external_Link` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        duration:
          type: integer
          description: Details how long (in minutes) the `url` is valid for.
          nullable: true
        expired:
          type: boolean
          description: <code>true</code> or <code>false</code>
        expires_at:
          type: string
          format: date-time
          description: When the external link expires
        file_id:
          type: string
          description: The `File` ID the `external_link` relates to.
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: Sets if the link is for uploading or downloading files from Finix.
          enum:
            - UPLOAD
            - DOWNLOAD
            - VIEW
        url:
          type: string
          description: The URL that can be used to upload, download, or view the file.
        user_id:
          type: string
          description: The ID of the `user` that requested to create this link.
    ExternalLinksList:
      title: ExternalLinksList
      x-stoplight:
        id: ls3c9xr95g8nz
      type: object
      x-examples: {}
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `external_link` resources.
          properties:
            external_links:
              type: array
              description: '`external_link` resources.'
              items:
                $ref: '#/components/schemas/ExternalLink'
        _links:
          $ref: '#/components/schemas/ListLinks'
    AdjustmentTransfersList:
      type: object
      x-examples: {}
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of adjustment `Transfers` created for a `Dispute`.
          properties:
            transfers:
              type: array
              description: '`Transfer` objects.'
              items:
                $ref: '#/components/schemas/transfer'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    RemoveSettlementTransfer:
      type: object
      x-examples:
        Delete a Transfer in a Settlement:
          transfers:
            - TRr61njQxaa7AJf6E1C3QwCc
      properties:
        transfers:
          type: array
          description: ID of `Transfer` resource.
          items:
            type: string
    RemoveSettlementEntries:
      type: object
      x-examples:
        Delete an Entry in a Settlement:
          settlement_entry_ids:
            - SEivAwLLW6c62Nbvvj7TcDAN
      properties:
        settlement_entry_ids:
          type: array
          description: ID of `Settlement Entry` resource.
          items:
            type: string
    ConfigurationDetails:
      title: ConfigurationDetails
      x-stoplight:
        id: czqjwiv5qz0zl
      type: object
      description: Configure the details of the activated device.
      properties:
        allow_debit:
          type: boolean
          description: >-
            `TRIPOS_CLOUD_V1` only. If **true** allow transaction to be
            processed on Debit rails. If **false**, Debit card transactions will
            be processed on Credit rails. `DATACAP_V1` must be configured by a
            Finix representative. `FINIX_V1` will always process debit cards as
            credit cards.
        check_for_duplicate_transactions:
          type: boolean
          description: >-
            `TRIPOS_CLOUD_V1` and `DATACAP_V1` only. Sets whether the `Device`
            will check for duplicate transactions. If a transaction is ran same
            day with the same card and the same amount, the terminal will reject
            the transaction.
        prompt_amount_confirmation:
          type: boolean
          description: >-
            Sets if the card holder needs to confirm the amount they will pay
            (defaults to **true**). `DATACAP_V1` and `TRIPOS_CLOUD_V1` only.
        prompt_manual_entry:
          type: boolean
          description: >-
            Sets if the device allows for manual entry as a card input method.
            (defaults to **false**).
        bypass_device_on_capture:
          type: boolean
          description: >-
            Sets whether or not the device will be used to capture transactions.
            This field should be set to **true** unless there are special
            circumstances. (defaults to **false**).
          nullable: true
        prompt_receipt_confirmation:
          type: boolean
          description: >-
            Sets where or not the device will present a screen to print receipt
            at the end of the transaction flow. (defaults to **true**).
            `FINIX_V1` and `DUMMY_V1` only
        display_tip_on_receipt:
          type: boolean
          description: >-
            Sets whether the device will display the blank tip amount on the
            receipt for authorizations to be later captured. (defaults to
            **false**). `FINIX_V1` only.
        allow_standalone_authorizations:
          type: boolean
          description: >-
            Sets whether the device will allow authorizations from its admin
            menu. (defaults to **false**). `FINIX_V1` and `DUMMY_V1` only.
        allow_standalone_sales:
          type: boolean
          description: >-
            Sets whether the device will allow standalone from its admin menu.
            (defaults to **false**). `FINIX_V1` and `DUMMY_V1` only.
        allow_standalone_refunds:
          type: boolean
          description: >-
            Sets whether the device will allow standalone from its admin menu.
            (defaults to **false**). `FINIX_V1` and `DUMMY_V1` only.
    BankReturnDetails:
      title: BankReturnDetails
      type: object
      description: >-
        Details about a transfer that was returned and was unable to be
        processed. Only present when state is `RETURNED`
      nullable: true
      properties:
        reason_code:
          type: string
          description: Return response code from bank.
        reason_message:
          type: string
          description: Detailed message explaining reason for the return.
        reason_title:
          type: string
          description: Short message categorizing reason for the return.
    UploadFileRequest:
      title: UploadFileRequest
      x-stoplight:
        id: 8f3scdwv78xcg
      type: object
      properties:
        file:
          type: string
          description: >-
            Path to the file to upload<br>(e.g.
            <code>@/Users/Desktop/finix_file.png</code>).
      required:
        - file
    UpdateWebhookRequest:
      title: UpdateWebhookRequest
      x-stoplight:
        id: 0jkq54c782t1w
      type: object
      properties:
        enabled:
          type: boolean
          description: >-
            Set to false to disable `Webhooks`. Default value when created is
            true.
        enabled_events:
          $ref: '#/components/schemas/WebhookEnabledEvents'
        url:
          type: string
          description: >-
            The HTTP or HTTPS url where the callbacks will be sent via POST
            request (max 120 characters).
    FileDownload:
      type: string
      title: FileDownload
      x-stoplight:
        id: fylqbqcpw7nuv
      format: binary
      description: The file in question will begin to download.
    PageCursor:
      title: PageCursor
      x-stoplight:
        id: 8v9on8n2939z2
      type: object
      properties:
        limit:
          type: integer
          description: The number of entries to return.
        next_cursor:
          type: string
          description: The cursor to use for the next page of results.
          nullable: true
      description: Details the page that's returned.
    PageOffset:
      title: PageOffset
      x-stoplight:
        id: 5l7dajuhlor26
      type: object
      properties:
        count:
          type: integer
          description: The number of entries returned.
        limit:
          type: integer
          description: The number of entries to return.
        offset:
          type: integer
          description: >-
            The number of items to skip before starting to collect the result
            set.
    BalanceAdjustment:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Balance Adjustment` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        amount:
          $ref: '#/components/schemas/amount'
        balance_entry_id:
          type: string
          description: >-
            A ledger record that tracks individual financial movements within a
            `Balance Adjustment`.
        currency:
          type: string
          description: ISO 4217 3 letter currency code.
          enum:
            - USD
        description:
          type: string
          description: A description of the `Balance Transfer`.
        failure_code:
          type: string
          description: >-
            The code of the failure so the decline can be handled
            programmatically. For more info on how to handle the failure, see
            [Failure Codes](/guides/payouts/handling-payout-failures).
          nullable: true
        failure_message:
          type: string
          description: >-
            The code of the failure so the decline can be handled
            programmatically. For more info on how to handle the failure, see
            [Failure Codes](/guides/payouts/handling-payout-failures).
          nullable: true
        instrument_id:
          type: string
          description: >-
            The account, card, or bank account that is credited or debited as
            part of the adjustment.
        processor:
          type: string
          description: >-
            The payment processing entity responsible for handling transactions,
            fund movements, etc., between different financial accounts.
          enum:
            - DUMMY_V1
            - FINIX_V1
        rail:
          type: string
          enum:
            - ACH
          description: The method of adjustment.
        state:
          type: string
          description: >
            The status of the balance adjustment, indicating whether the
            adjustment was successful or failed.


            - `SUBMITTED` - The balance adjustment has been initiated but is not
            yet confirmed.  

            - `SUCCEEDED` - The adjustment was successful, and the funds are
            available. This typically occurs 1-3 business days after
            `SUBMITTED`.  

            - `FAILED` - Finix was unable to process the adjustment, and the
            balance was not updated.  

            - `RETURN` - The adjustment was initially successful, but a
            subsequent return resulted in a reversal of the balance increase.
          enum:
            - FAILED
            - RETURNED
            - SUBMITTED
            - SUCCEEDED
        trace_id:
          type: string
          description: >-
            A unique identifier for tracking the `Balance Adjustment` across its
            lifecycle.
        type:
          type: string
          description: >
            Specifies whether the `Balance Adjustment` increases or decreases
            the account balance.


            - `TOP_UP` - Adds funds to the balance (e.g., a deposit or manual
            funding).   
          enum:
            - TOP_UP
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            An object containing link(s) relevant to the request. You can store
            these links for follow-up requests.
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The path to the new `Balance Adjustment` resource.
    BalanceAdjustmentList:
      type: object
      properties:
        _embedded:
          type: object
          description: List of `Balance Adjustment` objects.
          properties:
            balance_adjustments:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Balance Adjustment` objects.'
              items:
                $ref: '#/components/schemas/BalanceAdjustment'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    SubTypeTransfer:
      title: SubTypeTransfer
      x-stoplight:
        id: 2qbkukuj5e20b
      type: string
      enum:
        - API
        - APPLICATION_FEE
        - DISPUTE
        - MERCHANT_CREDIT
        - MERCHANT_CREDIT_ADJUSTMENT
        - MERCHANT_DEBIT
        - MERCHANT_DEBIT_ADJUSTMENT
        - PLATFORM_CREDIT
        - PLATFORM_CREDIT_ADJUSTMENT
        - PLATFORM_DEBIT
        - PLATFORM_DEBIT_ADJUSTMENT
        - PLATFORM_FEE
        - SETTLEMENT_MERCHANT
        - SETTLEMENT_NOOP
        - SETTLEMENT_PARTNER
        - SETTLEMENT_PLATFORM
        - SPLIT_PAYOUT
        - SPLIT_PAYOUT_ADJUSTMENT
    UpdateMerchantProfileRequest:
      title: UpdateMerchantProfileRequest
      x-stoplight:
        id: 9cuj94a54fwqp
      type: object
      properties:
        card_present_fee_profile:
          type: string
          description: ID of the `fee_profile` to be used for card present transfers.
          nullable: true
        fee_profile:
          type: string
          description: ID of the `fee_profile`.
        payout_profile:
          type: string
          description: ID of the `payout_profile`.
        risk_profile:
          type: string
          description: ID of the `risk_profile`.
        tags:
          $ref: '#/components/schemas/tags'
    SplitTransferRequest:
      title: SplitTransferRequest
      x-stoplight:
        id: nv8wk8rllstc0
      type: object
      description: >-
        Object detailing any [Split
        Transfers](/guides/online-payments/payment-features/split-transactions)
        for splitting the `Transfer`.
      nullable: true
      properties:
        merchant:
          type: string
          description: The ID of the `Merchants` that the funds will get split across.
          nullable: false
        amount:
          type: integer
          description: The amount to distribute into the `Settlements` of each `Merchant`.
          nullable: false
        tags:
          $ref: '#/components/schemas/tags'
    WebhookEnabledEvents:
      title: WebhookEnabledEvents
      x-stoplight:
        id: ux7v2p72v0shw
      type: array
      description: >-
        A list of events the [webhook is explicitly enabled
        for](/additional-resources/developers/webhooks/integrating-into-webhooks#filtering-webhooks).
      items:
        type: array
        items:
          type: object
          properties:
            entity:
              type: string
              description: >-
                The entity type for the enabled event, either `transfer` or
                `merchant`. There can only be one enabled event object for a
                given entity.
            types:
              type: array
              description: >
                A list of event types you want to receive for the specified
                `entity`. 


                - When `entity` is set to `transfers`, the acceptable value is
                `created`. 

                - When `entity` is set to `merchant`, the acceptable values are
                `created` and `underwritten`.
              items:
                type: string
    PayoutProfile:
      oneOf:
        - title: Payout Profile - Gross
          type: object
          properties:
            id:
              type: string
              description: The ID of the `Payout Profile` resource.
            created_at:
              $ref: '#/components/schemas/created_at'
            updated_at:
              $ref: '#/components/schemas/updated_at'
            gross:
              type: object
              description: >-
                Details how `Payout Profiles` with type **GROSS** are
                configured.
              nullable: true
              properties:
                fees:
                  type: object
                  description: Configures and details how fees get debited.
                  properties:
                    day_of_month:
                      type: integer
                      description: >-
                        Day of the month fees get debited. Required when
                        `frequency` is set to **MONTHLY**.
                    frequency:
                      type: string
                      description: >-
                        Configures how frequentyly *fees* get debited. To
                        configure a **CUSTOM** `frequency` [contact Finix
                        Support](/guides/payouts/).
                      enum:
                        - DAILY
                        - MONTHLY
                        - CONTINUOUS
                        - CUSTOM
                    payment_instrument_id:
                      type: string
                      description: >-
                        The `id` of the `Payment Instrument` that *fees* get
                        debited from.
                    rail:
                      type: string
                      description: >-
                        Configures how quickly and which payment `rail` will be
                        used to debit *fees*.
                      enum:
                        - NEXT_DAY_ACH
                        - SAME_DAY_ACH
                    submission_delay_days:
                      type: integer
                      description: >-
                        Include a number of `submission_delay_days` to delay
                        when `funding_transfers` for *fees* will get submitted
                        to debit (in days) the `payment_instrument_id`.
                payouts:
                  type: object
                  description: Configures and details how payouts get paid and credited.
                  properties:
                    frequency:
                      type: string
                      description: >-
                        Configures how frequentyly *payouts* get credited. To
                        configure a **CUSTOM** `frequency` [contact Finix
                        Support](/guides/payouts/).
                      enum:
                        - DAILY
                        - MONTHLY
                        - CONTINUOUS
                        - CUSTOM
                    payment_instrument_id:
                      type: string
                      description: >-
                        The `id` of the `Payment Instrument`that *payouts* will
                        get credited to.
                    rail:
                      type: string
                      description: >-
                        Configures how quickly and which payment `rail` will be
                        used to credit *payouts*.
                      enum:
                        - NEXT_DAY_ACH
                        - SAME_DAY_ACH
                    submission_delay_days:
                      type: integer
                      description: >-
                        Include a number of `submission_delay_days` to delay
                        when `funding_transfers` for *payouts* will get
                        submitted to credit (in days) the
                        `payment_instrument_id`.
            linked_id:
              type: string
              description: ID of the resource linked to the `Payout Profile`.
            linked_type:
              type: string
              description: The type of resource the `Payout Profile` is linked to.
            tags:
              $ref: '#/components/schemas/tags'
            type:
              type: string
              description: >-
                Configures how fees are calculated and billed from payouts. For
                more infromation, see [Payout
                Types](/guides/platform-payments/seller-payouts/managing-seller-payouts#payout-types).
              enum:
                - GROSS
                - NET
                - CUSTOM
            _links:
              $ref: '#/components/schemas/ListLinks'
        - title: Payout Profile - Net
          type: object
          properties:
            id:
              type: string
              description: The ID of the `Payout Profile` resource.
            created_at:
              $ref: '#/components/schemas/created_at'
            updated_at:
              $ref: '#/components/schemas/updated_at'
            linked_id:
              type: string
              description: ID of the resource linked to the `Payout Profile`.
            linked_type:
              type: string
              description: The type of resource the `Payout Profile` is linked to.
            net:
              type: object
              description: Details how `Payout Profiles` with type **NET** are configured.
              nullable: true
              properties:
                frequency:
                  type: string
                  description: >-
                    Configures how frequentyly fees and payouts get credited. To
                    configure a **CUSTOM** `frequency` [contact Finix
                    Support](/guides/payouts/).
                  enum:
                    - DAILY
                    - MONTHLY
                    - CONTINUOUS
                    - CUSTOM
                payment_instrument_id:
                  type: string
                  description: >-
                    The `id` of the `Payment Instrument` that payouts and fees
                    get credited to and debited from.
                rail:
                  type: string
                  description: >-
                    Configures how quickly and which payment `rail` will be used
                    to debit fees and credit payouts.
                  enum:
                    - NEXT_DAY_ACH
                    - SAME_DAY_ACH
                submission_delay_days:
                  type: integer
                  description: >-
                    Include a number of `submission_delay_days` to delay when
                    `funding_transfers` for both payouts and fees will get
                    submitted (in days) to debit/credit the
                    `payment_instrument_id`.
            tags:
              $ref: '#/components/schemas/tags'
            type:
              type: string
              description: >-
                Configures how fees are calculated and billed from payouts. For
                more infromation, see [Payout
                Types](/guides/platform-payments/seller-payouts/managing-seller-payouts#payout-types).
              enum:
                - NET
                - GROSS
                - CUSTOM
            _links:
              $ref: '#/components/schemas/ListLinks'
        - title: Payout Profile - Custom
          type: object
          properties:
            id:
              type: string
              description: The ID of the `Payout Profile` resource.
            created_at:
              $ref: '#/components/schemas/created_at'
            updated_at:
              $ref: '#/components/schemas/updated_at'
            custom:
              type: object
              description: >-
                Details how `Payout Profiles` with type **CUSTOM** are
                configured. `Payout Profiles` with type **CUSTOM** can be setup
                with more specific configurations. To configure a **CUSTOM**
                `Payout Profile` [contact Finix
                Support](/guides/platform-payments/seller-payouts/managing-seller-payouts#payout-types).
              nullable: true
            linked_id:
              type: string
              description: ID of the resource linked to the `Payout Profile`.
            linked_type:
              type: string
              description: The type of resource the `Payout Profile` is linked to.
            tags:
              $ref: '#/components/schemas/tags'
            type:
              type: string
              description: >-
                Configures how fees are calculated and billed from payouts. For
                more infromation, see [Payout
                Types](/guides/platform-payments/seller-payouts/managing-seller-payouts#payout-types).
              enum:
                - CUSTOM
                - GROSS
                - NET
            _links:
              $ref: '#/components/schemas/ListLinks'
    PayoutProfilesList:
      type: object
      x-examples:
        example-1:
          _embedded:
            payout_profiles:
              - id: PO6UbajkQrbFd5nAvs57dwyn
                created_at: '2022-10-24T21:38:23.72Z'
                updated_at: '2022-10-24T21:38:23.72Z'
                tags: {}
                linked_id: MU6TXYpA37uM9H4GwitQr8E3
                linked_type: MERCHANT
                type: GROSS
                gross:
                  payouts:
                    frequency: DAILY
                    submission_delay_days: 1
                    payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                    rail: STANDARD
                  fees:
                    frequency: MONTHLY
                    day_of_month: 1
                    submission_delay_days: 3
                    payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                    rail: STANDARD
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_profiles/PO6UbajkQrbFd5nAvs57dwyn
              - id: POf5rP3c3XyRX7M6PuCvmgxf
                created_at: '2022-10-20T19:43:18.02Z'
                updated_at: '2022-10-20T19:43:18.02Z'
                tags: {}
                linked_id: MUfbbKm7vRmBX2bP92pKw9zZ
                linked_type: MERCHANT
                type: CUSTOM
                custom: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf
          _links:
            self:
              href: https://finix.sandbox-payments-api.com/payout_profiles
            next:
              href: >-
                https://finix.sandbox-payments-api.com/payout_profiles?after_cursor=POf5rP3c3XyRX7M6PuCvmgxf
          page:
            limit: 100
            next_cursor: POf5rP3c3XyRX7M6PuCvmgxf
      description: List of `Payout Profiles`.
      properties:
        _embedded:
          type: object
          description: List of `Payout Profiles`.
          properties:
            payout_profiles:
              type: array
              description: '`Payout Profile` objects.'
              items:
                $ref: '#/components/schemas/PayoutProfile'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    SplitTransfersList:
      type: object
      x-examples:
        example-1:
          _embedded:
            payout_profiles:
              - id: PO6UbajkQrbFd5nAvs57dwyn
                created_at: '2022-10-24T21:38:23.72Z'
                updated_at: '2022-10-24T21:38:23.72Z'
                tags: {}
                linked_id: MU6TXYpA37uM9H4GwitQr8E3
                linked_type: MERCHANT
                type: GROSS
                gross:
                  payouts:
                    frequency: DAILY
                    submission_delay_days: 1
                    payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                    rail: STANDARD
                  fees:
                    frequency: MONTHLY
                    day_of_month: 1
                    submission_delay_days: 3
                    payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
                    rail: STANDARD
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_profiles/PO6UbajkQrbFd5nAvs57dwyn
              - id: POf5rP3c3XyRX7M6PuCvmgxf
                created_at: '2022-10-20T19:43:18.02Z'
                updated_at: '2022-10-20T19:43:18.02Z'
                tags: {}
                linked_id: MUfbbKm7vRmBX2bP92pKw9zZ
                linked_type: MERCHANT
                type: CUSTOM
                custom: {}
                _links:
                  self:
                    href: >-
                      https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf
          _links:
            self:
              href: https://finix.sandbox-payments-api.com/payout_profiles
            next:
              href: >-
                https://finix.sandbox-payments-api.com/payout_profiles?after_cursor=POf5rP3c3XyRX7M6PuCvmgxf
          page:
            limit: 100
            next_cursor: POf5rP3c3XyRX7M6PuCvmgxf
      description: List of `Split Transferss` created for a split `Transfer`.
      x-stoplight:
        id: 11d3f3351214e
      properties:
        _embedded:
          type: object
          description: List of `Payout Profiles`.
          properties:
            split_transfers:
              type: array
              description: '`Payout Profile` objects.'
              items:
                $ref: '#/components/schemas/SplitTransfer'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    ComplianceFormList:
      type: object
      x-examples: {}
      description: List of `Compliance Form` objects.
      x-stoplight:
        id: 11d3f3351214e
      properties:
        _embedded:
          type: object
          properties:
            compliance_forms:
              type: array
              description: List of `compliance_form` resources
              items:
                $ref: '#/components/schemas/compliance_form'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    UpdatePayoutProfileRequest:
      oneOf:
        - title: Payout Profile - Gross
          type: object
          properties:
            gross:
              type: object
              description: Configure how `Payout Profiles` with type **GROSS** are setup.
              nullable: true
              properties:
                fees:
                  type: object
                  description: Configures the details of how fees get debited.
                  properties:
                    day_of_month:
                      type: integer
                      description: >-
                        Day of the month fees get debited. Required when
                        `frequency` is set to **MONTHLY**.
                    frequency:
                      type: string
                      description: >-
                        Configures how frequentyly **fees** get debited. To
                        configure a **CUSTOM** `frequency` [contact Finix
                        Support](/guides/payouts/).
                      enum:
                        - DAILY
                        - MONTHLY
                        - CONTINUOUS
                        - CUSTOM
                    payment_instrument_id:
                      type: string
                      description: >-
                        The `id` of the `Payment Instrument`that **fees** get
                        debited from.
                    rail:
                      type: string
                      description: >-
                        Configures how quickly and which payment `rail` will be
                        used to debit **fees**.
                      enum:
                        - NEXT_DAY_ACH
                        - SAME_DAY_ACH
                    submission_delay_days:
                      type: integer
                      description: >-
                        Include a number of `submission_delay_days` to delay
                        when `funding_transfers` for `fees` will get submitted
                        to debit (in days) the `payment_instrument_id`.
                payouts:
                  type: object
                  description: Configures the details of how payouts get paid and credited.
                  properties:
                    frequency:
                      type: string
                      description: >-
                        Configures how frequentyly **payouts** get credited. To
                        configure a **CUSTOM** `frequency` [contact Finix
                        Support](/guides/payouts/).
                      enum:
                        - DAILY
                        - MONTHLY
                        - CONTINUOUS
                        - CUSTOM
                    payment_instrument_id:
                      type: string
                      description: >-
                        The `id` of the `Payment Instrument`that payouts will
                        get credited to.
                    rail:
                      type: string
                      description: >-
                        Configures how quickly and which payment `rail` will be
                        used to credit **payouts**.
                    submission_delay_days:
                      type: integer
                      description: >-
                        Include a number of `submission_delay_days` to delay
                        when `funding_transfers` for `payouts` will get
                        submitted to credit (in days) the
                        `payment_instrument_id`.
            tags:
              $ref: '#/components/schemas/tags'
            type:
              type: string
              description: >-
                Configures how fees are calculated and billed from payouts. For
                more infromation, see [Payout
                Types](/guides/platform-payments/seller-payouts/managing-seller-payouts#payout-types).
              enum:
                - CUSTOM
                - GROSS
                - NET
        - title: Payout Profile - Net
          type: object
          properties:
            net:
              type: object
              description: Configure how `Payout Profiles` with type **NET** are setup.
              nullable: true
              properties:
                frequency:
                  type: string
                  description: Configures how frequentyly fees *and* payouts get credited.
                  enum:
                    - DAILY
                    - MONTHLY
                    - CONTINUOUS
                    - CUSTOM
                payment_instrument_id:
                  type: string
                  description: >-
                    The `id` of the `Payment Instrument` that payouts *and* fees
                    get credited to and debited from.
                rail:
                  type: string
                  enum:
                    - NEXT_DAY_ACH
                    - SAME_DAY_ACH
                  description: >-
                    Configures how quickly and which payment `rail` will be used
                    to debit fees *and* credit payouts.
                submission_delay_days:
                  type: integer
                  description: >-
                    Include a number of `submission_delay_days` to delay when
                    `funding_transfers` for both payouts *and* fees get
                    submitted (in days) to debit/credit the
                    `payment_instrument_id`.
            tags:
              $ref: '#/components/schemas/tags'
            type:
              type: string
              description: >-
                Configures how fees are calculated and billed from payouts. For
                more infromation, see [Payout
                Types](/guides/platform-payments/seller-payouts/managing-seller-payouts#payout-types).
              enum:
                - CUSTOM
                - GROSS
                - NET
    SubmitDisputeEvidence:
      title: SubmitDisputeEvidence
      x-stoplight:
        id: 3ea63d77b21a4
      type: object
      properties:
        note:
          type: string
          description: >-
            Include a note to explain the evidence files and explanation for
            rebut of the `Dispute` 
          example: >-
            Partial rebuttal is due to double charging cardholder due to
            technical malfunction on point of sale, but we have attached receipt
            as proof that cardhoder received item.
        refund:
          type: string
          description: >
            ID of a Transfer. 

            This field should be used only if you are attempting to resolve
            INQUIRY dispute by pro-active refund to cardholder, or a refund was
            made before dispute creation but cardholder did not notice it.

            - Value should be the ID of the Transfer resource with a type of
            REVERSAL.

            - Or one of operation_key `UNREFERENCED_REFUND`,
            `CARD_NOT_PRESENT_UNREFERENCED_REFUND`,
            `CARD_PRESENT_UNREFERENCED_REFUND`
          example: TRxxxxxxxxx
          nullable: true
        amount:
          type: integer
          description: >
            Amount in cents for the partial amount of the dispute you wish to
            rebut. 

            Use if only partial amount of the Dispute is being rebutted. 

            Amount must be equal to or less than the amount of the dispute.

            If you use this field please provide details in notes on reason for
            partial amount.
          nullable: true
      required:
        - note
    UpdateDisputeEvidence:
      title: UpdateDisputeEvidence
      x-stoplight:
        id: 20436cd87ffb5
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - tags
    AcceptDispute:
      title: AcceptDispute
      type: object
      x-stoplight:
        id: 47d1ecd88c757
      properties:
        note:
          type: string
          description: 'Include a note or custom metadata to reference the `Dispute`. '
          example: 'Accepting Dispute: Mistaken Charge'
      required:
        - note
    CloseSettlement:
      title: CloseSettlement
      x-stoplight:
        id: apumcx91bdtxm
      type: object
      properties:
        action:
          type: string
          enum:
            - STOP_ACCRUAL
          description: >-
            The action you want to perform on the `settlement`. Use
            **STOP_ACCRUAL** to close the specified `settlement`.
      required:
        - action
    SplitTransfer:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `split_transfer` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        amount:
          $ref: '#/components/schemas/amount'
        fee:
          type: integer
          description: >-
            The minimum amount of the `Transfer` you'd like to collect as your
            fee in cents. Defaults to zero (must be less than or equal to the
            `amount`).

            - If the fees applied by the 'Fee Profile' are ***higher*** than the
            value passed in 'fee', 'fee' will not be applied and have no effect.

            - If the fees applied by the 'Fee Profile' are ***lower*** than the
            value passed in 'fee', an additional fee is be applied, in addition
            to the fees generated by the `Fee Profile`.
                - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`.
          format: int64
        currency:
          $ref: '#/components/schemas/currency'
        parent_transfer_id:
          type: string
          description: >-
            **ID** of the original parent `Transfer` where the split was
            defined.
          example: TR7h8NxhCDHunLFdJ1HCLp4r
          pattern: TRxxxxxxxxxxxxxxxxxxxxxx
        ready_to_settle_at:
          type: string
          format: date-time
          description: Timestamp of when the `Transfer` is ready to be settled at.
          nullable: true
        type:
          type: string
          description: Type of `split_transfer`.
        merchant_id:
          type: string
          description: >-
            The ID of the `Merchant` resource the `split_transfer` was created
            for and will settle under.
        identity_id:
          type: string
          description: >-
            The ID of `Identity` resource used by the `Merchant` the
            `split_transfer` was created for.
        fee_profile_id:
          type: string
          description: The `fee_profile` associated to this `split_transfer`.
        application_id:
          type: string
          description: The `application_id` associated to this `split_transfer`.
        tags:
          type: object
          properties:
            key:
              type: string
      description: The `split_transfer` resource that was created from a split transacion.
      title: ''
    SettlementEntry:
      type: object
      x-stoplight:
        id: 18c1315aef826
      x-examples:
        Example 1:
          id: SEivAwLLW6c62Nbvvj7TcDAN
          created_at: '2024-02-21T12:35:02.16Z'
          updated_at: '2024-02-21T12:35:02.16Z'
          amount: 20
          currency: USD
          entity_id: TRm9ppvqX43CbwmNzhckf2gb
          entity_details: {}
          entity_type: TRANSFER
          parent_entity_id: null
          parent_entity_type: null
          ready_to_settle_at: '2024-02-22T12:35:02.16Z'
          subtype: DEBIT
          should_fund: true
          _links: {}
      properties:
        id:
          type: string
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        amount:
          type: integer
          format: int64
        currency:
          $ref: '#/components/schemas/currency'
        entity_id:
          $ref: '#/components/schemas/EntityId'
        entity_details:
          type: object
          description: Object which contains additional details about the entity.
          properties:
            fee_category:
              type: string
              description: Describes the category of the fee.
              nullable: true
              enum:
                - PROCESSOR
                - INTERCHANGE
                - DUES_AND_ASSESSMENTS
                - THIRD_PARTY_SERVICE_PROVIDER
        entity_type:
          type: string
          enum:
            - TRANSFER
            - CUSTOM_FEE
            - SPLIT_TRANSFER
            - FEE
        parent_entity_id:
          type: string
          description: >-
            ID of the original parent resource where the transaction occurred.
            Only populated for Fees.
        parent_entity_type:
          type: string
          enum:
            - TRANSFER
        subtype:
          type: string
          enum:
            - DEBIT
            - CREDIT
            - FEE
            - REVERSAL
            - ADJUSTMENT
            - DISPUTE
            - CUSTOM
        ready_to_settle_at:
          type: string
          format: date-time
          description: Timestamp of when the `Settlement Entry` is ready to be settled at.
          nullable: true
        should_fund:
          type: boolean
      description: >-
        An entry is an object that describes the item inside of a settlement.
        Transfers, Split Transfers and Custom fees can all be represented by a
        Settlement Entry. 
    SettlementEntriesList:
      type: object
      x-stoplight:
        id: 108jdm9n0euid
      x-examples:
        Settlement Entries:
          _embedded:
            settlement_entries:
              - id: SEivAwLLW6c62Nbvvj7TcDAN
                created_at: '2024-02-21T12:35:02.16Z'
                updated_at: '2024-02-21T12:35:02.16Z'
                amount: 100
                currency: USD
                entity_id: TRm9ppvqX43CbwmNzhckf2gb
                entity_details: {}
                entity_type: TRANSFER
                parent_entity_id: null
                parent_entity_type: null
                ready_to_settle_at: '2024-02-22T12:35:02.16Z'
                subtype: DEBIT
                should_fund: true
                _links: {}
              - id: SEiwmJxC3u8gfPuLiwMSrn1a
                created_at: '2024-02-21T12:35:02.16Z'
                updated_at: '2024-02-21T12:35:02.16Z'
                amount: 2
                currency: USD
                entity_id: TRwgubpxAJWbaDZE1kKP6SSi
                entity_details:
                  fee_category: PROCESSOR
                entity_type: TRANSFER
                parent_entity_id: TRm9ppvqX43CbwmNzhckf2gb
                parent_entity_type: TRANSFER
                ready_to_settle_at: '2024-02-22T12:35:02.16Z'
                subtype: FEE
                should_fund: true
                _links: {}
          _links:
            self:
              href: >-
                https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/entries
            next:
              href: >-
                https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/entries?after_cursor=SEix6ptbScYkWFN1id25KbN5
          page:
            limit: 100
            next_cursor: SEix6ptbScYkWFN1id25KbN5
      description: 'List of `Settlement Entries`. '
      properties:
        _embedded:
          type: object
          description: List of `Settlement Entries`.
          properties:
            settlement_entries:
              type: array
              description: '`Settlement Entry` objects.'
              items:
                $ref: '#/components/schemas/SettlementEntry'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    SettlementQueueEntry:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the `Settlement Queue Entry` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application_id:
          type: string
          description: >-
            The application linked to the entity that triggered the creation of
            the `Settlement Queue Entry` resource.
        entity_id:
          $ref: '#/components/schemas/EntityId'
        entity_type:
          type: string
          description: The entity the `Settlement Queue Entry` is linked to.
          enum:
            - ADJUSTMENT
            - DISPUTE_TRANSFER
            - FEE
            - TRANSFER
            - REVERSE
            - SPLIT_TRANSFER
        merchant_id:
          type: string
          description: >-
            The ID of the `Merchant` resource the entity was created for and
            will settle under.
        platform_id:
          type: string
          description: >-
            The unique identifier for the Platform where the entity associated
            with the `Settlement Queue Entry` was created.
        ready_to_settle_after:
          type: string
          format: date-time
          description: >-
            Timestamp indicating when the `Settlement Queue Entry` can be
            processed for settlement.
          nullable: true
        state:
          type: string
          description: The current state of the `Settlement Queue Entry`.
          enum:
            - AWAITING_SETTLEMENT_TIME
            - PENDING
            - RELEASED
        _links:
          type: object
          description: >-
            An object containing link(s) relevant to the request. You can store
            these links for follow-up requests.
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The path to the new `Settlement Queue Entry` resource.
    SettlementQueueEntries:
      type: object
      properties:
        _embedded:
          type: object
          description: List of `Settlement Queue Entry` objects.
          properties:
            settlement_queue_entries:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Settlement Queue Entry` objects.'
              items:
                $ref: '#/components/schemas/SettlementQueueEntry'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    UpdateSettlementQueueEntriesRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: >-
            Array of IDs representing the `Settlement Queue Entry` resources on
            which to apply the specified `action`.
        action:
          type: string
          description: >-
            Specify the action to be performed on the `Settlement Queue Entry`
            resources. Use the `RELEASE` action to release a list of `Transfer`,
            `Fee`, or `Reversal` resources, placing them into a `Settlement` as
            corresponding `Settlement Entry` resources.
          enum:
            - RELEASE
    CreateFundingTransferAttemptRequest:
      type: object
      properties:
        instrument_id:
          type: string
          description: >-
            Instrument to use to submit the funds to. Currently instrument must
            be of type PAYMENT_CARD.
        amount:
          type: number
          description: >-
            Amount in cents you wish to be submitted to be paid out via instant
            payout
    SubscriptionBalanceEntryList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Subscription Balance Entry` objects.
          properties:
            subscriptions:
              type: array
              minItems: 0
              uniqueItems: true
              description: |
                `Subscription Balance Entry` objects.
              items:
                $ref: '#/components/schemas/SubscriptionBalanceEntry'
        _links:
          $ref: '#/components/schemas/ListLinks'
    SubscriptionPlan:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Subscription Plan` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        linked_to:
          type: string
          description: >
            The ID of the [`Merchant`](#Merchants) resource that you wish to
            link to the `Subscription Plan` (i.e., the merchant that the
            subscription plan belongs to).


            At this time, only approved merchants with one of the following
            processors are valid:


            - `DUMMY_V1`

            - `FINIX_V1`
        linked_type:
          type: string
          description: The type of the resource that is specified in the `linked_to` field.
          enum:
            - MERCHANT
        billing_interval:
          type: string
          description: How often the subscriber is billed.
          enum:
            - DAILY
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - YEARLY
        nickname:
          $ref: '#/components/schemas/nickname'
        plan_name:
          type: string
          description: A human-friendly name for the `Subscription Plan`.
        description:
          type: string
          description: A description of the `Subscription Plan`.
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          type: string
          description: >-
            ISO 4217 3-letter currency code. Currently, the only `currency`
            supported is `USD`.
          enum:
            - USD
        billing_defaults:
          type: object
          description: Object containing default billing settings.
          properties:
            collection_method:
              type: string
              description: >-
                The method by which subscription payments are collected.
                Currently, automatically billing the card on file is the only
                method available.
              enum:
                - BILL_AUTOMATICALLY
            send_invoice:
              type: boolean
              description: This feature has yet to be implemented.
            send_receipt:
              type: boolean
              description: This feature has yet to be implemented.
        trial_defaults:
          type: object
          description: Object containing default trial settings.
          properties:
            interval_type:
              type: string
              description: The unit of time for the trial period.
              enum:
                - DAY
                - WEEK
                - MONTH
                - YEAR
            interval_count:
              type: integer
              description: >-
                The number of intervals of `interval_type` used to describe the
                duration of the trial.
        discount_phase_defaults:
          type: object
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            billing_interval_count:
              type: integer
              description: >-
                The number of billing intervals the discount applies. After this
                period, the subscriber is charged the full `amount`.
        state:
          type: string
          description: The state of the `Subscription Plan`.
          enum:
            - ACTIVE
            - INACTIVE
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            An object containing link(s) relevant to the request. You can store
            these links for follow-up requests.
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The path to the new `Subscription Plan` resource.
    CreateSubscriptionBalanceEntryRequest:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          type: string
          description: >-
            ISO 4217 3-letter currency code. Currently, the only `currency`
            supported is `USD`.
          enum:
            - USD
        description:
          type: string
          description: >-
            A description of the reason for the subscription credit. No special
            characters are allowed.
        type:
          type: string
          description: Will always be `CREDIT`.
          enum:
            - CREDIT
      required:
        - type
    SubscriptionPlanList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Subscription Plan` objects.
          properties:
            subscriptions:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Subscription Plan` objects.'
              items:
                $ref: '#/components/schemas/SubscriptionPlan'
        _links:
          $ref: '#/components/schemas/ListLinks'
    CreateSubscriptionPlanRequest:
      type: object
      x-examples: {}
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          type: string
          description: >-
            ISO 4217 3-letter currency code. Currently, the only `currency`
            supported is `USD`.
          enum:
            - USD
        plan_name:
          type: string
          description: A human-friendly name for the `Subscription Plan`.
        description:
          type: string
          description: A description of the `Subscription Plan`.
        linked_to:
          type: string
          description: >
            The ID of the [`Merchant`](#Merchants) resource that you wish to
            link to the `Subscription Plan` (i.e., the merchant that the
            subscription plan belongs to).


            At this time, only approved merchants with one of the following
            processors are valid:


            - `DUMMY_V1`

            - `FINIX_V1`
        linked_type:
          type: string
          description: The type of the resource that is specified in the `linked_to` field.
          enum:
            - MERCHANT
        nickname:
          $ref: '#/components/schemas/nickname'
        billing_interval:
          type: string
          description: How often the customer subscriber is billed.
          enum:
            - DAILY
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - YEARLY
        billing_defaults:
          type: object
          description: Object containing default billing settings.
          properties:
            collection_method:
              type: string
              description: >-
                The method by which subscription payments are collected.
                Currently, automatically billing the card on file is the only
                method available.
              enum:
                - BILL_AUTOMATICALLY
          required:
            - collection_method
        trial_defaults:
          type: object
          description: Object containing default trial settings.
          properties:
            interval_type:
              type: string
              description: The unit of time for the trial period.
              enum:
                - DAY
                - WEEK
                - MONTH
                - YEAR
            interval_count:
              type: integer
              description: >-
                The number of intervals of `interval_type` used to describe the
                duration of the trial.
          required:
            - interval_type
            - interval_count
        discount_phase_defaults:
          type: object
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            billing_interval_count:
              type: integer
              description: >-
                The number of billing intervals the discount applies. After this
                period, the subscriber is charged the full `amount` from the
                `Subscription`.
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - amount
        - currency
        - plan_name
        - linked_to
        - linked_type
        - billing_interval
        - billing_defaults
    UpdateSubscriptionPlanRequest:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        nickname:
          $ref: '#/components/schemas/nickname'
        description:
          type: string
          description: A description for the `Subscription Plan`.
        state:
          type: string
          description: The state of the `Subscription Plan`.
          enum:
            - ACTIVE
            - INACTIVE
        tags:
          $ref: '#/components/schemas/tags'
        update_existing_subscriptions:
          type: boolean
          description: >-
            Set to `true` to update existing subscriptions created from this
            plan or `false` to make updates only effective for future
            subscriptions created from this plan. The default is `false`.
    Receipt:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Receipt` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        amount_breakdown:
          type: object
          description: The individual charges/fees that add up to the total amount.
          nullable: true
          properties:
            subtotal_amount:
              $ref: '#/components/schemas/subtotal_amount'
            discount_amount:
              type: integer
              description: A reduction applied to the total amount.
              nullable: true
            shipping_amount:
              type: integer
              description: The amount charged for shipping the items in the order.
              nullable: true
            estimated_tax_amount:
              type: integer
              description: The estimated amount of tax applied to the order.
              nullable: true
            tip_amount:
              type: integer
              description: The tip amount included in the order total.
              nullable: true
            additional_buyer_charges:
              description: Additional charges that the buyer paid.
              allOf:
                - $ref: '#/components/schemas/additional_buyer_charges'
        send_receipt_to_buyer:
          type: boolean
          description: Whether to send a receipt to the buyer.
        device_id:
          type: string
          description: >-
            Applies to [in-person payments](/guides/in-person-payments). The ID
            of the Point-of-Sale terminal used to process the payment.
          nullable: true
        entity_details:
          type: object
          description: >-
            The `Transfer` or `Authorization` details from which to generate the
            receipt.
          properties:
            id:
              type: string
              description: The ID of the `Transfer` or `Authorization`.
            created_at:
              type: string
              description: >-
                The timestamp when the `Transfer` or `Authorization` was
                created.
            operation_key:
              $ref: '#/components/schemas/operation_key'
            type:
              type: string
              description: The type of transaction the receipt was created for.
              enum:
                - TRANSFER
                - AUTHORIZATION
        type:
          type: string
          description: >
            The type of receipt, either for the customer (`BUYER`) or the
            merchant (`MERCHANT`) for a CP (card-present) transaction. For a CNP
            transaction, the `type` will be `BUYER`.
          enum:
            - BUYER
            - MERCHANT
        items:
          $ref: '#/components/schemas/items'
        merchant_details:
          type: object
          description: Object containing `Merchant` details.
          properties:
            id:
              type: string
              description: The ID of the `Merchant`.
            business_name:
              type: string
              minLength: 1
              maxLength: 120
              description: >
                The merchant's legal business name. For a sole proprietorship,
                pass the owner's legal first name, last name, and middle
                initial.
              nullable: true
            doing_business_as:
              type: string
              minLength: 1
              maxLength: 60
              description: >-
                Alternate names of the business. If there are no other names,
                pass the same value used for `business_name`.
              nullable: true
            business_address:
              type: object
              description: The primary address for the legal entity.
              nullable: true
              properties:
                city:
                  type: string
                  minLength: 1
                  maxLength: 20
                  description: City.
                  nullable: true
                country:
                  $ref: '#/components/schemas/country'
                line1:
                  type: string
                  minLength: 1
                  maxLength: 35
                  description: The first line of the address.
                  nullable: true
                line2:
                  type: string
                  minLength: 1
                  maxLength: 35
                  description: The second line of the address.
                  nullable: true
                postal_code:
                  type: string
                  minLength: 1
                  maxLength: 7
                  description: The zip or postal code.
                  nullable: true
                region:
                  type: string
                  minLength: 1
                  description: 2-letter state code.
                  nullable: true
        payment_instrument_details:
          type: object
          description: Object containing `Payment Instrument` details.
          properties:
            id:
              type: string
              description: The ID of the `Payment Instrument`.
            type:
              type: string
              description: The type of `Payment Instrument`.
              enum:
                - PAYMENT_CARD
            billing_address:
              type: object
              description: The primary address associated with the `Payment Instrument`.
              properties:
                city:
                  type: string
                  minLength: 1
                  maxLength: 20
                  description: City.
                  nullable: true
                country:
                  $ref: '#/components/schemas/country'
                line1:
                  type: string
                  minLength: 1
                  maxLength: 35
                  description: The first line of the address.
                  nullable: true
                line2:
                  type: string
                  minLength: 1
                  maxLength: 35
                  description: The second line of the address.
                  nullable: true
                postal_code:
                  type: string
                  minLength: 1
                  maxLength: 7
                  description: The zip or postal code.
                  nullable: true
                region:
                  type: string
                  minLength: 1
                  description: 2-letter state code.
                  nullable: true
            bin:
              type: string
              description: The Bank Identification Number for the `Payment Instrument`.
            brand:
              type: string
              enum:
                - UNKNOWN
                - DINERS_CLUB_INTERNATIONAL
                - DANKORT
                - MIR
                - TROY
                - UATP
                - CHINA_T_UNION
                - CHINA_UNION_PAY
                - AMERICAN_EXPRESS
                - VERVE
                - RUPAY
                - DISCOVER
                - JCB
                - MASTERCARD
                - INTERPAYMENT
                - INSTAPAYMENT
                - MAESTRO
                - VISA
                - LANKAPAY
                - DINERS_CLUB
                - INTERAC
              description: The `brand` of the card saved in the `Payment Instrument`.
            card_type:
              type: string
              enum:
                - CREDIT
                - DEBIT
                - HSA_FSA
                - NON_RELOADABLE_PREPAID
                - RELOADABLE_PREPAID
                - UNKNOWN
              description: The type of payment card saved in the `Payment Instrument`.
            last_four:
              type: string
              description: The last four digits of the card or bank account number.
            name:
              type: string
              description: The name of the bank account or card owner.
              nullable: true
        network_details:
          type: object
          description: An object containing EMV data.
          nullable: true
          properties:
            application_label:
              type: string
              description: The EMV application label. Tag 50 from the EMVCo standard.
              nullable: true
            application_identifier:
              type: string
              description: >-
                The ID of the application used in the transaction. Tag 9F06 from
                the EMVCo standard.
              nullable: true
            cryptogram:
              type: string
              description: >-
                The cryptogram returned by the card. Tag 9F26 of the EMVCo
                standard.
              nullable: true
            approval_code:
              type: string
              description: The unique ID used to identify the approval of the `Transfer`.
              nullable: true
        requested_delivery_methods:
          type: array
          default: []
          description: An array of delivery methods used to send the receipt.
          items:
            type: object
            description: An individual delivery method.
            required:
              - type
              - destinations
            properties:
              type:
                type: string
                description: The type of delivery method used to send the receipt.
                enum:
                  - EMAIL
                  - SMS
                  - PRINT
              destinations:
                type: array
                description: A list of destinations to send the receipt.
                items:
                  type: string
                  description: A destination to send the receipt.
        receipt_url:
          type: string
          description: The location of the receipt on Finix's Amazon S3.
        _links:
          type: object
          description: >-
            An object containing link(s) relevant to the request. You can store
            these links for follow-up requests.
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The path to the new resource.
    CreateReceiptRequest:
      type: object
      x-examples: {}
      properties:
        entity_id:
          type: string
          description: >-
            The ID of the `Transfer` or `Authorization` for which the receipt
            must be generated.
        send_receipt_to_buyer:
          type: boolean
          description: Whether to send a receipt to the buyer.
        requested_delivery_methods:
          type: array
          description: An array of delivery methods used to send the receipt.
          items:
            type: object
            description: An individual delivery method.
            required:
              - type
              - destinations
            properties:
              type:
                type: string
                description: The type of delivery method used to send the receipt.
                enum:
                  - EMAIL
                  - SMS
                  - PRINT
              destinations:
                type: array
                description: A list of destinations to send the receipt.
                items:
                  type: string
                  description: A destination to send the receipt.
        amount_breakdown:
          type: object
          description: The individual charges/fees that add up to the total amount.
          properties:
            subtotal_amount:
              $ref: '#/components/schemas/subtotal_amount'
            shipping_amount:
              type: integer
              description: The amount charged for shipping the items in the order.
            estimated_tax_amount:
              type: integer
              description: The estimated amount of tax applied to the order.
            additional_buyer_charges:
              description: Additional charges that the buyer paid.
              allOf:
                - $ref: '#/components/schemas/additional_buyer_charges'
            discount_amount:
              type: integer
              description: A reduction applied to the total amount.
            tip_amount:
              type: integer
              description: The tip amount included in the order total.
        items:
          $ref: '#/components/schemas/items'
        additional_details:
          type: array
          description: >-
            An array of key-value pairs for including any extra metadata or
            custom information related to the receipt. Each entry must contain a
            `name` and a corresponding `value`. **Currently these fields will
            only be used for receipts via devices.**
          items:
            type: object
            properties:
              name:
                type: string
                maxLength: 25
                description: >-
                  The label or title for the additional detail being provided.
                  This should be a short, human-readable identifier such as
                  "Invoice Number", "VIN", "Service Date", or "Technician".
              value:
                type: string
                maxLength: 25
                description: >-
                  The corresponding value for the detail specified in name. This
                  can be any string that provides relevant context or
                  information to appear on the receipt, such as an actual
                  invoice number, vehicle identification number, or date.
      required:
        - entity_id
        - send_receipt_to_buyer
    DeliveryAttempt:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Delivery Attempt` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        destination:
          type: string
          description: The receipt delivery attempt destination.
        receipt_id:
          type: string
          description: >-
            The ID of the `Receipt` resource associated with the `Delivery
            Attempt`.
        state:
          type: string
          description: Whether the delivery attempt succeeded or failed.
          enum:
            - SUCCEEDED
            - FAILED
        type:
          type: string
          description: The type of delivery method used to send the receipt.
          enum:
            - EMAIL
            - SMS
            - PRINT
    DeliveryAttemptList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Delivery Attempt` objects.
          properties:
            delivery_attempts:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Delivery Attempt` objects.'
              items:
                $ref: '#/components/schemas/DeliveryAttempt'
        _links:
          $ref: '#/components/schemas/ListLinks'
    CreateDeliveryAttempt:
      type: object
      properties:
        requested_delivery_methods:
          type: array
          description: A list of delivery methods used to send the receipt.
          items:
            type: object
            description: An individual delivery method.
            required:
              - type
              - destinations
            properties:
              type:
                type: string
                description: The type of delivery method used to send the receipt.
                enum:
                  - EMAIL
                  - SMS
                  - PRINT
              destinations:
                type: array
                description: A list of destinations to send the receipt.
                items:
                  type: string
                  description: A destination to send the receipt.
      required:
        - requested_delivery_methods
    ReviewQueueItem:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Review Queue` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          description: >-
            Unique identifier for the `Application` associated with this `Review
            Queue Item`.
          type: string
        completed_at:
          type: string
          format: date-time
          description: Timestamp when the `outcome` field was changed to `ACCEPTED`.
          nullable: true
        entity_id:
          type: string
          description: >-
            Unique identifier for the resource connected to this `Review Queue
            Item`.
        entity_type:
          type: string
          description: The type of entity being reviewed.
          enum:
            - MERCHANT
            - SETTLEMENT_V2
        outcome:
          type: string
          description: The outcome of the current `Review Queue Item`.
          enum:
            - ACCEPTED
            - MANUAL_REVIEW
            - PENDING
            - REJECTED
        processor_type:
          type: string
          example: DUMMY_V1
          description: The type of payment processor used.
          enum:
            - DUMMY_V1
        reviewed_by:
          type: string
          description: >-
            The ID of the user who last updated the `Review Queue Item`'s
            `outcome` property.
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            An object containing link(s) relevant to the request. You can store
            these links for follow-up requests.
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The path to the resource.
            settlement:
              type: object
              description: Link to the associated `Settlement` resource.
              properties:
                href:
                  type: string
            application:
              type: object
              description: Link to the associated `Application` resource.
              properties:
                href:
                  type: string
    ReviewQueueItems:
      type: object
      properties:
        _embedded:
          type: object
          description: List of `Review Queue Item` objects
          properties:
            review_queue_items:
              type: array
              minItems: 0
              uniqueItems: true
              items:
                $ref: '#/components/schemas/ReviewQueueItem'
        _links:
          $ref: '#/components/schemas/ListLinks'
        page:
          $ref: '#/components/schemas/PageCursor'
    UpdateReviewQueueItemRequest:
      type: object
      properties:
        outcome:
          type: string
          description: The current status of the `Review Queue Item`.
          enum:
            - ACCEPTED
            - MANUAL_REVIEW
            - PENDING
            - REJECTED
        tags:
          $ref: '#/components/schemas/tags'
    created_at:
      type: string
      format: date-time
      description: Timestamp of when the object was created.
    updated_at:
      type: string
      format: date-time
      description: Timestamp of when the object was last updated.
    tags:
      type: object
      title: tags
      additionalProperties:
        type: string
      description: >-
        Include up to 50 `key: value` pairs to annotate requests with custom
        metadata.

        - Maximum character length for individual `keys` is 40.

        - Maximum character length for individual `values` is 500.

        (For example, `order_number: 25`, `item_type: produce`, `department:
        sales`)
      nullable: true
    logref:
      type: object
      properties:
        logref:
          type: string
    page:
      type: object
      description: Details the page that's returned.
      properties:
        limit:
          type: integer
          description: The number of entries to return.
        next_cursor:
          type: string
          description: The cursor to use for the next page of results.
          nullable: true
    id:
      type: string
      minLength: 1
      description: The ID of the resource.
    account_updater_enabled_application:
      type: boolean
      description: >
        When enabled at the `Application`-level, Finix automatically checks for
        updates with card networks for all payment cards created after the
        feature is activated. This Account Updater functionality:


        - Automatically updates card details (e.g., number or expiration date)
        to maintain continuity of charges, increasing authorization rates.

        - Saves cardholders the hassle of updating card details across
        merchants.

        - Applies to all payment instruments by default but can be disabled for
        specific cards.


        The default value is `false` as explicit opt-in is required.


        **Note**: Cards created before the feature is enabled are unaffected by
        default. To include these cards, you can manually enable the Account
        Updater functionality for each card individually using a PUT request.
        Once enabled, you can link the card to this API call to trigger updates
        with card networks.
      default: false
    network_token_enabled_application:
      type: boolean
      description: >
        When enabled at the `Application` level, "network tokens" replace raw
        card details (e.g., the 16-digit PAN and expiration date) for
        transactions. Network tokens have several benefits:


        - Network tokens offer increased authorization rates, even for lost or
        stolen cards, as they remain valid while the physical card is replaced.

        - Visa reduces interchange fees when using network tokens.

        - Tokens enhance security by replacing card details with a non-sensitive
        string that is usable only within the Finix system.


        The default value is `false` as explicit opt-in is required.


        **Note**: Cards created before the feature is enabled are unaffected. To
        include them, update an individual `Payment Instrument`. Then, you can
        insert the hyperlink on the "update".
      default: false
    refunds_disabled_application:
      type: boolean
      default: false
      description: >-
        A value of `true` disables refunds for all merchants under this
        application, including both referenced and unreferenced refunds.
    self:
      type: object
      description: Link to the resource that was used in the request.
      properties:
        href:
          type: string
          minLength: 1
    application:
      title: Application
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        account_updater_enabled:
          $ref: '#/components/schemas/account_updater_enabled_application'
        card_cvv_required:
          type: boolean
          description: Details if the `Application` requires CVV code.
        card_expiration_date_required:
          type: boolean
          description: Details if the `Application` requires the card's expiration date.
        creating_transfer_from_report_enabled:
          type: boolean
          description: >-
            Details if the `Application` is automatically set to create
            `Transfers` once settlement reports get generated.
        disbursements_ach_pull_enabled:
          type: boolean
          description: >-
            Indicates whether ACH pull disbursements (debits) are enabled,
            allowing funds to be withdrawn from an account via ACH transfer.
        disbursements_ach_push_enabled:
          type: boolean
          description: >-
            Indicates whether ACH push disbursements (credits) are enabled,
            allowing funds to be sent to an account via ACH transfer.
        disbursements_card_pull_enabled:
          type: boolean
          description: >-
            Indicates whether card pull disbursements (debits) are enabled,
            allowing funds to be withdrawn from a card.
        disbursements_card_push_enabled:
          type: boolean
          description: >-
            Indicates whether card push disbursements (credits) are enabled,
            allowing funds to be sent to a card.
        disbursements_same_day_ach_pull_enabled:
          type: boolean
          description: >-
            Indicates whether same-day ACH pull disbursements (debits) are
            enabled, allowing funds to be withdrawn from an account via same-day
            ACH transfer.
        disbursements_same_day_ach_push_enabled:
          type: boolean
          description: >-
            Indicates whether same-day ACH push disbursements (credits) are
            enabled, allowing funds to be sent to an account via same-day ACH
            transfer.
        enabled:
          type: boolean
          description: >-
            Details if the `Application` is enabled and active. Set to **false**
            to disable the `Application`.
        fee_ready_to_settle_upon:
          type: string
          enum:
            - RECONCILIATION
            - SUCCESSFUL_CAPTURE
            - PROCESSOR_WINDOW
            - CONFIGURABLE_WINDOW
          description: >-
            Details when the `fees` of `Authroizations` submitted under the
            `Application` will be ready to settle.
          nullable: true
        instant_payouts_card_push_enabled:
          type: boolean
          description: >-
            Set to `true` if you want to allow the merchant to be enabled for
            settlement instant payouts.
          default: false
        name:
          type: string
          description: The name of the `Application`.
        network_token_enabled:
          $ref: '#/components/schemas/network_token_enabled_application'
        owner:
          type: string
          example: IDxxxxxxxxxxxxxxxxxx
          description: ID of the `Identity` resource that created the `Application`.
        processing_enabled:
          type: boolean
          description: 'Details if transaction processing is enabled for the `Application`. '
        ready_to_settle_upon:
          type: string
          enum:
            - RECONCILIATION
            - SUCCESSFUL_CAPTURE
            - PROCESSOR_WINDOW
            - CONFIGURABLE_WINDOW
          description: >-
            Details when transactions submitted under the `Application` will be
            ready to settle.
          nullable: true
        ready_to_settle_upon_delay_alignment:
          type: string
          description: >
            Indicates whether transaction settlement should be delayed to
            synchronize the timing of all transactions, including both card and
            ACH, ensuring they are settled together.


            Possible values include:


            - `ACH` - Align all transactions to match the timing of ACH
            settlements, so card transactions settle at the same speed as ACH
            transactions.

            - `NONE` - Default behavior where card transactions settle the next
            day (T+1) and ACH transactions settle two days later (T+2).
          enum:
            - ACH
            - NONE
        refunds_disabled:
          $ref: '#/components/schemas/refunds_disabled_application'
        settlement_approval_enabled:
          type: boolean
          description: >
            This flag determines if `ROLE_PARTNER`s associated with this
            `Application` can approve settlements. It lets customers allow
            partners to add items to exception settlements and approve them.
        settlement_enabled:
          type: boolean
          description: 'Details if settlement approvals are enabled for the `Application`. '
        settlement_funding_identifier:
          type: string
          enum:
            - UNSET
            - MID_AND_DATE
            - MID_AND_MERCHANT_NAME
          default: UNSET
          description: >-
            Includes additional information (like the MID or `Merchant` name)
            when submitting funding `Transfers` to processors.

            - **UNSET**: No additional details get provided to the processor.

            - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the
            funding `Transfer` was submitted (Date is in UTC). e.g
            **MID:12345678-20220225**

            - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the
            `Merchant#name` (white spaces will be removed). e.g.
            **MID:12345678-NameOfMerchant**


            These details appear alongside the seller's payout in their bank
            account as a description of the deposit.
        settlement_queue_mode:
          type: string
          description: >
            If `settlement_queue_mode` is set to `MANUAL`, Finix will
            automatically place all transactions (Sales, Fees, Refunds, and ACH
            Returns) into a settlement queue that you can manage. Each
            transaction will have a `Settlement Queue Entry`.


            When a `Settlement Queue Entry` is created, it will not be placed
            into `Settlement` until the `Settlement Queue Entry` is explicitly
            released.


            Note: We require the release of all settlement queue entries within
            30 days of creation.
          enum:
            - UNSET
            - MANUAL
        unreferenced_refund_manual_entry_enabled:
          type: boolean
          default: false
          description: >-
            Indicates if application is allowed to process unreferenced refunds
            initiated through manual card entry on Finix terminals.
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
    next:
      type: object
      description: Link to the next page of entries.
      properties:
        href:
          type: string
    genericError:
      type: object
      description: Error response containing one or more error details.
      properties:
        total:
          type: integer
          description: Total number of errors returned.
        _embedded:
          type: object
          description: Container for embedded error objects.
          properties:
            errors:
              type: array
              description: List of individual error objects.
              items:
                type: object
                description: Detailed information about an individual error.
                properties:
                  code:
                    type: string
                    description: >-
                      The error code. The `UNKNOWN` error code is returned for a
                      401 Unauthorized or 403 Forbidden request.
                  logref:
                    $ref: '#/components/schemas/logref'
                  message:
                    type: string
                    description: A human-friendly error message.
                  _links:
                    type: object
                    description: Links related to this error.
                    properties:
                      source:
                        type: object
                        description: Link to the resource related to the error.
                        properties:
                          href:
                            type: string
                            description: URL of the related resource.
                additionalProperties: true
      required:
        - total
        - _embedded
    country:
      type: string
      enum:
        - ABW
        - AFG
        - AGO
        - AIA
        - ALA
        - ALB
        - AND
        - ARE
        - ARG
        - ARM
        - ASM
        - ATA
        - ATF
        - ATG
        - AUS
        - AUT
        - AZE
        - BDI
        - BEL
        - BEN
        - BES
        - BFA
        - BGD
        - BGR
        - BHR
        - BHS
        - BIH
        - BLM
        - BLR
        - BLZ
        - BMU
        - BOL
        - BRA
        - BRB
        - BRN
        - BTN
        - BVT
        - BWA
        - CAF
        - CAN
        - CCK
        - CHE
        - CHL
        - CHN
        - CIV
        - CMR
        - COD
        - COG
        - COK
        - COL
        - COM
        - CPV
        - CRI
        - CUB
        - CUW
        - CXR
        - CYM
        - CYP
        - CZE
        - DEU
        - DJI
        - DMA
        - DNK
        - DOM
        - DZA
        - ECU
        - EGY
        - ERI
        - ESH
        - ESP
        - EST
        - ETH
        - FIN
        - FJI
        - FLK
        - FRA
        - FRO
        - FSM
        - GAB
        - GBR
        - GEO
        - GGY
        - GHA
        - GIB
        - GIN
        - GLP
        - GMB
        - GNB
        - GNQ
        - GRC
        - GRD
        - GRL
        - GTM
        - GUF
        - GUM
        - GUY
        - HKG
        - HMD
        - HND
        - HRV
        - HTI
        - HUN
        - IDN
        - IMN
        - IND
        - IOT
        - IRL
        - IRN
        - IRQ
        - ISL
        - ISR
        - ITA
        - JAM
        - JEY
        - JOR
        - JPN
        - KAZ
        - KEN
        - KGZ
        - KHM
        - KIR
        - KNA
        - KOR
        - KWT
        - LAO
        - LBN
        - LBR
        - LBY
        - LCA
        - LIE
        - LKA
        - LSO
        - LTU
        - LUX
        - LVA
        - MAC
        - MAF
        - MAR
        - MCO
        - MDA
        - MDG
        - MDV
        - MEX
        - MHL
        - MKD
        - MLI
        - MLT
        - MMR
        - MNE
        - MNG
        - MNP
        - MRT
        - MSR
        - MTQ
        - MUS
        - MWI
        - MYS
        - MYT
        - NAM
        - NCL
        - NER
        - NFK
        - NGA
        - NIC
        - NIU
        - NLD
        - NOR
        - NPL
        - NRU
        - NZL
        - OMN
        - PAK
        - PAN
        - PCN
        - PER
        - PHL
        - PLW
        - PNG
        - POL
        - PRI
        - PRK
        - PRT
        - PRY
        - PSE
        - PYF
        - QAT
        - REU
        - ROU
        - RUS
        - RWA
        - SAU
        - SDN
        - SEN
        - SGP
        - SGS
        - SHN
        - SJM
        - SLB
        - SLE
        - SLV
        - SMR
        - SOM
        - SPM
        - SRB
        - SSD
        - STP
        - SUR
        - SVK
        - SVN
        - SWE
        - SWZ
        - SXM
        - SYC
        - SYR
        - TCA
        - TCD
        - TGO
        - THA
        - TJK
        - TKL
        - TKM
        - TLS
        - TON
        - TTO
        - TUN
        - TUR
        - TUV
        - TWN
        - TZA
        - UGA
        - UKR
        - UMI
        - URY
        - USA
        - UZB
        - VAT
        - VCT
        - VEN
        - VGB
        - VIR
        - VNM
        - VUT
        - WLF
        - WSM
        - XKX
        - YEM
        - ZAF
        - ZMB
        - ZWE
      nullable: true
    address:
      type: object
      properties:
        line1:
          type: string
          minLength: 1
          description: First line of the address (max 35 characters).
          nullable: true
        line2:
          type: string
          minLength: 1
          description: Second line of the address (max 35 characters).
          nullable: true
        city:
          type: string
          minLength: 1
          description: City (max 20 characters).
          nullable: true
        region:
          type: string
          minLength: 1
          description: 2-letter State code.
          nullable: true
        postal_code:
          type: string
          minLength: 1
          description: Zip or Postal code (max 7 characters).
          nullable: true
        country:
          $ref: '#/components/schemas/country'
      required:
        - city
        - country
        - line1
        - postal_code
        - region
    default_statement_descriptor:
      type: string
      maxLength: 22
      nullable: true
      description: >-
        The description of the `Merchant` that appears on the buyer's bank or
        card statement.
    createApplicationRequiredFields:
      type: object
      properties:
        entity:
          type: object
          description: Information needed to verify the identity of the entity.
          properties:
            business_address:
              $ref: '#/components/schemas/address'
            business_name:
              type: string
              description: >-
                Merchant's full legal business name (If
                **INDIVIDUAL\_SOLE\_PROPRIETORSHIP**, input first name, Full
                legal last name and middle initial; max 120 characters)
              nullable: true
            business_phone:
              type: string
              description: >-
                Customer service phone number where the merchant can be reached
                (max 10 characters).
            business_tax_id:
              type: string
              description: >-
                Nine digit Tax Identification Number (TIN), Employer
                Identification Number (EIN). If the `business_type` is
                **INDIVIDUAL\_SOLE\_PROPRIETORSHIP** and they do not have an
                EIN, use the sole proprietor's Social Security Number (SSN).
            business_type:
              type: string
              enum:
                - INDIVIDUAL_SOLE_PROPRIETORSHIP
                - CORPORATION
                - LIMITED_LIABILITY_COMPANY
                - PARTNERSHIP
                - LIMITED_PARTNERSHIP
                - GENERAL_PARTNERSHIP
                - ASSOCIATION_ESTATE_TRUST
                - TAX_EXEMPT_ORGANIZATION
                - INTERNATIONAL_ORGANIZATION
                - GOVERNMENT_AGENCY
                - JOINT_VENTURE
              description: Include the value that applies the best.
              nullable: true
            default_statement_descriptor:
              $ref: '#/components/schemas/default_statement_descriptor'
            dob:
              type: object
              description: The principal control owner's date of birth.
              properties:
                day:
                  type: integer
                  description: Day of birth (between 1 and 31).
                month:
                  type: integer
                  description: Month of birth (between 1 and 12).
                year:
                  type: integer
                  description: Year of birth (4-digit).
            doing_business_as:
              type: string
              maxLength: 60
              description: >-
                Alternate name of the business. If no other name is used use the
                same value used in `business_name` (max 60 characters).
            email:
              type: string
              description: >-
                Control person's email address where they can be reached (max
                100 characters).
            first_name:
              type: string
              description: >-
                Full legal first name of the merchant's principal representative
                (max 20 characters).
            last_name:
              type: string
              description: >-
                Full legal last name of the merchant's principal representative
                (max 20 characters).
            max_transaction_amount:
              type: integer
              description: >-
                Maximum amount that can be processed for a single transaction in
                cents (max 12 characters).
              nullable: true
            personal_address:
              $ref: '#/components/schemas/address'
            phone:
              type: string
              description: Principal's phone number (max 10 characters).
            tax_id:
              type: string
              description: Used to verify `tax_id` was provided.
          required:
            - business_address
            - business_name
            - business_phone
            - business_tax_id
            - business_type
            - dob
            - doing_business_as
            - email
            - first_name
            - last_name
            - personal_address
            - phone
            - tax_id'
        user:
          type: string
          example: USxxxxxxxxxxxxxxxxxx
          description: ID of the `User` resource.
      required:
        - user
    createApplication:
      type: object
      title: Application
      allOf:
        - $ref: '#/components/schemas/createApplicationRequiredFields'
        - type: object
          properties:
            tags:
              $ref: '#/components/schemas/tags'
    createApplicationEnableAccountUpdater:
      type: object
      title: Application - Enable Account Updater
      allOf:
        - type: object
          properties:
            account_updater_enabled:
              $ref: '#/components/schemas/account_updater_enabled_application'
        - $ref: '#/components/schemas/createApplicationRequiredFields'
    createApplicationEnableNetworkTokens:
      type: object
      title: Application - Enable Network Tokens
      allOf:
        - type: object
          properties:
            network_token_enabled:
              $ref: '#/components/schemas/network_token_enabled_application'
        - $ref: '#/components/schemas/createApplicationRequiredFields'
    createApplicationDisableRefunds:
      type: object
      title: Application - Disable Refunds
      allOf:
        - $ref: '#/components/schemas/createApplicationRequiredFields'
        - type: object
          properties:
            refunds_disabled:
              $ref: '#/components/schemas/refunds_disabled_application'
    updateApplication:
      type: object
      properties:
        settlement_approval_enabled:
          type: boolean
          description: >
            This flag determines if `ROLE_PARTNER`s associated with this
            `Application` can approve settlements. It lets customers allow
            partners to add items to exception settlements and approve them.
        tags:
          $ref: '#/components/schemas/tags'
    currency:
      type: string
      description: ISO 4217 3-letter currency code.
      enum:
        - AED
        - AFN
        - ALL
        - AMD
        - ANG
        - AOA
        - ARS
        - AUD
        - AWG
        - AZN
        - BAM
        - BBD
        - BDT
        - BGN
        - BHD
        - BIF
        - BMD
        - BND
        - BOB
        - BOV
        - BRL
        - BSD
        - BTN
        - BWP
        - BYR
        - BZD
        - CAD
        - CDF
        - CHE
        - CHF
        - CHW
        - CLF
        - CLP
        - CNY
        - COP
        - COU
        - CRC
        - CUC
        - CUP
        - CVE
        - CZK
        - DJF
        - DKK
        - DOP
        - DZD
        - EGP
        - ERN
        - ETB
        - EUR
        - FJD
        - FKP
        - GBP
        - GEL
        - GHS
        - GIP
        - GMD
        - GNF
        - GTQ
        - GYD
        - HKD
        - HNL
        - HRK
        - HTG
        - HUF
        - IDR
        - ILS
        - INR
        - IQD
        - IRR
        - ISK
        - JMD
        - JOD
        - JPY
        - KES
        - KGS
        - KHR
        - KMF
        - KPW
        - KRW
        - KWD
        - KYD
        - KZT
        - LAK
        - LBP
        - LKR
        - LRD
        - LSL
        - LTL
        - LYD
        - MAD
        - MDL
        - MGA
        - MKD
        - MMK
        - MNT
        - MOP
        - MRO
        - MUR
        - MVR
        - MWK
        - MXN
        - MXV
        - MYR
        - MZN
        - NAD
        - NGN
        - NIO
        - NOK
        - NPR
        - NZD
        - OMR
        - PAB
        - PEN
        - PGK
        - PHP
        - PKR
        - PLN
        - PYG
        - QAR
        - RON
        - RSD
        - RUB
        - RWF
        - SAR
        - SBD
        - SCR
        - SDG
        - SEK
        - SGD
        - SHP
        - SLL
        - SOS
        - SRD
        - SSP
        - STD
        - SVC
        - SYP
        - SZL
        - THB
        - TJS
        - TMT
        - TND
        - TOP
        - TRY
        - TTD
        - TWD
        - TZS
        - UAH
        - UGX
        - USD
        - USN
        - UYI
        - UYU
        - UZS
        - VEF
        - VND
        - VUV
        - WST
        - XAF
        - XAG
        - XAU
        - XBA
        - XBB
        - XBC
        - XBD
        - XCD
        - XDR
        - XOF
        - XPD
        - XPF
        - XPT
        - XSU
        - XTS
        - XUA
        - XXX
        - YER
        - ZAR
        - ZMW
        - ZWL
    user:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        created_by:
          type: string
          description: The ID of the application user that created _this_ user.
        email:
          type: string
          minLength: 1
          description: The email address of the application user (max 100 characters).
        enabled:
          type: boolean
          description: >-
            Whether the `User` is enabled and active. Set to `false` to disable
            the `User`.
        identity:
          type: string
          example: IDxxxxxxxxxxxxxxxxxx
          description: ID of the `Identity` that the `User` object was created under.
          nullable: true
        last_used_date:
          type: string
          format: date-time
          description: >-
            Timestamp of when the user credentials were last used to make an API
            call.
        password:
          type: string
          description: The `password` you'll use to authetnicate requests.
          nullable: true
        role:
          enum:
            - ROLE_ADMIN
            - ROLE_PLATFORM
            - ROLE_PARTNER
            - ROLE_MERCHANT
          type: string
          description: Details the level of access the [`User`](#Users) has available.
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            application:
              type: object
              description: Link to the `Application` the resource was created under.
              properties:
                href:
                  type: string
            applications:
              type: object
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    additional_buyer_charges:
      type: object
      description: >
        Additional charges will be incurred by the buyer. 


        The following rules apply:


        - The `Merchant` must be enabled to charge these surcharges by setting
        the appropriate flags for each applicable surcharge to `true` using the
        PUT `/merchants` endpoint.

        - Only _one_ of the following charges can be applied during creation.
      nullable: true
      properties:
        convenience_amount:
          type: integer
          description: >-
            A convenience fee to charge the buyer for the transaction. This
            object property is mutually exclusive.
          nullable: true
        rent_surcharge_amount:
          type: integer
          description: >-
            A rent surcharge to charge the buyer for the transaction. This
            object property is mutually exclusive.
          nullable: true
        surcharge_amount:
          type: integer
          description: >-
            A surcharge amount to charge the buyer for the transaction. This
            object property is mutually exclusive.
          nullable: true
    additional_healthcare_data:
      type: object
      nullable: true
      properties:
        clinic_amount:
          type: integer
          description: A clinic or other qualified medical amount for the transaction.
          nullable: true
        dental_amount:
          type: integer
          description: The dental amount for the transaction.
          nullable: true
        prescription_amount:
          type: integer
          description: The prescription/RX amount for the transaction.
          nullable: true
        vision_amount:
          type: integer
          description: The vision/optical amount for the transaction.
          nullable: true
    additional_purchase_data:
      type: object
      description: >-
        Additional information about the purchase used for [Level 2 and Level 3
        Processing](/guides/online-payments/payment-features/level-2-level-3-processing).
        Please note that Visa is ending its Level 2 offering in April 2026.
      nullable: true
      properties:
        customer_reference_number:
          type: string
          description: The customer reference for the purchase (max 17 characters).
          maxLength: 17
        customs_duty_amount:
          type: integer
          description: The duty in cents on the total purchase amount for the order.
        destination_country_code:
          type: string
          description: The ISO country code of the order destination.
        destination_postal_code:
          type: string
          description: The postal code of the order destination (10 characters).
          maxLength: 10
        discount_amount:
          type: integer
          description: >-
            The amount in cents of the discount for the order. You must include
            this field to qualify for Level 3 interchange benefits. Even if the
            value is (0), you should pass the field to qualify for Level 3.
        invoice_reference_number:
          type: string
          description: The order's invoice number (max 15 characters).
          maxLength: 15
        order_date:
          type: object
          properties:
            day:
              type: integer
              description: Day of purchase (between 1 and 31).
            month:
              type: integer
              description: Month of purchase (between 1 and 12).
            year:
              type: integer
              description: Year of purchase (4-digit).
              minimum: 1990
        sales_tax:
          type: integer
          description: >-
            - Total aggregate tax amount in cents for the entire purchase. Field
            is automatically calculated if you pass in the itemized tax
            amounts. 

            - For non-taxable transactions either set `sales_tax` to 0 or omit
            from payload and also set `tax_exempt` to **True**.

            - Request must align so `amount_excluding_sales_tax` + `sales_tax` =
            `amount_including_sales_tax`.
        sales_tax_finix_generated:
          type: integer
          nullable: true
        ship_from_postal_code:
          type: string
          description: The postal code from where order is shipped (10 characters).
          maxLength: 10
        shipping_amount:
          type: integer
          description: |
            The shipping cost in cents for the order.
        tax_exempt:
          type: boolean
          description: |-
            - For tax exempt purchases set to **True**.
            - If set to **True**, request can't include `sales_tax`.
        item_data:
          type: array
          description: >-
            Additional information about the transaction. Used for Level 2 and
            Level 3 Processing.
          items:
            type: object
            properties:
              amount_excluding_sales_tax:
                type: integer
                description: >-
                  - Total cost of the line item in cents, excluding tax.

                  - Must align with `sales_tax` so `amount_excluding_sales_tax`
                  + `sales_tax` = `amount_including_sales_tax`.
              amount_including_sales_tax:
                type: integer
                description: >-
                  - Total cost of the line item in cents, including tax.

                  - Must align with `sales_tax` so `amount_excluding_sales_tax`
                  + `sales_tax` = `amount_including_sales_tax`.
              commodity_code:
                type: string
                description: >-
                  A commodity code is a numeric code representing a particular
                  product or service as defined by the National Institute of
                  Governmental Purchasing. The code can be 3, 5, 7, or 11 digits
                  in length. The longer the code the more granular the
                  description of the product/service. (max 12 characters).
                maxLength: 12
              cost_per_unit:
                type: integer
                description: The price in cents of one unit of the item purchased.
              item_description:
                type: string
                description: Required when `item_data` is supplied (max 25 characters).
                maxLength: 25
              item_discount_amount:
                type: integer
                description: >-
                  The item discount amount in cents. You must include this field
                  to qualify for Level 3 interchange benefits. Even if the value
                  is (0), you should pass the field to qualify for Level 3.
              merchant_product_code:
                type: string
                description: Merchant defined product code (max 12 characters).
                maxLength: 12
              quantity:
                type: integer
                description: The number of items purchased. Must be greater than 0.
                minimum: 1
                maximum: 99
              unit_of_measure:
                type: string
                description: The unit of measure of the purchased item (max 3 characters).
                maxLength: 3
      required:
        - customer_reference_number
        - sales_tax
    amount:
      type: integer
      description: >-
        The total amount that will be debited in cents (e.g. 100 cents to debit
        $1.00).
      format: int64
    card_present_details:
      type: object
      description: Details needed to process card present transactions.
      nullable: true
      properties:
        approval_code:
          type: string
          description: Unique ID used to identify the approval of the `Transfer`.
          nullable: true
        brand:
          type: string
          description: The brand of the card saved in the `Payment Instrument`.
          nullable: true
        emv_data:
          type: object
          description: Encrypted card data used to process the transaction.
          nullable: true
          properties:
            application_identifier:
              type: string
              description: >-
                ID of the application used in the transaction. Tag 9F06 from the
                EMVCo standard.
            application_label:
              type: string
              description: EMV application label. Tag 50 from the EMVCo standard.
            application_preferred_name:
              type: string
              description: >-
                EMV application label with formatting (if provided). Tag 9F12
                from the EMVCo standard.
              nullable: true
            application_transaction_counter:
              type: string
              description: >-
                Transaction number for the EMV application. Tag 9F36 from the
                EMVCo standard.
            cryptogram:
              type: string
              description: Cryptogram returned by the card. Tag 9F26 of the EMVCo standard.
            issuer_code_table_index:
              type: string
              description: >-
                The alphabet code table (according to ISO 8859) used by the EMV
                application (if provided). Tag 9F11.
              nullable: true
            pin_verified:
              type: boolean
              description: Whether the cardholder's PIN number was verified.
            tags:
              $ref: '#/components/schemas/tags'
        entry_mode:
          type: string
          description: >
            Details of the card payment method used to process the transaction.


            The possible enums are:


            - UNKNOWN - The method by which the payment card was used is
            unknown.

            - SWIPED - The card was swiped through a POS terminal. 

            - MANUAL_KEY_ENTRY - The cardholder's information was entered
            manually into a POS terminal.

            - CONTACTLESS - The payment was made by tapping a card on a POS
            terminal.

            - CHIP_ENTRY - The payment card was inserted into a card reader.
          enum:
            - UNKNOWN
            - SWIPED
            - MANUAL_KEY_ENTRY
            - CONTACTLESS
            - CHIP_ENTRY
          nullable: true
        masked_account_number:
          type: string
          description: Last four digits of the bank account number.
          nullable: true
        name:
          type: string
          description: The name of the bank account or card owner.
          nullable: true
        payment_type:
          type: string
          description: >-
            The type of `Payment Instrument` used in the transaction (or the
            original payment).
    failure_code:
      type: string
      description: >-
        The code of the failure so the decline can be handled programmatically.
        For more info on how to handle the failure, see [Failure
        Codes](../../../../additional-resources/developers/implementation-and-testing/error-codes/#failure-codes).
      nullable: true
    failure_message:
      type: string
      description: >-
        A human-readable description of why the transaction was declined. This
        will also include a suggestion on how to complete the payment.
      nullable: true
    idempotency_id:
      type: string
      description: >-
        Pass any randomly generated or internal ID to
        [idempotently](/api/section/idempotent-requests) identify `Transfers`,
        `Authorizations`, or refund requests.
      nullable: true
    ip_address_v4:
      type: string
      description: >-
        The card brands require the customer's IP address for online gaming
        clients. Only supports Internet Protocol version 4 (IPv4).
      example: 192.168.1.1
      nullable: true
    ip_address_details:
      type: object
      description: This field returns `null` for all users except `ROLE_PLATFORM` users.
      properties:
        ipv4:
          type: object
          properties:
            estimated_location:
              $ref: '#/components/schemas/address'
            ip:
              $ref: '#/components/schemas/ip_address_v4'
            latitude:
              type: number
              description: Geo-location based on the IP address.
            longitude:
              type: number
              description: Geo-location based on the IP address.
    raw:
      title: Raw
      description: Raw response from the processor.
      anyOf:
        - type: object
          nullable: true
        - type: string
          nullable: true
    source:
      type: string
      example: PIxxxxxxxxxxxxxxxxxx
      description: ID of the `Payment Instrument` where funds get debited.
    application_link:
      type: object
      description: Link to the `Application` the request was made under.
      properties:
        href:
          type: string
          minLength: 1
    merchant_identity:
      type: object
      description: >-
        Link to the `Identity` the `Merchant` was created under and the
        `Transfer` was submitted with.
      properties:
        href:
          type: string
    transfers:
      type: object
      description: Link to the `Transfer` the request was made under.
      properties:
        href:
          type: string
          minLength: 1
    authorization:
      type: object
      title: Authorization
      description: A charge authorization
      properties:
        id:
          type: string
          example: AUxxxxxxxxxxxxxxxxxx
          description: The ID of the `Authorization` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        3ds_redirect_url:
          type: string
          description: >-
            The redirect URL used for 3DS transactions (if supported by the
            processor).
          nullable: true
        additional_buyer_charges:
          description: >
            Details about any [Buyer
            Charges](../../../../guides/online-payments/payment-features/buyer-charges)
            included in the `Transfer`. The buyer charges are mutually
            exclusive.
          allOf:
            - $ref: '#/components/schemas/additional_buyer_charges'
        additional_healthcare_data:
          $ref: '#/components/schemas/additional_healthcare_data'
        additional_purchase_data:
          $ref: '#/components/schemas/additional_purchase_data'
        address_verification:
          type: string
          description: Details the results of the Address Verification checks.
          nullable: true
        amount:
          $ref: '#/components/schemas/amount'
        amount_requested:
          type: integer
          description: >-
            When `default_partial_authorization_enabled` is set to **true**,
            `amount_requested` indicates the amount the cardholder attempted to
            authorize.
        application:
          type: string
          description: >-
            The ID of the `Application` resource the `Authorization` was created
            under.
        card_present_details:
          $ref: '#/components/schemas/card_present_details'
        currency:
          $ref: '#/components/schemas/currency'
        device:
          type: string
          example: DVxxxxxxxxxxxxxxxxxx
          description: The ID of the activated device.
          nullable: true
        expires_at:
          type: string
          description: '`Authorization` expiration time.'
          format: date-time
        failure_code:
          $ref: '#/components/schemas/failure_code'
        failure_message:
          $ref: '#/components/schemas/failure_message'
        idempotency_id:
          $ref: '#/components/schemas/idempotency_id'
        ip_address_details:
          $ref: '#/components/schemas/ip_address_details'
        is_void:
          type: boolean
          description: Whether the `Authorization` has been voided.
        merchant:
          type: string
          example: MUxxxxxxxxxxxxxxxxxxxxxx
          description: >-
            The ID of the `Merchant` resource the `Authorization` was created
            under.
        merchant_identity:
          type: string
          example: IDxxxxxxxxxxxxxxxxxxxxxx
          description: >-
            The ID of the `Identity` resource used by the `Merchant` the
            `Authorization` was processed under.
        messages:
          type: array
          description: >-
            Message field that provides additional details. This field is
            typically **null**.
          nullable: true
          items:
            type: string
        raw:
          $ref: '#/components/schemas/raw'
        receipt_last_printed_at:
          type: string
          format: date-time
          description: Timestamp when the receipt was last printed.
          nullable: true
        security_code_verification:
          type: string
          description: Details the results of the Security Code Verification che
          nullable: true
        source:
          $ref: '#/components/schemas/source'
        state:
          type: string
          enum:
            - CANCELED
            - PENDING
            - FAILED
            - SUCCEEDED
            - UNKNOWN
          description: The state of the `Authorization`.
        supplemental_fee:
          type: string
          description: >-
            Amount in cents for which an additional fee will be created in
            addition to any fees created from the assigned fee profile.
          nullable: true
        tags:
          $ref: '#/components/schemas/tags'
        trace_id:
          type: string
          description: >-
            Trace ID of the `Authorization`. The processor sends back the
            `trace_id` so you can track the authorization end-to-end.
        transfer:
          type: string
          example: TRxxxxxxxxxxxxxxxxxx
          description: >-
            The ID of the `transfer` resource that gets created when the
            `Authorization` moves to **SUCCEEDED**.
          nullable: true
        void_state:
          type: string
          description: Details if the `Authorization` has been voided.
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
            application:
              $ref: '#/components/schemas/application_link'
            device:
              type: object
              description: Link to the `Device` the request was made under.
              properties:
                href:
                  type: string
            merchant_identity:
              $ref: '#/components/schemas/merchant_identity'
            transfers:
              $ref: '#/components/schemas/transfers'
    createAuthorizationMinimalFields:
      title: Authorization - Minimal Fields
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        merchant:
          type: string
          description: The ID of the `Merchant` that the `Authorization` was created under.
        source:
          $ref: '#/components/schemas/source'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - amount
        - currency
        - merchant
        - source
    3d_secure_authentication:
      type: object
      nullable: true
      properties:
        cardholder_authentication:
          type: string
          description: >-
            Provides evidence that the cardholder authentication occurred or
            that the merchant attempted authentication. This is unique for each
            authentication transaction and is sometimes referred to as the
            cardholder authentication verification value (CAVV).
        electronic_commerce_indicator:
          type: string
          description: >-
            - **AUTHENTICATED**: Approved by 3D Secure Vendor.

            - **ATTEMPTED**: Issuer or cardholder does not support 3D Secure.

            - **NON_AUTHENTICATED**: Did not pass in 3D Secure Data or passed in
            incorrect data when attempting 3D Secure.
        transaction_id:
          type: string
          maxLength: 36
          description: Unique identifier for the 3D Secure transaction.
      required:
        - cardholder_authentication
        - electronic_commerce_indicator
        - transaction_id
    fraud_session_id:
      type: string
      description: >-
        The [session
        ID](../../../../guides/online-payments/fraud-and-risk/fraud-detection#step-3-get-the-session-id)
        you want to review for fraud. For more info, see [Fraud
        Detection](/guides/online-payments/fraud-and-risk/fraud-detection).
    requested_delivery_methods:
      type: array
      description: An array of delivery methods used to send the receipt.
      items:
        type: object
        description: An individual delivery method.
        required:
          - type
          - destinations
        properties:
          type:
            type: string
            description: The type of delivery method used to send the receipt.
            enum:
              - EMAIL
              - SMS
              - PRINT
          destinations:
            type: array
            description: A list of destinations to send the receipt.
            items:
              type: string
              description: A destination to send the receipt.
    amount_breakdown:
      type: object
      description: The individual charges/fees that add up to the total amount.
      properties:
        subtotal_amount:
          type: integer
          description: >-
            The subtotal amount before any taxes, shipping, or additional
            charges are applied.
        shipping_amount:
          type: integer
          description: The amount charged for shipping the items in the order.
        estimated_tax_amount:
          type: integer
          description: The estimated amount of tax applied to the order.
        additional_buyer_charges:
          $ref: '#/components/schemas/additional_buyer_charges'
        discount_amount:
          type: integer
          description: A reduction applied to the total amount.
        tip_amount:
          type: integer
          description: The tip amount included in the order total.
    items:
      type: array
      default: []
      description: An itemized list of products/services.
      items:
        type: object
        properties:
          description:
            type: string
            description: A item description.
          image_details:
            type: object
            description: Product/service image locations.
            properties:
              primary_image_url:
                type: string
                description: The location of a item image.
              alternative_image_urls:
                type: array
                description: >-
                  The locations of backup images if there is an issue with the
                  primary image.
                items:
                  type: string
          name:
            type: string
            description: The item name.
          price_details:
            type: object
            description: Additional details about the price.
            properties:
              sale_amount:
                type: integer
                description: >-
                  The on-sale price of the item if it is different from the
                  `regular_amount`.
              currency:
                $ref: '#/components/schemas/currency'
              price_type:
                type: string
                description: >-
                  Whether the price is on-sale (`PROMOTIONAL`) or the normal
                  price (`REGULAR`).
                enum:
                  - PROMOTIONAL
                  - REGULAR
              regular_amount:
                type: integer
                description: >-
                  The standard price of the item without any adjustments applied
                  (e.g. discounts, taxes, sales).
              amount_excluding_sales_tax:
                type: integer
                description: The amount excluding sales tax.
              item_discount_amount:
                type: integer
                description: The item discount.
          quantity:
            type: integer
            description: The item quantity.
    additional_details_receipt:
      type: array
      description: >-
        An array of key-value pairs for including any extra metadata or custom
        information related to the receipt. Each entry must contain a `name` and
        a corresponding `value`. **Currently these fields will only be used for
        receipts via devices.**
      items:
        type: object
        properties:
          name:
            type: string
            maxLength: 25
            description: >-
              The label or title for the additional detail being provided. This
              should be a short, human-readable identifier such as "Invoice
              Number", "VIN", "Service Date", or "Technician".
          value:
            type: string
            maxLength: 25
            description: >-
              The corresponding value for the detail specified in name. This can
              be any string that provides relevant context or information to
              appear on the receipt, such as an actual invoice number, vehicle
              identification number, or date.
    statement_descriptor:
      type: string
      maxLength: 22
      nullable: true
      description: >-
        The description of the `Merchant` that appears on the buyer's bank or
        card statement.
    createAuthorization:
      title: Authorization - All Fields
      type: object
      properties:
        3d_secure_authentication:
          description: >-
            The 3D secure information required to create a 3D secure
            `Authorization.`
          allOf:
            - $ref: '#/components/schemas/3d_secure_authentication'
        additional_buyer_charges:
          description: >
            Details about any [Buyer
            Charges](../../../../guides/online-payments/payment-features/buyer-charges)
            included in the `Authorization`. The buyer charges are mutually
            exclusive.
          allOf:
            - $ref: '#/components/schemas/additional_buyer_charges'
        additional_healthcare_data:
          description: >
            Object detailing any additional healthcare amounts included in the
            `Authorization`. Only non-healthcare merchant category codes (MCCs)
            are required to pass in additional healthcare data and have the
            necessary SIGIS certification.
          allOf:
            - $ref: '#/components/schemas/additional_healthcare_data'
        additional_purchase_data:
          $ref: '#/components/schemas/additional_purchase_data'
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        device:
          type: string
          description: The ID of the `Device` that the `Authorization` was created under.
        fraud_session_id:
          $ref: '#/components/schemas/fraud_session_id'
        idempotency_id:
          $ref: '#/components/schemas/idempotency_id'
        ip_address_v4:
          $ref: '#/components/schemas/ip_address_v4'
        merchant:
          type: string
          description: The ID of the `Merchant` that the `Authorization` was created under.
        operation_key:
          type: string
          description: Details the operation that's performed in the authorization.
          enum:
            - AUTHORIZATION
            - CARD_PRESENT_AUTHORIZATION
        partial_authorization:
          type: boolean
          description: >-
            - Set to **true** if you want to enable partial authorizations for a
            specific transaction. 

            - If `partial_authorization` is enabled for an individual
            transaction, the `Merchant` value for
            `default_partial_authorization_enabled` is disregarded.

            - Partial authorizations enable you to collect a portion of the
            amount if the cardholder does not have the funds to cover the entire
            amount.
        receipt_options:
          type: object
          description: >-
            If provided the information will be used to generate a receipt if
            transaction is successful.
          nullable: true
          properties:
            requested_delivery_methods:
              $ref: '#/components/schemas/requested_delivery_methods'
            amount_breakdown:
              $ref: '#/components/schemas/amount_breakdown'
            items:
              $ref: '#/components/schemas/items'
            additional_details:
              $ref: '#/components/schemas/additional_details_receipt'
        security_code:
          type: string
          description: >-
            The 3-4 digit security code for the card (i.e. CVV code). Include
            the CVV code of the card to include [Card Verification
            Checks](/guides/online-payments/fraud-and-risk/risk-rules-card-checks)
            with the created `Authorization`.
        source:
          $ref: '#/components/schemas/source'
        statement_descriptor:
          $ref: '#/components/schemas/statement_descriptor'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - amount
        - currency
        - merchant
        - source
    createAuthorizationCanada:
      title: Authorization - Canada
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    createAuthorization3DSecure:
      title: Authorization - 3D Secure
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    createAuthorizationBuyerCharges:
      title: Authorization - Buyer Charges
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    createAuthorizationCardPresent:
      title: Authorization - Card Present
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        device:
          type: string
          description: The ID of the `Device` that the `Authorization` was created under.
        operation_key:
          type: string
          description: Details the operation that's performed in the authorization.
          enum:
            - AUTHORIZATION
            - CARD_PRESENT_AUTHORIZATION
        receipt_options:
          type: object
          description: >-
            If provided the information will be used to generate a receipt if
            transaction is successful.
          nullable: true
          properties:
            requested_delivery_methods:
              $ref: '#/components/schemas/requested_delivery_methods'
            amount_breakdown:
              $ref: '#/components/schemas/amount_breakdown'
            items:
              $ref: '#/components/schemas/items'
            additional_details:
              $ref: '#/components/schemas/additional_details_receipt'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - amount
        - currency
        - device
        - operation_key
    createAuthorizationCVV:
      title: Authorization - Authorization with CVV
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    createAuthorizationFraudDetection:
      title: Authorization - Fraud Detection
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    createAuthorizationGaming:
      title: Authorization - Gaming
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    createAuthorizationHSAorFSACard:
      title: Authorization - HSA or FSA Card for Non-Healthcare MCC
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    createAuthorizationLevel2Processing:
      title: Authorization - Level 2 Processing
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    createAuthorizationLevel3Processing:
      title: Authorization - Level 3 Processing
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    createAuthorizationPartialAuthorization:
      title: Authorization - Partial Authorization
      allOf:
        - $ref: '#/components/schemas/createAuthorization'
    capture_amount:
      type: integer
      format: int64
      description: >-
        The amount of the  `Authorization`  you would like to capture in cents.
        Must be less than or equal to the `amount` of the `Authorization`.
    split_transfers:
      type: array
      nullable: true
      description: >
        An array used to detail how funds from the `Transfer` will split and the
        amount `Merchants` receive.


        Rules:

        - The combined `amounts` under `split_transfers` must be equal to the
        `amount` submitted in the parent `Transfer.`

        - Merchants can be based in the United States or Canada.

        - The amount type must be `FIXED`.


        For more information, see:

        - [Split
        Transactions](../../../../guides/online-payments/payment-features/split-transactions).
      items:
        type: object
        nullable: true
        properties:
          merchant:
            type: string
            description: >-
              - The ID of the `Merchant` that will receive the specified
              `amount` under the `split_transfers` object.

              - In Split Transactions, the merchants specified in the
              `split_transfers` object are the ancillary merchants.
            nullable: false
          amount:
            type: integer
            format: int64
            description: >-
              - The amount of funds that get split and paid out to the specified
              `Merchant`.

              - Must be less than or equal to the `amount` of the `Transfer.`
            nullable: false
          fee:
            type: integer
            description: >
              - A processing fee is deducted when the `Merchant` receives their
              payout, specified in cents.

              - Must be less than or equal to the total amount being split for
              the designated `Merchant`. 

              - By default, this fee is set to `0`.
          tags:
            $ref: '#/components/schemas/tags'
    captureAuthorization:
      title: Capture Authorization
      type: object
      properties:
        capture_amount:
          $ref: '#/components/schemas/capture_amount'
        fee:
          type: integer
          format: int64
          description: >-
            The minimum amount of the `Authorization` you'd like to collect as
            your fee in cents. Defaults to zero (must be less than or equal to
            the `amount`).

            - If the fees applied by the 'Fee Profile' are ***higher*** than the
            value passed in 'fee', 'fee' will not be applied and have no effect.

            - If the fees applied by the 'Fee Profile' are ***lower*** than the
            value passed in 'fee', an additional fee is be applied, in addition
            to the fees generated by the `Fee Profile`.

            - The additional fee is equal to the difference between the value
            passed in 'fee' and the fees generated by the `Fee Profile`.
        split_transfers:
          description: >-
            - An array used to detail how funds for the created `Transfer` will
            split and the amount `Merchants` receive.

            - The combined `amounts` under `split_transfers` must be equal to or
            less than the `amount` submitted in the `Authorization`.

            - For more information, see [Split
            Transactions](../../../../guides/online-payments/payment-features/split-transactions).
          allOf:
            - $ref: '#/components/schemas/split_transfers'
      required:
        - capture_amount
    captureAuthorizationCardPresent:
      title: Capture Card Present Authorization
      type: object
      properties:
        capture_amount:
          $ref: '#/components/schemas/capture_amount'
      required:
        - capture_amount
    captureAuthorizationSplitTransfers:
      title: Capture Authorization with Split Transfers
      type: object
      properties:
        capture_amount:
          $ref: '#/components/schemas/capture_amount'
        split_transfers:
          description: >-
            - An array used to detail how funds for the created `Transfer` will
            split and the amount `Merchants` receive.

            - The combined `amounts` under `split_transfers` must be equal to or
            less than the `amount` submitted in the `Authorization`.

            - For more information, see [Split
            Transactions](../../../../guides/online-payments/payment-features/split-transactions).
          allOf:
            - $ref: '#/components/schemas/split_transfers'
      required:
        - capture_amount
    voidAuthorization:
      title: Void an Authorization
      type: object
      properties:
        void_me:
          type: boolean
          description: Set to **True** to void the `Authorization`.
    device_configuration:
      type: object
      title: DeviceConfigDetails
      description: >-
        Information used to configure how the `Device` handles transaction
        flows.
      properties:
        allow_debit:
          type: boolean
          description: >
            Enable processing of transactions through Debit rails. If set to
            `false`, Debit card transactions will instead be processed through
            Credit rails.
          default: true
        allow_standalone_authorizations:
          type: boolean
          description: >-
            Sets whether the device allows initialization authorizations on its
            interface.`FINIX_V1` and `DUMMY_V1` only.
          default: false
        allow_standalone_refunds:
          type: boolean
          description: >-
            Sets whether the device allows initialization refunds on its
            interface. `FINIX_V1` and `DUMMY_V1` only.
          default: false
        allow_standalone_sales:
          type: boolean
          description: >-
            Sets whether the device allows initialization sales on its
            interface.
          default: false
        bypass_device_on_capture:
          type: boolean
          description: >
            Sets whether or not the device will be used to capture transactions.
            This field should be set to `true` unless there are special
            circumstances.
          nullable: true
          default: false
        check_for_duplicate_transactions:
          type: boolean
          description: >-
            Sets if the device will check for duplicate transactions.
            `DATACAP_V1` only.
        display_tip_on_receipt:
          type: boolean
          description: >-
            Sets whether the device will display the blank tip amount on the
            receipt for authorizations to be later captured. `FINIX_V1` and
            `DUMMY_V1` only.
          default: false
        idle_image_file_id:
          type: string
          description: >-
            The ID of the file to be displayed on the device when it is idle.
            Passing a value of `null` resets the device's idle image to the
            default.
          nullable: true
        idle_message:
          type: string
          description: >-
            Sets the idle message text on the terminal. This is what will be
            presented on the welcome screen. `FINIX_V1` and `DUMMY_V1` only.
          nullable: true
        prompt_amount_confirmation:
          type: boolean
          description: >-
            Sets if the cardholder needs to confirm the amount they'll pay.
            `DATACAP_V1` only.
          default: true
        prompt_for_signature:
          type: string
          description: >
            Determines when the terminal prompts for an e-signature.


            - `ALWAYS`: The terminal will always request an e-signature.  

            - `NEVER`: The terminal will never request an e-signature.  

            - `ON_NETWORK_RECOMMENDATION`: The terminal follows card network
            recommendations on whether to prompt for a signature.  

            - `ON_THRESHOLD_AMOUNT`: The terminal requests an e-signature only
            when the transaction amount is greater than or equal to
            `signature_threshold_amount`.  
          enum:
            - ALWAYS
            - NEVER
            - ON_NETWORK_RECOMMENDATION
            - ON_THRESHOLD_AMOUNT
        prompt_manual_entry:
          type: boolean
          description: >-
            Sets if the device allows for manual entry as a card input method.
            `DATACAP_V1` and `FINIX_V1` only. On `DATACAP_V1` if this is set to
            true manual entry will be the default entry option.
          default: false
        prompt_receipt_confirmation:
          type: boolean
          description: >-
            Sets whether or not the device presents a screen prompting the buyer
            to print receipt at the end of the transaction flow. `FINIX_V1` and
            `DUMMY_V1` only.
          default: true
        prompt_tip_on_screen:
          type: boolean
          description: >-
            Sets whether the device will display the suggested tipping screen.
            `FINIX_V1` and `DUMMY_V1` only.
          default: false
        signature_threshold_amount:
          description: >-
            The transaction amount at which the terminal prompts for an
            e-signature.
        surcharge_basis_points:
          type: integer
          description: >
            Represents the transaction amount that a `Merchant` charges the
            buyer when creating a `Transfer` or an `Authorization`. The value
            cannot exceed `300` (i.e., 3%). For devices on Standalone Mode, the
            Finix Payment Application on the terminal will calculate and send a
            `Transfer` or an `Authorization` request with the surcharge added.
            Customers integrated directly into Finix API must contact Support to
            incorporate surcharging appropriately into their integration. 
          default: 0
          maximum: 300
        tipping_details:
          type: object
          description: >-
            An object that sets the configurations for the tipping page if it
            appears. `FINIX_V1` and `DUMMY_V1` only.
          properties:
            allow_custom_tip:
              type: boolean
              description: >-
                Allows the buyer to set a custom tip. `FINIX_V1` and `DUMMY_V1`
                only.
              default: true
            fixed_options:
              type: array
              description: >-
                Sets the fixed amount that will be displayed on the terminal.
                Defaults to `[100, 150, 200]`. Must be three integer values that
                represent cent values. `FINIX_V1` and `DUMMY_V1` only.
            percent_options:
              type: array
              description: >-
                Sets the percentages that will be displayed on the terminal.
                Defaults to `[18, 20, 22]`. Must be three integer values that
                represent percentages. `FINIX_V1` and `DUMMY_V1` only.
            percent_tipping_threshold:
              type: integer
              description: >-
                The inclusive value at which the terminal will present a percent
                based prompt instead of a fixed value prompt. Defaults to
                `false`. `FINIX_V1` and `DUMMY_V1` only.
    device:
      title: Device
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        android_version:
          type: string
          description: The Android version installed on the `Device`.
        configuration:
          $ref: '#/components/schemas/device_configuration'
        description:
          type: string
          description: Additional information about device (e.g. self serving terminal).
          nullable: true
        enabled:
          type: boolean
          description: Whether the `Device` is enabled. `false` indicates disabled.
        firmware_version:
          type: string
          description: The current version of the device's firmware.
        idle_message:
          type: string
          description: >-
            Sets the idle message text on the terminal. This is what will be
            presented on the welcome screen. `FINIX_V1` and `DUMMY_V1` only.
          nullable: true
        idle_image_file_id:
          type: string
          description: >-
            The ID of the file to be displayed on the device when it is idle.
            Passing a value of `null` resets the device's idle image to the
            default.
          nullable: true
        merchant:
          type: string
          example: MUxxxxxxxxxxxxxxxxxx
          description: ID of the `Merchant` resource.
        model:
          type: string
          description: The model type of the `Device`.
          enum:
            - PAX_A800
            - PAX_A920PRO
            - D135
        name:
          type: string
          description: The display name of the `Device` used for filtering purposes.
        payment_app_version:
          type: string
          description: The device’s current app version.
        prompt_signature:
          type: string
          description: When to prompt for a signature.
          enum:
            - ALWAYS
        serial_number:
          type: string
          description: >-
            The serial_number is a unique identifier for the `Device`, located
            on the back and typically composed of ~16 digits. Ensure the serial
            number is set before activating the `Device`, though it can also be
            added later using a PUT request.
          nullable: true
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            authorizations:
              type: object
              properties:
                href:
                  type: string
            merchant:
              type: object
              description: Link to the `Merhcant` resource that was used in the request.
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
            transfers:
              type: object
              properties:
                href:
                  type: string
    rule:
      type: object
      description: |
        A rule that sets limits on transactions.
      properties:
        count_limit:
          type: integer
          description: A limit on the number of transactions.
        volume_limit:
          type: integer
          description: A limit on the volume of transactions.
        enabled:
          type: boolean
          description: Whether the rule is enabled.
        day:
          type: string
          description: >
            The day of the week the rule applies to. For DAILY rules, only `ALL`
            is supported (i.e., the rule applies to all days).
          enum:
            - ALL
      required:
        - count_limit
        - enabled
        - volume_limit
    daily_rule:
      allOf:
        - $ref: '#/components/schemas/rule'
        - type: object
          description: >
            For DAILY rules, only a single rule is allowed, and it must apply to
            `ALL` days.
          properties:
            day:
              type: string
              description: >-
                The day of the week the rule resets. At present, only `ALL` is
                supported (i.e., for a given rule, you must set the `day`
                property to `ALL`).
              enum:
                - ALL
    daily_rule_configuration:
      title: Daily Rule Configuration
      description: Configuration settings for a DAILY rule.
      type: object
      properties:
        type:
          type: string
          description: >
            The type of rule configuration. `TIME_RANGE` rules reset based on a
            time frame.
          enum:
            - TIME_RANGE
          example: TIME_RANGE
        currency:
          $ref: '#/components/schemas/currency'
        time_frame:
          type: string
          enum:
            - DAILY
          description: |
            How often the rule resets. For this schema, always `DAILY`.
          example: DAILY
        start_time:
          type: integer
          description: >
            The time at which the rule resets. Accepts a value between `0` to
            `24`.
          example: 11
        time_zone:
          type: string
          description: The time zone used to determine when the rule resets.
        rules:
          type: array
          description: A list of rules for DAILY time frame.
          items:
            $ref: '#/components/schemas/daily_rule'
      required:
        - type
        - currency
        - time_frame
        - start_time
        - time_zone
        - rules
    monthly_rule_configuration:
      title: Monthly Rule Configuration
      description: Configuration settings for a MONTHLY rule.
      type: object
      properties:
        type:
          type: string
          description: >
            The type of rule configuration. `TIME_RANGE` rules reset based on a
            time frame.
          enum:
            - TIME_RANGE
          example: TIME_RANGE
        currency:
          $ref: '#/components/schemas/currency'
        time_frame:
          type: string
          enum:
            - MONTHLY
          description: |
            How often the rule resets. For this schema, always `MONTHLY`.
          example: MONTHLY
        start_time:
          type: integer
          description: >
            The time at which the rule resets. Accepts a value between `0` to
            `24`.
          example: 11
        time_zone:
          type: string
          description: The time zone used to determine when the rule resets.
        start_date:
          type: integer
          description: The day of the month that the rule resets.
          example: 15
        rules:
          type: array
          description: A list of rules for MONTHLY time frame.
          items:
            $ref: '#/components/schemas/rule'
      required:
        - type
        - currency
        - time_frame
        - start_time
        - time_zone
        - start_date
        - rules
    maximum_transaction_amount:
      title: Maximum Transaction Amount
      type: object
      description: >
        An object that contains settings for volume limits on individual
        transactions. This is a GLOBAL rule type that applies universally
        without time-based resets.
      properties:
        type:
          type: string
          description: |
            The type of rule configuration. For this schema, always `GLOBAL`.
          enum:
            - GLOBAL
          example: GLOBAL
        currency:
          $ref: '#/components/schemas/currency'
        max_transaction_amount:
          type: integer
          description: A volume limit for every transaction.
          example: 5000001
      required:
        - type
        - currency
        - max_transaction_amount
    recipient_sender_rule_details:
      type: object
      description: A container for rule configurations.
      properties:
        ach_rules:
          type: array
          title: ACH Rule Configurations
          description: >-
            List of configurations for ACH rules. Each rule can be a DAILY
            TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.
          items:
            oneOf:
              - $ref: '#/components/schemas/daily_rule_configuration'
              - $ref: '#/components/schemas/monthly_rule_configuration'
              - $ref: '#/components/schemas/maximum_transaction_amount'
        card_rules:
          type: array
          title: Card Rule Configurations
          description: >-
            List of configurations for card rules. Each rule can be a DAILY
            TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.
          items:
            oneOf:
              - $ref: '#/components/schemas/daily_rule_configuration'
              - $ref: '#/components/schemas/monthly_rule_configuration'
              - $ref: '#/components/schemas/maximum_transaction_amount'
        balance_adjustment_rules:
          type: array
          title: Balance Adjustment Rule Configurations
          description: >-
            List of configurations for balance adjustment rules. Each rule can
            be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule.
          items:
            oneOf:
              - $ref: '#/components/schemas/daily_rule_configuration'
              - $ref: '#/components/schemas/monthly_rule_configuration'
              - $ref: '#/components/schemas/maximum_transaction_amount'
    disbursement_rule:
      type: object
      description: >-
        A high-level object containing one or more rules and their
        configurations.
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application_details:
          $ref: '#/components/schemas/recipient_sender_rule_details'
        linked_to:
          type: string
          description: >
            The identifier for the `Application` or `Platform` resource
            associated with the `Disbursement Rule`.
        linked_type:
          type: string
          description: The type of the resource that is specified in the `linked_to` field.
          enum:
            - APPLICATION
            - PLATFORM
        recipient_details:
          $ref: '#/components/schemas/recipient_sender_rule_details'
        sender_details:
          $ref: '#/components/schemas/recipient_sender_rule_details'
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
    velocity:
      type: object
      description: |
        An object that contains the current usage and limits for disbursements.
      properties:
        current_volume:
          type: integer
          description: The current volume of disbursements.
        current_count:
          type: integer
          description: The current count of disbursements.
        volume_limit:
          type: integer
          description: The volume limit for disbursements.
        count_limit:
          type: integer
          description: The count limit for disbursements.
        window_reset:
          type: string
          format: date-time
          description: The date and time when the usage window resets.
    current_usage:
      type: object
      properties:
        ach_velocity:
          type: object
          description: >
            An object that contains the current usage and limits for ACH
            disbursements.
          properties:
            daily_velocity:
              $ref: '#/components/schemas/velocity'
            monthly_velocity:
              $ref: '#/components/schemas/velocity'
        card_velocity:
          type: object
          description: >
            An object that contains the current usage and limits for Card
            disbursements.
          properties:
            daily_velocity:
              $ref: '#/components/schemas/velocity'
            monthly_velocity:
              $ref: '#/components/schemas/velocity'
        balance_adjustment_velocity:
          type: object
          description: >
            An object that contains the current usage and limits for balance
            adjustments.
          properties:
            daily_velocity:
              $ref: '#/components/schemas/velocity'
            monthly_velocity:
              $ref: '#/components/schemas/velocity'
        currency:
          $ref: '#/components/schemas/currency'
        linked_to:
          type: string
          description: >
            The identifier for the `Application` or `Platform` resource
            associated with the `Disbursement Rule`.
        linked_type:
          type: string
          description: The type of the resource that is specified in the `linked_to` field.
          enum:
            - APPLICATION
            - PLATFORM
        type:
          type: string
          description: |
            The `type` will always be `TOTAL`.
          enum:
            - TOTAL
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
    ach_basis_points_fee_limit:
      type: integer
      description: >-
        Maximum ACH basis points fee (in cents) incurred for each individual
        `Transfer`.
      nullable: true
    ach_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of an eCheck (also
        called ACH payments). Calculated as one hundredth of one percent (1
        basis point = .0001 or .01%).
    ach_credit_return_fixed_fee:
      type: integer
      description: >-
        A fixed amount (in cents) that will be charged to the seller for
        receiving an ACH Credit Return.
      nullable: true
    ach_debit_return_fixed_fee:
      type: integer
      description: >-
        A fixed amount (in cents) that will be charged to the seller for
        receiving an ACH Debit Return.
      nullable: true
    ach_fixed_fee:
      type: integer
      description: Fee in cents incurred for each individual `Transfer`.
    ach_notice_of_change_credit_fixed_fee:
      type: integer
      description: >-
        The amount in cents charged as a fixed fee for processing ACH credit
        transactions that result in a Notice of Change (NOC).
      nullable: true
    ach_notice_of_change_debit_fixed_fee:
      type: integer
      description: >-
        Represents the fixed fee in cents for processing ACH debit transactions
        that generate a Notice of Change (NOC).
      nullable: true
    american_express_assessment_basis_points:
      type: integer
      description: Applies to gross American Express card volume.
      nullable: true
    american_express_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each American
        Express Transfer. Calculated as one hundredth of one percent (1 basis
        point = .0001 or .01%).
      nullable: true
    american_express_charge_dues_assessments:
      type: integer
      description: >-
        A fee associated with American Express's assessment of dues or ongoing
        charges for services provided through the American Express payment
        network.
      nullable: true
    american_express_charge_interchange:
      type: integer
      description: >-
        Set to `true` to incur interchange fees for American Express
        `Transfers`.
      nullable: true
    american_express_externally_funded_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each American
        Express externally funded `Transfer`. Calculated as one hundredth of one
        percent (1 basis point = .0001 or .01%).
      nullable: true
    american_express_externally_funded_fixed_fee:
      type: integer
      description: >-
        Fee in cents incurred for each individual American Express externally
        funded `Transfer`.
      nullable: true
    american_express_fixed_fee:
      type: integer
      description: Fee in cents incurred for each individual American Express `Transfer`.
      nullable: true
    ancillary_fixed_fee_primary:
      type: integer
      description: An additional fixed fee that can be charged per `Transfer`.
      nullable: true
    ancillary_fixed_fee_secondary:
      type: integer
      description: >-
        An additional fixed fee that can be charged per `Transfer` if
        `ancillary_fixed_fee_primary` is included.
      nullable: true
    application_id:
      type: string
      minLength: 1
      description: ID of the `Application` the resource was created under.
    basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each card-based
        `Transfer`. Calculated as one hundredth of one percent (1 basis point =
        .0001 or .01%).
    card_cross_border_basis_points:
      type: integer
      description: >-
        Percentage-based fee charged against the full amount of every `Transfer`
        that includes non-US cards. Calculated as one hundredth of one percent
        (1 basis point = .0001 or .01%).
      nullable: true
    charge_dues_assessments:
      type: boolean
      description: >-
        Whether to pass the dues and assessment fees levied by all applicable
        card brands (e.g., American Express, Discover, Visa, Mastercard).
    charge_interchange:
      type: boolean
      description: Set to **True** to incur interchange fees for card-based `Transfers`.
    compliance_forms_overdue_fixed_fee:
      type: integer
      description: Fee in cents charged for an overdue compliance form.
      nullable: true
    diners_club_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each Diners
        `Transfer`. Calculated as one hundredth of one percent (1 basis point =
        .0001 or .01%).
      nullable: true
    diners_club_charge_interchange:
      type: boolean
      description: Set to `true` to incur interchange fees for Diners `Transfers`.
      nullable: true
    diners_club_fixed_fee:
      type: integer
      description: Fee in cents incurred for each individual Diners `Transfer`.
      nullable: true
    discover_assessments_basis_points:
      type: integer
      description: An assessment that applies to gross Discover card transaction volume.
      nullable: true
    discover_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each Discover
        Transfer. Calculated as one hundredth of one percent (1 basis point =
        .0001 or .01%).
      nullable: true
    discover_charge_dues_assessments:
      type: integer
      description: >-
        A fee associated with Discover's assessment of dues or ongoing charges
        for services provided through the Discover payment network.
      nullable: true
    discover_charge_interchange:
      type: integer
      description: Set to `true` to incur interchange fees for Discover `Transfers`.
      nullable: true
    discover_data_usage_fixed_fee:
      type: integer
      description: Applies to all U.S.-based authorization transactions.
      nullable: true
    discover_externally_funded_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each Discover
        externally funded `Transfer`. Calculated as one hundredth of one percent
        (1 basis point = .0001 or .01%).
      nullable: true
    discover_externally_funded_fixed_fee:
      type: integer
      description: >-
        Fee in cents incurred for each individual Discover externally funded
        `Transfer`.
      nullable: true
    discover_fixed_fee:
      type: integer
      description: Fee in cents incurred for each individual Discover `Transfer`.
      nullable: true
    discover_network_authorization_fixed_fee:
      type: integer
      description: >-
        This fee will apply to all Discover network authorizations and will
        replace the previously assessed Data Transmission.
      nullable: true
    dispute_fixed_fee:
      type: integer
      description: Fee applied when a `Dispute` is created or updated to a `PENDING` state.
      nullable: true
    eft_basis_points_fee_limit:
      type: integer
      description: >-
        The maximum percentage-based fee (in cents) incurred for each individual
        `Transfer`.
      nullable: true
    eft_basis_points:
      type: integer
      description: >-
        The percentage-based fee applied to the total amount of an EFT sale.
        Measured in basis points, where 1 basis point equals 0.01% (e.g., 100
        basis points = 1%).
      nullable: true
    eft_credit_return_fixed_fee:
      type: integer
      description: >-
        A fixed fee (in cents) charged to the merchant for processing an EFT
        credit return.
      nullable: true
    eft_debit_return_fixed_fee:
      type: integer
      description: >-
        A fixed fee (in cents) charged to the seller for processing an EFT debit
        return.
      nullable: true
    eft_fixed_fee:
      type: integer
      description: >-
        A flat fee (in cents) incurred for each individual `Transfer` made from
        an EFT sale.
      nullable: true
    externally_funded_basis_points:
      type: integer
      description: >-
        The percentage-based fee applied to the total amount of each externally
        funded `Transfer`. Measured in basis points, where 1 basis point equals
        0.01%.
      nullable: true
    externally_funded_fixed_fee:
      type: integer
      description: >-
        A fixed fee (in cents) incurred for each individual externally funded
        `Transfer`.
      nullable: true
    fixed_fee:
      type: integer
      description: Fee in cents incurred for each individual card-based `Transfer`.
      nullable: true
    gross_monthly_fees_ach_basis_points:
      type: integer
      description: The total amount of ACH (eCheck) basis point fees charged over a month.
      nullable: true
    gross_monthly_fees_ach_fixed_fee:
      type: integer
      description: The total amount of ACH (eCheck) fixed fees charged over a month.
      nullable: true
    gross_monthly_fees_card_basis_points:
      type: integer
      description: The total amount of card basis point fees charged over a month.
      nullable: true
    gross_monthly_fees_card_fixed_fee:
      type: integer
      description: The total amount of card fixed fees charged over a month.
      nullable: true
    gross_monthly_fees_eft_basis_points:
      type: integer
      description: The total amount of EFT basis point fees charged over a month.
      nullable: true
    gross_monthly_fees_eft_fixed_fee:
      type: integer
      description: The total amount of EFT fixed fees charged over a month.
      nullable: true
    interac_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each Interac
        Transfer. Calculated as one hundredth of one percent (1 basis point =
        .0001 or .01%).
      nullable: true
    interac_fixed_fee:
      type: integer
      description: Fee in cents incurred for each individual Interac `Transfer`.
      nullable: true
    jcb_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each JCB
        Transfer. Calculated as one hundredth of one percent (1 basis point =
        .0001 or .01%).
      nullable: true
    jcb_charge_interchange:
      type: integer
      description: Set to `true` to incur interchange fees for JCB `Transfers`.
      nullable: true
    jcb_fixed_fee:
      type: integer
      description: Fee in cents incurred for each individual JCB `Transfer`.
      nullable: true
    mastercard_acquirer_fees_basis_points:
      type: integer
      description: >-
        A fee assessed on a business’s gross MasterCard processing volume. This
        fee varies per acquirer based on MasterCard’s assessed charge as it’s
        distributed across the acquirer’s portfolio of merchants. Generally,
        this fee is a fraction of a basis point. For example, 0.0045%, 0.0075%,
        etc. are examples of a likely fee.
      nullable: true
    mastercard_assessments_over1k_basis_points:
      type: integer
      description: Fee applied to Mastercard credit sale transactions greater than $1,000.
      nullable: true
    mastercard_assessments_under1k_basis_points:
      type: integer
      description: Fee applied to Mastercard transactions less than or equal to $1,000.
      nullable: true
    mastercard_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each MasterCard
        `Transfer`. Calculated as one hundredth of one percent (1 basis point =
        .0001 or .01%).
      nullable: true
    mastercard_charge_dues_assessments:
      type: integer
      description: >-
        A fee associated with MasterCard's assessment of dues or ongoing charges
        for services provided through the MasterCard payment network.
      nullable: true
    mastercard_charge_interchange:
      type: boolean
      description: Set to `true` to incur interchange fees for MasterCard `Transfers`.
      nullable: true
    mastercard_fixed_fee:
      type: integer
      description: Fee in cents incurred for each individual MasterCard `Transfer`.
      nullable: true
    settlement_funding_transfer_ach_basis_points_fee_limit:
      type: integer
      description: >-
        The maximum percentage-based fee (in cents) incurred for each individual
        Settlement Funding Transfer (ACH).
      nullable: true
    settlement_funding_transfer_ach_basis_points:
      type: integer
      description: >-
        A percentage-based fee applied to ACH transfers related to settlement
        funding. Calculated as one hundredth of one percent (1 basis point =
        .0001 or .01%).
      nullable: true
    settlement_funding_transfer_ach_credit_return_fixed_fee:
      type: integer
      description: >-
        A fixed fee (in cents) charged to the platform or seller when receiving
        a credit return related to a Settlement Funding Transfer (ACH).
      nullable: true
    settlement_funding_transfer_ach_debit_return_fixed_fee:
      type: integer
      description: >-
        A fixed fee (in cents) charged to the platform or seller when receiving
        a Debit Return related to a Settlement Funding Transfer (ACH).
      nullable: true
    settlement_funding_transfer_ach_fixed_fee:
      type: integer
      description: >-
        A flat fee (in cents) incurred for each individual Settlement Funding
        Transfer (ACH).
      nullable: true
    settlement_funding_transfer_eft_basis_points_fee_limit:
      type: integer
      description: >-
        The maximum percentage-based fee (in cents) incurred for each individual
        settlement funding `Transfer` made via an EFT.
      nullable: true
    settlement_funding_transfer_eft_basis_points:
      type: integer
      description: >-
        The percentage-based fee applied to the total amount of a settlement
        funding `Transfer` made via an EFT from a Canadian-based bank account.
        Measured in basis points, where 1 basis point equals 0.01% (e.g., 100
        basis points = 1%).
      nullable: true
    settlement_funding_transfer_eft_credit_return_fixed_fee:
      type: integer
      description: >-
        A fixed fee (in cents) charged for processing a Credit Return related to
        a settlement funding `Transfer`. This occurs when funds are returned
        from a Canadian-based bank account back to the seller's account via EFT.
      nullable: true
    settlement_funding_transfer_eft_debit_return_fixed_fee:
      type: integer
      description: >-
        A fixed fee (in cents) charged for processing a Debit Return related to
        a settlement funding `Transfer`. This occurs when funds are returned
        from the seller's account to a Canadian-based bank account via EFT due
        to a payment failure or reversal.
      nullable: true
    settlement_funding_transfer_eft_fixed_fee:
      type: integer
      description: >-
        A flat fee (in cents) incurred for each settlement funding `Transfer`
        made via an EFT from a Canadian-based bank account. This fee is
        independent of the payment amount.
      nullable: true
    settlement_funding_transfer_instant_payout_card_basis_points_fee_limit:
      type: integer
      description: >-
        The maximum percentage-based fee (in cents) incurred for each individual
        settlement funding `Transfer` made as an instant payout to a card.
      nullable: true
    settlement_funding_transfer_instant_payout_card_basis_points:
      type: integer
      description: >-
        The percentage-based fee applied to the total amount of a settlement
        funding `Transfer` made as an instant payout to a card. Measured in
        basis points, where 1 basis point equals 0.01% (e.g., 100 basis points =
        1%).
      nullable: true
    settlement_funding_transfer_instant_payout_card_fixed_fee:
      type: integer
      description: >-
        A flat fee (in cents) incurred for each settlement funding `Transfer`
        made as an instant payout to a card.
      nullable: true
    settlement_funding_transfer_noc_credit_fixed_fee:
      type: integer
      description: >-
        A fixed fee (in cents) charged for processing a Notification of Change
        (NOC) related to a credit transaction in settlement funding transfers.
      nullable: true
    settlement_funding_transfer_noc_debit_fixed_fee:
      type: integer
      description: >-
        A fixed fee (in cents) charged for processing a Notification of Change
        (NOC) related to a debit transaction in settlement funding transfers.
      nullable: true
    settlement_funding_transfer_same_day_ach_fixed_fee:
      type: integer
      description: >-
        A flat fee (in cents) incurred for each settlement funding `Transfer`
        made via same-day ACH.
      nullable: true
    subscription_ach_basis_points:
      type: integer
      description: >-
        The percentage-based fee incurred against the full amount of each ACH
        Direct Debit transaction created from a `Subscription`. Calculated as
        one hundredth of one percent (1 basis point = .0001 or .01%).
      nullable: true
    subscription_ach_basis_points_fee_limit:
      type: integer
      description: >-
        The maximum `subscription_ach_basis_points` fee (in cents) incurred for
        each individual `Transfer` created from a `Subscription`.
      nullable: true
    subscription_ach_fixed_fee:
      type: integer
      description: >-
        The fee in cents incurred for each individual ACH Direct Debit
        transaction created from a `Subscription`.
      nullable: true
    subscription_card_basis_points:
      type: integer
      description: >-
        The percentage-based fee incurred against the full amount of each
        card-based transaction created from a `Subscription`. Calculated as one
        hundredth of one percent (1 basis point = .0001 or .01%).
      nullable: true
    subscription_card_fixed_fee:
      type: integer
      description: >-
        The percentage-based fee incurred against the full amount of each EFT
        transaction created from a `Subscription`. Calculated as one hundredth
        of one percent (1 basis point = .0001 or .01%).
      nullable: true
    subscription_eft_basis_points:
      type: integer
      description: >-
        The percentage-based fee incurred against the full amount of each EFT
        transaction created from a `Subscription`. Calculated as one hundredth
        of one percent (1 basis point = .0001 or .01%).
      nullable: true
    subscription_eft_basis_points_fee_limit:
      type: integer
      description: >-
        The maximum `subscription_eft_basis_points` fee (in cents) incurred for
        each individual `Transfer` created from a `Subscription`.
      nullable: true
    subscription_eft_fixed_fee:
      type: integer
      description: >-
        The fee in cents incurred for each individual EFT transaction created
        from a `Subscription`.
      nullable: true
    visa_acquirer_processing_fixed_fee:
      type: integer
      description: >-
        Applies to all U.S.-based credit card authorizations acquired in the
        U.S., regardless of where the issuer/cardholder is located. If your
        business is based in the U.S., the acquirer processing fee will apply to
        all Visa credit card authorizations.
      nullable: true
    visa_base_II_credit_voucher_fixed_fee:
      type: integer
      description: Applies to all U.S.-based refunds.
      nullable: true
    visa_base_II_system_file_transmission_fixed_fee:
      type: integer
      description: >-
        Applies to all Visa transactions and is charged in addition to other
        transaction-based assessments.
      nullable: true
    visa_basis_points:
      type: integer
      description: >-
        Percentage-based fee incurred against the full amount of each Visa
        `Transfer`. Calculated as one hundredth of one percent (1 basis point =
        .0001 or .01%)
      nullable: true
    visa_charge_dues_assessments:
      type: integer
      description: >-
        A fee associated with Visa's assessment of dues or ongoing charges for
        services provided through the Visa payment network.
      nullable: true
    visa_charge_interchange:
      type: boolean
      description: Set to `true` to incur interchange fees for Visa `Transfers`.
      nullable: true
    visa_credit_voucher_fixed_fee:
      type: integer
      description: Applies to Visa refunds.
      nullable: true
    visa_fixed_fee:
      type: integer
      description: Fee in cents incurred for each individual Visa `Transfer`.
      nullable: true
    visa_kilobyte_access_fixed_fee:
      type: integer
      description: >-
        Charged on each authorization transaction submitted to Visa’s network
        for settlement.
      nullable: true
    fee_profile:
      title: Fee Profile
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        ach_basis_points_fee_limit:
          $ref: '#/components/schemas/ach_basis_points_fee_limit'
        ach_basis_points:
          $ref: '#/components/schemas/ach_basis_points'
        ach_credit_return_fixed_fee:
          $ref: '#/components/schemas/ach_credit_return_fixed_fee'
        ach_debit_return_fixed_fee:
          $ref: '#/components/schemas/ach_debit_return_fixed_fee'
        ach_fixed_fee:
          $ref: '#/components/schemas/ach_fixed_fee'
        ach_notice_of_change_credit_fixed_fee:
          $ref: '#/components/schemas/ach_notice_of_change_credit_fixed_fee'
        ach_notice_of_change_debit_fixed_fee:
          $ref: '#/components/schemas/ach_notice_of_change_debit_fixed_fee'
        american_express_assessment_basis_points:
          $ref: '#/components/schemas/american_express_assessment_basis_points'
        american_express_basis_points:
          $ref: '#/components/schemas/american_express_basis_points'
        american_express_charge_dues_assessments:
          $ref: '#/components/schemas/american_express_charge_dues_assessments'
        american_express_charge_interchange:
          $ref: '#/components/schemas/american_express_charge_interchange'
        american_express_externally_funded_basis_points:
          $ref: '#/components/schemas/american_express_externally_funded_basis_points'
        american_express_externally_funded_fixed_fee:
          $ref: '#/components/schemas/american_express_externally_funded_fixed_fee'
        american_express_fixed_fee:
          $ref: '#/components/schemas/american_express_fixed_fee'
        ancillary_fixed_fee_primary:
          $ref: '#/components/schemas/ancillary_fixed_fee_primary'
        ancillary_fixed_fee_secondary:
          $ref: '#/components/schemas/ancillary_fixed_fee_secondary'
        application:
          $ref: '#/components/schemas/application_id'
        basis_points:
          $ref: '#/components/schemas/basis_points'
        card_cross_border_basis_points:
          $ref: '#/components/schemas/card_cross_border_basis_points'
        card_cross_border_fixed_fee:
          $ref: '#/components/schemas/american_express_fixed_fee'
        charge_dues_assessments:
          $ref: '#/components/schemas/charge_dues_assessments'
        charge_interchange:
          $ref: '#/components/schemas/charge_interchange'
        compliance_forms_overdue_fixed_fee:
          $ref: '#/components/schemas/compliance_forms_overdue_fixed_fee'
        diners_club_basis_points:
          $ref: '#/components/schemas/diners_club_basis_points'
        diners_club_charge_interchange:
          $ref: '#/components/schemas/diners_club_charge_interchange'
        diners_club_fixed_fee:
          $ref: '#/components/schemas/diners_club_fixed_fee'
        discover_assessments_basis_points:
          $ref: '#/components/schemas/discover_assessments_basis_points'
        discover_basis_points:
          $ref: '#/components/schemas/discover_basis_points'
        discover_charge_dues_assessments:
          $ref: '#/components/schemas/discover_charge_dues_assessments'
        discover_charge_interchange:
          $ref: '#/components/schemas/discover_charge_interchange'
        discover_data_usage_fixed_fee:
          $ref: '#/components/schemas/discover_data_usage_fixed_fee'
        discover_externally_funded_basis_points:
          $ref: '#/components/schemas/discover_externally_funded_basis_points'
        discover_externally_funded_fixed_fee:
          $ref: '#/components/schemas/discover_externally_funded_fixed_fee'
        discover_fixed_fee:
          $ref: '#/components/schemas/discover_fixed_fee'
        discover_network_authorization_fixed_fee:
          $ref: '#/components/schemas/discover_network_authorization_fixed_fee'
        dispute_fixed_fee:
          $ref: '#/components/schemas/dispute_fixed_fee'
        dispute_inquiry_fixed_fee:
          $ref: '#/components/schemas/dispute_fixed_fee'
        eft_basis_points_fee_limit:
          $ref: '#/components/schemas/eft_basis_points_fee_limit'
        eft_basis_points:
          $ref: '#/components/schemas/eft_basis_points'
        eft_credit_return_fixed_fee:
          $ref: '#/components/schemas/eft_credit_return_fixed_fee'
        eft_debit_return_fixed_fee:
          $ref: '#/components/schemas/eft_debit_return_fixed_fee'
        eft_fixed_fee:
          $ref: '#/components/schemas/eft_fixed_fee'
        externally_funded_basis_points:
          $ref: '#/components/schemas/externally_funded_basis_points'
        externally_funded_fixed_fee:
          $ref: '#/components/schemas/externally_funded_fixed_fee'
        fixed_fee:
          $ref: '#/components/schemas/fixed_fee'
        gross_monthly_fees_ach_basis_points:
          $ref: '#/components/schemas/gross_monthly_fees_ach_basis_points'
        gross_monthly_fees_ach_fixed_fee:
          $ref: '#/components/schemas/gross_monthly_fees_ach_fixed_fee'
        gross_monthly_fees_card_basis_points:
          $ref: '#/components/schemas/gross_monthly_fees_card_basis_points'
        gross_monthly_fees_card_fixed_fee:
          $ref: '#/components/schemas/gross_monthly_fees_card_fixed_fee'
        gross_monthly_fees_eft_basis_points:
          $ref: '#/components/schemas/gross_monthly_fees_eft_basis_points'
        gross_monthly_fees_eft_fixed_fee:
          $ref: '#/components/schemas/gross_monthly_fees_eft_fixed_fee'
        interac_basis_points:
          $ref: '#/components/schemas/interac_basis_points'
        interac_fixed_fee:
          $ref: '#/components/schemas/interac_fixed_fee'
        jcb_basis_points:
          $ref: '#/components/schemas/jcb_basis_points'
        jcb_charge_interchange:
          $ref: '#/components/schemas/jcb_charge_interchange'
        jcb_fixed_fee:
          $ref: '#/components/schemas/jcb_fixed_fee'
        mastercard_acquirer_fees_basis_points:
          $ref: '#/components/schemas/mastercard_acquirer_fees_basis_points'
        mastercard_assessments_over1k_basis_points:
          $ref: '#/components/schemas/mastercard_assessments_over1k_basis_points'
        mastercard_assessments_under1k_basis_points:
          $ref: '#/components/schemas/mastercard_assessments_under1k_basis_points'
        mastercard_basis_points:
          $ref: '#/components/schemas/mastercard_basis_points'
        mastercard_charge_dues_assessments:
          $ref: '#/components/schemas/mastercard_charge_dues_assessments'
        mastercard_charge_interchange:
          $ref: '#/components/schemas/mastercard_charge_interchange'
        mastercard_fixed_fee:
          $ref: '#/components/schemas/mastercard_fixed_fee'
        qualified_tiers:
          type: object
          description: The top of the qualified tier tree.
          nullable: true
        rounding_mode:
          type: string
          description: >-
            Set to `AGGREGATE` to round after the settlement calculation. By
            default, rounding happens before the sum of the settlement
            calculation (i.e., round each fee transfer).
          enum:
            - TRANSACTION
            - AGGREGATE
        settlement_funding_transfer_ach_basis_points_fee_limit:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_ach_basis_points_fee_limit
        settlement_funding_transfer_ach_basis_points:
          $ref: '#/components/schemas/settlement_funding_transfer_ach_basis_points'
        settlement_funding_transfer_ach_credit_return_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_ach_credit_return_fixed_fee
        settlement_funding_transfer_ach_debit_return_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_ach_debit_return_fixed_fee
        settlement_funding_transfer_ach_fixed_fee:
          $ref: '#/components/schemas/settlement_funding_transfer_ach_fixed_fee'
        settlement_funding_transfer_eft_basis_points_fee_limit:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_eft_basis_points_fee_limit
        settlement_funding_transfer_eft_basis_points:
          $ref: '#/components/schemas/settlement_funding_transfer_eft_basis_points'
        settlement_funding_transfer_eft_credit_return_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_eft_credit_return_fixed_fee
        settlement_funding_transfer_eft_debit_return_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_eft_debit_return_fixed_fee
        settlement_funding_transfer_eft_fixed_fee:
          $ref: '#/components/schemas/settlement_funding_transfer_eft_fixed_fee'
        settlement_funding_transfer_instant_payout_card_basis_points_fee_limit:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_instant_payout_card_basis_points_fee_limit
        settlement_funding_transfer_instant_payout_card_basis_points:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_instant_payout_card_basis_points
        settlement_funding_transfer_instant_payout_card_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_instant_payout_card_fixed_fee
        settlement_funding_transfer_noc_credit_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_noc_credit_fixed_fee
        settlement_funding_transfer_noc_debit_fixed_fee:
          $ref: '#/components/schemas/settlement_funding_transfer_noc_debit_fixed_fee'
        settlement_funding_transfer_same_day_ach_basis_points_fee_limit:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_ach_basis_points_fee_limit
        settlement_funding_transfer_same_day_ach_basis_points:
          $ref: '#/components/schemas/settlement_funding_transfer_ach_basis_points'
        settlement_funding_transfer_same_day_ach_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_same_day_ach_fixed_fee
        subscription_ach_basis_points:
          $ref: '#/components/schemas/subscription_ach_basis_points'
        subscription_ach_basis_points_fee_limit:
          $ref: '#/components/schemas/subscription_ach_basis_points_fee_limit'
        subscription_ach_fixed_fee:
          $ref: '#/components/schemas/subscription_ach_fixed_fee'
        subscription_card_basis_points:
          $ref: '#/components/schemas/subscription_card_basis_points'
        subscription_card_fixed_fee:
          $ref: '#/components/schemas/subscription_card_fixed_fee'
        subscription_eft_basis_points:
          $ref: '#/components/schemas/subscription_eft_basis_points'
        subscription_eft_basis_points_fee_limit:
          $ref: '#/components/schemas/subscription_eft_basis_points_fee_limit'
        subscription_eft_fixed_fee:
          $ref: '#/components/schemas/subscription_eft_fixed_fee'
        visa_acquirer_processing_fixed_fee:
          $ref: '#/components/schemas/visa_acquirer_processing_fixed_fee'
        visa_assessments_basis_points:
          $ref: '#/components/schemas/visa_acquirer_processing_fixed_fee'
        visa_base_II_credit_voucher_fixed_fee:
          $ref: '#/components/schemas/visa_base_II_credit_voucher_fixed_fee'
        visa_base_II_system_file_transmission_fixed_fee:
          $ref: '#/components/schemas/visa_base_II_system_file_transmission_fixed_fee'
        visa_basis_points:
          $ref: '#/components/schemas/visa_basis_points'
        visa_charge_dues_assessments:
          $ref: '#/components/schemas/visa_charge_dues_assessments'
        visa_charge_interchange:
          $ref: '#/components/schemas/visa_charge_interchange'
        visa_credit_voucher_fixed_fee:
          $ref: '#/components/schemas/visa_credit_voucher_fixed_fee'
        visa_fixed_fee:
          $ref: '#/components/schemas/visa_fixed_fee'
        visa_kilobyte_access_fixed_fee:
          $ref: '#/components/schemas/visa_kilobyte_access_fixed_fee'
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
                  minLength: 1
            application:
              type: object
              description: Link to the `Application` the request was made under.
              properties:
                href:
                  type: string
                  minLength: 1
    createFeeProfile:
      type: object
      properties:
        ach_basis_points_fee_limit:
          $ref: '#/components/schemas/ach_basis_points_fee_limit'
        ach_basis_points:
          $ref: '#/components/schemas/ach_basis_points'
        ach_credit_return_fixed_fee:
          $ref: '#/components/schemas/ach_credit_return_fixed_fee'
        ach_debit_return_fixed_fee:
          $ref: '#/components/schemas/ach_debit_return_fixed_fee'
        ach_fixed_fee:
          $ref: '#/components/schemas/ach_fixed_fee'
        ach_notice_of_change_credit_fixed_fee:
          $ref: '#/components/schemas/ach_notice_of_change_credit_fixed_fee'
        ach_notice_of_change_debit_fixed_fee:
          $ref: '#/components/schemas/ach_notice_of_change_debit_fixed_fee'
        american_express_assessment_basis_points:
          $ref: '#/components/schemas/american_express_assessment_basis_points'
        american_express_basis_points:
          $ref: '#/components/schemas/american_express_basis_points'
        american_express_charge_dues_assessments:
          $ref: '#/components/schemas/american_express_charge_dues_assessments'
        american_express_charge_interchange:
          $ref: '#/components/schemas/american_express_charge_interchange'
        american_express_externally_funded_basis_points:
          $ref: '#/components/schemas/american_express_externally_funded_basis_points'
        american_express_externally_funded_fixed_fee:
          $ref: '#/components/schemas/american_express_externally_funded_fixed_fee'
        american_express_fixed_fee:
          $ref: '#/components/schemas/american_express_fixed_fee'
        ancillary_fixed_fee_primary:
          $ref: '#/components/schemas/ancillary_fixed_fee_primary'
        ancillary_fixed_fee_secondary:
          $ref: '#/components/schemas/ancillary_fixed_fee_secondary'
        basis_points:
          $ref: '#/components/schemas/basis_points'
        card_cross_border_basis_points:
          $ref: '#/components/schemas/card_cross_border_basis_points'
        card_cross_border_fixed_fee:
          $ref: '#/components/schemas/american_express_fixed_fee'
        charge_dues_assessments:
          $ref: '#/components/schemas/charge_dues_assessments'
        charge_interchange:
          $ref: '#/components/schemas/charge_interchange'
        compliance_forms_overdue_fixed_fee:
          $ref: '#/components/schemas/compliance_forms_overdue_fixed_fee'
        diners_club_basis_points:
          $ref: '#/components/schemas/diners_club_basis_points'
        diners_club_charge_interchange:
          $ref: '#/components/schemas/diners_club_charge_interchange'
        diners_club_fixed_fee:
          $ref: '#/components/schemas/diners_club_fixed_fee'
        discover_assessments_basis_points:
          $ref: '#/components/schemas/discover_assessments_basis_points'
        discover_basis_points:
          $ref: '#/components/schemas/discover_basis_points'
        discover_charge_dues_assessments:
          $ref: '#/components/schemas/discover_charge_dues_assessments'
        discover_charge_interchange:
          $ref: '#/components/schemas/discover_charge_interchange'
        discover_data_usage_fixed_fee:
          $ref: '#/components/schemas/discover_data_usage_fixed_fee'
        discover_externally_funded_basis_points:
          $ref: '#/components/schemas/discover_externally_funded_basis_points'
        discover_externally_funded_fixed_fee:
          $ref: '#/components/schemas/discover_externally_funded_fixed_fee'
        discover_fixed_fee:
          $ref: '#/components/schemas/discover_fixed_fee'
        discover_network_authorization_fixed_fee:
          $ref: '#/components/schemas/discover_network_authorization_fixed_fee'
        eft_basis_points_fee_limit:
          $ref: '#/components/schemas/eft_basis_points_fee_limit'
        eft_basis_points:
          $ref: '#/components/schemas/eft_basis_points'
        eft_credit_return_fixed_fee:
          $ref: '#/components/schemas/eft_credit_return_fixed_fee'
        eft_debit_return_fixed_fee:
          $ref: '#/components/schemas/eft_debit_return_fixed_fee'
        eft_fixed_fee:
          $ref: '#/components/schemas/eft_fixed_fee'
        externally_funded_basis_points:
          $ref: '#/components/schemas/externally_funded_basis_points'
        externally_funded_fixed_fee:
          $ref: '#/components/schemas/externally_funded_fixed_fee'
        fixed_fee:
          $ref: '#/components/schemas/fixed_fee'
        gross_monthly_fees_ach_basis_points:
          $ref: '#/components/schemas/gross_monthly_fees_ach_basis_points'
        gross_monthly_fees_ach_fixed_fee:
          $ref: '#/components/schemas/gross_monthly_fees_ach_fixed_fee'
        gross_monthly_fees_card_basis_points:
          $ref: '#/components/schemas/gross_monthly_fees_card_basis_points'
        gross_monthly_fees_card_fixed_fee:
          $ref: '#/components/schemas/gross_monthly_fees_card_fixed_fee'
        gross_monthly_fees_eft_basis_points:
          $ref: '#/components/schemas/gross_monthly_fees_eft_basis_points'
        gross_monthly_fees_eft_fixed_fee:
          $ref: '#/components/schemas/gross_monthly_fees_eft_fixed_fee'
        interac_basis_points:
          $ref: '#/components/schemas/interac_basis_points'
        interac_fixed_fee:
          $ref: '#/components/schemas/interac_fixed_fee'
        jcb_basis_points:
          $ref: '#/components/schemas/jcb_basis_points'
        jcb_charge_interchange:
          $ref: '#/components/schemas/jcb_charge_interchange'
        jcb_fixed_fee:
          $ref: '#/components/schemas/jcb_fixed_fee'
        mastercard_acquirer_fees_basis_points:
          $ref: '#/components/schemas/mastercard_acquirer_fees_basis_points'
        mastercard_assessments_over1k_basis_points:
          $ref: '#/components/schemas/mastercard_assessments_over1k_basis_points'
        mastercard_assessments_under1k_basis_points:
          $ref: '#/components/schemas/mastercard_assessments_under1k_basis_points'
        mastercard_basis_points:
          $ref: '#/components/schemas/mastercard_basis_points'
        mastercard_charge_dues_assessments:
          $ref: '#/components/schemas/mastercard_charge_dues_assessments'
        mastercard_charge_interchange:
          $ref: '#/components/schemas/mastercard_charge_interchange'
        mastercard_fixed_fee:
          $ref: '#/components/schemas/mastercard_fixed_fee'
        settlement_funding_transfer_ach_basis_points_fee_limit:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_ach_basis_points_fee_limit
        settlement_funding_transfer_ach_basis_points:
          $ref: '#/components/schemas/settlement_funding_transfer_ach_basis_points'
        settlement_funding_transfer_ach_credit_return_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_ach_credit_return_fixed_fee
        settlement_funding_transfer_ach_debit_return_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_ach_debit_return_fixed_fee
        settlement_funding_transfer_ach_fixed_fee:
          $ref: '#/components/schemas/settlement_funding_transfer_ach_fixed_fee'
        settlement_funding_transfer_eft_basis_points_fee_limit:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_eft_basis_points_fee_limit
        settlement_funding_transfer_eft_basis_points:
          $ref: '#/components/schemas/settlement_funding_transfer_eft_basis_points'
        settlement_funding_transfer_eft_credit_return_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_eft_credit_return_fixed_fee
        settlement_funding_transfer_eft_debit_return_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_eft_debit_return_fixed_fee
        settlement_funding_transfer_eft_fixed_fee:
          $ref: '#/components/schemas/settlement_funding_transfer_eft_fixed_fee'
        settlement_funding_transfer_instant_payout_card_basis_points_fee_limit:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_instant_payout_card_basis_points_fee_limit
        settlement_funding_transfer_instant_payout_card_basis_points:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_instant_payout_card_basis_points
        settlement_funding_transfer_instant_payout_card_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_instant_payout_card_fixed_fee
        settlement_funding_transfer_noc_credit_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_noc_credit_fixed_fee
        settlement_funding_transfer_noc_debit_fixed_fee:
          $ref: '#/components/schemas/settlement_funding_transfer_noc_debit_fixed_fee'
        settlement_funding_transfer_same_day_ach_basis_points_fee_limit:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_ach_basis_points_fee_limit
        settlement_funding_transfer_same_day_ach_basis_points:
          $ref: '#/components/schemas/settlement_funding_transfer_ach_basis_points'
        settlement_funding_transfer_same_day_ach_fixed_fee:
          $ref: >-
            #/components/schemas/settlement_funding_transfer_same_day_ach_fixed_fee
        subscription_ach_basis_points:
          $ref: '#/components/schemas/subscription_ach_basis_points'
        subscription_ach_basis_points_fee_limit:
          $ref: '#/components/schemas/subscription_ach_basis_points_fee_limit'
        subscription_ach_fixed_fee:
          $ref: '#/components/schemas/subscription_ach_fixed_fee'
        subscription_card_basis_points:
          $ref: '#/components/schemas/subscription_card_basis_points'
        subscription_card_fixed_fee:
          $ref: '#/components/schemas/subscription_card_fixed_fee'
        subscription_eft_basis_points:
          $ref: '#/components/schemas/subscription_eft_basis_points'
        subscription_eft_basis_points_fee_limit:
          $ref: '#/components/schemas/subscription_eft_basis_points_fee_limit'
        subscription_eft_fixed_fee:
          $ref: '#/components/schemas/subscription_eft_fixed_fee'
        visa_acquirer_processing_fixed_fee:
          $ref: '#/components/schemas/visa_acquirer_processing_fixed_fee'
        visa_assessments_basis_points:
          $ref: '#/components/schemas/visa_acquirer_processing_fixed_fee'
        visa_basis_points:
          $ref: '#/components/schemas/visa_basis_points'
        visa_charge_dues_assessments:
          $ref: '#/components/schemas/visa_charge_dues_assessments'
        visa_charge_interchange:
          $ref: '#/components/schemas/visa_charge_interchange'
        visa_credit_voucher_fixed_fee:
          $ref: '#/components/schemas/visa_credit_voucher_fixed_fee'
        visa_fixed_fee:
          $ref: '#/components/schemas/visa_fixed_fee'
        visa_kilobyte_access_fixed_fee:
          $ref: '#/components/schemas/visa_kilobyte_access_fixed_fee'
    additional_underwriting_data:
      type: object
      description: Additional underwriting data about the user.
      properties:
        annual_ach_volume:
          type: integer
          description: >-
            The approximate annual ACH sales expected to be processed (in cents)
            by this merchant (max 10 characters).
        average_ach_transfer_amount:
          type: integer
          description: >-
            The approximate average ACH sale amount (in cents) for this
            merchant.
        average_card_transfer_amount:
          type: integer
          description: The average credit card sale amount (in cents) for this merchant.
        business_description:
          type: string
          minLength: 1
          description: Description of this merchant's business (max 200 characters).
        card_volume_distribution:
          type: object
          description: >-
            The distribution of the merchant's credit card volume The sum of
            `card_volume_distribution` must be 100.
          nullable: true
          properties:
            card_present_percentage:
              type: integer
              description: >-
                The percentage of the merchant's volume that's card present
                (between 0 and 100).
            ecommerce_percentage:
              type: integer
              description: >-
                The percentage of the merchant's business that is eCommerce
                (between 0 and 100).
            mail_order_telephone_order_percentage:
              type: integer
              description: >-
                The percentage of the merchant's business that is a mail or
                telephone order (between 0 and 100).
        credit_check_allowed:
          type: boolean
          description: Sets if this merchant has consented and accepted to a credit check.
        credit_check_ip_address:
          type: string
          minLength: 1
          description: >-
            The IP address of the merchant when they consented to a credit check
            (e.g., 42.1.1.112 ).
        credit_check_timestamp:
          type: string
          minLength: 1
          description: >-
            A timestamp of when this merchant consented to a credit check (e.g.,
            2021-04-28T16:42:55Z).
        credit_check_user_agent:
          type: string
          minLength: 1
          description: >-
            The details of the browser that was used when this merchant
            consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac
            OS X 10 _14_6)).
        merchant_agreement_accepted:
          type: boolean
          description: >-
            Sets whether this merchant has accepted the terms and conditions of
            the merchant agreement.
        merchant_agreement_ip_address:
          type: string
          minLength: 1
          description: >-
            IP address of the merchant when this merchant accepted the merchant
            agreement (e.g., 42.1.1.113).
        merchant_agreement_timestamp:
          type: string
          minLength: 1
          description: >-
            Timestamp of when the merchant accepted Finix's Terms of Service
            (e.g., 2021-04-28T16:42:55Z).
        merchant_agreement_user_agent:
          type: string
          minLength: 1
          description: >-
            The details of the browser that was used when this merchant accepted
            Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS
            X 10 _14_6)).
        refund_policy:
          type: string
          minLength: 1
          description: Include the value that best applies to the merchant's refund policy.
          enum:
            - NO_REFUNDS
            - MERCHANDISE_EXCHANGE_ONLY
            - WITHIN_30_DAYS
            - OTHER
        volume_distribution_by_business_type:
          type: object
          description: >-
            Merchant's distribution of credit card volume by business type. Sum
            of `volume_distribution_by_business_type` must be 100.
          nullable: true
          properties:
            business_to_business_volume_percentage:
              type: integer
              description: >-
                The percentage of the merchant's volume that's business to
                business (between 0 and 100).
            business_to_consumer_volume_percentage:
              type: integer
              description: >-
                The percentage of the merchant's volume that's business to
                consumer (between 0 and 100).
            consumer_to_consumer_volume_percentage:
              type: integer
              description: >-
                Merchant's percentage of volume that is consumer to consumer
                (between 0 and 100).
            other_volume_percentage:
              type: integer
              description: >-
                The percentage of the merchant's volume that isn't represented
                by the previous fields (between 0 and 100).
            person_to_person_volume_percentage:
              type: integer
              description: >-
                The percentage the merchant's volume that's person to person
                (between 0 and 100).
    entity:
      type: object
      properties:
        amex_mid:
          type: integer
          description: >-
            Assigned amexMid value. If a value is passed, it must be 10 or 11
            digits.
          nullable: true
        annual_card_volume:
          type: integer
          description: >-
            The annual credit card sales (in cents) expected to be processed by
            this merchant (max 19 characters).
          nullable: true
        business_address:
          type: object
          description: The primary address for the legal entity.
          nullable: true
          properties:
            line1:
              type: string
              minLength: 1
              description: First line of the address (max 35 characters).
              nullable: true
            line2:
              type: string
              minLength: 1
              description: Second line of the address (max 35 characters).
              nullable: true
            city:
              type: string
              minLength: 1
              description: City (max 20 characters).
              nullable: true
            region:
              type: string
              minLength: 1
              description: 2-letter state code.
              nullable: true
            postal_code:
              type: string
              minLength: 1
              description: Zip or Postal code (max 7 characters).
              nullable: true
            country:
              type: string
              minLength: 1
              description: 3-Letter Country code (e.g. USA).
              nullable: true
        business_name:
          type: string
          minLength: 1
          description: >-
            The merchant's legal business name (max 120 characters).<ul><li>If
            <code>INDIVIDUAL_SOLE_PROPRIETORSHIP</code>, pass the owner's legal
            first name, last name, and middle initial.</li></ul>
          nullable: true
        business_phone:
          type: string
          minLength: 1
          description: >-
            Customer service phone number where the merchant can be reached (max
            10 characters).
          nullable: true
        business_tax_id:
          type: string
          description: >
            **US-based Merchants**:


            Nine digit Tax Identification Number (TIN), Employer Identification
            Number (EIN). If the `business_type` is
            **INDIVIDUAL\_SOLE\_PROPRIETORSHIP** and they do not have an EIN,
            use the sole proprietor''s Social Security Number (SSN).


            **Canada-based Merchants**:


            Nine-digit Business Number (BN) issued by the Canada Revenue Agency
            (CRA) for business tax purposes. If the business_type is
            INDIVIDUAL_SOLE_PROPRIETORSHIP and they do not have a Business
            Number, use the sole proprietor’s Social Insurance Number (SIN).
        business_type:
          description: Include the value that best applies to the merchant.
          type: string
          nullable: true
        default_statement_descriptor:
          $ref: '#/components/schemas/statement_descriptor'
        discover_mid:
          description: Assigned discoverMid value.
          type: integer
          nullable: true
        dob:
          type: object
          description: The control owner's date of birth.
          nullable: true
          properties:
            day:
              type: integer
              description: Day of birth (between 1 and 31).
              minimum: 1
            month:
              type: integer
              description: Month of birth (between 1 and 12).
              minimum: 1
            year:
              type: integer
              description: Year of birth (4-digit). Year must be greater than 1900.
              minimum: 1900
        doing_business_as:
          type: string
          minLength: 1
          description: >-
            Alternate names of the business. If there are no other names, pass
            the same value used for `business_name` (max 60 characters).
          nullable: true
        email:
          type: string
          minLength: 1
          description: >-
            The email address of the principal control owner where they can be
            reached (max 100 characters).
          nullable: true
        first_name:
          type: string
          minLength: 1
          description: >-
            The legal first name of the merchant's control owner (max 20
            characters).
          nullable: true
        has_accepted_credit_cards_previously:
          type: boolean
          description: Defaults to **false** if not passed.
        incorporation_date:
          type: object
          description: The date the company was founded and registered.
          nullable: true
          properties:
            day:
              type: integer
              description: Day business was incorporated (between 1 and 31).
            month:
              type: integer
              description: Month business was incorporated (between 1 and 12).
            year:
              type: integer
              description: Year business was incorporated (4-digit).
        last_name:
          type: string
          minLength: 1
          description: >-
            The legal last name of the merchant's control owner (max 20
            characters).
          nullable: true
        max_transaction_amount:
          type: integer
          description: >-
            The maximum amount (in cents) that can be charged for a single
            transaction (max 12 characters).
          nullable: true
        mcc:
          type: string
          minLength: 1
          description: >-
            The Merchant Category Code
            ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
            that this merchant will be classified under. For a list of approved
            MCCs, see [Approved Merchant Category
            Codes.](/guides/managing-operations/security-compliance/approved-merchant-category-codes)
          nullable: true
        ownership_type:
          type: string
          minLength: 1
          description: >-
            Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a
            publicly-traded company.</li><li><strong>PRIVATE</strong> for
            privately-held businesses.</li></ul>
          enum:
            - PUBLIC
            - PRIVATE
          nullable: true
        personal_address:
          allOf:
            - $ref: '#/components/schemas/address'
          description: |
            The entity's personal address.
        phone:
          type: string
          minLength: 1
          description: The principal control owner's phone number (max 10 characters).
          nullable: true
        principal_percentage_ownership:
          type: integer
          description: >-
            Percentage of the company owned by the principal control owner (min
            0; max 100).
          nullable: true
        short_business_name:
          type: string
          description: >-
            Abbreviated names of the business. If there are no abbreviated name,
            leave this field blank.
          nullable: true
        tax_authority:
          type: string
          description: >-
            <ul><li>Only required when onboarding a merchant with a
            <code>MCC</code> of <code>9311</code>.</li><li>The
            <code>tax_authority</code> is the tax gathering entity (e.g., San
            Francisco Water Authority).</li></ul>
          nullable: true
        title:
          type: string
          minLength: 1
          description: >-
            The corporate title of the control owner (e.g. Chief Executive
            Officer, CFO, etc. Max 60 characters).
          nullable: true
        url:
          type: string
          minLength: 1
          description: The URL of the merchant's public website.
          nullable: true
    identity_roles:
      type: array
      description: >-
        The set of roles available to the `Identity`. If none is provided, the
        Identity will be assigned `BUYER`.
      items:
        type: string
        enum:
          - APPLICATION_OWNER
          - BENEFICIAL_OWNER
          - BUYER
          - PLATFORM_OWNER
          - RECIPIENT
          - SELLER
          - SENDER
    verifications:
      type: object
      description: Link to the `Verification` the request was made under.
      properties:
        href:
          type: string
          minLength: 1
    merchants:
      type: object
      description: Link to the `Merchant` the request was made under.
      properties:
        href:
          type: string
          minLength: 1
    settlements:
      type: object
      description: Link to the `Settlement` the request was made under.
      properties:
        href:
          type: string
          minLength: 1
    authorizations:
      type: object
      description: Link to the `Authorization` the request was made under.
      properties:
        href:
          type: string
          minLength: 1
    payment_instruments:
      type: object
      description: Link to the `Payment Instrume` the request was made under.
      properties:
        href:
          type: string
          minLength: 1
    associated_identities:
      type: object
      description: Link to any other `Identites` associated with the request.
      properties:
        href:
          type: string
          minLength: 1
    disputes:
      type: object
      description: Link to the `Dispute` the request was made under.
      properties:
        href:
          type: string
          minLength: 1
    identitySellerUSA:
      title: Seller (USA)
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        additional_underwriting_data:
          $ref: '#/components/schemas/additional_underwriting_data'
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the resource.
        entity:
          $ref: '#/components/schemas/entity'
        identity_roles:
          $ref: '#/components/schemas/identity_roles'
        type:
          type: string
          description: The identity type.
          enum:
            - BUSINESS
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
            verifications:
              $ref: '#/components/schemas/verifications'
            merchants:
              $ref: '#/components/schemas/merchants'
            settlements:
              $ref: '#/components/schemas/settlements'
            authorizations:
              $ref: '#/components/schemas/authorizations'
            transfers:
              $ref: '#/components/schemas/transfers'
            payment_instruments:
              $ref: '#/components/schemas/payment_instruments'
            associated_identities:
              $ref: '#/components/schemas/associated_identities'
            disputes:
              $ref: '#/components/schemas/disputes'
            application:
              $ref: '#/components/schemas/application_link'
    identitySellerCAN:
      title: Seller (CAN)
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        additional_underwriting_data:
          $ref: '#/components/schemas/additional_underwriting_data'
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the resource.
        entity:
          $ref: '#/components/schemas/entity'
        identity_roles:
          $ref: '#/components/schemas/identity_roles'
        type:
          type: string
          description: The identity type.
          enum:
            - BUSINESS
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
            verifications:
              $ref: '#/components/schemas/verifications'
            merchants:
              $ref: '#/components/schemas/merchants'
            settlements:
              $ref: '#/components/schemas/settlements'
            authorizations:
              $ref: '#/components/schemas/authorizations'
            transfers:
              $ref: '#/components/schemas/transfers'
            payment_instruments:
              $ref: '#/components/schemas/payment_instruments'
            associated_identities:
              $ref: '#/components/schemas/associated_identities'
            disputes:
              $ref: '#/components/schemas/disputes'
            application:
              $ref: '#/components/schemas/application_link'
    identityRecipientBusiness:
      title: Recipient (Business)
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the resource.
        entity:
          $ref: '#/components/schemas/entity'
        identity_roles:
          $ref: '#/components/schemas/identity_roles'
        type:
          type: string
          description: The type of recipient.
          enum:
            - BUSINESS
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
            verifications:
              $ref: '#/components/schemas/verifications'
            merchants:
              $ref: '#/components/schemas/merchants'
            settlements:
              $ref: '#/components/schemas/settlements'
            authorizations:
              $ref: '#/components/schemas/authorizations'
            transfers:
              $ref: '#/components/schemas/transfers'
            payment_instruments:
              $ref: '#/components/schemas/payment_instruments'
            associated_identities:
              $ref: '#/components/schemas/associated_identities'
            disputes:
              $ref: '#/components/schemas/disputes'
            application:
              $ref: '#/components/schemas/application_link'
    identityRecipientPersonal:
      title: Recipient (Personal)
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the resource.
        entity:
          $ref: '#/components/schemas/entity'
        identity_roles:
          $ref: '#/components/schemas/identity_roles'
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: The type of recipient.
          enum:
            - PERSONAL
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
            verifications:
              $ref: '#/components/schemas/verifications'
            merchants:
              $ref: '#/components/schemas/merchants'
            settlements:
              $ref: '#/components/schemas/settlements'
            authorizations:
              $ref: '#/components/schemas/authorizations'
            transfers:
              $ref: '#/components/schemas/transfers'
            payment_instruments:
              $ref: '#/components/schemas/payment_instruments'
            associated_identities:
              $ref: '#/components/schemas/associated_identities'
            disputes:
              $ref: '#/components/schemas/disputes'
            application:
              $ref: '#/components/schemas/application_link'
    entity_buyer:
      type: object
      properties:
        amex_mid:
          type: integer
          description: >-
            Assigned amexMid value. If a value is passed, it must be 10 or 11
            digits.
          nullable: true
        annual_card_volume:
          type: integer
          description: >-
            The annual credit card sales (in cents) expected to be processed by
            this merchant (max 19 characters).
          nullable: true
        business_address:
          type: object
          description: The primary address for the legal entity.
          nullable: true
          properties:
            line1:
              type: string
              minLength: 1
              description: First line of the address (max 35 characters).
              nullable: true
            line2:
              type: string
              minLength: 1
              description: Second line of the address (max 35 characters).
              nullable: true
            city:
              type: string
              minLength: 1
              description: City (max 20 characters).
              nullable: true
            region:
              type: string
              minLength: 1
              description: 2-letter state code.
              nullable: true
            postal_code:
              type: string
              minLength: 1
              description: Zip or Postal code (max 7 characters).
              nullable: true
            country:
              type: string
              minLength: 1
              description: 3-Letter Country code (e.g. USA).
              nullable: true
        business_name:
          type: string
          minLength: 1
          description: >-
            The merchant's legal business name (max 120 characters).<ul><li>If
            <code>INDIVIDUAL_SOLE_PROPRIETORSHIP</code>, pass the owner's legal
            first name, last name, and middle initial.</li></ul>
          nullable: true
        business_phone:
          type: string
          minLength: 1
          description: >-
            Customer service phone number where the merchant can be reached (max
            10 characters).
          nullable: true
        business_tax_id:
          type: string
          description: >-
            Nine digit Tax Identification Number (TIN), Employer Identification
            Number (EIN). If the `business_type` is
            **INDIVIDUAL\_SOLE\_PROPRIETORSHIP** and they do not have an EIN,
            use the sole proprietor's Social Security Number (SSN).
        business_type:
          description: Include the value that best applies to the merchant.
          type: string
          nullable: true
        default_statement_descriptor:
          $ref: '#/components/schemas/statement_descriptor'
        discover_mid:
          description: Assigned discoverMid value.
          type: integer
          nullable: true
        dob:
          type: object
          description: The control owner's date of birth.
          nullable: true
          properties:
            day:
              type: integer
              description: Day of birth (between 1 and 31).
              minimum: 1
            month:
              type: integer
              description: Month of birth (between 1 and 12).
              minimum: 1
            year:
              type: integer
              description: Year of birth (4-digit). Year must be greater than 1900.
              minimum: 1900
        doing_business_as:
          type: string
          minLength: 1
          description: >-
            Alternate names of the business. If there are no other names, pass
            the same value used for `business_name` (max 60 characters).
          nullable: true
        email:
          type: string
          description: The email address of the buyer (max 100 characters).
          nullable: true
        first_name:
          type: string
          description: The legal first name of the buyer (max 20 characters).
          nullable: true
        has_accepted_credit_cards_previously:
          type: boolean
          description: Defaults to **false** if not passed.
        incorporation_date:
          type: object
          description: The date the company was founded and registered.
          nullable: true
          properties:
            day:
              type: integer
              description: Day business was incorporated (between 1 and 31).
            month:
              type: integer
              description: Month business was incorporated (between 1 and 12).
            year:
              type: integer
              description: Year business was incorporated (4-digit).
        last_name:
          type: string
          description: The legal last name of the buyer (max 20 characters).
          nullable: true
        max_transaction_amount:
          type: integer
          description: >-
            The maximum amount (in cents) that can be charged for a single
            transaction (max 12 characters).
          nullable: true
        mcc:
          type: string
          minLength: 1
          description: >-
            The Merchant Category Code
            ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
            that this merchant will be classified under. For a list of approved
            MCCs, see [Approved Merchant Category
            Codes.](/guides/managing-operations/security-compliance/approved-merchant-category-codes)
          nullable: true
        ownership_type:
          type: string
          minLength: 1
          description: >-
            Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a
            publicly-traded company.</li><li><strong>PRIVATE</strong> for
            privately-held businesses.</li></ul>
          enum:
            - PUBLIC
            - PRIVATE
          nullable: true
        personal_address:
          allOf:
            - $ref: '#/components/schemas/address'
          description: >-
            The billing address of the buyer. This field is used for identity
            verification purposes.
        phone:
          type: string
          minLength: 1
          description: Phone number where the buyer can be reached.
          nullable: true
        principal_percentage_ownership:
          type: integer
          description: >-
            Percentage of the company owned by the principal control owner (min
            0; max 100).
          nullable: true
        short_business_name:
          type: string
          description: >-
            Abbreviated names of the business. If there are no abbreviated name,
            leave this field blank.
          nullable: true
        tax_authority:
          type: string
          description: >-
            <ul><li>Only required when onboarding a merchant with a
            <code>MCC</code> of <code>9311</code>.</li><li>The
            <code>tax_authority</code> is the tax gathering entity (e.g., San
            Francisco Water Authority).</li></ul>
          nullable: true
        title:
          type: string
          minLength: 1
          description: >-
            The corporate title of the control owner (e.g. Chief Executive
            Officer, CFO, etc. Max 60 characters).
          nullable: true
        url:
          type: string
          minLength: 1
          description: The URL of the merchant's public website.
          nullable: true
    identityBuyer:
      title: Buyer
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the resource.
        entity:
          $ref: '#/components/schemas/entity_buyer'
        identity_roles:
          $ref: '#/components/schemas/identity_roles'
        type:
          type: string
          description: The `Identity` type.
          enum:
            - PERSONAL
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
            verifications:
              $ref: '#/components/schemas/verifications'
            merchants:
              $ref: '#/components/schemas/merchants'
            settlements:
              $ref: '#/components/schemas/settlements'
            authorizations:
              $ref: '#/components/schemas/authorizations'
            transfers:
              $ref: '#/components/schemas/transfers'
            payment_instruments:
              $ref: '#/components/schemas/payment_instruments'
            associated_identities:
              $ref: '#/components/schemas/associated_identities'
            disputes:
              $ref: '#/components/schemas/disputes'
            application:
              $ref: '#/components/schemas/application_link'
    createIdentitySellerUSA:
      title: Seller (USA)
      type: object
      properties:
        additional_underwriting_data:
          $ref: '#/components/schemas/additional_underwriting_data'
        entity:
          $ref: '#/components/schemas/entity'
        identity_roles:
          type: array
          description: The set of roles available to the `Identity`.
          items:
            type: string
            enum:
              - SELLER
        type:
          type: string
          description: The identity type.
          enum:
            - BUSINESS
        tags:
          $ref: '#/components/schemas/tags'
    createIdentitySellerCAN:
      title: Seller (CAN)
      type: object
      properties:
        additional_underwriting_data:
          $ref: '#/components/schemas/additional_underwriting_data'
        entity:
          $ref: '#/components/schemas/entity'
        identity_roles:
          type: array
          description: The set of roles available to the `Identity`.
          items:
            type: string
            enum:
              - SELLER
        type:
          type: string
          description: The identity type.
          enum:
            - BUSINESS
        tags:
          $ref: '#/components/schemas/tags'
    createIdentityRecipientBusiness:
      title: Recipient (Business)
      type: object
      properties:
        entity:
          type: object
          description: Identifying information about the recipient business.
          properties:
            business_address:
              description: The primary address for the legal entity.
              allOf:
                - $ref: '#/components/schemas/address'
            business_name:
              type: string
              minLength: 1
              description: >-
                The legal business name (max 120 characters).<ul><li>If
                <code>INDIVIDUAL_SOLE_PROPRIETORSHIP</code>, pass the owner's
                legal first name, last name, and middle initial.</li></ul>
              nullable: true
            doing_business_as:
              type: string
              minLength: 1
              description: >-
                Alternate names of the business. If there are no other names,
                pass the same value used for `business_name` (max 60
                characters).
              nullable: true
            first_name:
              type: string
              minLength: 1
              description: >-
                The legal first name of the recipient business's control owner
                (max 20 characters).
              nullable: true
            last_name:
              type: string
              minLength: 1
              description: >-
                The legal last name of the recipient business's control owner
                (max 20 characters).
              nullable: true
            personal_address:
              allOf:
                - $ref: '#/components/schemas/address'
              description: The billing address of the recipient business's control owner.
        identity_roles:
          type: array
          description: The set of roles available to the `Identity`.
          items:
            type: string
            enum:
              - RECIPIENT
        type:
          type: string
          description: The identity type.
          enum:
            - BUSINESS
        tags:
          $ref: '#/components/schemas/tags'
    createIdentityRecipientPersonal:
      title: Recipient (Personal)
      type: object
      properties:
        entity:
          type: object
          description: Identifying information about the recipient.
          properties:
            first_name:
              type: string
              description: The legal first name of the recipient (max 20 characters).
            last_name:
              type: string
              description: The legal last name of the recipient (max 20 characters).
            personal_address:
              allOf:
                - $ref: '#/components/schemas/address'
              description: >-
                The billing address of the recipient. This field is used for
                identity verification purposes.
        identity_roles:
          type: array
          description: The set of roles available to the `Identity`.
          items:
            type: string
            enum:
              - RECIPIENT
        type:
          type: string
          description: The identity type.
          enum:
            - PERSONAL
        tags:
          $ref: '#/components/schemas/tags'
    createIdentityBuyer:
      title: Buyer
      type: object
      properties:
        entity:
          type: object
          description: The underwriting details required to verify `Identities`.
          properties:
            email:
              type: string
              description: >-
                The email address of the buyer where they can be reached (max
                100 characters).
            first_name:
              type: string
              description: The legal first name of the buyer (max 20 characters).
            last_name:
              type: string
              description: The legal last name of the buyer (max 20 characters).
            personal_address:
              description: >
                The billing address of the buyer. This field is used for
                identity verification purposes.
              allOf:
                - $ref: '#/components/schemas/address'
            phone:
              type: string
              description: Phone number where the buyer can be reached.
        identity_roles:
          type: array
          description: The set of roles available to the `Identity`.
          items:
            type: string
            enum:
              - BUYER
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: The `Identity` type.
          enum:
            - PERSONAL
            - BUSINESS
      required:
        - entity
    createIdentityBuyerBlank:
      title: Buyer - Blank
      allOf:
        - $ref: '#/components/schemas/createIdentityBuyer'
    createUserRoleMerchant:
      title: User - ROLE_MERCHANT
      type: object
      properties: {}
    identityBuyerBlank:
      title: Buyer - Blank
      allOf:
        - $ref: '#/components/schemas/identityBuyer'
    updateIdentity:
      title: Update Identity
      type: object
      properties:
        entity:
          type: object
          description: Identifying information about the entity.
          properties:
            email:
              type: string
              description: The email address of the entity (max 100 characters).
            first_name:
              type: string
              description: The legal first name of the entity (max 20 characters).
            last_name:
              type: string
              description: The legal last name of the entity (max 20 characters).
            personal_address:
              allOf:
                - $ref: '#/components/schemas/address'
              description: >-
                The billing address of the entity. This field is used for
                identity verification purposes.
            phone:
              type: string
              description: Phone number where the entity can be reached.
        tags:
          $ref: '#/components/schemas/tags'
    createAssociatedIdentity:
      type: object
      properties:
        entity:
          $ref: '#/components/schemas/entity'
    associatedIdentityBuyer:
      title: Associated Identity (Buyer)
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the resource.
        entity:
          $ref: '#/components/schemas/entity_buyer'
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
            verifications:
              $ref: '#/components/schemas/verifications'
            merchants:
              $ref: '#/components/schemas/merchants'
            settlements:
              $ref: '#/components/schemas/settlements'
            authorizations:
              $ref: '#/components/schemas/authorizations'
            transfers:
              $ref: '#/components/schemas/transfers'
            payment_instruments:
              $ref: '#/components/schemas/payment_instruments'
            associated_identities:
              $ref: '#/components/schemas/associated_identities'
            disputes:
              $ref: '#/components/schemas/disputes'
            application:
              $ref: '#/components/schemas/application_link'
    associatedIdentitySeller:
      title: Associated Identity (Merchant)
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the resource.
        entity:
          $ref: '#/components/schemas/entity'
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
            verifications:
              $ref: '#/components/schemas/verifications'
            merchants:
              $ref: '#/components/schemas/merchants'
            settlements:
              $ref: '#/components/schemas/settlements'
            authorizations:
              $ref: '#/components/schemas/authorizations'
            transfers:
              $ref: '#/components/schemas/transfers'
            payment_instruments:
              $ref: '#/components/schemas/payment_instruments'
            associated_identities:
              $ref: '#/components/schemas/associated_identities'
            disputes:
              $ref: '#/components/schemas/disputes'
            application:
              $ref: '#/components/schemas/application_link'
    refunds_disabled_merchant:
      type: boolean
      default: false
      description: >-
        A value of `true` disables refunds for the `Merchant`, including both
        referenced and unreferenced refunds.
    identity:
      type: object
      description: Link to the `Identity` the request was made under.
      properties:
        href:
          type: string
    merchant_profiles:
      type: object
      description: Link to the `merchant_profile` the request was made under.
      properties:
        href:
          type: string
    merchant:
      title: Merchant Schema
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the resource.
        card_cvv_required:
          type: boolean
          description: Set to `true` to require the card's CVV code.
        card_expiration_date_required:
          type: boolean
          description: Set to `true` to require the card's expiration date.
        card_network_details:
          type: object
          nullable: true
        convenience_charges_enabled:
          type: boolean
          description: >-
            Set to `true` if you want to enable the `Merchant` to accept
            convenience fees and/or service fees.
        country:
          description: The `Merchant`'s country.
          allOf:
            - $ref: '#/components/schemas/country'
        creating_transfer_from_report_enabled:
          type: boolean
          description: >-
            Set to `true` to automatically create `Transfers` once settlement
            reports get generated.
        currencies:
          type: array
          description: ISO 4217 3-letter currency code.
          nullable: true
          items:
            $ref: '#/components/schemas/currency'
        default_partial_authorization_enabled:
          type: boolean
          default: false
          description: >
            - Set to **true** if you want to enable partial authorizations for a
            specific `Merchant`.

            - Partial authorizations enable the `Merchant` to collect a portion
            of the amount if the cardholder doesn't have the funds to cover the
            entire amount on their card.
        disbursements_same_day_ach_pull_enabled:
          type: boolean
          description: >-
            Indicates whether same-day ACH pull disbursements (debits) are
            enabled, allowing funds to be withdrawn from an account via same-day
            ACH transfer.
        disbursements_same_day_ach_push_enabled:
          type: boolean
          description: >-
            Indicates whether same-day ACH push disbursements (credits) are
            enabled, allowing funds to be sent to an account via same-day ACH
            transfer.
        fee_ready_to_settle_upon:
          type: string
          description: Details how the `Merchant` settles fees.
          enum:
            - RECONCILIATION
            - SUCCESSFUL_CAPTURE
            - PROCESSOR_WINDOW
            - CONFIGURABLE_WINDOW
        first_approved_at:
          type: string
          format: date-time
          description: >
            This field shows the timestamp when the `Merchant` was first
            approved. If the `Merchant` has not been approved yet, the value is
            `null`.
          nullable: true
        gateway:
          type: string
          description: >-
            Name of the gateway that routes the `Merchant's` transactions to the
            processor.
          enum:
            - TRIPOS_MOBILE_V1
            - TRIPOS_CLOUD_V1
            - DATACAP_V1
          nullable: true
        gross_settlement_enabled:
          type: boolean
          description: Set to `true` to enable gross settlements.
        identity:
          type: string
          description: The ID of the `Identity` resource associated with the `Merchant`.
        instant_payouts_card_push_enabled:
          type: boolean
          description: >-
            Set to `true` if you want to allow the merchant to be enabled for
            settlement instant payouts.
          default: false
        is_terminated:
          type: boolean
          description: >-
            Set to `true` to terminate the `Merchant`. A merchant can only be
            terminated if its current `onboarding_state` is `APPROVED`.
        level_two_level_three_data_enabled:
          type: boolean
          description: >-
            Set to `true` to enable the `Merchant` for Level 2 and Level 3
            processing. Default value is `false`.
        loan_repayment:
          type: boolean
          default: false
          description: >
            Whether the merchant is able to support loan repayment on the card
            networks.
        mcc:
          type: string
          description: >-
            The Merchant Category Code
            ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
            that this merchant will be classified under. For a list of approved
            MCCs, see [Approved Merchant Category
            Codes.](/guides/managing-operations/security-compliance/approved-merchant-category-codes)
          nullable: true
        merchant_name:
          type: string
          description: The legal name saved in the `Merchant` resource.
        merchant_profile:
          type: string
          description: >-
            Details if a merchant's info was submitted to third-party processors
            for provisioning.
        mid:
          type: string
          description: MID of the `Merchant`.
          nullable: true
        onboarding_state:
          type: string
          enum:
            - APPROVED
            - PROVISIONING
            - REJECTED
            - UPDATE_REQUESTED
          description: Details the state of the `Merchant's` onboarding.
        processing_enabled:
          type: boolean
          description: >-
            Details if transaction processing is enabled for the `Merchant`.
            `ROLE_PARTNER` can only set this value to `false`.
        processor:
          type: string
          description: Name of the transaction processor.
        processor_details:
          type: object
          description: Additional details specific to the processor.
          properties:
            mid:
              type: string
            api_key:
              type: string
        ready_to_settle_upon:
          type: string
          description: Details how transactions captured by the `Merchant` are settled.
          enum:
            - RECONCILIATION
            - SUCCESSFUL_CAPTURE
            - PROCESSOR_WINDOW
            - CONFIGURABLE_WINDOW
        ready_to_settle_upon_delay_alignment:
          type: string
          description: >
            Indicates whether transaction settlement should be delayed to
            synchronize the timing of all transactions, including both card and
            ACH, ensuring they are settled together.


            Possible values include:


            - `ACH` - Align all transactions to match the timing of ACH
            settlements, so card transactions settle at the same speed as ACH
            transactions.

            - `NONE` - Default behavior where card transactions settle the next
            day (T+1) and ACH transactions settle two days later (T+2).
          enum:
            - ACH
            - NONE
        refunds_disabled:
          $ref: '#/components/schemas/refunds_disabled_merchant'
        rent_surcharges_enabled:
          type: boolean
          description: >-
            Set to `true` if you want to enable a `Merchant` to accept rent
            charges.
        settlement_enabled:
          type: boolean
          description: >-
            Details if settlement approvals are enabled for the `Merchant`.
            `ROLE_PARTNER` can only set this value to false.
        settlement_funding_identifier:
          type: string
          description: >-
            Includes additional information (like the MID or `Merchant` name)
            when submitting funding `Transfers` to processors.

            - `UNSET`: No additional details get provided to the processor.

            - `MID_AND_DATE`: The `MID` of the `Merchant` and the date the
            funding `Transfer` was submitted (Date is in UTC). e.g
            `MID:12345678-20220225`

            - `MID_AND_MERCHANT_NAME`: The `MID` of the `Merchant` and the
            `Merchant#name` (white spaces will be removed). e.g.
            `MID:12345678-NameOfMerchant`


            These details appear alongside the seller's payout in their bank
            account as a description of the deposit.
          enum:
            - UNSET
            - MID_AND_DATE
            - MID_AND_MERCHANT_NAME
          default: UNSET
        settlement_queue_mode:
          type: string
          description: >
            If `settlement_queue_mode` is set to `MANUAL`, Finix will
            automatically place all transactions (Sales, Fees, Refunds, and ACH
            Returns) into a settlement queue that you can manage. Each
            transaction will have a `Settlement Queue Entry`.


            When a `Settlement Queue Entry` is created, it will not be placed
            into `Settlement` until the `Settlement Queue Entry` is explicitly
            released.


            Note: We require the release of all settlement queue entries within
            30 days of creation.
          enum:
            - UNSET
            - MANUAL
        surcharges_enabled:
          type: boolean
          default: false
          description: >-
            Set to `true` if you want to enable a `Merchant` to accept surcharge
            fees. For more details, see [Buyer
            Charges](/guides/online-payments/payment-features/buyer-charges).
        tags:
          $ref: '#/components/schemas/tags'
        termination_details:
          type: object
          properties:
            terminated_at:
              type: string
              title: CreatedAt
              format: date-time
              example: '2024-09-16T13:11:36.72Z'
              description: Timestamp indicating when the termination occurred.
            reason:
              type: string
              description: The reason for termination.
              enum:
                - CHURNED
                - FRAUD
                - IDENTITY_THEFT
            description:
              type: string
              description: An explanation that provides context for the termination.
              maxLength: 1000
            terminated_by:
              type: string
              description: >
                The role that initiated the termination. If the API key belongs
                to the `USER` role, the following values will be returned:
                  - If the role is `ROLE_PLATFORM`, it will return `PLATFORM_USER`.
                  - If the role is `ROLE_PARTNER`, it will return `PARTNER_USER`.
              enum:
                - PLATFORM_USER
                - PARTNER_USER
            terminated_by_user_id:
              type: string
              description: >-
                The `User` ID of the user who initiated the termination of the
                `Merchant` account.
        unreferenced_refund_manual_entry_enabled:
          type: boolean
          default: false
          description: >-
            Indicates if merchant is allowed to process unreferenced refunds
            initiated through manual card entry on Finix terminals.
        verification:
          type: string
          description: >-
            ID of the `Verification` that was submitted to verify the
            `Merchant`.
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              $ref: '#/components/schemas/self'
            identity:
              $ref: '#/components/schemas/identity'
            verifications:
              $ref: '#/components/schemas/verifications'
            merchant_profiles:
              $ref: '#/components/schemas/merchant_profiles'
            application:
              $ref: '#/components/schemas/application_link'
    processor_request:
      description: >
        Set the acquiring processor. Use `DUMMY_V1` or `null` for your Sandbox.
        For more details on which processor to use, reach out to your Finix
        point of contact or email [Finix
        Support](/guides/getting-started/support-at-finix/).
      type: string
      nullable: false
      enum:
        - DUMMY_V1
        - FINIX_V1
        - LITLE_V1
        - MASTERCARD_V1
        - NMI_V1
        - VANTIV_V1
        - VISA_V1
    createMerchant:
      title: Merchant - All Fields
      type: object
      properties:
        gateway:
          type: string
          enum:
            - TRIPOS_CLOUD_V1
            - TRIPOS_MOBILE_V1
            - DATACAP_V1
          description: >-
            Name of the gateway that processes the `Merchant's` card present
            transactions. Use `gateway` only to enable a merchant to accept card
            present transactions.
        default_partial_authorization_enabled:
          type: boolean
          default: false
          description: >-
            - Set to **true** if you want to enable partial authorizations for a
            specific `Merchant`.

            - Partial authorizations enable the `Merchant` to collect a portion
            of the amount if the cardholder doesn't have the funds to cover the
            entire amount on their card.
        loan_repayment:
          type: boolean
          default: false
          description: >-
            Set to `true` to enable the `Merchant` to process debt loan
            repayment. Only MCCs `6012` and `6051` are eligible.
        processor:
          $ref: '#/components/schemas/processor_request'
        refunds_disabled:
          $ref: '#/components/schemas/refunds_disabled_merchant'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - processor
    model:
      type: string
      description: The model type of the `Device`.
      enum:
        - PAX_A800
        - PAX_A920PRO
        - D135
    createMerchantDevice:
      type: object
      description: Schema for request to create a `Device` under a `Merchant`.
      properties:
        configuration:
          $ref: '#/components/schemas/device_configuration'
        description:
          type: string
          description: Additional information about device (e.g. self serving terminal).
        model:
          $ref: '#/components/schemas/model'
        name:
          type: string
          description: Name of the `Device`.
        serial_number:
          type: string
          description: The serial number of the `Device`.
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - configuration
        - model
        - name
        - serial_number
    updateMerchantDisableProcessing:
      title: Disable Processing
      type: object
      properties:
        processing_enabled:
          type: boolean
          description: >-
            Details if transaction processing is enabled for the `Merchant`.
            `ROLE_PARTNER` can only set this value to `false`.
        tags:
          $ref: '#/components/schemas/tags'
    updateMerchantDisableSettlements:
      title: Disable Settlements
      type: object
      properties:
        settlement_enabled:
          type: boolean
          description: >-
            Details if settlement approvals are enabled for the `Merchant`.
            `ROLE_PARTNER` can only set this value to `false`.
        tags:
          $ref: '#/components/schemas/tags'
    updateMerchantEnableBuyerCharges:
      title: Enable Buyer Charges
      type: object
      properties:
        convenience_charges_enabled:
          type: boolean
          description: >-
            Set to **true** if you want to enable the `Merchant` to accept
            convenience fees and/or service fees.
        rent_surcharges_enabled:
          type: boolean
          description: >-
            Set to **true** if you want to enable a `Merchant` to accept rent
            charges.
        surcharge_fees_enabled:
          type: boolean
          description: >-
            Set to **true** if you want to enable a `Merchant` to accept
            surcharge fees.
        tags:
          $ref: '#/components/schemas/tags'
    updateMerchantEnableL2L3Processing:
      title: Enable Level 2/3 Processing
      type: object
      properties:
        level_two_level_three_data_enabled:
          type: boolean
          description: >-
            Set to **true** to enable the `Merchant` for Level 2 and Level 3
            processing. Default value is **false**.
        tags:
          $ref: '#/components/schemas/tags'
    updateMerchantEnableLoanRepayment:
      title: Enable Loan Repayment
      type: object
      properties:
        loan_repayment:
          type: boolean
          default: false
          description: >-
            Set to `true` to enable the `Merchant` to process debt loan
            repayment. Only MCCs `6012` and `6051` are eligible.
        tags:
          $ref: '#/components/schemas/tags'
    updateMerchantEnablePartialAuthorizations:
      title: Enable Partial Authorizations
      type: object
      properties:
        default_partial_authorization_enabled:
          type: boolean
          description: >-
            - Set to **true** if you want to enable partial authorizations for a
            specific `Merchant`.

            - Partial authorizations enable the `Merchant` to collect a portion
            of the amount if the cardholder doesn't have the funds to cover the
            entire amount on their card.
        tags:
          $ref: '#/components/schemas/tags'
    updateMerchantEnableSameDayACH:
      title: Enable Disbursements Same-Day ACH Push & Pull
      type: object
      properties:
        disbursements_same_day_ach_pull_enabled:
          type: boolean
          description: >-
            Indicates whether same-day ACH pull disbursements (debits) are
            enabled, allowing funds to be withdrawn from an account via same-day
            ACH transfer.
        disbursements_same_day_ach_push_enabled:
          type: boolean
          description: >-
            Indicates whether same-day ACH push disbursements (credits) are
            enabled, allowing funds to be sent to an account via same-day ACH
            transfer.
        tags:
          $ref: '#/components/schemas/tags'
    updateMerchantSettlementQueue:
      title: Enable Settlement Queue
      type: object
      properties:
        settlement_queue_mode:
          type: string
          description: >-
            Set to `MANUAL` to enable the `Merchant` to use the Settlement
            Queue.
          default: UNSET
          enum:
            - UNSET
            - MANUAL
    updateMerchantTerminate:
      title: Terminate Merchant
      type: object
      properties:
        is_terminated:
          type: boolean
          description: >-
            Set to `true` to terminate the `Merchant`. A merchant can only be
            terminated if its current `onboarding_state` is `APPROVED`.
        termination_details:
          type: object
          properties:
            reason:
              type: string
              description: >-
                The reason for termination. Required if `is_terminated` is set
                to `true`.
              enum:
                - CHURNED
                - FRAUD
                - IDENTITY_THEFT
            description:
              type: string
              description: An explanation that provides context for the termination.
              maxLength: 1000
        tags:
          $ref: '#/components/schemas/tags'
    merchant-verification:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          $ref: '#/components/schemas/application_id'
        identity:
          type: string
          description: The ID of the `Identity` used to create the `Merchant`.
          nullable: true
          default: null
        merchant:
          type: string
          description: The ID of the `Merchant` sent for verification.
        merchant_identity:
          type: string
          description: The `Identity` ID associated with the `Merchant`.
        messages:
          type: array
          description: A codified list of reasons the verification request failed.
          items:
            type: string
          default: []
        outcome_summary:
          type: string
          description: >-
            A message providing additional context about why the verification
            request failed, available for `SELLER` merchants only.
          default: null
        outcomes:
          type: array
          description: >-
            A codified list of reasons the verification request failed,
            available for `SELLER` merchants only.
          items:
            type: object
          default: null
        payment_instrument:
          type: string
          description: This field is not applicable to merchant verification.
          default: null
        payment_instrument_verification_details:
          type: object
          description: This object is not applicable to merchant verification.
          properties:
            push_to_card_domestic:
              type: string
              description: This object is not applicable to merchant verification.
              nullable: true
              default: null
            push_to_card_cross_border:
              type: string
              description: This object is not applicable to merchant verification.
              nullable: true
              default: null
            card_type:
              type: string
              description: This object is not applicable to merchant verification.
              nullable: true
              default: null
            billing_currency:
              type: string
              description: This object is not applicable to merchant verification.
              nullable: true
              default: null
            issuer_country:
              type: string
              description: This object is not applicable to merchant verification.
              nullable: true
              default: null
        processor:
          type: string
          description: Name of the verification processor.
          enum:
            - LITLE_V1
            - VANTIV_V1
            - FINIX_V1
            - DUMMY_V1
        raw:
          description: >-
            Raw response from the processor. For `SELLER` Merchants, please use
            the newer `outcomes` and `outcome_summary` fields.
          anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
        state:
          type: string
          description: The state of the verification request.
          enum:
            - PENDING
            - FAILED
            - SUCCEEDED
        tags:
          $ref: '#/components/schemas/tags'
        trace_id:
          type: string
          description: An ID used for tracking the verification request.
        type:
          type: string
          description: Details the type of resource getting verified.
          enum:
            - MERCHANT
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: Link to the `Verification`.
              properties:
                href:
                  type: string
            merchant:
              type: object
              description: Link to the `Merchant` sent in the verification request.
              properties:
                href:
                  type: string
            application:
              type: object
              description: Link to the `Application` associated with this resource.
              properties:
                href:
                  type: string
    created_via:
      type: string
      description: The method by which the resource was created.
      enum:
        - API
    account_updater_enabled_card:
      type: boolean
      description: >
        When enabled at the `Payment Instrument`-level, Finix automatically
        checks for updates with card networks. This Account Updater
        functionality:


        - Automatically updates card details (e.g., number or expiration date)
        to maintain continuity of charges, increasing authorization rates.

        - Saves the cardholder the hassle of updating card details across
        `Merchants` for each of their `Subscriptions`.


        If set at the `Application` level, this `Payment Instrument`-level
        setting will override the `Application`-level configuration. If not
        configured at the `Application`-level, the card defaults to `false`,
        requiring explicit opt-in.


        **Note**: Cards created before the feature is enabled are unaffected by
        default. To include these cards, you can manually enable the Account
        Updater functionality for each card individually using a PUT request.
        Once enabled, you can link the card to this API call to trigger updates
        with card networks.
      default: false
    identity_id:
      type: string
      description: The ID of the `Identity` used to create the resource.
    network_token_enabled_card:
      type: boolean
      description: >
        When enabled at the `Payment Instrument` level, a "network token"
        replaces raw card details (e.g., the 16-digit PAN and expiration date)
        for transactions. Network tokens have several benefits:


        - The token offers increased authorization rates, even for lost or
        stolen cards, as it remains valid while the physical card is replaced.

        - Visa reduces interchange fees when using network tokens.

        - Tokens enhance security by replacing card details with a non-sensitive
        string that is usable only within the Finix system.


        If set at the `Application` level, this `Payment Instrument` level
        setting will override the application level configuration.  If not
        configured at the application level, the card defaults to `false`,
        requiring explicit opt-in.


        **Note**: Cards created before the feature is enabled are unaffected. To
        include them, update an individual `Payment Instrument`. Then, you can
        insert the hyperlink on the "update".
      default: false
    payment_instrument_card:
      type: object
      title: Payment Instrument - Card
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        created_via:
          $ref: '#/components/schemas/created_via'
        account_updater_enabled:
          $ref: '#/components/schemas/account_updater_enabled_card'
        address:
          description: >-
            The address of the card owner. Including a postal or zip code when
            creating a `Payment Instrument` can lower the interchange on credit
            card transactions.
          allOf:
            - $ref: '#/components/schemas/address'
        address_verification:
          type: string
          enum:
            - POSTAL_CODE_AND_STREET_MATCH
            - STREET_MATCH
            - POSTAL_CODE_MATCH
            - NO_ADDRESS
            - NO_MATCH
            - NOT_SUPPORTED
            - UNKNOWN
          description: |-
            - Details the results of verifying `address` with the issuing bank.
            - Set to **UNKNOWN** when `address` gets updated.
        application:
          $ref: '#/components/schemas/application_id'
        bin:
          type: string
          description: Bank Identification number for the `Payment Instrument`.
        brand:
          type: string
          enum:
            - UNKNOWN
            - DINERS_CLUB_INTERNATIONAL
            - DANKORT
            - MIR
            - TROY
            - UATP
            - CHINA_T_UNION
            - CHINA_UNION_PAY
            - AMERICAN_EXPRESS
            - VERVE
            - RUPAY
            - DISCOVER
            - JCB
            - MASTERCARD
            - INTERPAYMENT
            - INSTAPAYMENT
            - MAESTRO
            - VISA
            - LANKAPAY
            - DINERS_CLUB
            - INTERAC
          description: The `brand` of the card saved in the `Payment Instrument`.
        card_type:
          type: string
          enum:
            - CREDIT
            - DEBIT
            - HSA_FSA
            - NON_RELOADABLE_PREPAID
            - RELOADABLE_PREPAID
            - UNKNOWN
          description: The type of payment card saved in the `Payment Instrument`.
        country:
          $ref: '#/components/schemas/country'
        currency:
          $ref: '#/components/schemas/currency'
        disabled_code:
          type: string
          nullable: true
        disabled_message:
          type: string
          nullable: true
        enabled:
          type: boolean
          description: >-
            Indicates whether the `Payment Instrument` resource is enabled. The
            default value is `true`; set it to `false` to disable the `Payment
            Instrument`.
        expiration_month:
          type: integer
          maximum: 12
          minimum: 1
          description: Expiration month (e.g. 12 for December).
        expiration_year:
          type: integer
          minimum: 1
          description: 4-digit expiration year.
        fast_funds_indicator:
          type: string
          description: Details if Fast Funds is enabled for the card.
        fingerprint:
          type: string
          example: FPRxxxxxxxxxxxxxxxxx
          description: Unique ID that represents the tokenized card data.
        identity:
          $ref: '#/components/schemas/identity_id'
        instrument_type:
          type: string
          enum:
            - PAYMENT_CARD
            - TOKEN
          description: The type of `Payment Instrument`.
        issuer_country:
          type: string
          description: >
            The Alpha-3 Code of the country the card was issued in.


            In addition, the following values are possible:


            - `NON_USA` - The card was issued outside of the United States.

            - `UNKNOWN` - The processor did not return an issuer country for
            this particular BIN.
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GLP
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUF
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MTQ
            - MUS
            - MWI
            - MYS
            - MYT
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NON_USA
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - REU
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - UNKNOWN
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - YEM
            - ZAF
            - ZMB
            - ZWE
        last_four:
          type: string
          description: Last four digits of the card.
        name:
          type: string
          description: The name of the card owner.
          nullable: true
        network_token_enabled:
          $ref: '#/components/schemas/network_token_enabled_card'
        network_token_state:
          type: string
          description: >
            The state of the network token. The possible enum values are as
            follows:


            - `NOT_ENABLED`: The `network_token_state` is `NOT_ENABLED` when the
            value of `network_token_enabled` on the `Payment Instrument` is
            `false`.

            - `PENDING`: Immediately after Finix enables network tokens for a
            specific card, `network_token_state` is initially set to `PENDING`.

            - `ACTIVE`: After Finix receives the network token successfully from
            the card network, `network_token_state` updates to `ACTIVE`.

            - `FAILED`: In the event that there is an issue with the card
            network such as service becomes unavailable, `FAILED` is returned.

            - `SUSPENDED`: When the issuing bank does not allow the network
            token to be used in transactions, `SUSPENDED` is returned.

            - `CLOSED`: In the event that the issuing bank has closed the card
            permanently, `CLOSED` is returned.
          enum:
            - ACTIVE
            - CLOSED
            - FAILED
            - NOT_ENABLED
            - SUSPENDED
            - PENDING
        online_gambling_block_indicator:
          type: string
          description: >-
            Details if the card is enabled to receive push-payments for online
            gambling payouts.
        payload_type:
          type: string
          enum:
            - SOURCE
            - DESTINATION
        push_funds_block_indicator:
          type: string
          description: >-
            Details if the card is enabled to receive push-to-card
            disbursements.
        security_code_verification:
          type: string
          enum:
            - MATCHED
            - UNKNOWN
            - UNMATCHED
          description: Details the results of the Card Verification Code check.
        third-party:
          type: string
          description: This field is not applicable to payment cards.
          nullable: true
        third_party_token:
          type: string
          description: This field is not applicable to payment cards.
          nullable: true
        type:
          type: string
          enum:
            - PAYMENT_CARD
            - TOKEN
            - GOOGLE_PAY
            - APPLE_PAY
          description: Type of `Payment Instrument`.
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            application:
              type: object
              description: Link to the `Application` the request was made under.
              properties:
                href:
                  type: string
            authorizations:
              type: object
              description: Link to the `Authorizations` created under the resource.
              properties:
                href:
                  type: string
            identity:
              type: object
              description: Link to the `Identity` the request was made under.
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
            transfers:
              type: object
              description: Link to the `Transfers` created under the resource.
              properties:
                href:
                  type: string
            updates:
              type: object
              description: Link to the `Updates` created under the resource.
              properties:
                href:
                  type: string
            verifications:
              type: object
              description: >-
                Link to the `Verification` that was used to verify the
                `Merchant` that the request was made under.
              properties:
                href:
                  type: string
    institution_number:
      type: string
      nullable: true
      description: >
        Canadian bank identifier (EFT). Exactly 3 digits that identify the
        financial institution (e.g., 004 = TD, 002 = Scotiabank). Stored as a
        string to preserve leading zeros.
      example: '004'
      minLength: 3
      maxLength: 3
    transit_number:
      type: string
      nullable: true
      title: Transit Number
      description: >
        Canadian branch/branch-transit identifier (EFT). Exactly 5 digits that
        identify the branch where the account is held. Stored as a string to
        preserve leading zeros.
      example: '12345'
      minLength: 5
      maxLength: 5
    payment_instrument_bank:
      type: object
      title: Payment Instrument - Bank
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        created_via:
          $ref: '#/components/schemas/created_via'
        address:
          description: The address of the bank account owner.
          allOf:
            - $ref: '#/components/schemas/address'
        account_type:
          type: string
          enum:
            - CHECKING
            - SAVINGS
          description: The bank account type.
        application:
          $ref: '#/components/schemas/application_id'
        bank_account_validation_check:
          type: string
          enum:
            - INCONCLUSIVE
            - INVALID
            - NOT_ATTEMPTED
            - VALID
          default: NOT_ATTEMPTED
          description: >
            Possible values returned when
            `attempt_bank_account_validation_check` is `true` or the `Payment
            Instrument` is used for a `Transfer`:

              - `INCONCLUSIVE`: A verification check was conducted, but the bank account could not be found or verified with the issuing bank. Please contact the buyer to confirm the details collected or request an alternate method of payment.
              - `INVALID`: The Payment Instrument was involved in transactions that returned one or more of the following ACH errors:
                - Account Does Not Allow ACH Transactions
                - Account is Closed
                - Account Funds are Frozen
                - Deceased Account Holder
                - Invalid Account Number
                - Invalid Routing Number
                - No Account on File
              
                For further details about the different ACH failure codes, please refer to ACH Direct Debit documentation.

              - `NOT_ATTEMPTED`: A verification check was not performed, and the Payment Instrument has not been used to create a Transfer or Authorization.
              - `VALID`: The bank account was successfully verified. The Payment Instrument is eligible for use in creating ACH Direct Debits.
        bank_code:
          type: string
          description: The routing number of the bank account.
        country:
          $ref: '#/components/schemas/country'
        currency:
          $ref: '#/components/schemas/currency'
        disabled_code:
          type: string
          nullable: true
        disabled_message:
          type: string
          nullable: true
        enabled:
          type: boolean
          description: >-
            Indicates whether the `Payment Instrument` resource is enabled. The
            default value is `true`; set it to `false` to disable the `Payment
            Instrument`.
        identity:
          $ref: '#/components/schemas/identity_id'
        institution_number:
          $ref: '#/components/schemas/institution_number'
        instrument_type:
          type: string
          enum:
            - BANK_ACCOUNT
          description: The type of `Payment Instrument`.
        masked_account_number:
          type: string
          description: >-
            The last 4 digits of the account number used to create the `Payment
            Instrument`.
          nullable: true
        name:
          type: string
          description: The name of the bank account.
          nullable: true
        third-party:
          type: string
          description: This field is not applicable to bank accounts.
          nullable: true
        third_party_token:
          type: string
          description: This field is not applicanle to bank accounts.
          nullable: true
        transit_number:
          $ref: '#/components/schemas/transit_number'
        type:
          type: string
          enum:
            - BANK_ACCOUNT
          description: Type of `Payment Instrument`.
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            application:
              type: object
              description: Link to the `Application` the request was made under.
              properties:
                href:
                  type: string
            authorizations:
              type: object
              description: Link to the `Authorizations` created under the resource.
              properties:
                href:
                  type: string
            identity:
              type: object
              description: Link to the `Identity` the request was made under.
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
            transfers:
              type: object
              description: Link to the `Transfers` created under the resource.
              properties:
                href:
                  type: string
            verifications:
              type: object
              description: >-
                Link to the `Verification` that was used to verify the
                `Merchant` that the request was made under.
              properties:
                href:
                  type: string
    security_code:
      type: string
      description: >
        The 3-or 4-digit security code for the card (i.e., the CVV code). While
        providing a CVV is optional, it is recommended to include it wherever
        possible to prevent fraud.
      nullable: true
    createPaymentInstrumentCard:
      title: Payment Instrument - Card
      type: object
      properties:
        address:
          description: >
            The address of the card owner.


            **Note**: Including a postal or zip code when creating a `Payment
            Instrument` can lower the interchange on credit card transactions.
          allOf:
            - $ref: '#/components/schemas/address'
        expiration_month:
          type: integer
          description: The expiration month of the card (e.g. 12 for December).
        expiration_year:
          type: integer
          description: The 4-digit expiration year of the card.
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        name:
          type: string
          description: >-
            The name of the card owner. This value can get truncated to comply
            with processor requirements.
        number:
          type: string
          description: The card or bank account number (no dashes in between numbers).
        security_code:
          $ref: '#/components/schemas/security_code'
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: Type of `Payment Instrument`.
          enum:
            - PAYMENT_CARD
        third_party_token:
          type: string
          description: >-
            Stringified token provided by Apple or Google. Required if using
            Apple or Google Pay.
      required:
        - expiration_month
        - expiration_year
        - identity
        - name
        - number
        - type
    createPaymentInstrumentAccountUpdater:
      title: Payment Instrument - Card - Enable Account Updater
      type: object
      properties:
        account_updater_enabled:
          $ref: '#/components/schemas/account_updater_enabled_card'
        address:
          description: >
            The address of the card owner.


            **Note**: Including a postal or zip code when creating a `Payment
            Instrument` can lower the interchange on credit card transactions.
          allOf:
            - $ref: '#/components/schemas/address'
        expiration_month:
          type: integer
          description: The expiration month of the card (e.g. 12 for December).
        expiration_year:
          type: integer
          description: The 4-digit expiration year of the card.
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        name:
          type: string
          description: >-
            The name of the card owner. This value can get truncated to comply
            with processor requirements.
        number:
          type: string
          description: The card or bank account number (no dashes in between numbers).
        security_code:
          $ref: '#/components/schemas/security_code'
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: Type of `Payment Instrument`.
          enum:
            - PAYMENT_CARD
        third_party_token:
          type: string
          description: >-
            Stringified token provided by Apple or Google. Required if using
            Apple or Google Pay.
      required:
        - expiration_month
        - expiration_year
        - identity
        - name
        - number
        - type
    createPaymentInstrumentNetworkTokens:
      title: Payment Instrument - Card - Enable Network Tokens
      type: object
      properties:
        address:
          description: >
            The address of the card owner.


            **Note**: Including a postal or zip code when creating a `Payment
            Instrument` can lower the interchange on credit card transactions.
          allOf:
            - $ref: '#/components/schemas/address'
        expiration_month:
          type: integer
          description: The expiration month of the card (e.g. 12 for December).
        expiration_year:
          type: integer
          description: The 4-digit expiration year of the card.
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        name:
          type: string
          description: >-
            The name of the card owner. This value can get truncated to comply
            with processor requirements.
        network_token_enabled:
          $ref: '#/components/schemas/network_token_enabled_card'
        number:
          type: string
          description: The card or bank account number (no dashes in between numbers).
        security_code:
          $ref: '#/components/schemas/security_code'
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: Type of `Payment Instrument`.
          enum:
            - PAYMENT_CARD
        third_party_token:
          type: string
          description: >-
            Stringified token provided by Apple or Google. Required if using
            Apple or Google Pay.
      required:
        - expiration_month
        - expiration_year
        - identity
        - name
        - number
        - type
    createPaymentInstrumentBankAccount:
      title: Payment Instrument - Bank Account
      type: object
      properties:
        account_number:
          type: string
          description: The bank account number (no dashes in between numbers).
          minLength: 5
          maxLength: 17
        account_type:
          type: string
          enum:
            - PERSONAL_CHECKING
            - PERSONAL_SAVINGS
            - BUSINESS_CHECKING
            - BUSINESS_SAVINGS
          description: >-
            The type of bank account. Use the following respective enum when
            creating a `Payment Instrument`
            for:<ul><li><strong>PERSONAL_CHECKING: </strong>A personal checking
            account.</li><li><strong>PERSONAL_SAVINGS: </strong>A personal
            savings account.</li><li><strong>BUSINESS_CHECKING: </strong>A
            business checking account.</li><li><strong>BUSINESS_SAVINGS:
            </strong>A business savings account.</li></ul>
        attempt_bank_account_validation_check:
          type: boolean
          description: >
            Verify and validate the `Payment Instrument` to ensure it is
            suitable for [ACH Direct
            Debits](/guides/online-payments/bank-payments/ach-direct-debits).
            Set to `true` to confirm that the `Payment Instrument` can be used
            for ACH payments.
          default: false
        bank_code:
          type: string
          description: The routing number of the bank account.
          minLength: 9
          maxLength: 9
          example: '123456789'
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        name:
          type: string
          description: The name of the bank account owner.
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          enum:
            - BANK_ACCOUNT
          description: Type of `Payment Instrument`.
      required:
        - account_number
        - account_type
        - bank_code
        - identity
        - type
    createPaymentInstrumentPlaidBankAccount:
      title: Payment Instrument - Plaid Bank Account
      type: object
      properties:
        third_party:
          type: string
          description: A third-party service that allows for connecting to a bank account.
          enum:
            - PLAID
        third_party_token:
          type: string
          description: >
            A Plaid `processor_token` created with `processor: finix`. The token
            must have access to Plaid's `auth` and `identity` products, which
            can be configured when creating the Plaid `link_token`. For more
            information, see [Plaid's integration
            guide](https://plaid.com/docs/auth/partnerships/finix/) and [Finix's
            Plaid
            guide](/guides/online-payments/bank-payments/plaid-integration).
        type:
          type: string
          enum:
            - BANK_ACCOUNT
          description: Type of `Payment Instrument`.
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
      required:
        - third_party
        - third_party_token
        - identity
        - type
    createPaymentInstrumentCanadianBankAccount:
      title: Payment Instrument - Canadian Bank Account
      type: object
      properties:
        account_number:
          type: string
          description: >-
            The bank account number (no dashes in between numbers). Canadian
            bank account numbers cannot exceed 15 characters.
        account_type:
          type: string
          description: |
            The type of bank account.
          enum:
            - PERSONAL_CHECKING
            - PERSONAL_SAVINGS
            - BUSINESS_CHECKING
            - BUSINESS_SAVINGS
        country:
          type: string
          description: The 3-letter country code.
          enum:
            - CAN
        currency:
          type: string
          description: The ISO 4217 3-letter currency code.
          enum:
            - CAD
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        institution_number:
          $ref: '#/components/schemas/institution_number'
        name:
          type: string
          description: The name of the bank account owner.
        transit_number:
          $ref: '#/components/schemas/transit_number'
        type:
          type: string
          description: Type of `Payment Instrument`.
          enum:
            - BANK_ACCOUNT
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - account_number
        - account_type
        - country
        - currency
        - identity
        - institution_number
        - transit_number
        - type
    createPaymentInstrumentTokenCard:
      title: Payment Instrument - Token - Card
      type: object
      properties:
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        name:
          type: string
          description: >-
            The name of the bank account or card owner. This value can get
            truncated to comply with processor requirements.
        tags:
          $ref: '#/components/schemas/tags'
        token:
          type: string
          description: >-
            ID of the `Token` that was returned from the tokenization client or
            hosted fields
        type:
          type: string
          enum:
            - TOKEN
          description: Type of `Payment Instrument`.
      required:
        - identity
        - token
        - type
    createPaymentInstrumentTokenAccountUpdater:
      title: Payment Instrument - Token - Enable Account Updater
      type: object
      properties:
        account_updater_enabled:
          $ref: '#/components/schemas/account_updater_enabled_card'
        attempt_bank_account_validation_check:
          type: boolean
          description: >-
            Verify and validate the `Payment Instrument` to confirm it can be
            used for [ACH Direct
            Debits.](/guides/online-payments/bank-payments/ach-direct-debits)

            - Set to **True** to verify the `Payment Instrument` can be used for
            ACH payments. 

            - Only `Payment Instruments` created from bank accounts can be used
            for ACH payments.
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        name:
          type: string
          description: >-
            The name of the bank account or card owner. This value can get
            truncated to comply with processor requirements.
        tags:
          $ref: '#/components/schemas/tags'
        token:
          type: string
          description: >-
            ID of the `Token` that was returned from the tokenization client or
            hosted fields
        type:
          type: string
          enum:
            - TOKEN
          description: Type of `Payment Instrument`.
      required:
        - identity
        - token
        - type
    createPaymentInstrumentTokenBankAccount:
      title: Payment Instrument - Token - Bank Account
      type: object
      properties:
        attempt_bank_account_validation_check:
          type: boolean
          description: >-
            Verify and validate the `Payment Instrument` to confirm it can be
            used for [ACH Direct
            Debits.](/guides/online-payments/bank-payments/ach-direct-debits)

            - Set to **True** to verify the `Payment Instrument` can be used for
            ACH payments. 

            - Only `Payment Instruments` created from bank accounts can be used
            for ACH payments.
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        name:
          type: string
          description: >-
            The name of the bank account or card owner. This value can get
            truncated to comply with processor requirements.
        tags:
          $ref: '#/components/schemas/tags'
        token:
          type: string
          description: >-
            ID of the `Token` that was returned from the tokenization client or
            hosted fields.
        type:
          type: string
          enum:
            - TOKEN
          description: Type of `Payment Instrument`.
      required:
        - identity
        - token
        - type
    createPaymentInstrumentTokenNetworkTokens:
      title: Payment Instrument - Token - Enable Network Tokens
      type: object
      properties:
        attempt_bank_account_validation_check:
          type: boolean
          description: >-
            Verify and validate the `Payment Instrument` to confirm it can be
            used for [ACH Direct
            Debits.](/guides/online-payments/bank-payments/ach-direct-debits)

            - Set to **True** to verify the `Payment Instrument` can be used for
            ACH payments. 

            - Only `Payment Instruments` created from bank accounts can be used
            for ACH payments.
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        name:
          type: string
          description: >-
            The name of the bank account or card owner. This value can get
            truncated to comply with processor requirements.
        network_token_enabled:
          $ref: '#/components/schemas/network_token_enabled_card'
        tags:
          $ref: '#/components/schemas/tags'
        token:
          type: string
          description: >-
            ID of the `Token` that was returned from the tokenization client or
            hosted fields
        type:
          type: string
          enum:
            - TOKEN
          description: Type of `Payment Instrument`.
      required:
        - identity
        - token
        - type
    createPaymentInstrumentApplePay:
      title: Payment Instrument - Apple Pay
      type: object
      properties:
        identity:
          type: string
          description: The `Identity#id` of the buyer and owner of the card.
        merchant_identity:
          type: string
          description: >-
            The `id` of the identity used when registering the business with
            Apple Pay through our registration API.
        name:
          type: string
          description: >-
            The `id` of the `Identity` used when registering the seller with
            Apple Pay through our registration API.
        third_party_token:
          type: string
          description: >-
            Stringified token provided by Apple. Required to process Apple Pay
            transactions.
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: Type of `Payment Instrument`.
          enum:
            - APPLE_PAY
        address:
          $ref: '#/components/schemas/address'
      required:
        - identity
        - merchant_identity
        - third_party_token
        - type
    createPaymentInstrumentGooglePay:
      title: Payment Instrument - Google Pay
      type: object
      properties:
        identity:
          type: string
          description: >-
            The ID of the `Identity` used to create the `Payment Instrument`
            resource.
        merchant_identity:
          type: string
          description: >-
            The `id` of the identity used when registering the business with
            Google Pay through our registration API.
        name:
          type: string
          description: >-
            The name of the bank account or card owner. This value can get
            truncated to comply with processor requirements.
        tags:
          $ref: '#/components/schemas/tags'
        third_party_token:
          type: string
          description: >-
            Stringified token provided by Google. Required to process Google Pay
            transactions.
        type:
          type: string
          enum:
            - GOOGLE_PAY
          description: Type of `Payment Instrument`.
        address:
          $ref: '#/components/schemas/address'
      required:
        - identity
        - merchant_identity
        - third_party_token
    updatePaymentInstrumentBankAccountValidationCheck:
      title: Payment Instrument - Bank Account Validation Check
      type: object
      properties:
        attempt_bank_account_validation_check:
          type: boolean
          default: false
          description: >-
            Verify and validate the `Payment Instrument` to confirm it can be
            used for [ACH Direct
            Debits.](/guides/online-payments/bank-payments/ach-direct-debits)

            - Set to **True** to verify the `Payment Instrument` can be used for
            ACH payments. 

            - Only `Payment Instruments` created from bank accounts can be used
            for ACH payments.
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - attempt_bank_account_validation_check
    updatePaymentInstrumentDisable:
      title: Payment Instrument - Disable a Payment Instrument
      type: object
      properties:
        enabled:
          type: boolean
          description: >-
            Details if the `Payment Instrument` resource is enabled. Default
            value is **true**; set to **false** to disable the `Payment
            Instrument`.
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - enabled
    updatePaymentInstrumentAccountUpdater:
      title: Payment Instrument - Enable Account Updater
      type: object
      properties:
        account_updater_enabled:
          $ref: '#/components/schemas/account_updater_enabled_card'
    updatePaymentInstrumentNetworkTokens:
      title: Payment Instrument - Enable Network Tokens
      type: object
      properties:
        network_token_enabled:
          $ref: '#/components/schemas/network_token_enabled_card'
    updatePaymentInstrumentCardAddress:
      title: Payment Instrument - Update Card Address
      type: object
      properties:
        address:
          $ref: '#/components/schemas/address'
        merchant:
          default: false
          type: string
          description: >-
            The ID of the `Merchant` that the `Payment Instrument` will be
            created under.
        verify_payment_card:
          type: boolean
          description: >-
            - Set to **true** to verify card details with the card issuer.

            - Must be set to **true** to update the CVV or security code of a
            card.

            - When set to **true**, `merchant` must also be included with your
            request.
          default: false
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - address
        - merchant
        - verify_payment_card
    updatePaymentInstrumentName:
      title: Payment Instrument - Update Name
      type: object
      properties:
        name:
          type: string
          default: false
          description: >-
            The name of the card owner. This value can get truncated to comply
            with processor requirements.
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - name
    updatePaymentInstrumentTags:
      title: Payment Instrument - Update Tags
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - tags
    updatePaymentInstrumentAddressGoogleApplePay:
      title: Payment Instrument - Add Address for Google or Apply Pay
      type: object
      properties:
        address:
          $ref: '#/components/schemas/address'
      required:
        - address
    instrument_history_entry:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Instrument History Entry` resource.
        created_at:
          $ref: '#/components/schemas/created_at'
        type:
          type: string
          description: >
            A label indicating the type of update applied to the `Payment
            Instrument`. The following enums are possible:


            - `CONTACT_CARDHOLDER`: The cardholder has opted out of the service.
            Please get in touch with the cardholder to acquire up-to-date card
            information.

            - `FRAUD_REPORTED`: Fraud was reported by the `Merchant`.

            - `NUMBER_AND_EXPIRATION_UPDATED`: Both the card number and expiry
            date changed.

            - `NUMBER_UPDATED`: The card number has changed.

            - `NOT_FOUND`: The issuing bank does not participate in account
            updater. This enumerator will only be returned once.
          enum:
            - CONTACT_CARDHOLDER
            - FRAUD_REPORTED
            - NOT_FOUND
            - NUMBER_AND_EXPIRATION_UPDATED
            - NUMBER_UPDATED
        application_id:
          description: >
            The ID of the `Application` under which the `Payment Instrument` was
            created, resulting in this `Instrument History Entry`.
          type: string
        payment_instrument_id:
          type: string
          description: >-
            The `Payment Instrument` that triggered the creation of this
            `Instrument History Entry`.
        payment_instrument_type:
          type: string
          description: >-
            The type of `Payment Instrument` that triggered this `Instrument
            History Entry`.
          enum:
            - PAYMENT_CARD
        old_instrument_details:
          type: object
          description: >-
            Object containing the `Payment Instrument` details prior to the card
            update.
          properties:
            bin:
              type: string
              description: The Bank Identification Number for the `Payment Instrument`.
            brand:
              type: string
              enum:
                - UNKNOWN
                - DINERS_CLUB_INTERNATIONAL
                - DANKORT
                - MIR
                - TROY
                - UATP
                - CHINA_T_UNION
                - CHINA_UNION_PAY
                - AMERICAN_EXPRESS
                - VERVE
                - RUPAY
                - DISCOVER
                - JCB
                - MASTERCARD
                - INTERPAYMENT
                - INSTAPAYMENT
                - MAESTRO
                - VISA
                - LANKAPAY
                - DINERS_CLUB
                - INTERAC
              description: The `brand` of the card saved in the `Payment Instrument`.
            expiration_month:
              type: integer
              description: The expiration month of the card (e.g., `12` for December).
            expiration_year:
              type: integer
              description: The 4-digit expiration year of the card.
            last_four:
              type: string
              description: The last four digits of the card.
            fingerprint:
              type: string
              example: FPRxxxxxxxxxxxxxxxxx
              description: Unique ID that represents the tokenized card data.
        new_instrument_details:
          type: object
          description: >-
            Object containing the `Payment Instrument` details after the card
            update.
          properties:
            bin:
              type: string
              description: The Bank Identification Number for the `Payment Instrument`.
            brand:
              type: string
              enum:
                - UNKNOWN
                - DINERS_CLUB_INTERNATIONAL
                - DANKORT
                - MIR
                - TROY
                - UATP
                - CHINA_T_UNION
                - CHINA_UNION_PAY
                - AMERICAN_EXPRESS
                - VERVE
                - RUPAY
                - DISCOVER
                - JCB
                - MASTERCARD
                - INTERPAYMENT
                - INSTAPAYMENT
                - MAESTRO
                - VISA
                - LANKAPAY
                - DINERS_CLUB
                - INTERAC
              description: The `brand` of the card saved in the `Payment Instrument`.
            expiration_month:
              type: integer
              description: The expiration month of the card (e.g., `12` for December).
            expiration_year:
              type: integer
              description: The 4-digit expiration year of the card.
            last_four:
              type: string
              description: The last four digits of the card.
            fingerprint:
              type: string
              example: FPRxxxxxxxxxxxxxxxxx
              description: Unique ID that represents the tokenized card data.
        _links:
          type: object
          description: >-
            An object containing link(s) relevant to the request. You can store
            these links for follow-up requests.
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The path to the `Instrument History Entry` resource.
    updatePaymentInstrumentVerificationCVV:
      type: object
      title: CVV Verification
      properties:
        merchant:
          type: string
          description: |-
            - The ID of the `Merchant`.
            - Must be included when `verify_payment_card` is set to **true**.
        processor:
          type: string
          enum:
            - DUMMY_V1
            - FINIX_V1
            - MASTERCARD_V1
            - VISA_V1
          default: DUMMY_V1
          description: >-
            The acquiring processor. Use `DUMMY_V1` or `null` to use your
            sandbox. For more details on which processor to use, reach out to
            your Finix point of contact or email [Finix
            Support](/guides/getting-started/support-at-finix/).
        security_code:
          $ref: '#/components/schemas/security_code'
        verify_payment_card:
          type: boolean
          description: >-
            - Set to **true** to verify card details with the card issuer.

            - Must be set to **true** to update the CVV or security code of a
            card.

            - When set to **true**, `merchant` must also be included with your
            request.
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - merchant
        - security_code
        - verify_payment_card
    updatePaymentInstrumentVerificationAddress:
      type: object
      title: Address Verification
      properties:
        address:
          $ref: '#/components/schemas/address'
        merchant:
          type: string
          description: The ID of the `Merchant`.
        processor:
          type: string
          enum:
            - DUMMY_V1
            - FINIX_V1
            - MASTERCARD_V1
            - VISA_V1
          default: DUMMY_V1
          description: >-
            The acquiring processor. Use `DUMMY_V1` or `null` to use your
            sandbox. For more details on which processor to use, reach out to
            your Finix point of contact or email [Finix
            Support](/guides/getting-started/support-at-finix/).
        verify_payment_card:
          type: boolean
          description: >-
            - Set to **true** to verify card details with the card issuer.

            - Must be set to **true** to update the CVV or security code of a
            card.

            - When set to **true**, `merchant` must also be included with your
            request.
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - address
        - merchant
        - verify_payment_card
    createPaymentInstrumentVerificationPushToCard:
      type: object
      title: Push-to-Card Eligibility
      properties:
        processor:
          type: string
          enum:
            - DUMMY_V1
            - FINIX_V1
            - MASTERCARD_V1
            - VISA_V1
          default: DUMMY_V1
          description: >-
            The acquiring processor. Use `DUMMY_V1` to use your sandbox. For
            more details on which processor to use, reach out to your Finix
            point of contact or email [Finix
            Support](/guides/getting-started/support-at-finix/).
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - processor
    payment-instrument-verification:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          type: string
          $ref: '#/components/schemas/application_id'
        identity:
          type: string
          description: This field is not applicable to payment instrument verification.
          nullable: true
          default: null
        merchant:
          type: string
          description: This field is not applicable to payment instrument verification.
          nullable: true
          default: null
        merchant_identity:
          type: string
          description: This field is not applicable to payment instrument verification.
          nullable: true
          default: null
        messages:
          type: array
          description: A codified list of reasons the verification request failed.
          items:
            type: string
          default: []
        outcome_summary:
          type: string
          description: >-
            A message providing additional context about why the verification
            request failed.
          nullable: true
          default: null
        outcomes:
          type: array
          description: A codified list of reasons the verification request failed.
          items:
            type: object
          nullable: true
          default: null
        payment_instrument:
          type: string
          description: The `Payment Instrument` sent for verification.
          default: null
        payment_instrument_verification_details:
          type: object
          description: The payment instruction verification results.
          properties:
            push_to_card_domestic:
              type: string
              description: >-
                Indicates whether the `Payment Instrument` supports push-to-card
                and pull-from-card, domestically. For more details, see [Push to
                Card](/guides/payouts/card-payouts).
              enum:
                - FAST_FUNDS
                - NON_FAST_FUNDS
                - NOT_SUPPORTED
                - UNKNOWN
              nullable: true
              default: null
            push_to_card_cross_border:
              type: string
              description: >-
                Indicates whether the `Payment Instrument` supports push-to-card
                and pull-from-card, cross-border. For more details, see [Push to
                Card](/guides/payouts/card-payouts).
              enum:
                - FAST_FUNDS
                - NON_FAST_FUNDS
                - NOT_SUPPORTED
                - UNKNOWN
              nullable: true
              default: null
            card_type:
              type: string
              description: >-
                A code that indicates whether the card is credit, debit, or
                prepaid.
              enum:
                - CREDIT
                - DEBIT
                - HSA_FSA
                - RELOADABLE_PREPAID
                - UNRELOADABLE_PREPAID
                - UNKNOWN
              nullable: true
              default: null
            billing_currency:
              type: string
              description: >-
                The currency in which the payment instrument's holder is billed
                or charged.
              nullable: true
              default: null
            issuer_country:
              type: string
              description: >
                The country where the entity (bank or financial institution)
                that issued the payment instrument (e.g., credit card, debit
                card) is located.


                - `NON_USA` - The card was issued outside of the United States.

                - `USA` - The card was issued in the United States.

                - `UNKNOWN` - The processor did not return an issuer country for
                this particular BIN.
              enum:
                - NON_USA
                - USA
                - UNKNOWN
              nullable: true
              default: null
        processor:
          type: string
          description: Name of the verification processor.
          enum:
            - LITLE_V1
            - VANTIV_V1
            - FINIX_V1
            - DUMMY_V1
        raw:
          $ref: '#/components/schemas/raw'
        state:
          type: string
          description: The state of the payment instrument verification request.
          enum:
            - PENDING
            - FAILED
            - SUCCEEDED
        tags:
          $ref: '#/components/schemas/tags'
        trace_id:
          type: string
          description: An ID used for tracking the verification request.
        type:
          type: string
          description: Details the type of resource getting verified.
          enum:
            - PAYMENT_INSTRUMENT
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: Link to the `Verification`.
              properties:
                href:
                  type: string
            application:
              type: object
              description: Link to the `Application` associated with this resource.
              properties:
                href:
                  type: string
            payment_instrument:
              type: object
              description: Link to the `Payment Instrument` sent for verification.
              properties:
                href:
                  type: string
                  minLength: 1
    subtotal_amount:
      type: integer
      format: int32
      description: >
        The subtotal amount, in cents. This value reflects the total of all 

        line items before applying any discounts, taxes, shipping fees, or
        other 

        additional charges.
    operation_key:
      description: Details the operation that's performed in the transaction.
      type: string
      enum:
        - PUSH_TO_CARD
        - PULL_FROM_CARD
        - CARD_PRESENT_SALE
        - CARD_PRESENT_UNREFERENCED_REFUND
        - SALE
        - UNREFERENCED_REFUND
        - MERCHANT_CREDIT_ADJUSTMENT
        - MERCHANT_DEBIT_ADJUSTMENT
      nullable: true
    fee_transfer:
      type: integer
      format: int64
      description: >-
        The minimum amount of the `Transfer` you'd like to collect as your fee
        in cents. Defaults to zero (must be less than or equal to the `amount`).

        - If the fees applied by the 'Fee Profile' are ***higher*** than the
        value passed in 'fee', 'fee' will not be applied and have no effect.

        - If the fees applied by the 'Fee Profile' are ***lower*** than the
        value passed in 'fee', an additional fee is be applied, in addition to
        the fees generated by the `Fee Profile`.
            - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`.
    transfer:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        additional_buyer_charges:
          description: >
            Details about any [Buyer
            Charges](../../../../guides/online-payments/payment-features/buyer-charges)
            included in the `Transfer`. The buyer charges are mutually
            exclusive.
          allOf:
            - $ref: '#/components/schemas/additional_buyer_charges'
        additional_healthcare_data:
          $ref: '#/components/schemas/additional_healthcare_data'
        additional_purchase_data:
          $ref: '#/components/schemas/additional_purchase_data'
        address_verification:
          type: string
          description: Details the results of the address verification checks.
          nullable: true
          enum:
            - POSTAL_CODE_AND_STREET_MATCH
            - STREET_MATCH
            - POSTAL_CODE_MATCH
            - NO_ADDRESS
            - NO_MATCH
            - NOT_SUPPORTED
            - UNKNOWN
        amount:
          type: number
          format: double
          description: >
            The total amount that will be debited. The value may be returned as
            either:


            - an **integer** (`int32`) in cents for all transfer types except
            `FEE` (e.g., `100` = $1.00).  

            - a **number** (`double`) if `Transfer#type` is `FEE` for a
            fractional amount (e.g., `2.393`).
          example: 2.393
        amount_requested:
          type: number
          format: double
          description: >
            Details the `amount` that was requested to get debited from the
            `source` when the transaction was created.  The value may be
            returned as either:


            - an **integer** (`int32`) in cents for all transfer types except
            `FEE` (e.g., `100` = $1.00)

            - a **number** (`double`) if `Transfer#type` is `FEE` for a
            fractional amount (e.g., `2.393`)
          example: 2.393
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the resource.
        bank_return_details:
          type: object
          description: >-
            Details about a transfer that was returned and was unable to be
            processed. Only present when `state` is `RETURNED`
          nullable: true
          properties:
            reason_code:
              type: string
              description: Return response code from the bank.
            reason_message:
              type: string
              description: Detailed message explaining reason for the return.
            reason_title:
              type: string
              description: Short message categorizing reason for the return.
        card_present_details:
          type: object
          description: Details needed to process card present transactions.
          nullable: true
          properties:
            approval_code:
              type: string
              description: Unique ID used to identify the approval of the `Transfer`.
              nullable: true
            brand:
              type: string
              description: The brand of the card saved in the `Payment Instrument`.
              nullable: true
            emv_data:
              type: object
              description: Encrypted card data used to process the transaction.
              nullable: true
              properties:
                application_identifier:
                  type: string
                  description: >-
                    ID of the application used in the transaction. Tag 9F06 from
                    the EMVCo standard.
                application_label:
                  type: string
                  description: EMV application label. Tag 50 from the EMVCo standard.
                application_preferred_name:
                  type: string
                  description: >-
                    EMV application label with formatting (if provided). Tag
                    9F12 from the EMVCo standard.
                  nullable: true
                application_transaction_counter:
                  type: string
                  description: >-
                    Transaction number for the EMV application. Tag 9F36 from
                    the EMVCo standard.
                cryptogram:
                  type: string
                  description: >-
                    Cryptogram returned by the card. Tag 9F26 of the EMVCo
                    standard.
                issuer_code_table_index:
                  type: string
                  description: >-
                    The alphabet code table (according to ISO 8859) used by the
                    EMV application (if provided). Tag 9F11.
                  nullable: true
                pin_verified:
                  type: boolean
                  description: Whether the cardholder's PIN number was verified.
                tags:
                  $ref: '#/components/schemas/tags'
            entry_mode:
              type: string
              description: >
                Details of the card payment method used to process the
                transaction.


                The possible enums are:


                - UNKNOWN - The method by which the payment card was used is
                unknown.

                - SWIPED - The card was swiped through a POS terminal. 

                - MANUAL_KEY_ENTRY - The cardholder's information was entered
                manually into a POS terminal.

                - CONTACTLESS - The payment was made by tapping a card on a POS
                terminal.

                - CHIP_ENTRY - The payment card was inserted into a card reader.
              enum:
                - UNKNOWN
                - SWIPED
                - MANUAL_KEY_ENTRY
                - CONTACTLESS
                - CHIP_ENTRY
              nullable: true
            masked_account_number:
              type: string
              description: Last four digits of the bank account number.
              nullable: true
            name:
              type: string
              description: The name of the bank account or card owner.
              nullable: true
            payment_type:
              type: string
              description: >-
                The type of `Payment Instrument` used in the transaction (or the
                original payment).
        currency:
          $ref: '#/components/schemas/currency'
        destination:
          type: string
          description: ID of the `Payment Instrument` where funds will be sent.
          nullable: true
        device:
          type: string
          description: The ID of the `Device` resource the `Transfer` was created under.
        externally_funded:
          type: string
          description: >-
            Details if the `Transfer` will be settled externally by card
            processors.
        failure_code:
          $ref: '#/components/schemas/failure_code'
        failure_message:
          $ref: '#/components/schemas/failure_message'
        fee:
          $ref: '#/components/schemas/fee_transfer'
        fee_profile:
          type: string
          description: >-
            The ID of the `Fee Profile` that will be used for calculating fees
            for this transfer.
        fraud_session_id:
          $ref: '#/components/schemas/fraud_session_id'
        fee_type:
          type: string
          enum:
            - ACH_BASIS_POINTS
            - ACH_CREDIT_RETURN_FIXED_FEE
            - ACH_DEBIT_RETURN_FIXED_FEE
            - ACH_FIXED
            - ACH_MAX_FIXED
            - ACH_NOTICE_OF_CHANGE_CREDIT_FIXED
            - ACH_NOTICE_OF_CHANGE_DEBIT_FIXED
            - AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS
            - AMERICAN_EXPRESS_BASIS_POINTS
            - AMERICAN_EXPRESS_FIXED
            - AMERICAN_EXPRESS_INTERCHANGE
            - ANCILLARY_FIXED_FEE_PRIMARY
            - ANCILLARY_FIXED_FEE_SECONDARY
            - APPLICATION_FEE
            - CARD_BASIS_POINTS
            - CARD_FIXED
            - CARD_INTERCHANGE
            - CUSTOM
            - DINERS_CLUB_BASIS_POINTS
            - DINERS_CLUB_FIXED
            - DINERS_CLUB_INTERCHANGE
            - DISCOVER_ASSESSMENT_BASIS_POINTS
            - DISCOVER_BASIS_POINTS
            - DISCOVER_DATA_USAGE_FIXED
            - DISCOVER_FIXED
            - DISCOVER_INTERCHANGE
            - DISCOVER_NETWORK_AUTHORIZATION_FIXED
            - DISPUTE_FIXED_FEE
            - DISPUTE_INQUIRY_FIXED_FEE
            - EFT_MAX_FIXED
            - JCB_BASIS_POINTS
            - JCB_FIXED
            - JCB_INTERCHANGE
            - MASTERCARD_ACQUIRER_FEE_BASIS_POINTS
            - MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS
            - MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS
            - MASTERCARD_BASIS_POINTS
            - MASTERCARD_FIXED
            - MASTERCARD_INTERCHANGE
            - QUALIFIED_TIER_BASIS_POINTS_FEE
            - QUALIFIED_TIER_FIXED_FEE
            - SETTLEMENT_FUNDING_TRANSFER_ACH_BASIS_POINTS
            - SETTLEMENT_FUNDING_TRANSFER_ACH_CREDIT_RETURN_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_ACH_DEBIT_RETURN_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_ACH_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_ACH_MAX_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_EFT_BASIS_POINTS
            - SETTLEMENT_FUNDING_TRANSFER_EFT_CREDIT_RETURN_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_EFT_DEBIT_RETURN_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_EFT_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_EFT_MAX_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_BASIS_POINTS
            - SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_MAX_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_NOC_CREDIT_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_NOC_DEBIT_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_BASIS_POINTS
            - SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_FIXED
            - SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_MAX_FIXED
            - SETTLEMENT_V2_TRANSFER
            - SUBSCRIPTION_ACH_BASIS_POINTS
            - SUBSCRIPTION_ACH_FIXED
            - SUBSCRIPTION_ACH_MAX_FIXED
            - SUBSCRIPTION_CARD_BASIS_POINTS
            - SUBSCRIPTION_CARD_FIXED
            - SUBSCRIPTION_EFT_BASIS_POINTS
            - SUBSCRIPTION_EFT_FIXED
            - SUBSCRIPTION_EFT_MAX_FIXED
            - SUPPLEMENTAL_FEE_FIXED
            - VISA_ACQUIRER_PROCESSING_FIXED
            - VISA_ASSESSMENT_BASIS_POINTS
            - VISA_BASE_II_CREDIT_VOUCHER_FIXED
            - VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED
            - VISA_BASIS_POINTS
            - VISA_CREDIT_VOUCHER_FIXED
            - VISA_FIXED
            - VISA_INTERCHANGE
            - VISA_KILOBYTE_ACCESS_FIXED
          description: Details the type of fee if the `Transfer` includes a `fee`.
        idempotency_id:
          $ref: '#/components/schemas/idempotency_id'
        ip_address_details:
          $ref: '#/components/schemas/ip_address_details'
        merchant:
          type: string
          description: The ID of the `Merchant` resource the `Transfer` was created under.
          example: MUxxxxxxxxxxxxxxxxxxxxxxx
        merchant_identity:
          type: string
          example: IDxxxxxxxxxxxxxxxxxxxxxxxx
          description: >-
            The ID of `Identity` resource used by the `Merchant` the `Transfer`
            was created under.
        network_details:
          type: object
          description: >-
            Contains network-specific fields used by issuers to identify
            transactions.
          properties:
            brand:
              type: string
              description: Card brand associated with the saved payment instrument.
              example: VISA
            authorization_code:
              type: string
              description: >-
                Code returned by the issuing bank when a transaction is
                authorized.
              example: 840735
            acquirer_reference_number:
              type: string
              description: >-
                Unique identifier banks use to trace chargebacks or refunds.
                Available only for Mastercard transactions; otherwise returns
                `null`.
              nullable: true
              example: 521600805857
        operation_key:
          type: string
          enum:
            - PUSH_TO_CARD
            - PULL_FROM_CARD
            - CARD_PRESENT_DEBIT
            - CARD_NOT_PRESENT_SALE
            - CARD_PRESENT_SALE
            - CARD_PRESENT_UNREFERENCED_REFUND
            - SALE
            - UNREFERENCED_REFUND
            - MERCHANT_CREDIT_ADJUSTMENT
            - MERCHANT_DEBIT_ADJUSTMENT
            - CARD_PRESENT_AUTHORIZATION
            - STANDARD_MERCHANT_FUNDING_PUSH_TO_ACH
            - STANDARD_MERCHANT_FUNDING_PUSH_TO_SAME_DAY_ACH
            - STANDARD_MERCHANT_FUNDING_PUSH_TO_CARD
            - INSTANT_MERCHANT_FUNDING_PUSH_TO_ACH
            - INSTANT_MERCHANT_FUNDING_PUSH_TO_FED_NOW
            - INSTANT_MERCHANT_FUNDING_PUSH_TO_SAME_DAY_ACH
            - INSTANT_MERCHANT_FUNDING_PUSH_TO_CARD
            - STANDARD_MERCHANT_FUNDING_PULL_FROM_ACH
            - STANDARD_MERCHANT_FUNDING_PULL_FROM_SAME_DAY_ACH
            - STANDARD_MERCHANT_FUNDING_PULL_FROM_CARD
            - INSTANT_MERCHANT_FUNDING_PULL_FROM_ACH
            - INSTANT_MERCHANT_FUNDING_PULL_FROM_FED_NOW
            - INSTANT_MERCHANT_FUNDING_PULL_FROM_SAME_DAY_ACH
            - STANDARD_APPLICATION_FUNDING_PUSH_TO_ACH
            - STANDARD_APPLICATION_FUNDING_PUSH_TO_SAME_DAY_ACH
            - STANDARD_APPLICATION_FUNDING_PUSH_TO_CARD
            - INSTANT_APPLICATION_FUNDING_PUSH_TO_ACH
            - INSTANT_APPLICATION_FUNDING_PUSH_TO_FED_NOW
            - INSTANT_APPLICATION_FUNDING_PUSH_TO_SAME_DAY_ACH
            - INSTANT_APPLICATION_FUNDING_PUSH_TO_CARD
            - STANDARD_APPLICATION_FUNDING_PULL_FROM_ACH
            - STANDARD_APPLICATION_FUNDING_PULL_FROM_SAME_DAY_ACH
            - STANDARD_APPLICATION_FUNDING_PULL_FROM_CARD
            - INSTANT_APPLICATION_FUNDING_PULL_FROM_CARD
            - INSTANT_APPLICATION_FUNDING_PULL_FROM_ACH
            - INSTANT_APPLICATION_FUNDING_PULL_FROM_FED_NOW
            - INSTANT_APPLICATION_FUNDING_PULL_FROM_SAME_DAY_ACH
          description: Details the operation that's performed in the transaction.
          nullable: true
        parent_transfer:
          type: string
          description: >-
            - ID of the original parent `Transfer` where the transaction
            occurred.

            - Only is present when `type` is `REVERSAL` or `FEE`.
          nullable: true
        parent_transfer_trace_id:
          type: string
          description: >-
            - The `trace_id` of the original parent `Transfer` where the
            transaction occurred.

            - Only visible when `type` is `REVERSAL` or `FEE`.
          nullable: true
        messages:
          type: array
          description: Message field that provides additional details.
          default: []
          items:
            type: string
        raw:
          description: Raw response from the processor.
          anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
        ready_to_settle_at:
          type: string
          format: date-time
          description: The timestamp indicating when the `Transfer` is ready to be settled.
          nullable: true
        receipt_last_printed_at:
          type: string
          format: date-time
          description: Timestamp when the receipt was last printed.
          nullable: true
        security_code_verification:
          type: string
          description: Details the results of the Card Verification Code check.
          enum:
            - MATCHED
            - UNKNOWN
            - UNMATCHED
        source:
          type: string
          description: >-
            The ID of the `Payment Instrument` that will be debited and
            performing the `Transfer`.
          nullable: true
        split_transfers:
          type: array
          description: >
            - Array containing the resource IDs of the `Split Transfers`
            generated from the `Transfer`. 

            - Only used for Split Transactions. For more information, see [Split
            Transactions](../../../../guides/online-payments/payment-features/split-transactions).
          default: []
          items:
            type: string
        state:
          type: string
          enum:
            - CANCELED
            - PENDING
            - FAILED
            - SUCCEEDED
            - UNKNOWN
            - RETURNED
          description: The status of the `Transfer`.
        statement_descriptor:
          $ref: '#/components/schemas/statement_descriptor'
        subtype:
          type: string
          description: Additional information describing the `payment_type`.
          enum:
            - API
            - APPLICATION_FEE
            - DISPUTE
            - MERCHANT_CREDIT
            - MERCHANT_CREDIT_ADJUSTMENT
            - MERCHANT_DEBIT
            - MERCHANT_DEBIT_ADJUSTMENT
            - PLATFORM_CREDIT
            - PLATFORM_CREDIT_ADJUSTMENT
            - PLATFORM_DEBIT
            - PLATFORM_DEBIT_ADJUSTMENT
            - PLATFORM_FEE
            - SETTLEMENT_MERCHANT
            - SETTLEMENT_NOOP
            - SETTLEMENT_PARTNER
            - SETTLEMENT_PLATFORM
            - SPLIT_PAYOUT
            - SPLIT_PAYOUT_ADJUSTMENT
            - SYSTEM
        supplemental_fee:
          type: string
          description: >-
            Amount in cents for which an additional fee will be created in
            addition to any fees created from the assigned fee profile.
          nullable: true
        tip_amount:
          type: integer
          description: The tip amount included in the total amount.
          nullable: true
        trace_id:
          type: string
          description: >-
            Trace ID of the `Transfer`. The processor sends back the `trace_id`
            so you can track the `Transfer` end-to-end.
          nullable: true
        type:
          type: string
          description: Type of `Transfer`.
          enum:
            - DEBIT
            - CREDIT
            - REVERSAL
            - FEE
            - ADJUSTMENT
            - DISPUTE
            - RESERVE
            - SETTLEMENT
            - UNKNOWN
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            application:
              $ref: '#/components/schemas/application_link'
            destination:
              type: object
              description: Link to the `Payment Instrument` where funds are getting sent.
              properties:
                href:
                  type: string
            device:
              type: object
              description: Link to the `Device` the request was made under.
              properties:
                href:
                  type: string
            disputes:
              type: object
              description: Link to the `Dispute` the request was made under.
              properties:
                href:
                  type: string
            fee_profile:
              type: object
              description: Link to the `fee_profile` the request was made under.
              properties:
                href:
                  type: string
            fees:
              type: object
              description: Link to the `fees` the request is associated with.
              properties:
                href:
                  type: string
            merchant_identity:
              type: object
              description: >-
                Link to the `Identity` the `Merchant` was created under and the
                `Transfer` was submitted with.
              properties:
                href:
                  type: string
            payment_instruments:
              type: object
              description: Link to the `Payment Instrument` associated with the Transfer.
              properties:
                href:
                  type: string
            disputed_transfer:
              type: object
              description: Link to the `Transfer` the `Dispute` is about.
              properties:
                href:
                  type: string
            parent:
              type: object
              description: Link to the original resource that was used in the request.
              properties:
                href:
                  type: string
            reversals:
              type: object
              description: Link to the `reversals` associated with the `Transfer`.
              properties:
                href:
                  type: string
            self:
              $ref: '#/components/schemas/self'
            source:
              type: object
              description: >-
                Link to the `Payment Instrument` the `Transfer` was created
                under.
              properties:
                href:
                  type: string
    createTransferRequiredFields:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        merchant:
          type: string
          description: The ID of the `Merchant` under which to create the `Transfer`.
        source:
          $ref: '#/components/schemas/source'
      required:
        - amount
        - currency
        - merchant
        - source
    createTransferOptionalFields:
      type: object
      properties:
        idempotency_id:
          $ref: '#/components/schemas/idempotency_id'
        tags:
          $ref: '#/components/schemas/tags'
    createTransferMinimalFields:
      title: Transfer - Minimal Fields
      allOf:
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferAllFields:
      title: Transfer - All Fields
      properties:
        3d_secure_authentication:
          description: The 3D secure information required to create a 3D secure `Transfer.`
          allOf:
            - $ref: '#/components/schemas/3d_secure_authentication'
        additional_buyer_charges:
          description: >
            Details about any [Buyer
            Charges](../../../../guides/online-payments/payment-features/buyer-charges)
            included in the `Transfer`. The buyer charges are mutually
            exclusive.
          allOf:
            - $ref: '#/components/schemas/additional_buyer_charges'
        additional_healthcare_data:
          $ref: '#/components/schemas/additional_healthcare_data'
        additional_purchase_data:
          $ref: '#/components/schemas/additional_purchase_data'
        adjustment_request:
          type: boolean
          description: Details if the `Transfer` was created to adjust funds.
          nullable: true
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        destination:
          type: string
          description: ID of the `Payment Instrument` where funds will be sent.
          nullable: true
        device:
          type: string
          description: >-
            The unique identifier of the activated device. This applies only to
            in-person payments.
          nullable: true
        fee:
          $ref: '#/components/schemas/fee_transfer'
        fee_profile:
          type: string
          description: >-
            Optional field to specify which fee_profile to use for this
            `Transfer`. If not provided, the currently assigned `Fee Profile`
            will be used.
          nullable: true
        fraud_session_id:
          $ref: '#/components/schemas/fraud_session_id'
        idempotency_id:
          $ref: '#/components/schemas/idempotency_id'
        ip_address_v4:
          $ref: '#/components/schemas/ip_address_v4'
        merchant:
          type: string
          description: The ID of the `Merchant` under which to create the `Transfer`.
          nullable: true
        operation_key:
          type: string
          enum:
            - PUSH_TO_CARD
            - PULL_FROM_CARD
            - CARD_PRESENT_DEBIT
            - CARD_PRESENT_UNREFERENCED_REFUND
            - SALE
            - UNREFERENCED_REFUND
            - MERCHANT_CREDIT_ADJUSTMENT
            - MERCHANT_DEBIT_ADJUSTMENT
          description: Details the operation that is be performed in the transaction.
          nullable: true
        processor:
          type: string
          description: Name of the transaction processor.
        receipt_options:
          type: object
          description: >-
            If provided the information will be used to generate a receipt if
            transaction is successful.
          nullable: true
          properties:
            requested_delivery_methods:
              $ref: '#/components/schemas/requested_delivery_methods'
            amount_breakdown:
              $ref: '#/components/schemas/amount_breakdown'
            items:
              $ref: '#/components/schemas/items'
            additional_details:
              $ref: '#/components/schemas/additional_details_receipt'
        source:
          type: string
          description: ID of the `Payment Instrument` where funds get debited.
        security_code:
          $ref: '#/components/schemas/security_code'
        statement_descriptor:
          $ref: '#/components/schemas/statement_descriptor'
        supplemental_fee:
          type: integer
          format: int64
          description: >-
            Amount in cents for which an additional fee will be created in
            addition to any fees created from the assigned fee profile.
          nullable: true
        split_transfers:
          description: >-
            - An array used to detail how funds from the `Transfer` will split
            and the amount `Merchants` receive.

            - The combined `amounts` under `split_transfers` must be equal to
            the `amount` submitted in the parent `Transfer.`

            - For more information, see [Split
            Transactions](../../../../guides/online-payments/payment-features/split-transactions).
          allOf:
            - $ref: '#/components/schemas/split_transfers'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - amount
        - currency
        - merchant
        - source
    createTransferCanadaEFT:
      title: Transfer - Canada - EFT
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        idempotency_id:
          $ref: '#/components/schemas/idempotency_id'
        merchant:
          type: string
          description: The ID of the `Merchant` under which to create the `Transfer`.
        source:
          $ref: '#/components/schemas/source'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - amount
        - currency
        - merchant
        - source
    createTransfer3DSecure:
      title: Transfer - 3D Secure
      allOf:
        - type: object
          properties:
            3d_secure_authentication:
              description: >-
                The 3D secure information required to create a 3D secure
                `Transfer.`
              allOf:
                - $ref: '#/components/schemas/3d_secure_authentication'
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferBankPayout:
      title: Transfer - Bank Payout
      allOf:
        - type: object
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
            operation_key:
              type: string
              enum:
                - PUSH_TO_ACH
              description: >-
                A key indicating the type of operation. Refer to
                [](../../../../../guides/payouts/bank-payouts) for an
                explanation of "Next Day" versus "Same Day" ACH.
              nullable: true
            processor:
              type: string
              description: >-
                The payment processing entity responsible for handling
                transactions, fund movements, etc., between different financial
                accounts.
              enum:
                - DUMMY_V1
                - FINIX_V1
            destination:
              type: string
              description: >-
                Identifier of the `Payment Instrument` that will receive the
                payout.
          required:
            - amount
            - currency
            - operation_key
            - processor
            - destination
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferBankPayoutSameDay:
      title: Transfer - Bank Payout - Same Day
      allOf:
        - type: object
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
            operation_key:
              type: string
              enum:
                - PUSH_TO_SAME_DAY_ACH
              description: >-
                A key indicating the type of operation. Refer to
                [](../../../../../guides/payouts/bank-payouts) for an
                explanation of "Next Day" versus "Same Day" ACH.
              nullable: true
            processor:
              type: string
              description: >-
                The payment processing entity responsible for handling
                transactions, fund movements, etc., between different financial
                accounts.
              enum:
                - DUMMY_V1
                - FINIX_V1
            destination:
              type: string
              description: >-
                Identifier of the `Payment Instrument` that will receive the
                payout.
          required:
            - amount
            - currency
            - operation_key
            - processor
            - destination
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferCardPayout:
      title: Transfer - Card Payout
      allOf:
        - type: object
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
            operation_key:
              type: string
              enum:
                - PUSH_TO_CARD
              description: >-
                A key indicating that the operation type should be an card
                payout.
              nullable: true
            processor:
              type: string
              description: >-
                The payment processing entity responsible for handling
                transactions, fund movements, etc., between different financial
                accounts.
              enum:
                - DUMMY_V1
                - FINIX_V1
            destination:
              type: string
              description: >-
                Identifier of the `Payment Instrument` that will receive the
                payout.
          required:
            - amount
            - currency
            - operation_key
            - processor
            - destination
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferCardPresent:
      title: Transfer - Card Present
      allOf:
        - type: object
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
            device:
              type: string
              description: The ID of the activated device.
            operation_key:
              type: string
              enum:
                - CARD_PRESENT_SALE
              description: >-
                A key indicating that the operation type should be a
                card-present sale.
              nullable: true
          required:
            - amount
            - currency
            - device
            - operation_key
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferUnreferencedRefund:
      title: Transfer - Card Present - Unreferenced Refund
      description: >-
        Request fields to perform an [unreferenced
        refund](/guides/after-the-payment/refunds#unreferenced-refunds).
      allOf:
        - type: object
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
            device:
              type: string
              description: The ID of the `Device` the `Transfer` was created under.
            operation_key:
              type: string
              description: >-
                The operation key for an [unreferenced
                refund](/guides/after-the-payment/refunds#unreferenced-refunds).
              enum:
                - CARD_PRESENT_UNREFERENCED_REFUND
              nullable: true
          required:
            - amount
            - currency
            - device
            - operation_key
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferCardVerificationCheck:
      title: Transfer - Card Verification Checks
      allOf:
        - type: object
          properties:
            security_code:
              type: string
              description: >
                The 3-or 4-digit security code for the card (i.e., the CVV
                code). Include the CVV code of the card to perform [Card
                Verification
                Checks](../../../guides/online-payments/fraud-and-risk/risk-rules-card-checks).
              nullable: true
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferConvenienceFee:
      title: Transfer - Convenience Fee
      allOf:
        - type: object
          properties:
            additional_buyer_charges:
              description: >
                Details about any [Buyer
                Charges](../../../../guides/online-payments/payment-features/buyer-charges)
                included in the `Transfer`. The buyer charges are mutually
                exclusive.
              allOf:
                - $ref: '#/components/schemas/additional_buyer_charges'
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferDebitBankAccount:
      title: Transfer - Debit Bank Account
      allOf:
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferFeeProfile:
      title: Transfer - Fee Profile
      allOf:
        - type: object
          properties:
            fee_profile:
              type: string
              description: >-
                The ID of a [Fee Profile](/api/fee-profiles) to apply to the
                `Transfer`.
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferFraudDetection:
      title: Transfer - Fraud Detection
      allOf:
        - type: object
          properties:
            fraud_session_id:
              type: string
              description: >-
                Including the `fraud_session_id` allows Finix to review buyer
                information, such as IP address and web browser, to confirm if
                fraud occurred during that specific checkout session.
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferGaming:
      title: Transfer - Gaming
      allOf:
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - type: object
          properties:
            ip_address_v4:
              $ref: '#/components/schemas/ip_address_v4'
            tags:
              $ref: '#/components/schemas/tags'
    createTransferHSAorFSACard:
      title: Transfer - HSA or FSA Card for Non-Healthcare MCC
      allOf:
        - type: object
          properties:
            additional_healthcare_data:
              $ref: '#/components/schemas/additional_healthcare_data'
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferLvl2Processing:
      title: Transfer - Level 2 Processing
      allOf:
        - type: object
          properties:
            additional_purchase_data:
              $ref: '#/components/schemas/additional_purchase_data'
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferLvl3Processing:
      title: Transfer - Level 3 Processing
      allOf:
        - type: object
          properties:
            additional_purchase_data:
              $ref: '#/components/schemas/additional_purchase_data'
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferPartialAuthorization:
      title: Transfer - Partial Authorization
      allOf:
        - type: object
          properties:
            partial_authorization:
              type: boolean
              description: >
                - Set to `true` if you want to enable partial authorizations for
                a specific transaction.

                - If `partial_authorization` is enabled for an individual
                transaction, the `Merchant` value for
                `default_partial_authorization_enabled` is disregarded.

                - Partial authorizations enable you to collect a portion of the
                amount if the cardholder does not have the funds to cover the
                entire amount.
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferRentSurcharge:
      title: Transfer - Rent Surcharge
      allOf:
        - type: object
          properties:
            additional_buyer_charges:
              description: >
                Details about any [Buyer
                Charges](../../../../guides/online-payments/payment-features/buyer-charges)
                included in the `Transfer`. The buyer charges are mutually
                exclusive.
              allOf:
                - $ref: '#/components/schemas/additional_buyer_charges'
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferSplitTransaction:
      title: Transfer - Split Transaction
      allOf:
        - type: object
          properties:
            split_transfers:
              description: >-
                - An array used to detail how funds from the `Transfer` will
                split and the amount `Merchants` receive.

                - The combined `amounts` under `split_transfers` must be equal
                to the `amount` submitted in the parent `Transfer.`

                - For more information, see [Split
                Transactions](../../../../guides/online-payments/payment-features/split-transactions).
              allOf:
                - $ref: '#/components/schemas/split_transfers'
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferSurcharge:
      title: Transfer - Surcharge
      allOf:
        - type: object
          properties:
            additional_buyer_charges:
              description: >
                Details about any [Buyer
                Charges](../../../../guides/online-payments/payment-features/buyer-charges)
                included in the `Transfer`. The buyer charges are mutually
                exclusive.
              allOf:
                - $ref: '#/components/schemas/additional_buyer_charges'
        - $ref: '#/components/schemas/createTransferRequiredFields'
        - $ref: '#/components/schemas/createTransferOptionalFields'
    updateTransfer:
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/tags'
    createTransferReversal:
      title: Refund Transfer
      allOf:
        - type: object
          properties:
            refund_amount:
              type: integer
              description: >-
                The amount of the refund in cents. It must be equal to or less
                than the amount of the original `Transfer`.
          required:
            - refund_amount
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferReversalSplitTransaction:
      title: Refund Transfer - Split Transaction
      allOf:
        - type: object
          properties:
            refund_amount:
              type: integer
              description: >-
                The amount of the refund in cents. It must be equal to or less
                than the amount of the original `Transfer`.
            split_transfers:
              description: >-
                - An array used to detail how funds from the `Transfer` will
                split and the amount `Merchants` receive.

                - The combined `amounts` under `split_transfers` must be equal
                to the `amount` submitted in the parent `Transfer.`

                - For more information, see [Split
                Transactions](../../../../guides/online-payments/payment-features/split-transactions).
              allOf:
                - $ref: '#/components/schemas/split_transfers'
          required:
            - refund_amount
        - $ref: '#/components/schemas/createTransferOptionalFields'
    createTransferReversalReferencedRefund:
      title: Refund Card Present Transfer - Referenced
      description: >-
        Request fields to perform a [referenced
        refund](/guides/after-the-payment/refunds#referenced-refunds).
      allOf:
        - type: object
          properties:
            device:
              type: string
              description: The ID of the `Device` the `Transfer` was created under.
            refund_amount:
              type: integer
              description: >-
                The amount of the refund in cents. It must be equal to or less
                than the amount of the original `Transfer`.
          required:
            - refund_amount
        - $ref: '#/components/schemas/createTransferOptionalFields'
    receipt_requested_delivery_methods:
      type: array
      description: >
        A list of requested delivery methods. Each method specifies 

        the type of delivery and the destination(s) where the receipt should be
        sent.
      items:
        type: object
        required:
          - type
          - destinations
        properties:
          type:
            type: string
            description: |
              The method of receipt delivery.
            enum:
              - EMAIL
              - SMS
              - PRINT
          destinations:
            type: array
            description: >
              A list of destination addresses or identifiers where the receipt
              should be sent.
            items:
              type: string
            minItems: 1
    createApplePaySession:
      type: object
      title: Payment Instrument - Apple Pay Session
      properties:
        display_name:
          type: string
          description: >-
            This will be the merchant name shown to users when making a purchase
            via Apple Pay.
        domain:
          type: string
          description: The domain (or website) where the buyer is initiating the payment.
        merchant_identity:
          type: string
          description: >-
            The `merchant_identity_id` used when registering the business with
            Apple Pay through our registration API.
        validation_url:
          type: string
          description: >-
            A unique validation URL that will be provided by the Apple SDK
            front-end for every payment.
    payment_instrument_apple_pay_session:
      type: object
      title: Payment Instrument - Apple Pay Session
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        session_details:
          type: string
          description: Details about the `apple_pay_session` that was created.
        _links:
          type: object
          description: >-
            For your convenience, every response includes several URLs which
            link to resources relevant to the request. You can use these
            `_links` to make your follow-up requests and quickly access relevant
            IDs.
          properties:
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    compliance_form:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          description: ID of the `Application` to which the `Compliance Form` belongs.
          type: string
          x-stoplight:
            id: z19ttkxt3mfpa
        compliance_form_template:
          type: string
          description: ID of the template used to create the `Compliance Form`.
        due_at:
          type: string
          format: date-time
          description: >-
            Timestamp of when the `Compliance Form` is due. By default, this is
            3 months after the form was created.
        files:
          type: object
          description: >-
            IDs of the `File` resources for the signed and unsigned `Compliance
            Form` PDFs.
          properties:
            signed_file:
              type: string
              description: ID of the `File` resource for the signed `Compliance Form` PDF.
              default: null
              nullable: true
            unsigned_file:
              type: string
              description: >-
                ID of the `File` resource for the unsigned `Compliance Form`
                PDF.
        linked_to:
          type: string
          description: ID of the resource to which the `Compliance Form` belongs.
        linked_type:
          type: string
          description: Type of the resource to which the `Compliance Form` belongs.
          enum:
            - MERCHANT
        pci_saq_a:
          type: object
          description: Details about the signee's digital signature
          properties:
            ip_address:
              type: string
              x-stoplight:
                id: p905xt2fqm16e
              description: IP address of the signee
              default: null
              nullable: true
            is_accepted:
              type: boolean
              x-stoplight:
                id: jdhaxbld6kuta
              default: false
              description: Whether the signee has signed the form yet
            name:
              type: string
              x-stoplight:
                id: dpj0ogcekudk4
              default: null
              description: Full name of the signee
              nullable: true
            signed_at:
              type: string
              x-stoplight:
                id: cmnrze1f1yk67
              default: null
              description: Timestamp of the signee's signature
              nullable: true
            title:
              type: string
              x-stoplight:
                id: 0353tckuu2ch5
              default: null
              description: Job title of the signee
              nullable: true
            user_agent:
              type: string
              x-stoplight:
                id: mdy7is4txx886
              default: null
              description: User-Agent string of the signee's device
              nullable: true
        state:
          type: string
          enum:
            - INCOMPLETE
            - OVERDUE
            - COMPLETE
            - EXPIRED
            - INVALID
          default: INCOMPLETE
          description: State of the `Compliance Form`
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: Type of the `Compliance Form`
          enum:
            - PCI_SAQ_A
        valid_from:
          type: string
          description: >-
            Timestamp of when the `Compliance Form` is valid from. This is set
            to the form's `signed_at` timestamp upon signature.
          format: date-time
          default: null
          nullable: true
        valid_until:
          type: string
          description: >-
            Timestamp of when the `Compliance Form` is valid until. This is set
            to one year after the form's `signed_at` timestamp upon signature.
          format: date-time
          default: null
          nullable: true
        version:
          type: string
          description: Version of the `Compliance Form`
    updateComplianceForm:
      type: object
      properties:
        pci_saq_a:
          type: object
          description: Details about the signee's digital signature.
          properties:
            ip_address:
              type: string
              description: The IP address of the signee.
            name:
              type: string
              description: Full name of the signee
            signed_at:
              type: string
              description: The timestamp of the signee's signature.
            title:
              type: string
              description: The job title of the signe.
            user_agent:
              type: string
              description: The User-Agent of the Merchant attesting to the form.
      required:
        - pci_saq_a
    onboarding_data:
      type: object
      description: >-
        The prefilled information of the user that's being onboarded. For more
        information, see [Prefilling
        Fields](/guides/platform-payments/onboarding-sellers/seller-onboarding-forms/#prefilling-fields).
      properties:
        additional_underwriting_data:
          type: object
          description: Additional underwriting data about the user.
          properties:
            annual_ach_volume:
              type: integer
              description: >-
                The approximate annual ACH sales expected to be processed (in
                cents) by this merchant (max 10 characters).
            average_ach_transfer_amount:
              type: integer
              description: >-
                The approximate average ACH sale amount (in cents) for this
                merchant.
            average_card_transfer_amount:
              type: integer
              description: >-
                The average credit card sale amount (in cents) for this
                merchant.
            business_description:
              type: string
              minLength: 1
              description: Description of this merchant's business (max 200 characters).
            card_volume_distribution:
              type: object
              description: >-
                The distribution of the merchant's credit card volume The sum of
                `card_volume_distribution` must be 100.
              nullable: true
              properties:
                card_present_percentage:
                  type: integer
                  description: >-
                    The percentage of the merchant's volume that's card present
                    (between 0 and 100).
                ecommerce_percentage:
                  type: integer
                  description: >-
                    The percentage of the merchant's business that is eCommerce
                    (between 0 and 100).
                mail_order_telephone_order_percentage:
                  type: integer
                  description: >-
                    The percentage of the merchant's business that is a mail or
                    telephone order (between 0 and 100).
            credit_check_timestamp:
              type: string
              minLength: 1
              description: >-
                A timestamp of when this merchant consented to a credit check
                (e.g., 2021-04-28T16:42:55Z).
            credit_check_user_agent:
              type: string
              minLength: 1
              description: >-
                The details of the browser that was used when this merchant
                consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel
                Mac OS X 10 _14_6)).
            merchant_agreement_accepted:
              type: boolean
              description: >-
                Sets whether this merchant has accepted the terms and conditions
                of the merchant agreement.
            merchant_agreement_ip_address:
              type: string
              minLength: 1
              description: >-
                IP address of the merchant when this merchant accepted the
                merchant agreement (e.g., 42.1.1.113).
            merchant_agreement_timestamp:
              type: string
              minLength: 1
              description: >-
                Timestamp of when the merchant accepted Finix's Terms of Service
                (e.g., 2021-04-28T16:42:55Z).
            merchant_agreement_user_agent:
              type: string
              minLength: 1
              description: >-
                The details of the browser that was used when this merchant
                accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh;
                Intel Mac OS X 10 _14_6)).
            refund_policy:
              type: string
              minLength: 1
              description: >-
                Include the value that best applies to the merchant's refund
                policy.
              enum:
                - NO_REFUNDS
                - MERCHANDISE_EXCHANGE_ONLY
                - WITHIN_30_DAYS
                - OTHER
            volume_distribution_by_business_type:
              type: object
              description: >-
                Merchant's distribution of credit card volume by business type.
                Sum of `volume_distribution_by_business_type` must be 100.
              nullable: true
              properties:
                business_to_business_volume_percentage:
                  type: integer
                  description: >-
                    The percentage of the merchant's volume that's business to
                    business (between 0 and 100).
                business_to_consumer_volume_percentage:
                  type: integer
                  description: >-
                    The percentage of the merchant's volume that's business to
                    consumer (between 0 and 100).
                consumer_to_consumer_volume_percentage:
                  type: integer
                  description: >-
                    Merchant's percentage of volume that is consumer to consumer
                    (between 0 and 100).
                other_volume_percentage:
                  type: integer
                  description: >-
                    The percentage of the merchant's volume that isn't
                    represented by the previous fields (between 0 and 100).
                person_to_person_volume_percentage:
                  type: integer
                  description: >-
                    The percentage the merchant's volume that's person to person
                    (between 0 and 100).
            amex_marketing_consent:
              type: object
              description: >-
                Details about the merchant's consent to receive American Express
                marketing communications.
              nullable: true
              properties:
                accepted:
                  type: boolean
                  description: Whether the merchant accepted Amex marketing consent.
                ip_address:
                  type: string
                  description: >-
                    IP address of the merchant when they provided their
                    marketing consent decision.
                user_agent:
                  type: string
                  description: >-
                    The browser user agent details when the merchant provided
                    their marketing consent decision.
                timestamp:
                  type: string
                  description: >-
                    Timestamp of when the merchant provided their marketing
                    consent decision (ISO 8601 format).
        associated_entities:
          type: array
          description: >-
            The `entities` saved in the `associated_identities` of the user. For
            more information, see [Create an Associated
            Identity](#operation/createAssociatedIdentity).
          items:
            type: object
            description: Underwriting data that's required to verify the `Identity`.
            properties:
              annual_card_volume:
                type: integer
                description: >-
                  The annual credit card sales (in cents) expected to be
                  processed (max 19 characters).
              business_address:
                type: object
                description: The primary address for the legal entity.
                nullable: true
                properties:
                  city:
                    type: string
                    description: City (max 20 characters).
                    minLength: 1
                  country:
                    type: string
                    minLength: 1
                  line2:
                    type: string
                    minLength: 1
                    description: Second line of the address (max 35 characters).
                  line1:
                    type: string
                    minLength: 1
                    description: First line of the address (max 35 characters).
                  postal_code:
                    type: string
                    minLength: 1
                    description: Zip or Postal code (max 7 characters).
                  region:
                    type: string
                    minLength: 1
                    description: 2-letter state code.
              business_name:
                type: string
                minLength: 1
                description: >-
                  Abbreviated names of the business. If there are no abbreviated
                  name, leave this field blank.
                nullable: true
              business_phone:
                type: string
                minLength: 1
                description: >-
                  Customer service phone number where the merchant can be
                  reached (max 10 characters).
              business_tax_id:
                type: string
                minLength: 1
                description: >-
                  Nine digit Tax Identification Number (TIN), Employer
                  Identification Number (EIN). If the `business_type` is
                  **INDIVIDUAL\_SOLE\_PROPRIETORSHIP** and they do not have an
                  EIN, use the sole proprietor's Social Security Number (SSN).
              business_type:
                type: string
                minLength: 1
                description: Include the value that best applies to the merchant.
                enum:
                  - INDIVIDUAL_SOLE_PROPRIETORSHIP
                  - CORPORATION
                  - LIMITED_LIABILITY_COMPANY
                  - PARTNERSHIP
                  - ASSOCIATION_ESTATE_TRUST
                  - TAX_EXEMPT_ORGANIZATION
                  - INTERNATIONAL_ORGANIZATION
                  - GOVERNMENT_AGENCY
              default_statement_descriptor:
                $ref: '#/components/schemas/statement_descriptor'
              dob:
                type: object
                description: |
                  The control owner's date of birth.
                properties:
                  day:
                    type: integer
                  month:
                    type: integer
                  year:
                    type: integer
              doing_business_as:
                type: string
                minLength: 1
                description: >-
                  Alternate names of the business. If there are no other names,
                  pass the same value used for `business_name` (max 60
                  characters).
              email:
                type: string
                minLength: 1
                description: >-
                  The email address of the principal control owner where they
                  can be reached (max 100 characters).
              first_name:
                type: string
                minLength: 1
                description: The legal first name of the control owner (max 20 characters).
              has_accepted_credit_cards_previously:
                type: boolean
                description: Defaults to **false** if not passed.
              incorporation_date:
                type: object
                description: The date the company was founded and registered.
                nullable: true
                properties:
                  day:
                    type: integer
                    description: Day business was incorporated (between 1 and 31).
                  month:
                    type: integer
                    description: Month business was incorporated (between 1 and 12).
                  year:
                    type: integer
                    description: Year business was incorporated (4-digit).
              last_name:
                type: string
                minLength: 1
                description: The `Identity` owner's legal last name.
              max_transaction_amount:
                type: integer
                description: >-
                  The maximum amount (in cents) that can be charged for a single
                  transaction (max 12 characters).
              mcc:
                type: string
                minLength: 1
                description: >-
                  The Merchant Category Code
                  ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
                  that this merchant will be classified under. For a list of
                  approved MCCs, see [Approved Merchant Category
                  Codes.](/guides/managing-operations/security-compliance/approved-merchant-category-codes)
              ownership_type:
                type: string
                minLength: 1
                description: |
                  Values can be either:
                  - `PUBLIC` to indicate a publicly-traded company.
                  - `PRIVATE` for privately-held businesses.
                nullable: true
              personal_address:
                type: object
                description: >-
                  The home address of the principal control owner. This field is
                  used for identity verification purposes.
                properties:
                  city:
                    type: string
                    minLength: 1
                    description: City (max 20 characters).
                  country:
                    type: string
                    minLength: 1
                    description: 3-Letter country code (e.g. USA).
                  line1:
                    type: string
                    minLength: 1
                    description: First line of the address (max 35 characters).
                  line2:
                    type: string
                    minLength: 1
                    description: Second line of the address (max 35 characters).
                  postal_code:
                    type: string
                    minLength: 1
                    description: Zip or Postal code (max 7 characters).
                  region:
                    type: string
                    minLength: 1
                    description: 2-letter State code.
              phone:
                type: string
                minLength: 1
                description: >-
                  The principal control owner's phone number (max 10
                  characters).
              principal_percentage_ownership:
                type: integer
                description: >-
                  Percentage of the company owned by the principal control owner
                  (min 0; max 100).
              tax_id:
                type: string
                minLength: 1
                description: Details if the `tax_id` was provided.
              title:
                type: string
                minLength: 1
                description: >-
                  The corporate title of the control owner (e.g. Chief Executive
                  Officer, CFO, etc. Max 60 characters).
              url:
                type: string
                minLength: 1
                description: The URL of the `Identity` owner's public website.
        country:
          type: string
          description: Country of the Merchant's business
          enum:
            - USA
            - CAN
        entity:
          type: object
          description: The `entity` information saved in the `Identity` of the user.
          properties:
            amex_mid:
              type: integer
              description: >-
                Assigned amexMid value. If a value is passed, it must be 10 or
                11 digits.
              nullable: true
            annual_card_volume:
              type: integer
              description: >-
                The annual credit card sales (in cents) expected to be processed
                by this seller (max 19 characters).
              nullable: true
            business_address:
              type: object
              description: The primary address for the legal entity.
              nullable: true
              properties:
                line1:
                  type: string
                  minLength: 1
                  description: First line of the address (max 35 characters).
                  nullable: true
                line2:
                  type: string
                  minLength: 1
                  description: Second line of the address (max 35 characters).
                  nullable: true
                city:
                  type: string
                  minLength: 1
                  description: City (max 20 characters).
                  nullable: true
                region:
                  type: string
                  minLength: 1
                  description: 2-letter state code.
                  nullable: true
                postal_code:
                  type: string
                  minLength: 1
                  description: Zip or Postal code (max 7 characters).
                  nullable: true
                country:
                  type: string
                  minLength: 1
                  description: 3-Letter Country code (e.g. USA).
                  nullable: true
            business_name:
              type: string
              minLength: 1
              description: >-
                The merchant's legal business name (max 120
                characters).<ul><li>If
                <code>INDIVIDUAL_SOLE_PROPRIETORSHIP</code>, pass the owner's
                legal first name, last name, and middle initial.</li></ul>
              nullable: true
            business_phone:
              type: string
              minLength: 1
              description: >-
                Customer service phone number where the seller can be reached
                (max 10 characters).
              nullable: true
            business_tax_id_provided:
              type: boolean
              description: Details if the `business_tax_id` was provided.
            business_type:
              description: Include the value that best applies to the seller.
              type: string
              nullable: true
            default_statement_descriptor:
              $ref: '#/components/schemas/statement_descriptor'
            discover_mid:
              description: Assigned discoverMid value.
              type: integer
              nullable: true
            dob:
              type: object
              description: The control owner's date of birth.
              nullable: true
              properties:
                day:
                  type: integer
                  description: Day of birth (between 1 and 31).
                  minimum: 1
                month:
                  type: integer
                  description: Month of birth (between 1 and 12).
                  minimum: 1
                year:
                  type: integer
                  description: Year of birth (4-digit). Year must be greater than 1900.
                  minimum: 1900
            doing_business_as:
              type: string
              minLength: 1
              description: >-
                Alternate names of the business. If there are no other names,
                pass the same value used for `business_name` (max 60
                characters).
              nullable: true
            email:
              type: string
              minLength: 1
              description: >-
                The email address of the principal control owner where they can
                be reached (max 100 characters).
              nullable: true
            first_name:
              type: string
              minLength: 1
              description: >-
                The legal first name of the merchant's control owner (max 20
                characters).
              nullable: true
            has_accepted_credit_cards_previously:
              type: boolean
              description: Defaults to **false** if not passed.
            incorporation_date:
              type: object
              description: The date the company was founded and registered with the US.
              nullable: true
              properties:
                day:
                  type: integer
                  description: Day business was incorporated (between 1 and 31).
                month:
                  type: integer
                  description: Month of birth (between 1 and 12).
                year:
                  type: integer
                  description: Year business was incorporated (4-digit).
            last_name:
              type: string
              minLength: 1
              description: >-
                The legal last name of the merchant's control owner (max 20
                characters).
              nullable: true
            mcc:
              type: string
              minLength: 1
              description: >-
                The Merchant Category Code
                ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
                that this merchant will be classified under. For a list of
                approved MCCs, see [Approved Merchant Category
                Codes.](/guides/managing-operations/security-compliance/approved-merchant-category-codes)
              nullable: true
            ownership_type:
              type: string
              minLength: 1
              description: >-
                Values can be either: <ul><li><strong>PUBLIC</strong> to
                indicate a publicly-traded
                company.</li><li><strong>PRIVATE</strong> for privately-held
                businesses.</li></ul>
              enum:
                - PUBLIC
                - PRIVATE
              nullable: true
            personal_address:
              type: object
              description: >-
                The home address of the merchant's principal control owner. This
                field is used for identity verification purposes.
              nullable: true
              properties:
                line1:
                  type: string
                  minLength: 1
                  description: First line of the address (max 35 characters).
                  nullable: true
                line2:
                  type: string
                  minLength: 1
                  description: Second line of the address (max 35 characters).
                  nullable: true
                city:
                  type: string
                  minLength: 1
                  description: City (max 20 characters).
                  nullable: true
                region:
                  type: string
                  minLength: 1
                  description: 2-letter State code.
                  nullable: true
                postal_code:
                  type: string
                  minLength: 1
                  description: Zip or Postal code (max 7 characters).
                  nullable: true
                country:
                  type: string
                  minLength: 1
                  description: 3-Letter country code (e.g. USA).
                  nullable: true
            phone:
              type: string
              minLength: 1
              description: The principal control owner's phone number (max 10 characters).
              nullable: true
            principal_percentage_ownership:
              type: integer
              description: >-
                Percentage of the company owned by the principal control owner
                (min 0; max 100).
              nullable: true
            short_business_name:
              type: string
              description: >-
                Abbreviated names of the business. If there are no abbreviated
                name, leave this field blank.
              nullable: true
            tax_authority:
              type: string
              description: >-
                <ul><li>Only required when onboarding a seller with a
                <code>MCC</code> of <code>9311</code>.</li><li>The
                <code>tax_authority</code> is the tax gathering entity (e.g.,
                San Francisco Water Authority).</li></ul>
              nullable: true
            tax_id:
              type: string
              minLength: 1
              description: >-
                The control owner's Social Security Number (SSN). Masked in
                responses (e.g., `*****3333`).
              nullable: true
            tax_id_provided:
              type: boolean
              description: Details if the `tax_id` was provided.
            business_tax_id:
              type: string
              minLength: 1
              description: >-
                Nine digit Tax Identification Number (TIN) or Employer
                Identification Number (EIN). Masked in responses (e.g.,
                `*****2222`).
              nullable: true
            title:
              type: string
              minLength: 1
              description: >-
                The corporate title of the control owner (e.g. Chief Executive
                Officer, CFO, etc. Max 60 characters).
              nullable: true
            url:
              type: string
              minLength: 1
              description: The URL of the merchant's public website.
              nullable: true
        payment_instruments:
          type: object
          description: >-
            The `Payment Instrument` that'll be used to payout the seller. For
            more information, see [Payouts](/guides/payouts/).
          properties:
            account_number:
              type: string
              description: >-
                The bank account number (no dashes in between numbers). Canadian
                bank account numbers cannot exceed 15 characters.
            account_type:
              type: string
              description: >-
                The type of bank account. Use the following respective enum when
                creating a `Payment Instrument` for:<ul><li><strong>CHECKING:
                </strong>The checking account of your
                buyer.</li><li><strong>SAVINGS: </strong>The savings account of
                your buyer.</li><li><strong>CORPORATE: </strong>A corporate
                checking account.</li><li><strong>CORP_SAVINGS: </strong>A
                corporate savings account.</li><li><strong>BUSINESS_CHECKING:
                </strong>A checking account primarily owned by a
                business.</li><li><strong>BUSINESS_SAVINGS: </strong>A savings
                account primarily owned by a
                business</li><li><strong>PERSONAL_CHECKING: </strong>Seller's
                using their personal checking
                account.</li><li><strong>PERSONAL_SAVINGS: </strong>Seller's
                using their personal savings account.</li></ul>
            attempt_bank_account_validation_check:
              enum:
                - CHECKING
                - SAVINGS
                - PERSONAL_CHECKING
                - PERSONAL_SAVINGS
                - BUSINESS_CHECKING
                - BUSINESS_SAVINGS
                - CORPORATE
                - CORP_SAVINGS
            bank_code:
              type: string
              description: The routing number of the bank account.
            name:
              type: string
              description: The name of the bank account owner.
            type:
              type: string
              description: Type of `Payment Instrument`.
              enum:
                - BANK_ACCOUNT
            country:
              type: string
              description: 3-letter country code for the bank account (e.g., USA, CAN).
            currency:
              type: string
              description: >-
                3-letter ISO currency code for the bank account (e.g., USD,
                CAD).
        max_transaction_amount:
          type: integer
          description: >-
            Maximum card amount that can be transacted for a single transaction
            in cents (max 12 characters). Must be equal to or less than your
            `max_transaction_amount`.
        ach_max_transaction_amount:
          type: integer
          description: >-
            Maximum ACH amount that can be transacted for a single transaction
            in cents (max 12 characters). Must be equal to or less than your
            `ach_max_transaction_amount`.
        associated_files:
          type: array
          description: >-
            List of [Files](#Files) your user uploaded inside their Onboarding
            Form.
          items:
            type: object
            properties:
              type:
                description: The `type` of the File.
                type: string
              name:
                description: The name of the File.
                type: string
              id:
                description: The `id` of the File.
                type: string
              related_to:
                description: The `id` of the resource the File is linked to.
                type: string
          default: []
      required:
        - max_transaction_amount
    onboarding_link_details:
      type: object
      description: >-
        The information of the initial onboarding link. This is only provided
        when creating an `onboarding_form`.
      properties:
        expiration_in_minutes:
          type: integer
          description: >-
            How long (in minutes) the link should be valid for. Defaults to 60
            minutes.
        expired_session_url:
          type: string
          description: The URL users get sent to if the bearer token expires.
        fee_details_url:
          type: string
          description: >-
            The URL of the page where you display the fees related to processing
            payments (for more info, see [Onboarding
            Forms](/guides/platform-payments/onboarding-sellers/seller-onboarding-forms/)).
        merchant_max_transaction_amount:
          type: integer
          description: >-
            The maximum transaction amount for the merchant's card payment
            processing.
        merchant_ach_max_transaction_amount:
          type: integer
          description: >-
            The maximum transaction amount for the merchant's ACH payment
            processing.
        return_url:
          type: string
          description: The URL users get sent to after completing the onboarding flow.
        terms_of_service_url:
          type: string
          description: >-
            Your Terms of Service URL. The URL is provided to users for consent
            along with Finix's Terms of Service.
      required:
        - expiration_in_minutes
        - expired_session_url
        - fee_details_url
        - return_url
        - terms_of_service_url
    createOnboardingForm:
      type: object
      properties:
        merchant_processors:
          type: array
          description: >-
            An array of objects with the processors and gateways users will be
            onboarded to.
          items:
            type: object
            properties:
              processor:
                type: string
                description: The name of the processor you plan to onboard users to.
            required:
              - processor
        onboarding_data:
          $ref: '#/components/schemas/onboarding_data'
        onboarding_link_details:
          $ref: '#/components/schemas/onboarding_link_details'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - merchant_processors
        - onboarding_data
        - onboarding_link_details
    onboarding_link:
      type: object
      description: >-
        The information of the initial onboarding link. This is only provided
        when creating an `onboarding_form`.
      properties:
        expires_at:
          type: string
          description: >-
            A UTC timestamp detailing when the onboarding form expires and will
            no longer be available via `link_url`. To generate a new link to the
            same form, see [Get an Onboarding Form
            URL](/guides/platform-payments/onboarding-sellers/seller-onboarding-forms/#fetching-an-onboarding-form-link).
        link_url:
          type: string
          description: >-
            The URL of the user's Finix Onboarding Form. Users can use the
            `link_url` to return to the form until the link expires.
    onboarding_form:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        onboarding_data:
          $ref: '#/components/schemas/onboarding_data'
        merchant_processors:
          type: array
          description: >-
            An array of objects with the processors and gateways users will be
            onboarded to.
          items:
            type: object
            properties:
              processor:
                type: string
                description: The name of the processor you plan to onboard users to.
        onboarding_link_details:
          $ref: '#/components/schemas/onboarding_link_details'
        onboarding_link:
          $ref: '#/components/schemas/onboarding_link'
        status:
          type: string
          description: Status of the `onboarding_form`.
          enum:
            - IN_PROGRESS
            - COMPLETED
            - UPDATE_REQUESTED
        identity_id:
          type: string
          description: >-
            The ID of the `identity` resource. This is only provided when the
            `onboarding_form` is `COMPLETED`.
        application_id:
          $ref: '#/components/schemas/application_id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        tags:
          $ref: '#/components/schemas/tags'
    additional_details:
      type: object
      description: Object containing additional details.
      properties:
        collect_billing_address:
          type: boolean
          description: The collected billing address. Defaults to `false`.
        collect_email:
          type: boolean
          description: The collected email address.
        collect_name:
          type: boolean
          description: The collected name.
        collect_shipping_address:
          type: boolean
          description: The collected shipping address.
        expiration_in_minutes:
          type: integer
          description: The expiration in minutes.
        expired_session_url:
          type: string
          description: A URL to redirect the user if their session times out.
        receipt_requested_delivery_methods:
          $ref: '#/components/schemas/receipt_requested_delivery_methods'
        send_receipt:
          type: boolean
          description: Whether to send the user a receipt.
        success_return_url:
          type: string
          description: The redirect URL for a successful outcome.
        terms_of_service_url:
          type: string
          description: Your Terms of Service URL.
        unsuccessful_return_url:
          type: string
          description: The redirect URL for an unsuccessful outcome.
      required:
        - terms_of_service_url
    allowed_payment_methods:
      type: array
      description: The allowed payment methods.
      items:
        type: string
        enum:
          - APPLE_PAY
          - BANK_ACCOUNT
          - GOOGLE_PAY
          - PAYMENT_CARD
    branding:
      type: object
      properties:
        accent_color:
          type: string
          description: Hex code of the accent color.
          example: '#F2F2F2'
        brand_color:
          type: string
          description: Hex code of branding color.
          example: '#F2F2F2'
        button_font_color:
          type: string
          description: Hex code of the button font color.
          nullable: true
        icon:
          type: string
          description: URL for the icon of the payment link.
        logo:
          type: string
          description: URL of the logo for the payment link.
        logo_alternative_text:
          type: string
          description: Alternate text displayed if the logo image cannot display.
          nullable: true
      required:
        - accent_color
        - brand_color
        - icon
        - logo
    payment_link:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        additional_details:
          description: Object containing additional details.
          allOf:
            - $ref: '#/components/schemas/additional_details'
            - type: object
              properties:
                collect_phone:
                  type: boolean
                  description: The collected phone number.
        allowed_payment_methods:
          $ref: '#/components/schemas/allowed_payment_methods'
        amount_details:
          type: object
          description: Object containing amount details.
          properties:
            amount_breakdown:
              type: object
              description: >-
                The individual charges/fees that add up to the total amount.
                This field is required for the transaction to qualify for Level
                2 or Level 3 processing.
              properties:
                additional_buyer_charges:
                  $ref: '#/components/schemas/additional_buyer_charges'
                customs_duty_amount:
                  type: integer
                  description: >-
                    The duty in cents on the total amount for the payment. If
                    Level 2/3 processing is enabled, this optional field must
                    have a value of at least `0`.
                discount_amount:
                  type: integer
                  description: >-
                    A reduction applied to the total amount. If Level 2/3
                    processing is enabled, this optional field must have a value
                    of at least `0`.
                estimated_tax_amount:
                  type: integer
                  description: >-
                    The estimated amount of tax applied to the order. This field
                    is optional for Level 2 processing. In order for a
                    transaction to qualify for Level 3 processing, this field
                    must omitted or set to `null`.
                subtotal_amount:
                  type: integer
                  description: >-
                    The subtotal amount before any taxes, shipping, or
                    additional charges are applied.
                shipping_amount:
                  type: integer
                  description: >-
                    The amount charged for shipping the items in the order. If
                    Level 2/3 processing is enabled, this optional field must
                    have a value of at least `0`.
                tax_exempt:
                  type: boolean
                  description: >-
                    For tax exempt payments set to `true`. This field is used
                    for Level 2/3 processing when enabled, but it is optional.
                tip_amount:
                  type: integer
                  description: The tip amount included in the order total.
            amount_type:
              type: string
              description: >
                The supported enums are:


                `FIXED` - A set amount that cannot be altered by the user. 

                `VARIABLE` - Allows the user to set their own amount, provided
                it adheres to the minimum and maximum limits (`min_amount` and
                `max_amount`, respectively).
              enum:
                - FIXED
                - VARIABLE
            currency:
              type: string
              description: >-
                3-letter ISO code designating the currency of the Transfers
                (e.g. USD).
            max_amount:
              description: Maximum amount allowed when the amount is `VARIABLE`.
              type: integer
              nullable: true
            min_amount:
              description: Minimum amount allowed when the amount is `VARIABLE`.
              type: integer
              nullable: true
            total_amount:
              type: integer
              description: The total amount.
        application_id:
          type: string
          description: >-
            The ID of the `Application` that the `Payment Link` was created
            under.
        attempt_level_two_level_three_payment:
          type: boolean
          description: >-
            Setting this field to true enables Level 2/Level 3 data collection
            for card payments.
        branding:
          $ref: '#/components/schemas/branding'
        buyer_details:
          type: object
          description: >-
            Object containing details about the buyer. This object is only used
            for `SINGLE_USE` payment links.
          properties:
            customer_reference_number:
              type: string
              description: >-
                The customer reference for the purchase (max 17 characters).
                This field is required for the transaction to qualify for Level
                2 / Level 3 processing.
            first_name:
              type: string
              description: First name of the buyer.
            identity_id:
              type: string
              description: The `Identity` ID of the buyer.
            last_name:
              type: string
              description: Last name of the buyer.
        is_authorization:
          type: boolean
          description: >-
            When set to `true`, submitting the `Payment Link` creates an
            `Authorization` instead of a `Transfer`.
        is_multiple_use:
          type: boolean
          description: >-
            If set to `true`, the payment link can be used for multiple
            purchases.
        items:
          type: array
          default: []
          description: >-
            An itemized list of products/services. This field is required for
            the transaction to qualify for Level 3 processing.
          items:
            type: object
            properties:
              description:
                type: string
                description: >-
                  A item description. This field is required for the transaction
                  to qualify for Level 3 processing.
              image_details:
                type: object
                description: Product/service image locations.
                properties:
                  primary_image_url:
                    type: string
                    description: The location of a item image.
                  alternative_image_urls:
                    type: array
                    description: >-
                      The locations of backup images if there is an issue with
                      the primary image.
                    items:
                      type: string
              item_details:
                type: object
                description: >-
                  Additional details about the item. This field is required for
                  the transaction to qualify for Level 3 processing.
                properties:
                  commodity_code:
                    type: string
                    description: Commodity code for the item.
                    example: 175-62-20
                  merchant_product_code:
                    type: string
                    description: Merchant's product code for the item.
                    example: '1149611'
                  unit_of_measure:
                    type: string
                    description: Unit of measure for the item.
                    example: BX
                  cost_per_unit:
                    type: integer
                    description: Cost per unit in cents.
                    example: 500
                required:
                  - commodity_code
                  - merchant_product_code
                  - unit_of_measure
                  - cost_per_unit
              name:
                type: string
                description: The item name.
              price_details:
                type: object
                description: >-
                  Additional details about the price. This field is required for
                  the transaction to qualify for Level 3 processing.
                properties:
                  amount_excluding_sales_tax:
                    type: integer
                    description: >-
                      The amount excluding sales tax. This field is required for
                      the transaction to qualify for Level 3 processing.
                  sale_amount:
                    type: integer
                    description: >-
                      The on-sale price of the item if it is different from the
                      `regular_amount`.
                  currency:
                    $ref: '#/components/schemas/currency'
                  price_type:
                    type: string
                    description: >-
                      Whether the price is on-sale (`PROMOTIONAL`) or the normal
                      price (`REGULAR`).
                    enum:
                      - PROMOTIONAL
                      - REGULAR
                  regular_amount:
                    type: integer
                    description: >-
                      The standard price of the item without any adjustments
                      applied (e.g. discounts, taxes, sales). This field is
                      required for the transaction to qualify for Level 3
                      processing.
                  item_discount_amount:
                    type: integer
                    description: >-
                      The item discount. If Level 2/3 processing is enabled,
                      this optional field must have a value of at least `0`.
              quantity:
                type: integer
                description: >-
                  The item quantity. This field is required for the transaction
                  to qualify for Level 3 processing.
        link_expires_at:
          type: string
          description: Timestamp of when the `Payment Link` will expire.
        link_url:
          type: string
          description: The URL of the `Payment Link` you can share with the buyer.
        merchant_id:
          type: string
          description: >-
            The `id` of the `Merchant` the payment is getting created under.
            Currently, only Merchants on the following processors can use
            Payment Links: `FINIX_V1`, `LITLE_V1`, `DUMMY_V1`, 
        nickname:
          type: string
          description: Descriptor name of the payment link.
        payment_frequency:
          type: string
          description: >-
            Whether the Payment Link is one-time only or recurring. Currently,
            only `ONE_TIME` is supported.
          enum:
            - ONE_TIME
            - RECURRING
        split_transfers:
          $ref: '#/components/schemas/split_transfers'
        state:
          type: string
          description: The state of the `Payment Link`.
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
    createPaymentLink:
      type: object
      properties:
        additional_details:
          description: Object containing additional details.
          allOf:
            - $ref: '#/components/schemas/additional_details'
            - type: object
              properties:
                collect_phone:
                  type: boolean
                  description: The collected phone number.
        allowed_payment_methods:
          $ref: '#/components/schemas/allowed_payment_methods'
        amount_details:
          type: object
          description: Object containing amount details.
          properties:
            amount_breakdown:
              type: object
              description: >-
                The individual charges/fees that add up to the total amount.
                This field is required for the transaction to qualify for Level
                2 or Level 3 processing.
              properties:
                additional_buyer_charges:
                  $ref: '#/components/schemas/additional_buyer_charges'
                customs_duty_amount:
                  type: integer
                  description: >-
                    The duty in cents on the total amount for the payment. If
                    Level 2/3 processing is enabled, this optional field must
                    have a value of at least `0`.
                discount_amount:
                  type: integer
                  description: >-
                    A reduction applied to the total amount. If Level 2/3
                    processing is enabled, this optional field must have a value
                    of at least `0`.
                estimated_tax_amount:
                  type: integer
                  description: >-
                    The estimated amount of tax applied to the order. This field
                    is optional for Level 2 processing. In order for a
                    transaction to qualify for Level 3 processing, this field
                    must omitted or set to `null`.
                subtotal_amount:
                  type: integer
                  description: >-
                    The subtotal amount before any taxes, shipping, or
                    additional charges are applied.
                shipping_amount:
                  type: integer
                  description: >-
                    The amount charged for shipping the items in the order. If
                    Level 2/3 processing is enabled, this optional field must
                    have a value of at least `0`.
                tax_exempt:
                  type: boolean
                  description: >-
                    For tax exempt payments set to `true`. This field is used
                    for Level 2/3 processing when enabled, but it is optional.
                tip_amount:
                  type: integer
                  description: The tip amount included in the order total.
            amount_type:
              type: string
              description: >
                The supported enums are:


                `FIXED` - A set amount that cannot be altered by the user. 

                `VARIABLE` - Allows the user to set their own amount, provided
                it adheres to the minimum and maximum limits (`min_amount` and
                `max_amount`, respectively).
              enum:
                - FIXED
                - VARIABLE
            currency:
              type: string
              description: >-
                3-letter ISO code designating the currency of the Transfers
                (e.g. USD).
            max_amount:
              description: Maximum amount allowed when the amount is `VARIABLE`.
              type: integer
              nullable: true
            min_amount:
              description: Minimum amount allowed when the amount is `VARIABLE`.
              type: integer
              nullable: true
            total_amount:
              type: integer
              description: The total amount.
        attempt_level_two_level_three_payment:
          type: boolean
          description: >-
            Setting this field to true enables Level 2/Level 3 data collection
            for card payments.
        branding:
          $ref: '#/components/schemas/branding'
        buyer_details:
          type: object
          description: >-
            Object containing details about the buyer. This object is only used
            for `SINGLE_USE` payment links.
          properties:
            customer_reference_number:
              type: string
              description: >-
                The customer reference for the purchase (max 17 characters).
                This field is required for the transaction to qualify for Level
                2 / Level 3 processing.
            first_name:
              type: string
              description: First name of the buyer.
            identity_id:
              type: string
              description: The `Identity` ID of the buyer.
            last_name:
              type: string
              description: Last name of the buyer.
        is_authorization:
          type: boolean
          description: >-
            When set to `true`, submitting the `Payment Link` creates an
            `Authorization` instead of a `Transfer`.
        is_multiple_use:
          type: boolean
          description: >-
            If set to `true`, the payment link can be used for multiple
            purchases.
        items:
          type: array
          default: []
          description: >-
            An itemized list of products/services. This field is required for
            the transaction to qualify for Level 3 processing.
          items:
            type: object
            properties:
              description:
                type: string
                description: >-
                  A item description. This field is required for the transaction
                  to qualify for Level 3 processing.
              image_details:
                type: object
                description: Product/service image locations.
                properties:
                  primary_image_url:
                    type: string
                    description: The location of a item image.
                  alternative_image_urls:
                    type: array
                    description: >-
                      The locations of backup images if there is an issue with
                      the primary image.
                    items:
                      type: string
              item_details:
                type: object
                description: >-
                  Additional details about the item. This field is required for
                  the transaction to qualify for Level 3 processing.
                properties:
                  commodity_code:
                    type: string
                    description: Commodity code for the item.
                    example: 175-62-20
                  merchant_product_code:
                    type: string
                    description: Merchant's product code for the item.
                    example: '1149611'
                  unit_of_measure:
                    type: string
                    description: Unit of measure for the item.
                    example: BX
                  cost_per_unit:
                    type: integer
                    description: Cost per unit in cents.
                    example: 500
                required:
                  - commodity_code
                  - merchant_product_code
                  - unit_of_measure
                  - cost_per_unit
              name:
                type: string
                description: The item name.
              price_details:
                type: object
                description: >-
                  Additional details about the price. This field is required for
                  the transaction to qualify for Level 3 processing.
                properties:
                  amount_excluding_sales_tax:
                    type: integer
                    description: >-
                      The amount excluding sales tax. This field is required for
                      the transaction to qualify for Level 3 processing.
                  sale_amount:
                    type: integer
                    description: >-
                      The on-sale price of the item if it is different from the
                      `regular_amount`.
                  currency:
                    $ref: '#/components/schemas/currency'
                  price_type:
                    type: string
                    description: >-
                      Whether the price is on-sale (`PROMOTIONAL`) or the normal
                      price (`REGULAR`).
                    enum:
                      - PROMOTIONAL
                      - REGULAR
                  regular_amount:
                    type: integer
                    description: >-
                      The standard price of the item without any adjustments
                      applied (e.g. discounts, taxes, sales). This field is
                      required for the transaction to qualify for Level 3
                      processing.
                  item_discount_amount:
                    type: integer
                    description: >-
                      The item discount. If Level 2/3 processing is enabled,
                      this optional field must have a value of at least `0`.
              quantity:
                type: integer
                description: >-
                  The item quantity. This field is required for the transaction
                  to qualify for Level 3 processing.
        merchant_id:
          type: string
          description: >-
            The `id` of the `Merchant` the payment is getting created under.
            Currently, only Merchants on the following processors can use
            Payment Links: `FINIX_V1`, `LITLE_V1`, `DUMMY_V1`, 
        nickname:
          type: string
          description: Descriptor name of the payment link.
        payment_frequency:
          type: string
          description: >-
            Whether the Payment Link is one-time only or recurring. Currently,
            only `ONE_TIME` is supported.
          enum:
            - ONE_TIME
            - RECURRING
        split_transfers:
          $ref: '#/components/schemas/split_transfers'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - additional_details
        - allowed_payment_methods
        - amount_details
        - branding
        - merchant_id
        - nickname
        - payment_frequency
    nickname:
      type: string
      description: A human-readable name for the resource.
    amount_details:
      type: object
      description: Object containing amount details.
      properties:
        amount_breakdown:
          $ref: '#/components/schemas/amount_breakdown'
        amount_type:
          type: string
          description: >
            The supported enums are:


            `FIXED` - A set amount that cannot be altered by the user. 

            `VARIABLE` - Allows the user to set their own amount, provided it
            adheres to the minimum and maximum limits (`min_amount` and
            `max_amount`, respectively).
          enum:
            - FIXED
            - VARIABLE
        currency:
          type: string
          description: >-
            3-letter ISO code designating the currency of the Transfers (e.g.
            USD).
        max_amount:
          description: Maximum amount allowed when the amount is `VARIABLE`.
          type: integer
          nullable: true
        min_amount:
          description: Minimum amount allowed when the amount is `VARIABLE`.
          type: integer
          nullable: true
        total_amount:
          type: integer
          description: The total amount.
    buyer_details:
      type: object
      description: >-
        Object containing details about the user. This object is only valid when
        `payment_frequency` is `ONE_TIME`.
      properties:
        identity_id:
          type: string
          description: The `Identity` `id` of the buyer.
        first_name:
          type: string
          description: First name of the buyer.
        last_name:
          type: string
          description: Last name of the buyer.
        email:
          description: Email address of the buyer.
          type: string
          nullable: true
        shipping_address:
          $ref: '#/components/schemas/address'
        billing_address:
          $ref: '#/components/schemas/address'
        phone_number:
          description: Phone number of the buyer.
          type: string
          nullable: true
    updatePaymentLink:
      oneOf:
        - title: Update Payment Link
          type: object
          properties:
            nickname:
              $ref: '#/components/schemas/nickname'
            tags:
              $ref: '#/components/schemas/tags'
        - title: Update Payment Link - Multi-Use Active
          type: object
          properties:
            additional_details:
              description: Object containing additional details.
              allOf:
                - $ref: '#/components/schemas/additional_details'
                - type: object
                  properties:
                    collect_phone:
                      type: boolean
                      description: The collected phone number.
            allowed_payment_methods:
              $ref: '#/components/schemas/allowed_payment_methods'
            amount_details:
              $ref: '#/components/schemas/amount_details'
            nickname:
              $ref: '#/components/schemas/nickname'
            state:
              type: string
              description: The state of the `Payment Link`.
              enum:
                - ACTIVE
                - DEACTIVATED
            tags:
              $ref: '#/components/schemas/tags'
        - title: Update Payment Link - Single-Use Active
          type: object
          properties:
            additional_details:
              description: Object containing additional details.
              allOf:
                - $ref: '#/components/schemas/additional_details'
                - type: object
                  properties:
                    collect_phone:
                      type: boolean
                      description: The collected phone number.
            allowed_payment_methods:
              $ref: '#/components/schemas/allowed_payment_methods'
            amount_details:
              $ref: '#/components/schemas/amount_details'
            buyer_details:
              $ref: '#/components/schemas/buyer_details'
            items:
              $ref: '#/components/schemas/items'
            nickname:
              $ref: '#/components/schemas/nickname'
            state:
              type: string
              description: The state of the `Payment Link`.
              enum:
                - ACTIVE
                - DEACTIVATED
            tags:
              $ref: '#/components/schemas/tags'
        - title: Update Payment Link - Deactivate
          type: object
          properties:
            state:
              type: string
              description: The state of the `Payment Link`.
              enum:
                - ACTIVE
                - DEACTIVATED
    checkout_form:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        application:
          $ref: '#/components/schemas/application_id'
        merchant_id:
          type: string
          description: >-
            The ID of the `Merchant` resource the `payment_link` was created for
            and will settle under.
        nickname:
          $ref: '#/components/schemas/nickname'
        payment_frequency:
          type: string
          description: >-
            Details if a payment created from a checkout form is:
            <ul><strong><li>ONE\_TIME</li><li>RECURRING</li></strong></ul> At
            this time, only **ONE\_TIME** is supported.
        allowed_payment_methods:
          $ref: '#/components/schemas/allowed_payment_methods'
        state:
          type: string
          description: The state of the `Checkout Form`.
        items:
          $ref: '#/components/schemas/items'
        buyer_details:
          $ref: '#/components/schemas/buyer_details'
        amount_details:
          $ref: '#/components/schemas/amount_details'
        branding:
          type: object
          description: Object containing branding details for the checkout form.
          x-stoplight:
            id: mr8akrywdl5cl
          properties:
            brand_color:
              type: string
              description: Hex code of branding color.
              example: '#F2F2F2'
            accent_color:
              type: string
              description: Hex code of the accent color.
              example: '#F2F2F2'
            logo:
              type: string
              description: URL of the logo for the payment link.
            icon:
              type: string
              description: URL for the icon of the payment link.
            logo_alternative_text:
              type: string
              description: Alternate text displayed if the logo image cannot display.
              nullable: true
            button_font_color:
              type: string
              description: Hex code of the button font color.
              nullable: true
        additional_details:
          type: object
          description: Object containing additional details about the checkout form.
          properties:
            collect_name:
              type: boolean
              description: Collect email address from the payment link.
            collect_email:
              type: boolean
              description: Collect email address from the payment link.
            collect_phone_number:
              type: boolean
              description: Collect phone number from the payment link.
            collect_billing_address:
              type: boolean
              description: >-
                Collect billing address from the payment link. Defaults to
                **false**.
            collect_shipping_address:
              type: boolean
              description: Collect shipping address from the payment link.
            receipt_requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
            send_receipt:
              type: boolean
              description: Whether to send the user a receipt.
            success_return_url:
              type: string
              description: URL to redirect the user to, after the payment is successful.
            unsuccessful_return_url:
              type: string
              description: The redirect URL for an unsuccessful payment.
            cart_return_url:
              type: string
              description: URL to redirect the user back to their cart.
            expired_session_url:
              type: string
              description: URL to redirect the buyer to if their session times out.
            terms_of_service_url:
              type: string
              description: Your Terms of Service URL.
            expiration_in_minutes:
              type: integer
              minimum: 1
              maximum: 1576800
              description: Details how long (in minutes) the payment link is valid for.
        link_url:
          type: string
          description: >-
            The URL of the user's Finix Onboarding Form. Users can use the
            `link_url` to return to the form until the link expires.
        link_expires_at:
          type: string
          description: Timestamp of when the `Checkout ` will expire.
        split_transfers:
          $ref: '#/components/schemas/split_transfers'
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
    createCheckoutForm:
      type: object
      properties:
        merchant_id:
          type: string
          description: >-
            The **ID** of the `Merchant` the payment is getting created under.
            </br> </br> Only approved `Merchants` with one of the following
            processors can create checkout pages: **DUMMY_V1**, **LITLE_V1** or
            **FINIX_V1**.
        payment_frequency:
          type: string
          description: >-
            Details if a payment created from a checkout form is:
            <ul><strong><li>ONE\_TIME</li><li>RECURRING</li></strong></ul> At
            this time, only **ONE\_TIME** is supported.
        allowed_payment_methods:
          $ref: '#/components/schemas/allowed_payment_methods'
        nickname:
          type: string
          description: Descriptor name of the checkout form.
        items:
          $ref: '#/components/schemas/items'
        buyer_details:
          $ref: '#/components/schemas/buyer_details'
        amount_details:
          $ref: '#/components/schemas/amount_details'
        branding:
          $ref: '#/components/schemas/branding'
        additional_details:
          description: Object containing additional details.
          allOf:
            - $ref: '#/components/schemas/additional_details'
            - type: object
              properties:
                collect_phone_number:
                  type: boolean
                  description: The collected phone number.
                cart_return_url:
                  type: string
                  description: URL to redirect the user back to their cart.
        split_transfers:
          $ref: '#/components/schemas/split_transfers'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - additional_details
        - allowed_payment_methods
        - amount_details
        - branding
        - merchant_id
        - nickname
        - payment_frequency
    additional_details_payout:
      type: object
      description: Object containing additional details about the `Payout Link`.
      properties:
        expiration_in_minutes:
          type: integer
          minimum: 1
          description: >-
            Details how long (in minutes) the `Payout Link` is valid for. The
            max value is subject to risk approvals. Refer to the maximum value
            in your Finix Dashboard.
        expired_session_url:
          type: string
          description: The URL to redirect the recipient to if their session times out.
          nullable: true
        success_return_url:
          type: string
          description: A URL to redirect the recipient to after the payout is successful.
          nullable: true
        terms_of_service_url:
          type: string
          description: Your Terms of Service URL.
        unsuccessful_return_url:
          type: string
          description: A URL to redirect the recipient to if the payout was successful.
          nullable: true
      required:
        - terms_of_service_url
    allowed_payout_operations:
      type: array
      description: >-
        Defines the types of operations permitted in the payout process when the
        recipient submits the payout form.
      items:
        type: string
        enum:
          - PUSH_TO_ACH
          - PUSH_TO_CARD
    recipient_details:
      type: object
      description: Details of the recipient.
      properties:
        business_name:
          type: string
          minLength: 1
          maxLength: 120
          description: >
            The recipient's legal business name. For a sole proprietorship, pass
            the owner's legal first name, last name, and middle initial.
          nullable: true
        doing_business_as:
          type: string
          minLength: 1
          maxLength: 60
          description: >-
            Alternate names of the business. If there are no other names, pass
            the same value used for `business_name`.
          nullable: true
        email:
          type: string
          description: Email address of the recipient.
          nullable: true
        first_name:
          type: string
          description: First name of the recipient.
          nullable: true
        last_name:
          type: string
          description: Last name of the recipient.
          nullable: true
        merchant_id:
          type: string
          description: >-
            The `Merchant` resource linked to the recipient targeted by the
            `Payout Link`.
          example: MUcgYZswyRfqSSbvMsxuaHxZ
    payout_link:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        additional_details:
          $ref: '#/components/schemas/additional_details_payout'
        allowed_payout_operations:
          $ref: '#/components/schemas/allowed_payout_operations'
        amount_details:
          type: object
          description: >-
            Contains information about the amount paid to the recipient through
            the `Payout Link`.
          properties:
            total_amount:
              type: integer
              description: The total amount paid to the recipient.
            currency:
              type: string
              description: >-
                The 3-letter ISO code designating the currency of the payout
                (e.g., USD).
        application_id:
          $ref: '#/components/schemas/application_id'
        branding:
          $ref: '#/components/schemas/branding'
        items:
          type: array
          default: []
          description: >
            The list of items that will be "paid out". For example, insurance
            payouts, sales commissions, etc.
          items:
            type: object
            properties:
              name:
                type: string
                description: The payout item name.
              description:
                type: string
                description: A payout item description.
                example: Car damage
              image_details:
                type: object
                description: Payout item image locations.
                properties:
                  primary_image_url:
                    type: string
                    description: The location of a payout item's image.
                  alternative_image_urls:
                    type: array
                    default: []
                    description: >-
                      The locations of backup images if there is an issue with
                      the primary image.
                    items:
                      type: string
              price_details:
                type: object
                description: Additional details about the price.
                properties:
                  amount:
                    type: integer
                    description: >-
                      The total amount to be paid to the recipient for the
                      payout item.
                  currency:
                    $ref: '#/components/schemas/currency'
              quantity:
                type: integer
                description: The payout item quantity.
        link_expires_at:
          type: string
          description: Timestamp of when the `Payout Link` will expire.
        link_url:
          type: string
          description: >-
            The URL of the `Payout Link`. Recipients can re-visit the link to
            check the status of their payout.
        nickname:
          $ref: '#/components/schemas/nickname'
        recipient_details:
          allOf:
            - $ref: '#/components/schemas/recipient_details'
          nullable: true
        state:
          type: string
          description: The state of the `Payout Link`.
          enum:
            - ACTIVE
            - AWAITING_PAYOUT
            - EXPIRED
            - COMPLETED
            - DEACTIVATED
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            An object containing link(s) relevant to the request. You can store
            these links for follow-up requests.
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The path to the `Payout Link` resource.
    createPayoutLink:
      type: object
      properties:
        additional_details:
          $ref: '#/components/schemas/additional_details_payout'
        allowed_payout_operations:
          $ref: '#/components/schemas/allowed_payout_operations'
        amount_details:
          type: object
          description: >-
            Contains information about the amount paid to the recipient through
            the `Payout Link`.
          properties:
            total_amount:
              type: integer
              description: The total amount paid to the recipient.
            currency:
              type: string
              description: >-
                The 3-letter ISO code designating the currency of the payout
                (e.g., USD).
          required:
            - total_amount
            - currency
        branding:
          $ref: '#/components/schemas/branding'
        items:
          type: array
          default: []
          description: >
            The list of items that will be "paid out". For example, insurance
            payouts, sales commissions, etc.
          items:
            type: object
            properties:
              name:
                type: string
                description: The payout item name.
              description:
                type: string
                description: A payout item description.
                example: Car damage
              image_details:
                type: object
                description: Payout item image locations.
                properties:
                  primary_image_url:
                    type: string
                    description: The location of a payout item's image.
                  alternative_image_urls:
                    type: array
                    default: []
                    description: >-
                      The locations of backup images if there is an issue with
                      the primary image.
                    items:
                      type: string
              price_details:
                type: object
                description: Additional details about the price.
                properties:
                  amount:
                    type: integer
                    description: >-
                      The total amount to be paid to the recipient for the
                      payout item.
                  currency:
                    $ref: '#/components/schemas/currency'
              quantity:
                type: integer
                description: The payout item quantity.
        nickname:
          $ref: '#/components/schemas/nickname'
        recipient_details:
          $ref: '#/components/schemas/recipient_details'
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - additional_details
        - branding
        - allowed_payout_operations
        - amount_details
    updatePayoutLink:
      title: Update Payout Link
      type: object
      properties:
        allowed_payout_operations:
          $ref: '#/components/schemas/allowed_payout_operations'
        recipient_details:
          $ref: '#/components/schemas/recipient_details'
        nickname:
          $ref: '#/components/schemas/nickname'
        state:
          type: string
          description: The state of the `Payout Link`.
          enum:
            - ACTIVE
            - AWAITING_PAYOUT
            - EXPIRED
            - COMPLETED
            - DEACTIVATED
        tags:
          $ref: '#/components/schemas/tags'
    subscription:
      title: Subscription
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          $ref: '#/components/schemas/updated_at'
        first_charge_at:
          type: string
          format: date-time
          description: Timestamp when the first [`Transfer`](#Transfers) will occur.
        next_billing_date:
          type: object
          description: Details when the next [`Transfer`](#Transfers) will occur.
          properties:
            year:
              type: integer
              description: The year the next `Transfer` will occur.
            month:
              type: integer
              description: The month the next `Transfer` will occur.
            day:
              type: integer
              description: The day the next `Transfer` will occur.
        amount:
          $ref: '#/components/schemas/amount'
        buyer_details:
          type: object
          description: An object containing details about the subscriber.
          properties:
            identity_id:
              type: string
              description: The [identity ID](/api/identities) of the subscriber.
            instrument_id:
              description: >-
                The ID of the [`Payment Instrument`](/api/payment-instruments)
                from which the subscription payments get debited.
            requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
        currency:
          type: string
          description: >-
            ISO 4217 3-letter currency code. Currently, the only `currency`
            supported is `USD`.
          enum:
            - USD
        linked_to:
          type: string
          description: >
            The ID of the [`Merchant`](#Merchants) resource that you wish to
            link to the `Subscription` (i.e., the merchant that the subscription
            belongs to).


            At this time, only approved merchants with one of the following
            processors are valid: 


            - `DUMMY_V1`

            - `FINIX_V1`
        linked_type:
          type: string
          description: The type of the resource that is specified in the `linked_to` field.
          enum:
            - MERCHANT
        nickname:
          $ref: '#/components/schemas/nickname'
        billing_interval:
          type: string
          description: How often the subscriber is billed.
          enum:
            - DAILY
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - YEARLY
        subscription_details:
          type: object
          description: An object containing subscription details.
          properties:
            collection_method:
              type: string
              description: >-
                The method by which subscription payments are collected.
                Currently, automatically billing the card on file is the only
                method available.
              enum:
                - BILL_AUTOMATICALLY
            send_invoice:
              type: boolean
              description: Whether to send the user an invoice.
            send_receipt:
              type: boolean
              description: Whether to send the user a receipt.
            trial_details:
              type: object
              description: Object containing trial details.
              properties:
                interval_type:
                  type: string
                  description: The unit of time for the trial period.
                  enum:
                    - DAY
                    - WEEK
                    - MONTH
                    - YEAR
                interval_count:
                  type: integer
                  description: >-
                    The number of intervals of `interval_type` used to describe
                    the duration of the trial.
                trial_started_at:
                  type: string
                  format: date-time
                  description: A timestamp indicating when the trial period began.
                trial_expected_end_at:
                  type: string
                  format: date-time
                  description: A timestamp indicating when the trial period ends.
            discount_details:
              type: object
              description: Object containing discount details.
              properties:
                interval_type:
                  type: string
                  description: The unit of time for the discount period.
                  enum:
                    - DAY
                    - WEEK
                    - MONTH
                    - YEAR
                billing_interval_count:
                  type: integer
                  description: >-
                    The number of billing intervals the discount applies. After
                    this period, the subscriber is charged the full `amount`
                    from the `Subscription`.
              required:
                - interval_type
                - billing_interval_count
          required:
            - collection_method
        subscription_phase:
          type: string
          description: >
            Indicates the period within a subscription where specific rules
            apply.  


            - `EVERGREEN` - The subscriber is billed continuously for the
            subscription until the subscription is canceled.  

            - `DISCOUNT` - The subscriber receives a discounted price for a
            limited billing interval, after which the customer is charged the
            full subscription amount.

            - `FIXED` state - Applicable to fixed-length subscriptions.

            - `NONE` - Indicates that when the `start_subscription_at` timestamp
            is set during subscription creation, the subscription is not yet in
            any phase, and billing has not started.

            - `TRIAL` - The period during which the subscriber is not billed;
            after this phase, the subscriber will begin being billed. 
          enum:
            - EVERGREEN
            - DISCOUNT
            - FIXED
            - NONE
            - TRIAL
        state:
          type: string
          description: >
            The state of the `Subscription`. 


            - The `NOT_STARTED` state occurs when the subscription has not yet
            started, typically indicated by a `start_subscription_at` timestamp
            set during creation.

            - A subscription in the `PAST_DUE` state is unpaid but has not yet
            been canceled.
          enum:
            - ACTIVE
            - CANCELED
            - EXPIRED
            - NOT_STARTED
            - PAST_DUE
        subscription_plan_id:
          type: string
          description: >-
            The ID of the `Subscription Plan` from which to create the
            `Subscription`.
        start_subscription_at:
          type: string
          format: date-time
          description: >-
            Indicates that the subscription is scheduled to begin in the future.
            The timestamp specifies the exact start date for subscription
            billing.
        total_billing_intervals:
          type: integer
          description: >-
            The total number of billing intervals for the `Subscription`. This
            represents the total count of recurring billing cycles, such as
            months or weeks, depending on the billing frequency.
        expires_at:
          type: string
          format: date-time
          description: >-
            The date-time that the `Subscription` expires if
            `total_billing_intervals` is set for the `Subscription`.
        canceled_via:
          type: string
          description: The method that was used to cancel the `Subscription`.
        tags:
          $ref: '#/components/schemas/tags'
        _links:
          type: object
          description: >-
            An object containing link(s) relevant to the request. You can store
            these links for follow-up requests.
          properties:
            self:
              $ref: '#/components/schemas/self'
    createSubscriptionMinimalFields:
      title: Subscription - Minimal Fields
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        billing_interval:
          type: string
          description: How often the subscriber is billed.
          enum:
            - DAILY
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - YEARLY
        currency:
          type: string
          description: >-
            ISO 4217 3-letter currency code. Currently, the only `currency`
            supported is `USD`.
          enum:
            - USD
        linked_to:
          type: string
          description: >
            The ID of the [`Merchant`](#Merchants) resource that you wish to
            link to the `Subscription` (i.e., the merchant that the subscription
            belongs to).


            At this time, only approved merchants with one of the following
            processors are valid:


            - `DUMMY_V1`

            - `FINIX_V1`
        linked_type:
          type: string
          description: The type of the resource that is specified in the `linked_to` field.
          enum:
            - MERCHANT
        nickname:
          $ref: '#/components/schemas/nickname'
        subscription_details:
          type: object
          description: An object containing subscription details.
          properties:
            collection_method:
              type: string
              description: >-
                The method by which subscription payments are collected.
                Currently, automatically billing the card on file is the only
                method available.
              enum:
                - BILL_AUTOMATICALLY
            trial_details:
              type: object
              description: Object containing trial details.
              properties:
                interval_type:
                  type: string
                  description: The unit of time for the trial period.
                  enum:
                    - DAY
                    - WEEK
                    - MONTH
                    - YEAR
                interval_count:
                  type: integer
                  description: >-
                    The number of intervals of `interval_type` used to describe
                    the duration of the trial.
              required:
                - interval_type
                - interval_count
            discount_details:
              type: object
              description: Object containing discount details.
              properties:
                interval_type:
                  type: string
                  description: The unit of time for the discount period.
                  enum:
                    - DAY
                    - WEEK
                    - MONTH
                    - YEAR
                billing_interval_count:
                  type: integer
                  description: >-
                    The number of billing intervals the discount applies. After
                    this period, the subscriber is charged the full `amount`
                    from the `Subscription`.
              required:
                - interval_type
                - billing_interval_count
          required:
            - collection_method
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - currency
        - linked_to
        - linked_type
        - billing_interval
        - subscription_details
    createSubscription:
      title: Subscription - All Fields
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        buyer_details:
          type: object
          description: An object containing details about the subscriber.
          properties:
            requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
            identity_id:
              type: string
              description: The [identity ID](/api/identities) of the subscriber.
            instrument_id:
              description: >-
                The ID of the [`Payment Instrument`](/api/payment-instruments)
                from which the subscription payments get debited.
          required:
            - identity_id
            - instrument_id
        currency:
          type: string
          description: >-
            ISO 4217 3-letter currency code. Currently, the only `currency`
            supported is `USD`.
          enum:
            - USD
        linked_to:
          type: string
          description: >
            The ID of the [`Merchant`](#Merchants) resource that you wish to
            link to the `Subscription` (i.e., the merchant that the subscription
            belongs to).


            At this time, only approved merchants with one of the following
            processors are valid:


            - `DUMMY_V1`

            - `FINIX_V1`
        linked_type:
          type: string
          description: The type of the resource that is specified in the `linked_to` field.
          enum:
            - MERCHANT
        billing_interval:
          type: string
          description: How often the subscriber is billed.
          enum:
            - DAILY
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - YEARLY
        nickname:
          $ref: '#/components/schemas/nickname'
        start_subscription_at:
          type: string
          format: date-time
          description: >-
            Indicates that the subscription is scheduled to begin in the future.
            The timestamp specifies the exact start date for subscription
            billing.
        subscription_details:
          type: object
          description: An object containing subscription details.
          properties:
            collection_method:
              type: string
              description: >-
                The method by which subscription payments are collected.
                Currently, automatically billing the card on file is the only
                method available.
              enum:
                - BILL_AUTOMATICALLY
            trial_details:
              type: object
              description: Object containing trial details.
              properties:
                interval_type:
                  type: string
                  description: The unit of time for the trial period.
                  enum:
                    - DAY
                    - WEEK
                    - MONTH
                    - YEAR
                interval_count:
                  type: integer
                  description: >-
                    The number of intervals of `interval_type` used to describe
                    the duration of the trial.
              required:
                - interval_type
                - interval_count
            discount_details:
              type: object
              description: Object containing discount details.
              properties:
                interval_type:
                  type: string
                  description: The unit of time for the discount period.
                  enum:
                    - DAY
                    - WEEK
                    - MONTH
                    - YEAR
                billing_interval_count:
                  type: integer
                  description: >-
                    The number of billing intervals the discount applies. After
                    this period, the subscriber is charged the full `amount`
                    from the `Subscription`.
              required:
                - interval_type
                - billing_interval_count
          required:
            - collection_method
        subscription_plan_id:
          type: string
          description: >-
            The ID of the `Subscription Plan` from which to create the
            `Subscription`.
        total_billing_intervals:
          type: integer
          description: >-
            The total number of billing intervals for the `Subscription`. This
            represents the total count of recurring billing cycles, such as
            months or weeks, depending on the billing frequency.
      required:
        - currency
        - linked_to
        - linked_type
        - billing_interval
        - subscription_details
    createSubscriptionDiscountPhase:
      title: Subscription - Discount Phase
      allOf:
        - $ref: '#/components/schemas/createSubscription'
    createSubscriptionFixed:
      title: Subscription - Fixed-Length
      allOf:
        - $ref: '#/components/schemas/createSubscription'
    createSubscriptionFuture:
      title: Subscription - Future Start Date
      allOf:
        - $ref: '#/components/schemas/createSubscription'
    createSubscriptionTrial:
      title: Subscription - Trial Period
      allOf:
        - $ref: '#/components/schemas/createSubscription'
    createSubscriptionFromPlan:
      title: Subscription - Subscription Plan - All Fields
      properties:
        buyer_details:
          type: object
          description: An object containing details about the subscriber.
          properties:
            requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
            identity_id:
              type: string
              description: The [identity ID](/api/identities) of the subscriber.
            instrument_id:
              description: >-
                The ID of the [`Payment Instrument`](/api/payment-instruments)
                from which the subscription payments get debited.
          required:
            - identity_id
            - instrument_id
        linked_to:
          type: string
          description: >
            The ID of the [`Merchant`](#Merchants) resource that you wish to
            link to the `Subscription` (i.e., the merchant that the subscription
            belongs to).


            At this time, only approved merchants with one of the following
            processors are valid:


            - `DUMMY_V1`

            - `FINIX_V1`
        linked_type:
          type: string
          description: The type of the resource that is specified in the `linked_to` field.
          enum:
            - MERCHANT
        nickname:
          $ref: '#/components/schemas/nickname'
        subscription_plan_id:
          type: string
          description: >-
            The ID of the `Subscription Plan` from which to create the
            `Subscription`.
        total_billing_intervals:
          type: integer
          description: >-
            The total number of billing intervals for the `Subscription`. This
            represents the total count of recurring billing cycles, such as
            months or weeks, depending on the billing frequency.
        start_subscription_at:
          type: string
          format: date-time
          description: >-
            Indicates that the subscription is scheduled to begin in the future.
            The timestamp specifies the exact start date for subscription
            billing.
        tags:
          $ref: '#/components/schemas/tags'
      required:
        - linked_to
        - linked_type
        - subscription_plan_id
    createSubscriptionFromPlanMinimalFields:
      title: Subscription - Subscription Plan - Minimal Fields
      type: object
      properties:
        buyer_details:
          type: object
          description: An object containing details about the subscriber.
          properties:
            requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
            identity_id:
              type: string
              description: The [identity ID](/api/identities) of the subscriber.
            instrument_id:
              description: >-
                The ID of the [`Payment Instrument`](/api/payment-instruments)
                from which the subscription payments get debited.
          required:
            - identity_id
            - instrument_id
        linked_to:
          type: string
          description: >
            The ID of the [`Merchant`](#Merchants) resource that you wish to
            link to the `Subscription` (i.e., the merchant that the subscription
            belongs to).


            At this time, only approved merchants with one of the following
            processors are valid:


            - `DUMMY_V1`

            - `FINIX_V1`
        linked_type:
          type: string
          description: The type of the resource that is specified in the `linked_to` field.
          enum:
            - MERCHANT
        subscription_plan_id:
          type: string
          description: >-
            The ID of the `Subscription Plan` from which to create the
            `Subscription`.
      required:
        - buyer_details
        - linked_to
        - linked_type
        - subscription_plan_id
    createSubscriptionFromPlanFixed:
      title: Subscription - Subscription Plan - Fixed-Length
      allOf:
        - $ref: '#/components/schemas/createSubscriptionFromPlan'
    createSubscriptionFromPlanFuture:
      title: Subscription - Subscription Plan - Future Start Date
      allOf:
        - $ref: '#/components/schemas/createSubscriptionFromPlan'
    updateSubscription:
      title: Update Subscription
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        nickname:
          $ref: '#/components/schemas/nickname'
        subscription_details:
          type: object
          description: An object containing subscription details.
          properties:
            send_invoice:
              type: boolean
              description: Whether to send the user an invoice.
            send_receipt:
              type: boolean
              description: Whether to send the user a receipt.
        tags:
          $ref: '#/components/schemas/tags'
    image_details:
      type: object
      properties:
        primary_image_url:
          type: string
          description: The primary image location.
        alternative_image_urls:
          type: array
          default: []
          description: >-
            The locations of backup images if there is an issue with the primary
            image.
          items:
            type: string
    subscription_link:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        additional_details:
          description: |
            Object containing additional details about the link.
          type: object
          properties:
            collect_name:
              type: boolean
              description: The collected user's name.
            collect_email:
              type: boolean
              description: The collected email address.
            collect_phone:
              type: boolean
              description: The collected phone number.
            collect_shipping_address:
              type: boolean
              description: The collected shipping address.
            expiration_in_minutes:
              type: string
              description: >-
                How long (in minutes) the link should be valid for. Defaults to
                60 minutes.
            expired_session_url:
              type: string
              description: The URL to redirect the user to if the link expires.
            receipt_requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
            send_confirmation:
              type: boolean
              description: >
                Setting this flag to `true` validates the provided email address
                and sends a confirmation email to that address. When set to
                `true`, the `collect_email` field must include an email. When
                set to `false` (default), no confirmation email will be sent
                (e.g., the merchant does not require it.) 
            send_receipt:
              type: boolean
              description: Whether to send the user a `Receipt`.
            success_return_url:
              type: string
              description: >-
                A URL to redirect the subscriber after the transaction
                completes.
              nullable: true
            terms_of_service_url:
              type: string
              description: The URL to the Terms of Service.
              nullable: true
            unsuccessful_return_url:
              type: string
              description: A URL to redirect the user to if the transaction was successful.
              nullable: true
        allowed_payment_methods:
          $ref: '#/components/schemas/allowed_payment_methods'
        application_id:
          type: string
          minLength: 1
          description: >-
            The ID of the `Application` the `Subscription Link` was created
            under.
        branding:
          description: Branding settings for the `Subscription Link`.
          allOf:
            - $ref: '#/components/schemas/branding'
            - type: object
              properties:
                button_label:
                  type: string
                  description: The text that displays within the button.
        created_at:
          $ref: '#/components/schemas/created_at'
        is_multiple_use:
          type: boolean
          description: If set to `true`, the link can be used more than once.
        link_expires_at:
          type: string
          description: Timestamp of when the link will expire.
        link_url:
          type: string
          description: |
            The URL of the link.
        merchant_id:
          type: string
          description: The `Merchant` asssociated with the link.
        nickname:
          $ref: '#/components/schemas/nickname'
        plans:
          type: array
          description: >-
            A list of `Subscription Plan` objects, along with additional
            information for each plan if selected.
          items:
            type: object
            properties:
              subscription_plan_id:
                type: string
                description: >-
                  The `Subscription Plan` that a customer selects via the
                  `Subscription Link`.
              name:
                type: string
                description: >-
                  The name of the `Subscription Plan` you wish to display to
                  your buyer. This may differ from the internal `nickname` of
                  the `Subscription Plan`.
              image_details:
                type: object
                description: |
                  `Subscription Link` image locations.
                allOf:
                  - $ref: '#/components/schemas/image_details'
              url_details:
                type: object
                properties:
                  success_return_url:
                    type: string
                    description: >-
                      The URL to redirect the user after the transaction
                      completes.
                  unsuccessful_return_url:
                    type: string
                    description: >-
                      If an attempt is made but fails, redirect the user to this
                      URL.
                  expired_session_url:
                    type: string
                    description: >-
                      The URL to redirect the user to if their session times
                      out.
                  terms_of_service_url:
                    type: string
                    description: A Terms of Service URL.
        state:
          type: string
          description: The current state of the `Subscription Link`.
          enum:
            - ACTIVE
            - DEACTIVATED
            - EXPIRED
            - COMPLETED
        tags:
          $ref: '#/components/schemas/tags'
        type:
          type: string
          description: >-
            The type of `Subscription Link`. This is very useful for filtering
            and informing the frontend about the type of `Subscription Link`.
          enum:
            - SUBSCRIPTION_PLAN
            - MULTIPLE_SUBSCRIPTION_PLANS
        updated_at:
          $ref: '#/components/schemas/updated_at'
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/self'
    createSubscriptionLinkRequiredFields:
      type: object
      properties:
        additional_details:
          description: |
            Object containing additional details about the `Subscription Link`.
          type: object
          properties:
            collect_name:
              type: boolean
              description: The collected user's name.
            collect_email:
              type: boolean
              description: The collected email address.
            collect_phone:
              type: boolean
              description: The collected phone number.
            collect_billing_address:
              type: boolean
              description: The collected billing address.
            collect_shipping_address:
              type: boolean
              description: The collected shipping address.
            expiration_in_minutes:
              type: string
              description: >-
                How long (in minutes) the link should be valid for. Defaults to
                60 minutes.
            expired_session_url:
              type: string
              description: The URL to redirect the user to if the link expires.
            receipt_requested_delivery_methods:
              $ref: '#/components/schemas/receipt_requested_delivery_methods'
            send_confirmation:
              type: boolean
              description: >
                Setting this flag to `true` validates the provided email address
                and sends a confirmation email to that address. When set to
                `true`, the `collect_email` field must include an email. When
                set to `false` (default), no confirmation email will be sent
                (e.g., the merchant does not require it.) 
            send_receipt:
              type: boolean
              description: Whether to send the user a `Receipt`.
            success_return_url:
              type: string
              description: A URL to redirect the user after the transaction completes.
              nullable: true
            terms_of_service_url:
              type: string
              description: The URL to the Terms of Service.
              nullable: true
        allowed_payment_methods:
          $ref: '#/components/schemas/allowed_payment_methods'
        branding:
          description: Branding settings for the `Subscription Link`.
          allOf:
            - $ref: '#/components/schemas/branding'
            - type: object
              properties:
                button_label:
                  type: string
                  description: The text that displays within the button.
        currency:
          $ref: '#/components/schemas/currency'
        is_multiple_use:
          type: boolean
          description: If set to `true`, the link can be used more than once.
        merchant_id:
          type: string
          description: The `Merchant` asssociated with the link.
        nickname:
          $ref: '#/components/schemas/nickname'
        plans:
          type: array
          description: >-
            A list of `Subscription Plan` objects, along with additional
            information for each plan if selected.
          items:
            type: object
            properties:
              subscription_plan_id:
                type: string
                description: >-
                  The `Subscription Plan` that a customer selects via the
                  `Subscription Link`.
              name:
                type: string
                description: >-
                  The name of the `Subscription Plan` you wish to display to
                  your buyer. This may differ from the internal `nickname` of
                  the `Subscription Plan`.
              image_details:
                type: object
                description: |
                  `Subscription Link` image locations.
                allOf:
                  - $ref: '#/components/schemas/image_details'
              url_details:
                type: object
                properties:
                  success_return_url:
                    type: string
                    description: >-
                      The URL to redirect the user after the transaction
                      completes.
                  unsuccessful_return_url:
                    type: string
                    description: >-
                      If an attempt is made but fails, redirect the user to this
                      URL.
        type:
          type: string
          description: >-
            The type of `Subscription Link`. This is very useful for filtering
            and informing the front-end about the type of `Subscription Link`.
          enum:
            - SUBSCRIPTION_PLAN
            - MULTIPLE_SUBSCRIPTION_PLANS
    createSubscriptionLinkOneSubscriptionPlan:
      title: Subscription Link - One Subscription Plan
      allOf:
        - $ref: '#/components/schemas/createSubscriptionLinkRequiredFields'
    createSubscriptionLinkMultipleSubscriptionPlans:
      title: Subscription Link - Multiple Subscription Plans
      allOf:
        - $ref: '#/components/schemas/createSubscriptionLinkRequiredFields'
    createSubscriptionLinkConfirmation:
      title: Subscription Link - Send Confirmation Email
      allOf:
        - $ref: '#/components/schemas/createSubscriptionLinkRequiredFields'
    deactivateSubscriptionLink:
      type: object
      properties:
        state:
          type: string
          description: The current state of the `Subscription Link`.
          enum:
            - DEACTIVATED
        tags:
          $ref: '#/components/schemas/tags'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: ''
security:
  - BasicAuth: []
x-exclude-tags-from-libraries:
  - Applications
  - Application Profiles
  - Fees
  - Payment Instruments P2C
  - Processors
  - Review Queue
  - Subscription Schedules
  - Subscription Amounts
  - Subscription Enrollments
  - Users
