finix.yaml

openapi: 3.0.2
x-stoplight:
  id: c6861590dda46
info:
  title: Finix API
  description:
    $ref: api-descriptions/main.md
  contact:
    name: Finix
    url: https://finix.com
    email: support@finixpayments.com
  version: '2022-02-01'
x-ignoredHeaderParameters:
  - Accept
  - finix-apiuser-role
  - date
  - x-request-id
servers:
  - description: Sandbox server to be used for testing and development
    url: https://finix.sandbox-payments-api.com
tags:
  - name: Authorizations
    description:
      $ref: api-descriptions/tags/authorizations.md
  - name: Balance Transfers
    description:
      $ref: api-descriptions/tags/balance-transfers.md
  - name: Disputes
    description:
      $ref: api-descriptions/tags/disputes.md
  - name: Fee Profiles
    description:
      $ref: api-descriptions/tags/fee-profiles.md
  - name: Identities
    description:
      $ref: api-descriptions/tags/identities.md
  - name: Merchants
    description:
      $ref: api-descriptions/tags/merchants.md
  - name: Payment Instruments
    description:
      $ref: api-descriptions/tags/payment-instruments.md
  - name: Settlements
    description:
      $ref: api-descriptions/tags/settlements.md
  - name: Transfers
    description:
      $ref: api-descriptions/tags/transfers.md
  - name: Webhooks
    description:
      $ref: api-descriptions/tags/webhooks.md
  - name: Devices
    description:
      $ref: api-descriptions/tags/devices.md
  - name: Merchant Profiles
    description:
      $ref: api-descriptions/tags/merchant-profiles.md
  - name: Reversals
    description:
      $ref: api-descriptions/tags/reversals.md
  - name: Risk profiles
    description:
      $ref: api-descriptions/tags/risk-profiles.md
  - name: Verifications
    description:
      $ref: api-descriptions/tags/verifications.md
  - name: Files
    description:
      $ref: api-descriptions/tags/files.md
  - name: Instrument Updates
    description:
      $ref: api-descriptions/tags/instrument-updates.md
  - name: Onboarding Forms
    description:
      $ref: api-descriptions/tags/onboarding-forms.md
  - name: Compliance Forms
    description:
      $ref: api-descriptions/tags/compliance-forms.md
x-tagGroups:
  - name: MAIN RESOURCES
    tags:
      - Identities
      - Merchants
      - Payment Instruments
      - Authorizations
      - Transfers
      - Webhooks
      - Settlements
      - Disputes
      - Files
      - Verifications
      - Fees
      - Users
      - Instrument Updates
      - Merchant Profiles
      - Fee Profiles
      - Onboarding Forms
      - Compliance Forms
      - Devices
  - name: CORE-PAYFAC RESOURCES
    tags:
      - Applications
      - Application Profiles
      - Processors
      - Balance Transfers
  - name: SUBSCRIPTION BILLING
    tags:
      - Subscription Schedules
      - Subscription Amounts
      - Subscription Enrollments
paths:
  /authorizations:
    post:
      tags:
        - Authorizations
      description: "Create an `Authorization` to process a transaction.\n\n`Authorizations`\
        \ can have six possible `states`, two of which are expected:\n\n- **SUCCEEDED**\
        \ \n- **FAILED**\n\nIf the `Authorization` has **SUCCEEDED** , it must be\
        \ captured before `expires_at` passes or the funds will be released. If the\
        \ `transfer` field of an `Authorization` is **null**, it hasn't been captured\
        \ yet.\n\nLearn how to prevent duplicate authorizations by passing an [Idempotency\
        \ ID](#section/Idempotency-Requests) in the payload.\n- `Authorizations` on\
        \ debit cards place a hold on funds in the cardholder's bank account and can\
        \ lead to lower than expected balances or issues with insufficient funds."
      summary: Create an Authorization
      operationId: createAuthorization
      requestBody:
        $ref: '#/components/requestBodies/CreateAuthorizationRequest'
      responses:
        '201':
          $ref: '#/components/responses/Authorization'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '402':
          $ref: '#/components/responses/ErrorPaymentRequired'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-java-method-name: create
      x-python-method-name: create
    get:
      tags:
        - Authorizations
      description: 'Retrieve a list of `Authorizations`. '
      summary: List Authorizations
      operationId: listAuthorizations
      parameters:
        - $ref: '#/components/parameters/QueryAmountFilter'
        - $ref: '#/components/parameters/QueryAmountGtFilter'
        - $ref: '#/components/parameters/QueryAmountGteFilter'
        - $ref: '#/components/parameters/QueryAmountLtFilter'
        - $ref: '#/components/parameters/QueryAmountLteFilter'
        - $ref: '#/components/parameters/QueryBeforeCursor'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryIdempotencyIdFilter'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QuerySort'
        - in: query
          name: state
          description: Filter by Transaction state.
          schema:
            enum:
              - SUCCEEDED
              - FAILED
              - PENDING
              - CANCELED
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
        - $ref: '#/components/parameters/QueryTraceIdFilter'
        - $ref: '#/components/parameters/QueryVoidFilter'
        - in: query
          name: instrument_bin
          description: Filter by Bank Identification Number (BIN). The BIN is the first
            6 digits of the masked number.
          schema:
            type: string
        - schema:
            type: string
          in: query
          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 number\tinstrument_account_last4=9444\
          \ BIN."
        - schema:
            type: string
          in: query
          name: instrument_brand_type
          description: Filter by card brand. Available card brand types can be found
            in the drop-down.
        - schema:
            type: string
          in: query
          name: merchant_identity_id
          description: Filter by `Identity` ID.
        - schema:
            type: string
          in: query
          name: merchant_identity_name
          description: Filter Transactions by `Identity` name. The name is not case-sensitive.
        - schema:
            type: string
          in: query
          name: instrument_name
          description: Filter Transactions by `Payment Instrument` name.
        - schema:
            type: string
          in: query
          name: instrument_type
          description: 'Filter Transactions by `Payment Instrument` type. Available
          instrument types include: Bank Account or Payment Card.'
        - schema:
            type: string
          in: query
          name: merchant_id
          description: Filter by `Merchant` ID.
        - schema:
            type: string
          in: query
          name: merchant_mid
          description: Filter by Merchant Identification Number (MID).
        - schema:
            type: string
          in: query
          name: instrument_card_last4
          description: Filter by the payment card last 4 digits.
        - schema:
            type: string
          in: query
          name: merchant_processor_id
          description: Filter by `Processor` ID.
        - schema:
            type: string
          in: query
          name: type
          description: Type of the `Authorization`.
        - $ref: '#/components/parameters/QueryAfterCursor'
      responses:
        '200':
          $ref: '#/components/responses/AuthorizationsList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '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/authorizations \\\n \
          \ -H \"Content-Type: application/vnd.json+api\" \\\n  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041\n"
      x-python-method-name: list
      x-returns-list: true
  /authorizations/{authorization_id}:
    get:
      tags:
        - Authorizations
      description: Retrieve the details of a previously created `Authorization`.
      summary: Fetch an Authorization
      operationId: getAuthorization
      responses:
        '200':
          $ref: '#/components/responses/Authorization'
        '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/authorizations/AUcaGi9WKyKn2GwX3bNSpsXo\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041\n"
      x-python-method-name: get
    parameters:
      - $ref: '#/components/parameters/AuthorizationId'
    put:
      tags:
        - Authorizations
      description: "If successfully captured, the `transfer` field of the `Authorization`\
        \ will contain the ID of the `Transfer` resource that'll move funds. \n\n\
        By default, `Transfers` are in a **PENDING** state. The **PENDING** state\
        \ means the request to capture funds hasn't been submitted yet. Capture requests\
        \ get submitted via a batch request. \n\nOnce the `Authorization` is updated\
        \ with a `capture_amount` (i.e. *Captured*), the state of the `Transfer` will\
        \ update to **SUCCEEDED**.\n\n> Voided `Authorizations` can't be captured."
      summary: Capture an Authorization
      operationId: captureAuthorization
      requestBody:
        $ref: '#/components/requestBodies/UpdateAuthorizationRequest'
      responses:
        '200':
          $ref: '#/components/responses/AuthorizationUpdated'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-internal: false
      x-java-method-name: update
      x-python-method-name: update
  /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-python-method-name: create
    parameters: []
    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 `balance_transfers`.
      parameters:
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryOffset'
        - 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/ \\\
          \n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99\n"
      x-python-method-name: list
      x-returns-list: true
  /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\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99\n"
      x-python-method-name: get
  /devices/{device_id}:
    get:
      description: 'Retrieve the details of an existing `Device`.


        To check the connectivity of the device, include `?include_connection\=true\`
        at the end of the request endpoint.'
      summary: Fetch a Device
      operationId: getDevice
      responses:
        '200':
          $ref: '#/components/responses/Device'
        '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:
        - schema:
            type: boolean
          in: query
          name: include_connection
          description: Specifies whether the connection information should be included.
      x-group-parameters: true
      tags:
        - Devices
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3\n"
      x-python-method-name: get
    parameters:
      - description: ID of the `Device`.
        required: true
        in: path
        name: device_id
        schema:
          type: string
    put:
      description: Initiate an action on a `Device`. These actions include activation,
        rebooting, setting an idle message, or deactivate it.
      summary: Initiate Action on Device
      operationId: updateDevice
      requestBody:
        $ref: '#/components/requestBodies/UpdateDeviceRequest'
      responses:
        '200':
          $ref: '#/components/responses/Device'
        '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
      tags:
        - Devices
      x-python-method-name: update
  /disputes:
    get:
      tags:
        - Disputes
      description: Retrieve a list of `Disputes`.
      summary: List Disputes
      operationId: listDisputes
      parameters:
        - $ref: '#/components/parameters/QuerySort'
        - $ref: '#/components/parameters/QueryOffset'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
      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/ \\\n  -H \"\
          Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /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
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    parameters:
      - description: ID of `Dispute` to fetch.
        required: true
        in: path
        name: dispute_id
        schema:
          type: string
  /disputes/{dispute_id}/evidence:
    post:
      tags:
        - Disputes
      description: 'Upload dispute 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 JPG, PNG, PDF, or TIFF.

        - Individual PNG and JPEG files can''t exceed 50 KB; PDF and TIFF files can''t
        exceed 1 MB.'
      summary: Upload 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'
      parameters: []
      requestBody:
        $ref: '#/components/requestBodies/CreateDisputeEvidenceRequest'
      x-python-method-name: create_dispute_evidence
    get:
      tags:
        - Disputes
      description: Retrieve a list of dispute evidence for a `Dispute`.
      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/DIs7yQRkHDdMYhurzYz72SFk/evidence\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list_dispute_evidence_by_dispute_id
      x-returns-list: true
    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`. \n\nIf you don't have\
        \ the Finix Dashboard available, you can fetch the evidence to review the\
        \ `status` 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/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get_dispute_evidence
    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
  /fee_profiles:
    get:
      description: List all `Fee Profiles`.
      summary: List Fee Profiles
      operationId: listFeeProfiles
      responses:
        '200':
          $ref: '#/components/responses/FeeProfilesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: list
      x-group-parameters: true
      parameters:
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
        - $ref: '#/components/parameters/QueryLimit'
      tags:
        - Fee Profiles
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/fee_profiles \\\n  -H\
          \ \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
    post:
      description: Create a `fee_profile`.
      summary: Create a Fee Profile
      operationId: createFeeProfile
      requestBody:
        $ref: '#/components/requestBodies/CreateFeeProfileRequest'
      responses:
        '201':
          $ref: '#/components/responses/FeeProfile'
        '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
      tags:
        - Fee Profiles
      x-python-method-name: create
  /fee_profiles/{fee_profile_id}:
    get:
      description: Get a `fee_profile`.
      summary: Fetch a Fee Profile
      operationId: getFeeProfile
      responses:
        '200':
          $ref: '#/components/responses/FeeProfile'
        '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
      tags:
        - Fee Profiles
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    parameters:
      - required: true
        in: path
        name: fee_profile_id
        schema:
          type: string
        description: The ID of the `fee_profile`.
  /identities:
    post:
      tags:
        - Identities
      description: "Create an `Identity` for your merchant or buyer.\n\nAll fields\
        \ for a buyer's `Identity` are optional. \n\nProviding `business_type` indicates\
        \ that the `Identity` is being created for a Merchant.\n\nCreating `Identities`\
        \ for merchants requires they provide [KYC details](/docs/guides/getting-started/).\n\
        - When creating an `Identity` for a buyer , don't pass the `business_type`\
        \ field. Including a value for `business_type` configures the created `Identity`\
        \ to get processed as a merchant.\n- When creating an `Identity` for a buyer,\
        \ all fields are optional .\nRelated Guides: [Getting Started](/docs/guides/getting-started/),\
        \ [Onboarding](/docs/guides/onboarding/)"
      summary: Create an Identity
      operationId: createIdentity
      requestBody:
        $ref: '#/components/requestBodies/CreateIdentityRequest'
      responses:
        '201':
          $ref: '#/components/responses/Identity'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: create
      x-python-method-name: create
    get:
      tags:
        - Identities
      description: Retrieves a list of `Identities`.
      summary: List Identities
      operationId: listIdentities
      parameters:
        - $ref: '#/components/parameters/QuerySort'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryIdFilter'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryDefaultStatementDescriptorFilter'
        - $ref: '#/components/parameters/QueryBusinessName'
        - $ref: '#/components/parameters/QueryBusinessType'
        - $ref: '#/components/parameters/QueryEmail'
        - $ref: '#/components/parameters/QueryFirstName'
        - $ref: '#/components/parameters/QueryLastName'
        - $ref: '#/components/parameters/QueryTitle'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      responses:
        '200':
          $ref: '#/components/responses/IdentitiesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '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/identities \\\n  -H \"\
          Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /identities/{identity_id}:
    get:
      tags:
        - Identities
      description: Retrieve the details of a previously created `Identity`.
      summary: Fetch an Identity
      operationId: getIdentity
      responses:
        '200':
          $ref: '#/components/responses/Identity'
        '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/identities/IDgWxBhfGYLLdkhxx2ddYf9K\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    parameters:
      - description: ID of the `Identity` to fetch.
        required: true
        in: path
        name: identity_id
        schema:
          type: string
    put:
      tags:
        - Identities
      description: "Update an existing `Identity`.\n\nIf you are updating the `Identity`\
        \ of a `Merchant` that\u2019s already been onboarded, you need to [verify\
        \ the merchant again](#operation/createMerchantVerification)."
      summary: Update an Identity
      operationId: updateIdentity
      requestBody:
        $ref: '#/components/requestBodies/UpdateIdentityRequest'
      responses:
        '200':
          $ref: '#/components/responses/Identity'
        '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-java-method-name: update
      x-python-method-name: update
  /identities/{identity_id}/associated_identities:
    post:
      tags:
        - Identities
      description: Create an associated `Identity` for [every owner with 25% or more
        ownership](/guides/onboarding/#step-3-add-associated-identities) over the
        merchant.
      summary: Create an Associated Identity
      operationId: createAssociatedIdentity
      requestBody:
        $ref: '#/components/requestBodies/CreateAssociatedIdentityRequest'
      responses:
        '201':
          $ref: '#/components/responses/Identity'
        '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-java-method-name: createAssociatedIdentity
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/identities/IDgXNAaoy5d4TLkp5ze6gScA/associated_identities\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n\
          \  -d '\n{\n    \"entity\": {\n        \"first_name\": \"John\", \n    \
          \    \"last_name\": \"Smith\", \n        \"title\": \"Founder\", \n    \
          \    \"dob\": {\n            \"month\": 1, \n            \"day\": 1, \n\
          \            \"year\": 2013\n        }, \n        \"principal_percentage_ownership\"\
          : 25, \n        \"phone\": \"1234567890\", \n        \"personal_address\"\
          : {\n            \"city\": \"San Francisco\", \n            \"region\":\
          \ \"CA\", \n            \"postal_code\": \"90650\", \n            \"line1\"\
          : \"123 Main Street\", \n            \"country\": \"USA\"\n        }, \n\
          \        \"email\": \"john.smith@company1.com\", \n        \"tax_id\": \"\
          123456789\"\n    }\n}'\n"
      x-python-method-name: create_associated_identity
    get:
      tags:
        - Identities
      description: Retrieve a list of `Associated Identities` for an `Identity`.
      summary: List Associated Identities
      operationId: listIdentityAssociatedIdentities
      parameters:
        - required: false
          in: query
          name: limit
          schema:
            type: integer
            format: int64
          description: The number of entries to return.
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      responses:
        '200':
          $ref: '#/components/responses/IdentitiesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: listAssociatedIdentities
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/identities/IDf33pdVaTZGXVFNccdKvaPu/associated_identities\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list_associated_identities
      x-returns-list: true
    parameters:
      - description: ID of `Identity` to associate object with.
        required: true
        in: path
        name: identity_id
        schema:
          type: string
  /identities/{identity_id}/merchants:
    parameters:
      - description: ID of `Identity` to fetch.
        required: true
        in: path
        name: identity_id
        schema:
          type: string
    post:
      description: "Create a `Merchant` to start the underwriting (also called provisioning)\
        \ process for your merchant. `Merchants` must be created under an [`Identity`](#tag/Identities).\n\
        \n> A bank account must be associated with the previously created `Identity`\
        \ before a `Merchant` can be succefully onboarded and verified.\n\n`Merchant`\
        \ resources can have three possible `onboarding_states`:\n\n1. **PROVISIONING**:\
        \ The request is pending (the state can change after two minutes).\n    *\
        \ `processing_enabled`: **False**\n    * `settlement_enabled`: **False**\n\
        \n1. **APPROVED**: The `Merchant` has been approved and can begin processing\
        \ payments.\n    * `processing_enabled`: **True**\n   * `settlement_enabled`:\
        \ **True**\n\n1. **REJECTED**: The `Merchant` was rejected by the processor\
        \ because of invalid information or it failed a regulatory and/or compliance\
        \ check (e.g. KYC, OFAC, or MATCH). Make any changes that are needed, and\
        \ [try verifying the `Merchant` again](#operation/createMerchantVerification).\n\
        \    * `processing_enabled`: **False**\n    * `settlement_enabled`: **False**\n\
        \n\n> Provisioning a `Merchant` account is an asynchronous request. We recommend\
        \ creating a [`Webhook`](#tag/Webhooks) to listen for the state change."
      summary: Create a Merchant
      operationId: createMerchant
      requestBody:
        $ref: '#/components/requestBodies/CreateMerchantUnderwritingRequest'
      responses:
        '201':
          $ref: '#/components/responses/Merchant'
        '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/ErrorUnprocessableEntity'
      tags:
        - Merchants
      x-java-method-name: create
      x-python-method-name: create
  /identities/{identity_id}/settlements:
    parameters:
      - description: 'ID of the `Identity` for the merchant you want to settle. '
        required: true
        in: path
        name: identity_id
        schema:
          type: string
    post:
      description: "Close the currently accruing `settlement`. \n\nFinix, by default,\
        \ creates accruing `settlements` then closes them based on your payout configurations.\
        \ Use this endpoint to manually close the currently accruing settlement.\n\
        \nThe closed `Settlement` will not accrue any further transactions and gets\
        \ immediately submitted for approval.\n- Any refunded `Transfers` get included\
        \ in `Settlements` as a deduction.\n- **PENDING** `Transfers` don't get included\
        \ in `Settlements`. \n- The `total_amount` minus the `total_fee` equals the\
        \ `net_amount`. The `net_amount` is the amount in cents that gets deposited\
        \ into the merchant's bank account.\n\nRelated Guides: [Accruing Settlements](/guides/payouts/~accruing-settlements/#closing-an-accruing-settlement)"
      summary: Close Current Active Settlement
      operationId: createIdentitySettlement
      requestBody:
        $ref: '#/components/requestBodies/CreateIdentitySettlementRequest'
      responses:
        '201':
          $ref: '#/components/responses/Settlement'
        '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/ErrorMerchantIdentityDisabled'
      x-internal: false
      x-java-method-name: create
      tags:
        - Settlements
      x-python-method-name: create
  /identities/{identity_id}/verifications:
    parameters:
      - description: ID of `Identity` to verify.
        required: true
        in: path
        name: identity_id
        schema:
          type: string
    post:
      summary: Verify an Identity
      operationId: createIdentityVerification
      responses:
        '201':
          $ref: '#/components/responses/Verification'
        '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'
      description: Verify an `Identity`.
      requestBody:
        $ref: '#/components/requestBodies/CreateVerificationRequest'
      tags:
        - Identities
      x-python-method-name: create_identity_verification
  /merchant_profiles:
    get:
      tags:
        - Merchant Profiles
      description: Retireve a list of all `merchant_profiles`.
      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 \\\n\
          \  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /merchants:
    get:
      tags:
        - Merchants
      description: 'Retrieve a list of `Merchants`. '
      summary: List Merchants
      operationId: listMerchants
      parameters:
        - $ref: '#/components/parameters/QueryIdFilter'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QuerySort'
      responses:
        '200':
          $ref: '#/components/responses/MerchantsList'
        '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-java-method-name: list
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/merchants \\\n  -H \"\
          Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /merchants/{merchant_id}/devices:
    parameters:
      - description: ID of the `Merchant` object.
        required: true
        in: path
        name: merchant_id
        schema:
          type: string
    post:
      description: Create a `Device` under a `Merchant`.
      summary: Create a Device
      operationId: createMerchantDevice
      responses:
        '200':
          $ref: '#/components/responses/Device'
        '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:
        - Devices
      requestBody:
        $ref: '#/components/requestBodies/CreateDeviceRequest'
      x-java-method-name: create
      x-python-method-name: create
  /merchants/{merchant_id}:
    get:
      tags:
        - Merchants
      description: Retrieve the details of a `Merchant`.
      summary: Fetch a Merchant
      operationId: getMerchant
      responses:
        '200':
          $ref: '#/components/responses/Merchant'
        '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/merchants/MUmUL7aBsHkxVLQawJxEXw6N\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    parameters:
      - description: ID of `Merchant`.
        required: true
        in: path
        name: merchant_id
        schema:
          type: string
    put:
      tags:
        - Merchants
      description: "Update a `Merchant` to: \n- Change the `Identity` information\
        \ saved with the underlying processor\n- Enable Level 2/3 processing\n- Enable\
        \ [Buyer Chages](/guides/payments/buyer-charges/)"
      summary: Update a Merchant
      operationId: updateMerchant
      requestBody:
        $ref: '#/components/requestBodies/UpdateMerchantRequest'
      responses:
        '200':
          $ref: '#/components/responses/MerchantUpdated'
        '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-python-method-name: update
  /merchant_profiles/{merchant_profile_id}:
    get:
      tags:
        - Merchant Profiles
      description: Retrieve the details of a previosuly 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/MPsdo8WPP5erWzfPwMjYjVy3\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    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-internal: false
      x-python-method-name: update
  /merchants/{merchant_id}/verifications:
    get:
      description: Get a list of all the `Verifications` for a `Merchant` resource.
      summary: List Merchant Verifications
      operationId: listMerchantVerifications
      parameters:
        - required: false
          in: query
          name: limit
          schema:
            type: integer
            format: int64
          description: The number of entries to return.
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      responses:
        '200':
          $ref: '#/components/responses/VerificationsList'
        '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: listByMerchantId
      x-group-parameters: true
      tags:
        - Verifications
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list_by_merchant_id
      x-returns-list: true
    parameters:
      - description: ID of `Merchant` object.
        required: true
        in: path
        name: merchant_id
        schema:
          type: string
    post:
      tags:
        - Merchants
      description: If the `onboarding_state` for a `Merchant` returns **FAILED**,
        correct the `Identity` information saved for the `Merchant`. Once corrected,
        try verifying (also called provisioning) the `Merchant` again with another
        request.
      summary: Verify a Merchant
      operationId: createMerchantVerification
      requestBody:
        $ref: '#/components/requestBodies/CreateVerificationRequest'
      responses:
        '201':
          $ref: '#/components/responses/Verification'
        '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-python-method-name: create_merchant_verification
  /payment_instruments:
    post:
      tags:
        - Payment Instruments
      description: 'Create a `Payment Instrument` resource using a card or bank account.


        To accept payment details, review our guide on how to [tokenize cards using
        hosted fields](/guides/payments/tokenization-with-hosted-fields).


        - The creation of `Payment Instruments` directly via Finix''s API should only
        be done for testing purposes. You must use the Hosted Tokenization fields
        or the javascript client to remain out of PCI scope.'
      summary: Create a Payment Instrument
      operationId: createPaymentInstrument
      requestBody:
        $ref: '#/components/requestBodies/CreatePaymentInstrumentRequest'
      responses:
        '201':
          $ref: '#/components/responses/PaymentInstrument'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: create
      x-python-method-name: create
    get:
      tags:
        - Payment Instruments
      description: Retrieve a list of `Payment Instruments`.
      summary: List Payment Instruments
      operationId: listPaymentInstruments
      parameters:
        - $ref: '#/components/parameters/QueryAccountLastFour'
        - $ref: '#/components/parameters/QueryAccountRoutingNumber'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryApplicationFilter'
        - $ref: '#/components/parameters/QueryBeforeCursor'
        - $ref: '#/components/parameters/QueryBin'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryExpirationMonth'
        - $ref: '#/components/parameters/QueryExpirationYear'
        - $ref: '#/components/parameters/QueryLastFour'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryName'
        - $ref: '#/components/parameters/QueryOwnerIdentity'
        - $ref: '#/components/parameters/QueryPaymentInstrumentType'
      responses:
        '200':
          $ref: '#/components/responses/PaymentInstrumentsList'
        '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/payment_instruments \\\
          \n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /payment_instruments/{payment_instrument_id}:
    get:
      tags:
        - Payment Instruments
      description: Retrieve the details of a `Payment Instrument`.
      summary: Fetch a Payment Instrument
      operationId: getPaymentInstrument
      responses:
        '200':
          $ref: '#/components/responses/PaymentInstrument'
        '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-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    parameters:
      - description: ID of object
        required: true
        in: path
        name: payment_instrument_id
        schema:
          type: string
    put:
      tags:
        - Payment Instruments
      description: Update a `Payment Instrument`.
      summary: Update a Payment Instrument
      operationId: updatePaymentInstrument
      requestBody:
        $ref: '#/components/requestBodies/UpdatePaymentInstrumentRequest'
      responses:
        '200':
          $ref: '#/components/responses/PaymentInstrument'
        '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-python-method-name: update
  /payment_instruments/{payment_instrument_id}/updates:
    get:
      tags:
        - Payment Instruments
      description: 'List the updates on a `Payment Instrument`.


        When using the [account updater](/guides/payments/account-updater), `Payment
        Instrument` details that are updated are represented by an `Update`.'
      summary: List Payment Instrument Updates
      operationId: listPaymentInstrumentUpdates
      parameters:
        - required: false
          in: query
          name: limit
          schema:
            type: integer
            format: int64
          description: The number of entries to return.
        - required: false
          in: query
          name: offset
          schema:
            type: integer
            format: int64
          description: The number of items to skip before starting to collect the result
            set.
        - required: false
          in: query
          name: pageSize
          schema:
            type: integer
            format: int64
          description: The size of the page.
      responses:
        '200':
          $ref: '#/components/responses/PaymentInstrumentUpdatesList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: listUpdatesByPaymentInstrumentId
      x-group-parameters: true
      x-internal: false
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/updates\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list_updates_by_payment_instrument_id
      x-returns-list: true
    parameters:
      - description: ID of `Payment Instrument` object.
        required: true
        in: path
        name: payment_instrument_id
        schema:
          type: string
  /payment_instruments/{payment_instrument_id}/verifications:
    get:
      tags:
        - Verifications
      description: List all the `Verifications` created for a `Payment Instrument`.
      summary: List Payment Instrument Verifications
      operationId: listPaymentInstrumentVerifications
      parameters:
        - required: false
          in: query
          name: limit
          schema:
            type: integer
            format: int64
          description: The number of entries to return.
        - required: false
          in: query
          name: offset
          schema:
            type: integer
            format: int64
          description: The number of items to skip before starting to collect the result
            set.
        - required: false
          in: query
          name: pageNumber
          schema:
            type: integer
            format: int64
          description: The page number to list.
        - required: false
          in: query
          name: pageSize
          schema:
            type: integer
            format: int64
          description: The size of the page.
      responses:
        '200':
          $ref: '#/components/responses/VerificationsList'
        '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: listByPaymentInstrumentId
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/payment_instruments/PImc5nvdnp15atLxEBAGtxJs/verifications/\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USpEbizhxFRAFT7oYgWjX87B:6d3ace2c-23f9-4e59-8b75-a1a5b8a53055\n"
      x-python-method-name: list_by_payment_instrument_id
      x-returns-list: true
    parameters:
      - description: ID of `Payment Instrument `object.
        required: true
        in: path
        name: payment_instrument_id
        schema:
          type: string
  /settlements:
    get:
      tags:
        - Settlements
      description: 'Retrieve a list of `Settlements`.

        '
      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/QueryIdFilter'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      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/ \\\n  -H\
          \ \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /settlements/{settlement_id}:
    get:
      tags:
        - Settlements
      description: Retreive 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/STimypRqs5TXoCDRq2swMFUY\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    parameters:
      - 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**.
      summary: List Settlement Funding Transfers
      operationId: listSettlementFundingTransfers
      responses:
        '200':
          $ref: '#/components/responses/TransfersList'
        '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'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list_funding_transfers
      x-returns-list: true
    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 a `Transfer` that makes up a `Settlement`.


        As long as the `Settlement` hasn''t 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
      requestBody:
        $ref: '#/components/requestBodies/RemoveSettlementTransfer'
      x-python-method-name: remove_transfers_from_settlement
    get:
      description: Retrieve a list of every `Transfer` in a `Settlement` that has
        `type` **DEBIT** or **REFUND**.
      summary: List Settlement Transfers
      operationId: listSettlementTransfers
      responses:
        '200':
          $ref: '#/components/responses/TransfersList'
        '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'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list_transfers_by_settlement_id
      x-returns-list: true
    parameters:
      - description: ID of `Settlement` object.
        required: true
        in: path
        name: settlement_id
        schema:
          type: string
  /transfers:
    post:
      tags:
        - Transfers
      description: "Create a `Transfer`. \n\n> By default, Finix implements a 3 (business)\
        \ day delay when debiting bank accounts (i.e. eChecks)."
      summary: Create a Transfer
      operationId: createTransfer
      requestBody:
        $ref: '#/components/requestBodies/CreateTransferRequest'
      responses:
        '201':
          $ref: '#/components/responses/Transfer'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '402':
          $ref: '#/components/responses/ErrorTransfers402'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      x-java-method-name: create
      x-python-method-name: create
    get:
      tags:
        - Transfers
      description: Retrieve a list of `Transfers`.
      summary: List Transfers
      operationId: listTransfers
      parameters:
        - $ref: '#/components/parameters/QuerySort'
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryLimit'
        - $ref: '#/components/parameters/QueryAmountFilter'
        - $ref: '#/components/parameters/QueryAmountGteFilter'
        - $ref: '#/components/parameters/QueryAmountGtFilter'
        - $ref: '#/components/parameters/QueryAmountLteFilter'
        - $ref: '#/components/parameters/QueryAmountLtFilter'
        - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
        - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
        - $ref: '#/components/parameters/QueryIdempotencyIdFilter'
        - $ref: '#/components/parameters/QueryIdFilter'
        - in: query
          name: state
          description: Filter by Transaction state.
          schema:
            enum:
              - ALL
              - SUCCEEDED
              - FAILED
              - PENDING
              - CANCELED
        - $ref: '#/components/parameters/QuerySettlementReadyToSettleAtGteFilter'
        - $ref: '#/components/parameters/QuerySettlementReadyToSettleAtLteFilter'
        - $ref: '#/components/parameters/QueryStatementDescriptorFilter'
        - $ref: '#/components/parameters/QueryTraceIdFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
        - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
        - in: query
          name: instrument_bin
          description: Filter by Bank Identification Number (BIN). The BIN is the first
            6 digits of the masked number.
          schema:
            type: string
        - schema:
            type: string
          in: query
          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 number\tinstrument_account_last4=9444\
          \ BIN."
        - schema:
            type: string
          in: query
          name: instrument_brand_type
          description: Filter by card brand. Available card brand types can be found
            in the drop-down.
        - schema:
            type: string
          in: query
          name: merchant_identity_id
          description: Filter by `Identity` ID.
        - schema:
            type: string
          in: query
          name: merchant_identity_name
          description: Filter Transactions by `Identity` name. The name is not case-sensitive.
        - schema:
            type: string
          in: query
          name: instrument_name
          description: Filter Transactions by `Payment Instrument` name.
        - schema:
            type: string
          in: query
          name: instrument_type
          description: 'Filter Transactions by `Payment Instrument` type. Available
          instrument types include: Bank Account or Payment Card'
        - schema:
            type: string
          in: query
          name: merchant
          description: Filter by `Merchant` ID.
        - schema:
            type: string
          in: query
          name: merchant_mid
          description: Filter by Merchant Identification Number (MID).
        - schema:
            type: string
          in: query
          name: instrument_card_last4
          description: Filter by the payment card last 4 digits.
        - schema:
            type: string
          in: query
          name: merchant_processor_id
          description: Filter by `Processor` ID.
        - schema:
            type: string
            enum:
              - ALL
              - DEBITS
              - CREDITS
              - REVERSAL
              - SETTLEMENT
            example: REVERSAL
          in: query
          name: type
          description: 'Filter by `Transfer` type. Available type filters include: All,
          Debits, Refunds, or Credits.'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      responses:
        '200':
          $ref: '#/components/responses/TransfersList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '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/transfers \\\n  -H \"\
          Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /transfers/{transfer_id}:
    get:
      tags:
        - Transfers
      description: Retrieve a `Transfer`.
      summary: Fetch a Transfer
      operationId: getTransfer
      responses:
        '200':
          $ref: '#/components/responses/Transfer'
        '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/transfers/TRvypRNBeqM597Zi4DcqJ2Vh\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    parameters:
      - description: ID of `Transfer` resource.
        required: true
        in: path
        name: transfer_id
        schema:
          type: string
    put:
      tags:
        - Transfers
      description: Update a `Transfer`.
      summary: Update a Transfer
      operationId: updateTransfer
      responses:
        '200':
          $ref: '#/components/responses/Transfer'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      requestBody:
        $ref: '#/components/requestBodies/UpdateTransferRequest'
      x-java-method-name: update
      x-python-method-name: update
  /transfers/{transfer_id}/reversals:
    post:
      tags:
        - Transfers
      description: "Reverse a transfer with a `type` of **DEBIT**. This reversal creates\
        \ a new `Transfer` resource with a `type` of **REVERSAL**. \n\nThe refund\
        \ can get delivered in most cases without the physical card. The card only\
        \ needs to be swiped (to receive the refund) when:\n\n- The payment type is\
        \ **DEBIT**, and the transaction is no longer in the Settlement batch.\n-\
        \ The payment type is **CREDIT**, and the transaction is no longer in the\
        \ batch and is older than 45 days."
      summary: Refund or Reverse a Transfer
      operationId: createTransferReversal
      requestBody:
        $ref: '#/components/requestBodies/CreateReversalRequest'
      responses:
        '201':
          $ref: '#/components/responses/Transfer'
        '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/ErrorUnprocessableEntity'
      x-python-method-name: create_transfer_reversal
    get:
      tags:
        - Transfers
      description: Retrieve a list of reversals for a `Transfer`.
      summary: List Reversals on a Transfer
      operationId: listTransferReversals
      parameters:
        - required: false
          in: query
          name: limit
          schema:
            type: integer
            format: int64
          description: The number of entries to return.
        - $ref: '#/components/parameters/QueryAfterCursor'
        - $ref: '#/components/parameters/QueryBeforeCursor'
      responses:
        '200':
          $ref: '#/components/responses/ReversalsList'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      x-java-method-name: listTransfersReversals
      x-group-parameters: true
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list_transfers_reversals
      x-returns-list: true
    parameters:
      - description: ID of `Transfer` object.
        required: true
        in: path
        name: transfer_id
        schema:
          type: string
  /verifications:
    post:
      tags:
        - Verifications
      description: 'Create a `Verification` to verify a merchant''s `Identity`.


        Verifications can also be created directly on the resources you want to verify:

        - `POST /merchants/{merchant_id}/verifications`


        Verify `Payment Instruments` directly on the resource:


        - `POST /payment_instruments/{payment_instrument_id}/verifications`'
      summary: Create a Merchant Verification
      operationId: createVerification
      requestBody:
        $ref: '#/components/requestBodies/CreateVerificationRequest'
      responses:
        '201':
          $ref: '#/components/responses/Verification'
        '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
      x-python-method-name: create
    get:
      tags:
        - Verifications
      description: Retrieve a list of `Verifications`.
      summary: List Verifications
      operationId: listVerifications
      parameters:
        - $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 \\\n  -H\
          \ \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /verifications/{verification_id}:
    get:
      tags:
        - Verifications
      description: Retrieve the details of a `Verification`.
      summary: Fetch a Verification
      operationId: getVerification
      responses:
        '200':
          $ref: '#/components/responses/Verification'
        '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/verifications/VIbXwBuccEcqw7rfZneELCv4\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    parameters:
      - description: ID of `Verification` object.
        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
      x-python-method-name: create
    get:
      tags:
        - Webhooks
      description: Retrieve a list of `Webhooks`.
      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 \\\n  -H \"\
          Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /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
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-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`.
      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
      x-python-method-name: update
  /instrument_updates:
    post:
      summary: Create Instrument Updates
      operationId: createPaymentInstrumentUpdate
      responses:
        '200':
          $ref: '#/components/responses/InstrumentUpdate'
        '400':
          $ref: '#/components/responses/ErrorUnprocessableEntity'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: To update the card details of your customers, create an `instrument_updates`
        resource. Include the `Payment Instrument` IDs you want to update in a CSV.
      requestBody:
        $ref: '#/components/requestBodies/CreateInstrumentUpdateRequest'
      parameters: []
      tags:
        - Instrument Updates
      x-java-method-name: create
      x-python-method-name: create
  /instrument_updates/{instrument_updates_id}/download:
    parameters:
      - schema:
          type: string
        name: instrument_updates_id
        in: path
        required: true
        description: The ID of the `instrument_updates` resource. This ID was returned
          when initially creating the `instrument_updates` object.
    get:
      summary: Download Instrument Updates
      tags:
        - Instrument Updates
      responses:
        '200':
          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\n\
            PIlkAOt5kTVhuuxxbmOi9qn |  | INVALID\\_CARD\nPIiRLbbG4i5daypWNzIrq2xD\
            \   |  | NO\\_CHANGE\\_FOUND\nPIy5llZGt6VxlDqbcTgATqeH     | \t  | UNKNOWN"
          content:
            application/json:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: downloadInstrumentUpdate
      description: "Fetch a previously created `instrument_updates` resource as a\
        \ CSV. \n\nTo fetch the `instrument_updates` resource in JSON, add `?format=json`\
        \ to the request endpoint."
      parameters:
        - $ref: '#/components/parameters/QueryFormat'
      x-group-parameters: true
      x-java-method-name: download
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/instrument_updates/IUp9oSWhWUF31DPrJ8CojQeQ/download\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: download
  /files:
    post:
      summary: Create a File
      operationId: createFiles
      responses:
        '200':
          $ref: '#/components/responses/File'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      description: "Before uploading a file, you need to create a `File` resource.\
        \ \n\nOnce created, you can [upload](/#operation/uploadFile) your file to\
        \ the new `File` resource."
      requestBody:
        $ref: '#/components/requestBodies/CreateFileRequest'
      tags:
        - Files
      x-java-method-name: create
      x-python-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: List all the `File` resources you've created. For more info, see
        [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-1-create-a-file).
      parameters:
        - $ref: '#/components/parameters/QuerySort'
        - $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 \\\n  -H \"Content-Type:\
          \ application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /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/File'
        '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. For more info see [Uploading
        files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/files/FILE_abki8bFEjq51eZ5w2pYFik\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
  /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
        more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).
      parameters:
        - $ref: '#/components/parameters/QuerySort'
        - $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_bJecqoRPasStEPVpvKHtgA/external_links\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list_external_links
      x-returns-list: true
    post:
      summary: Create an External Link
      operationId: createExternalLink
      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'
      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](/docs/guides/onboarding/uploading-files-to-finix/). \n\n\
        Once created, you can request the user to upload a file to the `external_link`\
        \ resource: [Upload files to External Link](#operation/uploadExternalLink)"
      requestBody:
        $ref: '#/components/requestBodies/CreateExternalLinkRequest'
      tags:
        - Files
      x-python-method-name: create_external_link
  /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/File'
        '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. For
        more info see, [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-2-upload-the-file).
      parameters: []
      x-java-method-name: upload
      tags:
        - Files
      requestBody:
        $ref: '#/components/requestBodies/UploadFileRequest'
      x-python-method-name: upload
  /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. For more
        info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix).
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStGPVpvKHtgA/download\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: download
  /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 retireve.
    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. For more info
        see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links/EL_dh5YS66GePpkeSVyL4VdBL\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get_external_link
  /apple_pay_sessions:
    post:
      summary: Create an Apple Pay Session
      operationId: createApplePaySession
      responses:
        '200':
          $ref: '#/components/responses/ApplePaySession'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      tags:
        - Payment Instruments
      x-java-method-name: createApplePaySession
      requestBody:
        $ref: '#/components/requestBodies/CreateApplePaySessionRequest'
      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](/docs/guides/payments/alternative-payment-methods/apple-pay/).'
      x-python-method-name: create_apple_pay_session
  /disputes/{dispute_id}/adjustment_transfers:
    parameters:
      - schema:
          type: string
        name: dispute_id
        in: path
        required: true
        description: ID of the `Dispute` resource.
    get:
      summary: Fetch 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/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list_disputes_adjustments
      x-returns-list: true
  /instrument_updates/{instrument_updates_id}:
    parameters:
      - schema:
          type: string
        description: The ID of the `instrument_update`.
        name: instrument_updates_id
        in: path
        required: true
    get:
      summary: Fetch an Instrument Update
      tags:
        - Instrument Updates
      responses:
        '200':
          $ref: '#/components/responses/InstrumentUpdate'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden403'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/Error406NotAcceptable'
      operationId: getInstrumentUpdate
      description: Fetch a specific `instrument_update` from an `instrument_updates`
        resource. For more information, see the guide on using our [Account Updater](/guides/payments/account-updater).
      x-java-method-name: get
      x-codeSamples:
        - lang: cURL
          label: curl
          source: "curl https://finix.sandbox-payments-api.com/instrument_updates/IUp9oSWhWUF31DPrJ8CojQeQ/\
          \ \\\n  -H \"Content-Type: application/vnd.json+api\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
  /compliance_forms/{compliance_forms_id}:
    parameters:
      - schema:
          type: string
        name: compliance_forms_id
        in: path
        required: true
        description: ID of the `compliance_form`.
    get:
      summary: View Compliance Forms
      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: getComplianceForms
      x-java-method-name: list
      description: 'A webhook notifies you when Finix creates a `compliance_form`.


        Use the ID in the webhook to fetch the `compliance_form` resource from the
        `/compliance_forms/:COMPLIANCE_FORM_ID:` endpoint.'
      x-python-method-name: list
    put:
      summary: Complete Compliance Forms
      operationId: updateComplianceForms
      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'
        '422':
          $ref: '#/components/responses/Error422InvalidField'
      description: 'As part of onboarding your users, you''ll need to build a UI experience
        that allows users to complete the PCI `compliance_form` and download the form
        as a PDF if requested.


        To complete PCI compliance forms:


        1. Get the `compliance_form` generated for the merchant using the `ID` from
        the webhook and present the form to your users when requested.

        2. Show your users the [required text](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#obtaining-compliance-consent)
        to obtain consent.

        3. Submit a PUT API request with the necessary [attestation](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-the-questionnaire)
        information.


        For more information, see [Managing Compliance Forms](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-compliance-forms).'
      tags:
        - Compliance Forms
      requestBody:
        $ref: '#/components/requestBodies/UpdateComplianceForm'
      x-java-method-name: update
      x-python-method-name: update
  /onboarding_forms:
    post:
      summary: Create an Onboarding Form
      operationId: createOnboardingForm
      responses:
        '200':
          $ref: '#/components/responses/OnboardingForm'
        '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: 'Create an onboarding_form with the name of the processor you plan
        to onboard users to and the links they get redirected to when completing or
        moving away from the Finix Onboarding Form.


        > Use your **ROLE_PARTNER** credentials to create an `onboarding_form`.'
      requestBody:
        $ref: '#/components/requestBodies/CreateOnboardingFormRequest'
      tags:
        - Onboarding Forms
      x-java-method-name: create
      x-python-method-name: create
    parameters: []
  /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
      responses:
        '200':
          $ref: '#/components/responses/OnboardingForm'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
      description: Retrieve the details of an `onboarding_form`.
      tags:
        - Onboarding Forms
      x-java-method-name: get
      x-python-method-name: get
  /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
      responses:
        '200':
          $ref: '#/components/responses/OnboardingFormLink'
        '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: You can use the `onboarding_forms` API to create a link that can
        return users to where they left off completing their Finix Onboarding Form.
      requestBody:
        $ref: '#/components/requestBodies/CreateOnboardingFormLinkRequest'
      tags:
        - Onboarding Forms
      x-java-method-name: createLink
      x-python-method-name: create_link
components:
  headers:
    date:
      schema:
        type: string
    finix-apiuser-role:
      schema:
        type: string
        enum:
          - ROLE_ADMIN
          - ROLE_PLATFORM
          - ROLE_PARTNER
          - ROLE_MERCHANT
    x-request-id:
      description: A unique ID for this specific API request attempt.
      schema:
        type: string
  parameters:
    ApplicationId:
      description: ID of `Application` to use.
      in: path
      name: application_id
      schema:
        type: string
      required: true
    ApplicationProfileId:
      description: ID of `Application` profile to use.
      required: true
      in: path
      name: application_profile_id
      schema:
        type: string
    AuthorizationId:
      description: ID of `Authorization` to fetch.
      required: true
      in: path
      name: authorization_id
      schema:
        type: string
    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
      style: form
    QueryAmountGtFilter:
      description: Filter by an amount greater than.
      in: query
      name: amount.gt
      schema:
        type: integer
      style: form
    QueryAmountGteFilter:
      description: Filter by an amount greater than or equal.
      in: query
      name: amount.gte
      schema:
        type: integer
      style: form
    QueryAmountLtFilter:
      description: Filter by an amount less than.
      in: query
      name: amount.lt
      schema:
        type: integer
      style: form
    QueryAmountLteFilter:
      description: Filter by an amount less than or equal.
      in: query
      name: amount.lte
      schema:
        type: integer
      style: form
    QueryApplicationFilter:
      description: Filter by `Application` ID.
      in: query
      name: application
      schema:
        type: string
      style: form
    QueryCreatedAtGteFilter:
      description: Filter where `created_at` is after the given date.
      in: query
      name: created_at.gte
      schema:
        type: string
        format: date-time
        example: created_at.gte=2019-06-15
      style: form
    QueryCreatedAtLteFilter:
      description: Filter where `created_at` is before the given date.
      in: query
      name: created_at.lte
      schema:
        type: string
        format: date-time
        example: created_at.lte=2019-06-15
      style: form
    QueryDefaultStatementDescriptorFilter:
      description: Filter by the `default_statement_descriptor`.
      in: query
      name: default_statement_descriptor
      schema:
        type: string
      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
      style: form
    QueryLimit:
      description: The numbers of items to return.
      example: 10
      in: query
      name: limit
      schema:
        type: integer
      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
      style: form
    QuerySettlementReadyToSettleAtGteFilter:
      description: Filter by `ready_to_settle_at`.
      in: query
      name: ready_to_settle_at.gte
      schema:
        type: string
      style: form
    QuerySettlementReadyToSettleAtLteFilter:
      description: Filter by `ready_to_settle_at`.
      in: query
      name: ready_to_settle_at.lte
      schema:
        type: string
      style: form
    QuerySort:
      description: Specify key to be used for sorting the collection.
      in: query
      name: sort
      schema:
        type: string
      style: form
    QueryStatementDescriptorFilter:
      description: Filter by `statement_descriptor`.
      in: query
      name: statement_descriptor
      schema:
        type: integer
      style: form
    QueryTraceIdFilter:
      description: Filter by `trace_id`.
      in: query
      name: trace_id
      schema:
        type: string
      style: form
    QueryUpdatedAtGteFilter:
      description: Filter where `updated_at` is after the given date.
      in: query
      name: updated_at.gte
      schema:
        type: string
      style: form
    QueryUpdatedAtLteFilter:
      description: Filter where `updated_at` is before the given date.
      in: query
      name: updated_at.lte
      schema:
        type: string
      style: form
    QueryVoidFilter:
      description: Filter by `idempotency_id`.
      in: query
      name: is_void
      schema:
        type: string
      style: form
    QueryBusinessName:
      name: business_name
      in: query
      required: false
      schema:
        type: string
      description: Filter by the full business name. Partial business names are not
        supported.
    QueryBusinessType:
      name: business_type
      in: query
      required: false
      schema:
        type: string
      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: first_name=Daphne
      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: kline
      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.
    QueryAccountLastFour:
      name: account_last4
      in: query
      required: false
      schema:
        type: string
        example: '9444'
      description: Filter by the last 4 digits of the account if available.
    QueryAccountRoutingNumber:
      name: account_routing_number
      in: query
      required: false
      schema:
        type: string
        example: '9444'
      description: Filter by the account routing number if available.
    QueryBin:
      name: bin
      in: query
      required: false
      schema:
        type: string
        example: '489514'
      description: Filter by Bank Identification Number (BIN). The BIN is the first
        6 digits of the masked number.
    QueryExpirationMonth:
      name: expiration_month
      in: query
      required: false
      schema:
        type: string
        example: '1'
      description: Filter by the expiration month associated with the `Payment Instrument`
        if applicable. This filter only applies to payment cards.
    QueryExpirationYear:
      name: expiration_year
      in: query
      required: false
      schema:
        type: string
        example: '2022'
      description: Filter by the 4 digit expiration year associated with the Payment
        Instrument if applicable. This filter only applies to payment cards.
    QueryLastFour:
      name: last_four
      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.
    QueryName:
      name: name
      in: query
      required: false
      schema:
        type: string
        example: fran%20lemke
      description: Filter by the name.
    QueryOwnerIdentity:
      name: owner_identity_id
      in: query
      required: false
      schema:
        type: string
        example: IDcWwprrKrD6cSh225JWPri3
      description: Filter by the owner id of the associated `Identity`.
    QueryPaymentInstrumentType:
      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.
    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: /download?format=json
      description: Specify the format you'd like to download the response in (JSON
        is the only other format available for download).
  requestBodies:
    CreateApplicationRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateApplicationRequest'
          examples:
            Create an Application:
              value:
                tags:
                  application_name: Finix Flowers
                user: USpbnPYf1MMaYYtBqNsNzD6T
                entity:
                  business_type: LIMITED_LIABILITY_COMPANY
                  business_phone: +1 (408) 756-4497
                  first_name: John
                  last_name: Smith
                  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: Finix Flowers
                  personal_address:
                    city: San Mateo
                    country: USA
                    region: CA
                    line2: Apartment 7
                    line1: 741 Douglass St
                    postal_code: '94114'
                  business_name: Finix Flowers
                  business_tax_id: '123456789'
                  email: user@example.org
                  tax_id: '123456789'
    UpdateApplicationProfileRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateApplicationProfileRequest'
    CreateAuthorizationRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateAuthorizationRequest'
          examples:
            Create an Authorization:
              value:
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                tags:
                  order_number: 21DFASJSAKAS
                currency: USD
                amount: 100
                processor: DUMMY_V1
            Create an Authorization (with 3D Secure):
              value:
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                3d_secure_authentication:
                  electronic_commerce_indicator: AUTHENTICATED
                  cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
                  transaction_id: EaOMucALHQqLAEGAgk
                source: PIe2YvpcjvoVJ6PzoRPBK137
                tags:
                  order_number: 21DFASJSAKAS
                currency: USD
                amount: 100
            Create an Authorization (with Level 2 Processing):
              value:
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                source: PIe2YvpcjvoVJ6PzoRPBK137
                additional_purchase_data:
                  customer_reference_number: 321xyz
                  sales_tax: 200
                tags:
                  order_number: 21DFASJSAKAS
                currency: USD
                amount: 1000
                processor: DUMMY_V1
            Create an Authorization (with Level 3 Processing):
              value:
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                source: PIe2YvpcjvoVJ6PzoRPBK137
                additional_purchase_data:
                  item_data:
                    - amount_including_sales_tax: 500
                      unit_of_measure: BX
                      merchant_product_code: '1149611'
                      amount_excluding_sales_tax: 400
                      cost_per_unit: 500
                      commodity_code: 175-62-20
                      item_discount_amount: 100
                      item_description: printing paper
                      quantity: 1
                    - amount_including_sales_tax: 500
                      unit_of_measure: CTN
                      merchant_product_code: '2149612'
                      amount_excluding_sales_tax: 400
                      cost_per_unit: 500
                      commodity_code: 207-72-54
                      item_discount_amount: 0
                      item_description: printing ink
                      quantity: 1
                  discount_amount: 100
                  customer_reference_number: 321xyz
                  shipping_amount: 100
                  customs_duty_amount: 10
                tags:
                  order_number: 21DFASJSAKAS
                currency: USD
                amount: 1000
                processor: DUMMY_V1
            Create a Card Present Authorization with an EMV Card:
              value:
                device: DVf2H8sh4LZZC52GTUrwCPPf
                tags:
                  order_number: test123transfer
                currency: USD
                amount: 150
                operation_key: CARD_PRESENT_AUTHORIZATION
            Create a Card Present Authorization with a Non-EMV Card:
              value:
                device: DVf2H8sh4LZZC52GTUrwCPPf
                tags:
                  order_number: test123transfer
                currency: USD
                amount: 150
                operation_key: CARD_PRESENT_AUTHORIZATION
            Create an Authorization with Buyer Charges:
              value:
                additional_buyer_charges:
                  rent_surcharge_amount: 150
                amount: 5200
                currency: USD
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                source: PIe2YvpcjvoVJ6PzoRPBK137
                tags:
                  test: sale
    UpdateAuthorizationRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateAuthorizationRequest'
          examples:
            Capture an Authorization:
              value:
                fee: 0
                capture_amount: 100
            Capture an Authorization (with Level 2/3 Processing):
              value:
                additional_purchase_data:
                  item_data:
                    - amount_including_sales_tax: 500
                      unit_of_measure: BX
                      merchant_product_code: '1149611'
                      amount_excluding_sales_tax: 400
                      cost_per_unit: 500
                      commodity_code: 175-62-20
                      item_discount_amount: 100
                      item_description: printing paper
                      quantity: 1
                    - amount_including_sales_tax: 500
                      unit_of_measure: CTN
                      merchant_product_code: '2149612'
                      amount_excluding_sales_tax: 400
                      cost_per_unit: 500
                      commodity_code: 207-72-54
                      item_discount_amount: 0
                      item_description: printing ink
                      quantity: 1
                  discount_amount: 100
                  customer_reference_number: 321xyz
                  shipping_amount: 100
                  customs_duty_amount: 10
                fee: 0
                capture_amount: 100
            Void an Authorization:
              value:
                void_me: true
            Capture a Card Present Authorization:
              value:
                capture_amount: 150
    CreateDisputeEvidenceRequest:
      content:
        multipart/form-data:
          schema:
            $ref: '#/components/schemas/CreateDisputeEvidenceRequest'
          examples:
            Upload dispute evidence:
              value:
                file: '@path/to/local/file'
    CreateFeeRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateFeeRequest'
          examples:
            One-Time Fee:
              value:
                amount: 1000
                currency: USD
                fee_type: CUSTOM
                fee_subtype: CUSTOM
                merchant_id: MUhQVWbSdd3Da68RKpfodqEV
                label: April_Performance_Analytics_Fees
                settlement_delay_days: 3
    CreateFeeProfileRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateFeeProfileRequest'
          examples:
            Create a Fee Profile:
              value:
                ach_fixed_fee: 30
                tags:
                  app pricing: sample
                basis_points: 200
                application: APmuwPBaW8pVcwb4vCTHQH32
                charge_interchange: false
                fixed_fee: 100
                ach_basis_points: 300
    UpdateFeeRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateFeeRequest'
          examples: {}
    CreateIdentityRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateIdentityRequest'
          examples:
            Create an Identity (Merchant):
              value:
                additional_underwriting_data:
                  merchant_agreement_accepted: true
                  merchant_agreement_ip_address: 42.1.1.113
                  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
                  average_ach_transfer_amount: 200000
                  annual_ach_volume: 200000
                  credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10
                    _14_6)
                  refund_policy: MERCHANDISE_EXCHANGE_ONLY
                  credit_check_timestamp: '2021-04-28T16:42:55Z'
                  credit_check_allowed: true
                  merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
                  business_description: SB3 vegan cafe
                  average_card_transfer_amount: 200000
                  credit_check_ip_address: 42.1.1.113
                  merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac
                    OS X 10_14_6)
                  card_volume_distribution:
                    card_present_percentage: 30
                    mail_order_telephone_order_percentage: 10
                    ecommerce_percentage: 60
                tags:
                  Studio Rating: '4.7'
                entity:
                  last_name: Smith
                  max_transaction_amount: 12000000
                  has_accepted_credit_cards_previously: true
                  default_statement_descriptor: Daphne's Corner
                  personal_address:
                    city: San Mateo
                    country: USA
                    region: CA
                    line2: Apartment 7
                    line1: 741 Douglass St
                    postal_code: '94114'
                  incorporation_date:
                    year: 1978
                    day: 27
                    month: 6
                  business_address:
                    city: San Mateo
                    country: USA
                    region: CA
                    line2: Apartment 8
                    line1: 741 Douglass St
                    postal_code: '94114'
                  ownership_type: PRIVATE
                  first_name: dwayne
                  title: CEO
                  business_tax_id: '123456789'
                  doing_business_as: Petes Coffee
                  principal_percentage_ownership: 50
                  email: user@example.org
                  mcc: '0742'
                  phone: '1234567890'
                  business_name: Petes Coffee
                  tax_id: '123456789'
                  business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
                  business_phone: +1 (408) 756-4497
                  dob:
                    year: 1978
                    day: 27
                    month: 6
                  url: www.PetesCoffee.com
                  annual_card_volume: 12000000
            Create an Identity (Buyer):
              value:
                entity:
                  phone: '7145677613'
                  first_name: John
                  last_name: Smith
                  email: user@example.org
                  personal_address:
                    city: San Mateo
                    country: USA
                    region: CA
                    line2: Apartment 7
                    line1: 741 Douglass St
                    postal_code: '94114'
                  tags:
                    key: value
      description: ''
    CreateIdentitySettlementRequest:
      content:
        application/hal+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/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateMerchantProfileRequest'
          examples:
            Update the Fee Profile for a Merchant Profile:
              value:
                fee_profile: FP4xXhxyFRiRePKBQXmueVTh
    CreateMerchantUnderwritingRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateMerchantUnderwritingRequest'
          examples:
            Create a Merchant:
              value:
                tags:
                  key_2: value_2
                processor: DUMMY_V1
            Create a Merchant with Card Present Enabled:
              value:
                tags:
                  key_2: value_2
                gateway: TRIPOS_CLOUD_V1
                processor: VANTIV_V1
    CreatePaymentInstrumentRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreatePaymentInstrumentRequest'
            descriminator:
              propertyName: type
          examples:
            Create a Payment Instrument (Card):
              value:
                name: Amy White
                expiration_year: 2029
                tags:
                  card_name: Business Card
                number: '5200828282828210'
                expiration_month: 12
                address:
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  line1: 900 Metro Center Blv
                  country: USA
                security_code: '022'
                type: PAYMENT_CARD
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
            Create a Payment Instrument (Bank Account):
              value:
                account_type: SAVINGS
                name: Alice
                tags:
                  Bank Account: Company Account
                country: USA
                bank_code: '123123123'
                account_number: '123123123'
                type: BANK_ACCOUNT
                identity: IDpYDM7J9n57q849o9E9yNrG
            Create a Payment Instrument (Token):
              value:
                token: TKiMxe323RE5Dq3wLVtG8kSW
                type: TOKEN
                identity: IDpYDM7J9n57q849o9E9yNrG
            Create Apple Pay Web Payment Instrument:
              value:
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                merchant_identity: IDpYDM7J9n57q849o9E9yNrG
                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
      description: ''
    CreateProcessorRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateProcessorRequest'
          examples:
            'Enable an Application Processor ':
              value:
                type: DUMMY_V1
                config:
                  canDebitBankAccount: true
    UpdateProcessorRequest:
      content:
        application/hal+json:
          schema:
            type: object
    CreateReversalRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateReversalRequest'
          examples:
            Refund a Transfer:
              value:
                refund_amount: 100
                tags:
                  test: refund
            Refund a Transfer (Card Present):
              value:
                refund_amount: 150
                device: DVkBqa68V1ZQusodU8o6mB62
            Refund a Transfer (Swiped Card):
              value:
                device: DVf2H8sh4LZZC52GTUrwCPPf
                tags:
                  test: refund
                currency: USD
                amount: 150
                operation_key: CARD_PRESENT_UNREFERENCED_REFUND
    CreateSettlementRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateSettlementRequest'
          examples:
            Create a Settlement:
              value:
                currency: USD
                processor: DUMMY_V1
                merchant_id: MUfBgBvvv355djUi4uXQKtit
                tags:
                  Internal Daily Settlement ID: 21DFASJSAKAS
    CreateTransferRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateTransferRequest'
          examples:
            Create a Transfer:
              value:
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                currency: USD
                amount: 662154
                source: PIe2YvpcjvoVJ6PzoRPBK137
                tags:
                  test: sale
            Create a Transfer (Debit a Bank Account):
              value:
                fee: 603
                currency: USD
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                tags:
                  order_number: 21DFASJSAKAS
                source: PIk3AG7aUSCyNgYpDwCKkwDC
                amount: 6031
            Create a Transfer (with 3D Secure):
              value:
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                3d_secure_authentication:
                  electronic_commerce_indicator: AUTHENTICATED
                  cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
                  transaction_id: EaOMucALHQqLAEGAgk
                source: PIe2YvpcjvoVJ6PzoRPBK137
                tags:
                  test: sale
                currency: USD
                amount: 92169
            Create a Transfer (with Level 2 Processing):
              value:
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                source: PIe2YvpcjvoVJ6PzoRPBK137
                additional_purchase_data:
                  customer_reference_number: 321xyz
                  sales_tax: 200
                tags:
                  test: sale
                currency: USD
                amount: 1000
            Create a Transfer (with Level 3 Processing):
              value:
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                source: PIe2YvpcjvoVJ6PzoRPBK137
                additional_purchase_data:
                  item_data:
                    - amount_including_sales_tax: 500
                      unit_of_measure: BX
                      merchant_product_code: '1149611'
                      amount_excluding_sales_tax: 400
                      cost_per_unit: 500
                      commodity_code: 175-62-20
                      item_discount_amount: 100
                      item_description: printing paper
                      quantity: 1
                    - amount_including_sales_tax: 500
                      unit_of_measure: CTN
                      merchant_product_code: '2149612'
                      amount_excluding_sales_tax: 400
                      cost_per_unit: 500
                      commodity_code: 207-72-54
                      item_discount_amount: 0
                      item_description: printing ink
                      quantity: 1
                  discount_amount: 100
                  customer_reference_number: 321xyz
                  shipping_amount: 100
                  customs_duty_amount: 10
                tags:
                  test: sale
                currency: USD
                amount: 1000
            Create a Card Present Transfer with an EMV Card:
              value:
                device: DVf2H8sh4LZZC52GTUrwCPPf
                tags:
                  order_number: test123transfer
                currency: USD
                amount: 150
                operation_key: CARD_PRESENT_DEBIT
            Create a Card Present Transfer with a Non-EMV Card:
              value:
                device: DVf2H8sh4LZZC52GTUrwCPPf
                currency: USD
                amount: 150
                operation_key: CARD_PRESENT_DEBIT
                tags:
                  order_number: test123transfer
            Create a Card Present Transfer via Manual Entry:
              value:
                device: DVf2H8sh4LZZC52GTUrwCPPf
                tags:
                  order_number: test123transfer
                device_configuration:
                  prompt_manual_entry: true
                currency: USD
                amount: 150
                operation_key: CARD_PRESENT_DEBIT
            Create a Transfer with Buyer Charges:
              value:
                additional_buyer_charges:
                  convenience_amount: 300
                amount: 10300
                currency: USD
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                source: PIe2YvpcjvoVJ6PzoRPBK137
                tags:
                  test: sale
    UpdateDeviceRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateDeviceRequest'
          examples:
            Activate a Device:
              value:
                activation_code: C887298
                action: ACTIVATE
            Reboot a Device:
              value:
                action: REBOOT
            Set Idle Message on Device:
              value:
                idle_message: Finix Flowers
                action: CREATE_IDLE_MESSAGE
            Deactivate a Device:
              value:
                action: DEACTIVATE
    CreateUserRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateUserRequest'
    CreateVerificationRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateVerificationRequest'
          examples:
            Create a Merchant Verification:
              value:
                merchant: MUgWbPVvtKbzjKNNGKqdQYV7
                processor: DUMMY_V1
                identity: ID2CGJmjqyYaQAu6qyuvGeWK
                tags:
                  card_name: Business_Card
    CreateWebhookRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateWebhookRequest'
          examples:
            Create a Webhook with no Authentication:
              value:
                url: https://example.com/event_handler
                authentication:
                  type: NONE
            Create a Webhook with Basic authentication:
              value:
                url: https://example.com/event_handler
                authentication:
                  type: BASIC
                  basic:
                    username: basic-auth-username
                    password: basic-auth-password
            Create a Webhook with Bearer Token Authentication:
              value:
                url: https://example.com/event_handler
                enabled: true
                authentication:
                  type: BEARER
                  bearer:
                    token: U3VwZXIgc2VjcmV0IGVuY29kZWQgdG9rZW4=
    UpdateTransferRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateTransferRequest'
          examples:
            example-1:
              value:
                tags:
                  test: sale
    UpdateSettlementRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateSettlementRequest'
    CreateSubscriptionAmountRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateSubscriptionAmountRequest'
          examples:
            Create a POS_INSTALLMENT_FEE amount:
              value:
                amount_type: FEE
                fee_amount_data:
                  currency: USD
                  amount: 2500
                  label: POS_INSTALLMENT_FEE
                nickname: POS_INSTALLMENT_FEE
                tags:
                  order_number: '124'
    UpdateSubscriptionAmountRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateSubscriptionAmountRequest'
          examples:
            Update a Subscription Amount:
              value:
                amount_type: FEE
                fee_amount_data:
                  currency: USD
                  amount: 2500
                  label: POS_INSTALLMENT_FEE
                nickname: POS_INSTALLMENT_FEE
                tags:
                  order_number: '124'
    CreateSubscriptionScheduleRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateSubscriptionScheduleRequest'
          examples:
            Create a Subscription Schedule (FIXED_TIME_INTERVAL):
              value:
                line_item_type: FEE
                nickname: Fixed_Time_Subscription_Schedule
                fixed_time_interval_offset:
                  interval_count: 4
                  hourly_interval: 24
                subscription_type: FIXED_TIME_INTERVAL
            Create a Subscription Schedule (PERIODIC_MONTHLY):
              value:
                line_item_type: FEE
                period_offset:
                  day: 1
                  month: null
                nickname: Monthly_Subscription_Schedule
                subscription_type: PERIODIC_MONTHLY
            Create a Subscription Schedule (PERIODIC_YEARLY):
              value:
                line_item_type: FEE
                period_offset:
                  day: 5
                  month: 1
                nickname: Yearly_Subscription_Schedule
                subscription_type: PERIODIC_YEARLY
    UpdateSubscriptionScheduleRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateSubscriptionScheduleRequest'
          examples:
            Update Tags:
              value:
                tags:
                  order-reference: A1B2C3D4E5
    CreateSubscriptionEnrollmentRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateSubscriptionEnrollmentRequest'
          examples:
            Example of a "Security Fee":
              value:
                merchant: MUucec6fHeaWo3VHYoSkUySM
                started_at: '2022-11-11T16:50:59.891Z'
                nickname: Security Fee
                tags:
                  enrollment_info: Security Fee Enrollment
    UpdateSubscriptionEnrollmentRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateSubscriptionEnrollmentRequest'
    UpdateUserRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateUserRequest'
          examples:
            Update User:
              value:
                tags:
                  card_name: New Employee
    CreateDeviceRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateDevice'
          examples:
            Create a Device:
              value:
                name: 'Finix  triPOS #1'
                model: MX915
                description: John Smith
                configuration:
                  allow_debit: true
                  prompt_signature: NEVER
    UpdatePaymentInstrumentRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdatePaymentInstrumentRequest'
          examples:
            Update Tag:
              value:
                tags:
                  custom_key: custome value
    UpdateMerchantRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateMerchantRequest'
          examples:
            Update Merchant to Enable Level 2/3 Processing:
              value:
                level_two_level_three_data_enabled: true
            Update Merchant to Enable Buyer Charges:
              value:
                convenience_charges_enabled: true
                rent_surcharges_enabled: true
    UpdateIdentityRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateIdentityRequest'
          examples:
            Update an Identity:
              value:
                entity:
                  last_name: Smith
                  first_name: John
                  email: user@example.org
                  phone: '7145677613'
    CreateAssociatedIdentityRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateAssociatedIdentityRequest'
          examples:
            Create an Associated Identity:
              value:
                entity:
                  first_name: John
                  last_name: Smith
                  title: Founder
                  dob:
                    month: 1
                    day: 1
                    year: 2013
                  principal_percentage_ownership: 25
                  phone: '1234567890'
                  personal_address:
                    city: San Francisco
                    region: CA
                    postal_code: '90650'
                    line1: 123 Main Street
                    country: USA
                  email: john.smith@company1.com
                  tax_id: '123456789'
    CreateBalanceTransferRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/CreateBalanceTransferRequest'
          examples:
            Create a Balance Transfer:
              value:
                description: Need to increase buffer given the high number of NSFs
                  on merchant fee debits
                tags:
                  example: documentation tag
                destination: FOR_BENEFIT_OF_ACCOUNT
                currency: USD
                amount: 4000
                source: OPERATING_ACCOUNT
                processor_type: LITLE_V1
    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/vnd.api+json:
          schema:
            $ref: '#/components/schemas/CreateFileRequest'
          examples:
            Create a File:
              value:
                display_name: My Drivers License
                linked_to: MU2n7BSovtwYsWYZF6rBnnzk
                tags:
                  key_1: value_1
                type: DRIVERS_LICENSE_FRONT
    CreateExternalLinkRequest:
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/CreateExternalLinkRequest'
          examples:
            Create an External Link:
              value:
                type: UPLOAD
                duration: 15
    CreateApplePaySessionRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ApplePaySessionRequest'
          examples:
            Create an 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
    RemoveSettlementTransfer:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/RemoveSettlementTransfer'
          examples:
            Remove a Transfer in a Settlement:
              value:
                transfers:
                  - TRr61njQxaa7AJf6E1C3QwCc
    UploadFileRequest:
      content:
        multipart/form-data:
          schema:
            $ref: '#/components/schemas/UploadFileRequest'
    UpdateWebhookRequest:
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UpdateWebhookRequest'
          examples:
            Update a Webhook:
              value:
                url: https://eohzjuj2prziycz.m.pipedream.net
                enabled: true
    UpdateComplianceForm:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateComplianceFormRequest'
          examples:
            Complete Compliance Form:
              value:
                pci_saq_a:
                  name: John Booker
                  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
                  title: CTO
    CreateOnboardingFormRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateOnboardingFormRequest'
          examples:
            Create an Onboarding Form:
              value:
                onboarding_data:
                  entity: {}
                  associated_entities: []
                  additional_underwriting_data: {}
                  payment_instruments: {}
                  max_transaction_amount: 100000
                merchant_processors:
                  - processor: LITLE_V1
                onboarding_link_details:
                  return_url: https://www.finix.com/docs
                  expired_session_url: https://www.finix.com/
                  terms_of_service_url: https://www.finix.com/terms-and-policies
                  fee_details_url: https://www.finix.com/docs
                  expiration_in_minutes: '30'
    CreateOnboardingFormLinkRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateOnboardingFormLinkRequest'
          examples:
            Create an Onboarding Form Link:
              value:
                terms_of_service_url: https://www.finix.com/terms-and-policies
                return_url: https://www.finix.com/docs
                fee_details_url: https://www.finix.com/docs
                expired_session_url: https://www.finix.com/
                expiration_in_minutes: 30
  responses:
    Application:
      description: Single application object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Application'
          examples:
            Application Created:
              value:
                id: APgPDQrLD52TYvqazjHJJchM
                enabled: true
                tags:
                  application_name: Finix Flowers
                owner: IDuquemzE7UkUJioGJfVKBKt
                name: Finix Flowers
                processing_enabled: true
                settlement_enabled: true
                creating_transfer_from_report_enabled: true
                card_expiration_date_required: true
                card_cvv_required: false
                settlement_funding_identifier: UNSET
                ready_to_settle_upon: RECONCILIATION
                fee_ready_to_settle_upon: RECONCILIATION
                created_at: '2022-01-27T07:36:33.59Z'
                updated_at: '2022-01-27T07:44:04.94Z'
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  processors:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/processors
                  users:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/users
                  owner_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt
                  transfers:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/transfers
                  disputes:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/disputes
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/authorizations
                  settlements:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/settlements
                  merchants:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/merchants
                  identities:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/identities
                  webhooks:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/webhooks
                  reversals:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/reversals
                  tokens:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/tokens
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/payment_instruments
                  application_profile:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/application_profile
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ApplicationProfile:
      description: Single application_profile object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ApplicationProfile'
          examples:
            Application Profile:
              value:
                id: PP6Gu3JTdcS5CVuTsY8eCoU7
                tags: {}
                application: APkhCuFhbgVgNKKExUf8rpdV
                fee_profile: null
                risk_profile: RPk3988fTnZS6nEyU1WtNgyd
                created_at: '2022-07-28T21:52:54.54Z'
                updated_at: '2022-07-28T21:52:54.54Z'
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/application_profiles/PP6Gu3JTdcS5CVuTsY8eCoU7
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV
                  risk_profile:
                    href: https://finix.sandbox-payments-api.com/risk_profiles/RPk3988fTnZS6nEyU1WtNgyd
      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/hal+json:
          schema:
            $ref: '#/components/schemas/ApplicationProfilesList'
          examples:
            List of Application Profiles:
              value:
                _embedded:
                  application_profiles:
                    - id: PPrVzFBWaCL3TeEWHq1tv4Ay
                      tags: {}
                      application: APtjNWUxQKj4Gkw1L4rQ1yNB
                      fee_profile: null
                      risk_profile: RPaPp5SBdiR6TpiS6sZUKxwd
                      created_at: '2022-05-31T16:18:44.56Z'
                      updated_at: '2022-05-31T16:18:44.56Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/application_profiles/PPrVzFBWaCL3TeEWHq1tv4Ay
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB
                        risk_profile:
                          href: https://finix.sandbox-payments-api.com/risk_profiles/RPaPp5SBdiR6TpiS6sZUKxwd
                    - id: PPc931nKUintrvYY98itsM9M
                      tags: {}
                      application: APoUsWg49wfXomJTGnvuKZeT
                      fee_profile: null
                      risk_profile: RPjEJsR9nVbHPzPvGU8vg8g9
                      created_at: '2022-03-24T16:25:56.28Z'
                      updated_at: '2022-03-24T16:25:56.28Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/application_profiles/PPc931nKUintrvYY98itsM9M
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT
                        risk_profile:
                          href: https://finix.sandbox-payments-api.com/risk_profiles/RPjEJsR9nVbHPzPvGU8vg8g9
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/application_profiles?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  next_cursor: PPc931nKUintrvYY98itsM9M
                  limit: 20
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ApplicationsList:
      description: List of `Applications`.
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ApplicationsList'
          examples:
            List of Applications:
              value:
                _embedded:
                  applications:
                    - id: APkhCuFhbgVgNKKExUf8rpdV
                      enabled: true
                      tags:
                        name: application
                      owner: IDthvyMNJ4tK2A8K35rdX1kx
                      name: business inc
                      processing_enabled: true
                      settlement_enabled: true
                      creating_transfer_from_report_enabled: false
                      card_expiration_date_required: true
                      card_cvv_required: false
                      settlement_funding_identifier: UNSET
                      ready_to_settle_upon: RECONCILIATION
                      fee_ready_to_settle_upon: RECONCILIATION
                      created_at: '2022-07-28T21:52:54.47Z'
                      updated_at: '2022-07-28T21:52:54.47Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV
                        processors:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/processors
                        users:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/users
                        owner_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDthvyMNJ4tK2A8K35rdX1kx
                        transfers:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/transfers
                        disputes:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/disputes
                        authorizations:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/authorizations
                        settlements:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/settlements
                        merchants:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/merchants
                        identities:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/identities
                        webhooks:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/webhooks
                        reversals:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/reversals
                        tokens:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/tokens
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/payment_instruments
                        application_profile:
                          href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/application_profile
                    - id: APeT9uYCjww9UuKQB2mgi21A
                      enabled: true
                      tags: {}
                      owner: IDcfZEYCYQG42RDZR2nqUVNm
                      name: Chris application
                      processing_enabled: true
                      settlement_enabled: true
                      creating_transfer_from_report_enabled: false
                      card_expiration_date_required: true
                      card_cvv_required: false
                      settlement_funding_identifier: UNSET
                      ready_to_settle_upon: RECONCILIATION
                      fee_ready_to_settle_upon: RECONCILIATION
                      created_at: '2022-04-22T20:32:33.47Z'
                      updated_at: '2022-04-22T20:32:33.47Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A
                        processors:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/processors
                        users:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/users
                        owner_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDcfZEYCYQG42RDZR2nqUVNm
                        transfers:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/transfers
                        disputes:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/disputes
                        authorizations:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/authorizations
                        settlements:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/settlements
                        merchants:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/merchants
                        identities:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/identities
                        webhooks:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/webhooks
                        reversals:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/reversals
                        tokens:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/tokens
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/payment_instruments
                        application_profile:
                          href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/application_profile
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/applications?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/applications?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/applications?offset=110400&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Authorization:
      description: Single Authorization object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Authorization'
          examples:
            Authorization:
              value:
                id: AUcaGi9WKyKn2GwX3bNSpsXo
                application: AP3AB2itAWrrrPVS6spvrGYp
                amount: 100
                tags: {}
                state: SUCCEEDED
                currency: USD
                transfer: null
                messages: []
                raw:
                  additional_large_number: 9223372036854776000
                  value: 100
                  order_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce
                created_at: '2022-08-01T22:15:30.41Z'
                updated_at: '2022-08-01T22:15:30.51Z'
                trace_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce
                source: PIbDnouV59En1yKfYUNLTpG9
                merchant_identity: IDsArLxCm9QGbi2QfhaFrTED
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2022-08-08T22:15:30.41Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUcaGi9WKyKn2GwX3bNSpsXo
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsArLxCm9QGbi2QfhaFrTED
            Authorization (with 3D Secure):
              value:
                id: AU27TBqkcCQn94aSVyTvRyrn
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 100
                tags:
                  order_number: 21DFASJSAKAS
                state: SUCCEEDED
                currency: USD
                transfer: TRsBcF8LjV1UaK5vXY6pFHmG
                messages: []
                raw: null
                created_at: '2022-01-27T07:37:19.95Z'
                updated_at: '2022-01-27T07:37:20.03Z'
                trace_id: ce97465f-b620-4d98-adba-378756d7013a
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2022-02-03T07:37:19.95Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AU27TBqkcCQn94aSVyTvRyrn
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Authorization (with Level 2 Processing):
              value:
                id: AUq2Xz5VS46U4hzzhX9WJCxx
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 1000
                tags:
                  order_number: 21DFASJSAKAS
                state: SUCCEEDED
                currency: USD
                transfer: null
                messages: []
                raw: null
                created_at: '2022-01-27T07:37:20.68Z'
                updated_at: '2022-01-27T07:37:20.86Z'
                trace_id: 2b181625-616a-45b1-a8e7-311d76fddd5e
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2022-02-03T07:37:20.68Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUq2Xz5VS46U4hzzhX9WJCxx
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Authorization (with Level 3 Processing):
              value:
                id: AUsQsCLRp9ENxrh563w1zZHi
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 1000
                tags:
                  order_number: 21DFASJSAKAS
                state: SUCCEEDED
                currency: USD
                transfer: null
                messages: []
                raw: null
                created_at: '2022-01-27T07:37:21.55Z'
                updated_at: '2022-01-27T07:37:21.68Z'
                trace_id: 88136ea9-9393-4b95-b4c0-940b49ab707d
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2022-02-03T07:37:21.55Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUsQsCLRp9ENxrh563w1zZHi
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Voided Authorization:
              value:
                id: AU2UkcVZU94rNqonfcLGZRSJ
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 100
                tags:
                  order_number: 21DFASJSAKAS
                state: SUCCEEDED
                currency: USD
                transfer: null
                messages: []
                raw: null
                created_at: '2022-01-27T07:37:28.10Z'
                updated_at: '2022-01-27T07:37:29.15Z'
                trace_id: 710b6745-c424-4101-84e5-4a49cf317dc7
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDpYDM7J9n57q849o9E9yNrG
                3ds_redirect_url: null
                is_void: true
                void_state: PENDING
                expires_at: '2022-02-03T07:37:28.10Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AU2UkcVZU94rNqonfcLGZRSJ
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
            Card Present Authorization with an EMV Card:
              value:
                id: AUeEok8811pDqsR1BbxZLbw1
                application: APeUbTUjvYb1CdPXvNcwW1wP
                amount: 150
                tags:
                  order_number: test123transfer
                state: SUCCEEDED
                currency: USD
                transfer: null
                messages: []
                raw: null
                card_present_details:
                  emv_data:
                    application_identifier: A0000000031010
                    application_label: Visa Credit
                    application_preferred_name: null
                    application_transaction_counter: '004F'
                    cryptogram: TC F8C706E8A0368D15
                    issuer_code_table_index: null
                    pin_verified: false
                    tags: {}
                  masked_account_number: '************7564'
                  name: 'AARON/CHRISTOPHER W '
                  brand: VISA
                  entry_mode: CHIP_ENTRY
                  payment_type: CREDIT
                  approval_code: '000036'
                created_at: '2019-03-11T23:36:42.03Z'
                updated_at: '2019-03-11T23:36:57.09Z'
                trace_id: FNXmEM7d6ns8LMMzt61AD8TrR
                source: PIcW77CfRyBUWJhA231TWXWf
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                device: DVf2H8sh4LZZC52GTUrwCPPf
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2019-03-18T23:36:42.03Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                sub_type: API
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUeEok8811pDqsR1BbxZLbw1
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
            Card Present Authorization with a Non-EMV Card:
              value:
                id: AUiJS1VhMy8zpACLoacPFG7m
                application: APeUbTUjvYb1CdPXvNcwW1wP
                amount: 150
                tags:
                  order_number: test123transfer
                state: SUCCEEDED
                currency: USD
                transfer: null
                messages: []
                raw: null
                card_present_details:
                  emv_data: null
                  masked_account_number: '************0011'
                  name: TEST/WORLDPAY
                  brand: UNKNOWN
                  entry_mode: SWIPED
                  payment_type: CREDIT
                  approval_code: '000037'
                created_at: '2019-03-01T03:37:10.10Z'
                updated_at: '2019-03-01T03:37:23.63Z'
                trace_id: 556185b9-ceaa-490b-bae2-a662757b42e0
                source: PIaqFoGabsBTTowVr5z7jiLv
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                device: DVf2H8sh4LZZC52GTUrwCPPf
                is_void: false
                expires_at: '2019-03-08T03:37:10.10Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUiJS1VhMy8zpACLoacPFG7m
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
            Authorization with Buyer Charges:
              value:
                id: AUnxmW39jBePKqYKwQamC3BR
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 5200
                tags:
                  test: sale
                state: SUCCEEDED
                currency: USD
                transfer: null
                messages: []
                raw: null
                created_at: '2022-08-01T19:04:00.29Z'
                updated_at: '2022-08-01T19:04:00.43Z'
                trace_id: dcb4b954-89b3-4c5e-9b3a-1b8e70e30556
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2022-08-08T19:04:00.29Z'
                idempotency_id: null
                additional_buyer_charges:
                  convenience_amount: 0
                  rent_surcharge_amount: 200
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUnxmW39jBePKqYKwQamC3BR
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    AuthorizationsList:
      description: List of Authorization objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/AuthorizationsList'
          examples:
            List of Authorizations:
              value:
                _embedded:
                  authorizations:
                    - id: AUcaGi9WKyKn2GwX3bNSpsXo
                      application: AP3AB2itAWrrrPVS6spvrGYp
                      amount: 100
                      tags: {}
                      state: SUCCEEDED
                      currency: USD
                      transfer: null
                      messages: []
                      raw:
                        additional_large_number: 9223372036854776000
                        value: 100
                        order_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce
                      created_at: '2022-08-01T22:15:30.41Z'
                      updated_at: '2022-08-01T22:15:30.51Z'
                      trace_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce
                      source: PIbDnouV59En1yKfYUNLTpG9
                      merchant_identity: IDsArLxCm9QGbi2QfhaFrTED
                      3ds_redirect_url: null
                      is_void: false
                      void_state: UNATTEMPTED
                      expires_at: '2022-08-08T22:15:30.41Z'
                      idempotency_id: null
                      additional_buyer_charges: null
                      failure_code: null
                      failure_message: null
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/authorizations/AUcaGi9WKyKn2GwX3bNSpsXo
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDsArLxCm9QGbi2QfhaFrTED
                    - id: AUfh49WdxqokwZMkxiDaAp9d
                      application: APeUbTUjvYb1CdPXvNcwW1wP
                      amount: 150
                      tags:
                        order_number: test123transfer
                      state: FAILED
                      currency: USD
                      transfer: null
                      messages:
                        - LaneID 1 does not exist.
                        - 'Authorization AUfh49WdxqokwZMkxiDaAp9d 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: FNX7FBcyvYEAfuVczJdtR8VpV
                        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: []
                      card_present_details:
                        emv_data: null
                        masked_account_number: null
                        name: null
                        brand: null
                        entry_mode: null
                        payment_type: NONE
                        approval_code: '000037'
                      created_at: '2022-08-01T20:00:07.65Z'
                      updated_at: '2022-08-01T20:00:08.07Z'
                      trace_id: FNX7FBcyvYEAfuVczJdtR8VpV
                      source: PI2tXhSnoqT6pwyvWLHBkun5
                      merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                      device: DVf2H8sh4LZZC52GTUrwCPPf
                      3ds_redirect_url: null
                      is_void: false
                      void_state: UNATTEMPTED
                      expires_at: '2022-08-08T20:00:07.65Z'
                      idempotency_id: null
                      additional_buyer_charges: null
                      failure_code: null
                      failure_message: null
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/authorizations/AUfh49WdxqokwZMkxiDaAp9d
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                        device:
                          href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
                _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: 2
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    CreatePaymentInstrumentToken:
      description: Token response object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/PaymentInstrumentToken'
      headers:
        date:
          required: true
          schema:
            type: string
    Device:
      description: Single Device object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Device'
          examples:
            Device:
              value:
                id: DVf2H8sh4LZZC52GTUrwCPPf
                merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                name: 'Finix Tripos #1'
                model: MX915
                description: John Smith
                serial_number: null
                idle_message: null
                enabled: false
                tags: {}
                created_at: '2019-03-01T02:27:20.366Z'
                updated_at: '2022-04-05T18:48:40.383Z'
                configuration_details:
                  allow_debit: true
                  check_for_duplicate_transactions: false
                  prompt_amount_confirmation: true
                  prompt_manual_entry: false
                  prompt_signature: NEVER
                  signature_threshold_amount: 0
                  bypass_device_on_capture: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
                  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 (Activated):
              value:
                id: DV8EVnpCwHwB9Dk3xTysgt5d
                merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                name: 'Finix Tripos #1'
                model: MX915
                description: John Smith
                serial_number: 262-410-025
                idle_message: null
                enabled: true
                tags: {}
                created_at: '2022-06-06T03:59:42.415893Z'
                updated_at: '2022-06-06T03:59:42.416446Z'
                configuration_details:
                  allow_debit: true
                  check_for_duplicate_transactions: true
                  prompt_amount_confirmation: true
                  prompt_manual_entry: false
                  prompt_signature: NEVER
                  signature_threshold_amount: 0
                  bypass_device_on_capture: false
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d
                  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 (Idle Message Set):
              value:
                id: DV8EVnpCwHwB9Dk3xTysgt5d
                merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                name: 'Finix Tripos #1'
                model: MX915
                description: John Smith
                serial_number: 262-410-025
                idle_message: Daphne's Corner
                enabled: true
                tags: {}
                created_at: '2022-06-06T03:59:42.415893Z'
                updated_at: '2022-06-06T03:59:42.416446Z'
                configuration_details:
                  allow_debit: true
                  check_for_duplicate_transactions: true
                  prompt_amount_confirmation: true
                  prompt_manual_entry: false
                  prompt_signature: NEVER
                  signature_threshold_amount: 0
                  bypass_device_on_capture: false
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d
                  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 (Connection Check):
              value:
                id: DV8EVnpCwHwB9Dk3xTysgt5d
                merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                name: 'Finix Tripos #1'
                model: MX915
                description: John Smith
                serial_number: 262-410-025
                idle_message: Daphne's Corner
                connection: Open
                enabled: true
                tags: {}
                created_at: '2022-06-06T03:59:42.415893Z'
                updated_at: '2022-06-06T03:59:42.416446Z'
                configuration_details:
                  allow_debit: true
                  check_for_duplicate_transactions: true
                  prompt_amount_confirmation: true
                  prompt_manual_entry: false
                  prompt_signature: NEVER
                  signature_threshold_amount: 0
                  bypass_device_on_capture: false
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d
                  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 (Deactivated):
              value:
                id: DV8EVnpCwHwB9Dk3xTysgt5d
                merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                name: 'Finix Tripos #1'
                model: MX915
                description: John Smith
                serial_number: 262-410-025
                idle_message: Daphne's Corner
                enabled: false
                tags: {}
                created_at: '2022-06-06T03:59:42.415893Z'
                updated_at: '2022-06-06T03:59:42.416446Z'
                configuration_details: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d
                  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
      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/hal+json:
          schema:
            $ref: '#/components/schemas/Dispute'
          examples:
            Dispute:
              value:
                id: DIs7yQRkHDdMYhurzYz72SFk
                application: APgPDQrLD52TYvqazjHJJchM
                tags:
                  order_number: 21DFASJSAKAS
                amount: 888888
                state: PENDING
                transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
                reason: FRAUD
                message: null
                action: null
                identity: IDpYDM7J9n57q849o9E9yNrG
                created_at: '2022-01-27T07:43:03.74Z'
                updated_at: '2022-01-27T07:43:03.48Z'
                occurred_at: '2022-01-27T07:42:48.56Z'
                respond_by: '2022-02-03T07:43:03.73Z'
                dispute_details:
                  arn: '123'
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  transfer:
                    href: https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky
                  evidence:
                    href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence
                  adjustment_transfers:
                    href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/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/hal+json:
          schema:
            $ref: '#/components/schemas/DisputeEvidence'
          examples:
            Dispute Evidence:
              value:
                id: DF58kdVTa5eMQUjcXH2F7DH4
                tags:
                  file-extension: .png
                  content-type: image/png
                  file-name: test_file.png
                dispute: DIs7yQRkHDdMYhurzYz72SFk
                state: SUCCEEDED
                created_at: '2022-08-15T21:37:04.41Z'
                updated_at: '2022-08-15T21:45:00.74Z'
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4
      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/hal+json:
          schema:
            $ref: '#/components/schemas/DisputeEvidenceList'
          examples:
            List of Dispute Evidence:
              value:
                _embedded:
                  evidences:
                    - id: DF47KJ5djC346QuLVaQSSw8H
                      tags:
                        file-extension: .png
                        content-type: image/png
                        file-name: test_file.png
                      dispute: DIs7yQRkHDdMYhurzYz72SFk
                      state: SUCCEEDED
                      created_at: '2022-08-16T18:50:24.16Z'
                      updated_at: '2022-08-16T19:00:01.10Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF47KJ5djC346QuLVaQSSw8H
                    - id: DFoLbyCxETSX6ScfMgnrZGER
                      tags:
                        file-extension: .png
                        content-type: image/png
                        file-name: finix_file.png
                      dispute: DIs7yQRkHDdMYhurzYz72SFk
                      state: SUCCEEDED
                      created_at: '2022-08-15T20:23:04.01Z'
                      updated_at: '2022-08-15T20:30:00.54Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFoLbyCxETSX6ScfMgnrZGER
                    - id: DFo3KoCCCAhN7iJNmdt4CAqm
                      tags:
                        file-extension: .png
                        content-type: image/png
                        file-name: finix_file.png
                      dispute: DIs7yQRkHDdMYhurzYz72SFk
                      state: SUCCEEDED
                      created_at: '2022-08-15T18:48:32.81Z'
                      updated_at: '2022-08-15T19:00:00.64Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFo3KoCCCAhN7iJNmdt4CAqm
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=1040&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'
    DisputesList:
      description: List of Disputes
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/DisputesList'
          examples:
            List of Disputes:
              value:
                _embedded:
                  disputes:
                    - id: DIb72obRhTmPdMG1VxDKFLrb
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        test: sale
                      amount: 888888
                      state: PENDING
                      transfer: TRkhvS4GfMKxaHyBBdkPSx6g
                      reason: FRAUD
                      message: null
                      action: null
                      identity: IDuqZpDw28f2KK6YuDk4jNLg
                      created_at: '2022-07-14T19:40:06.52Z'
                      updated_at: '2022-07-14T19:40:06.11Z'
                      occurred_at: '2022-07-14T19:39:00.77Z'
                      respond_by: '2022-07-21T19:40:06.51Z'
                      dispute_details:
                        arn: '123'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        transfer:
                          href: https://finix.sandbox-payments-api.com/transfers/TRkhvS4GfMKxaHyBBdkPSx6g
                        evidence:
                          href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/evidence
                        adjustment_transfers:
                          href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/adjustment_transfers
                    - id: DIuk8T4ayQdmxewz8EDLHe49
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        order_number: 21DFASJSAKAS
                      amount: 888888
                      state: PENDING
                      transfer: TR27JnLR2pKDXjVVcGBKrjwU
                      reason: FRAUD
                      message: null
                      action: null
                      identity: IDpYDM7J9n57q849o9E9yNrG
                      created_at: '2022-06-15T16:14:03.95Z'
                      updated_at: '2022-06-15T16:14:03.64Z'
                      occurred_at: '2022-06-15T16:13:04.09Z'
                      respond_by: '2022-06-22T16:14:03.94Z'
                      dispute_details:
                        arn: '123'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        transfer:
                          href: https://finix.sandbox-payments-api.com/transfers/TR27JnLR2pKDXjVVcGBKrjwU
                        evidence:
                          href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/evidence
                        adjustment_transfers:
                          href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/adjustment_transfers
                    - id: DIs7yQRkHDdMYhurzYz72SFk
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        order_number: 21DFASJSAKAS
                      amount: 888888
                      state: PENDING
                      transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
                      reason: FRAUD
                      message: null
                      action: null
                      identity: IDpYDM7J9n57q849o9E9yNrG
                      created_at: '2022-01-27T07:43:03.74Z'
                      updated_at: '2022-01-27T07:43:03.48Z'
                      occurred_at: '2022-01-27T07:42:48.56Z'
                      respond_by: '2022-02-03T07:43:03.73Z'
                      dispute_details:
                        arn: '123'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        transfer:
                          href: https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky
                        evidence:
                          href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence
                        adjustment_transfers:
                          href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/disputes/?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'
    Error406NotAcceptable:
      description: Not Acceptable
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Error406NotAcceptable'
          examples: {}
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Error422InvalidField:
      description: Invalid field
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Error422InvalidFieldList'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ErrorForbidden403:
      description: Forbidden
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Error403ForbiddenList'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ErrorMerchantIdentityDisabled:
      description: Merchant identity disabled error
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ErrorMethodNotAllowed:
      description: 405 - Method not allowed
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ErrorNotFound:
      description: Object does not exist
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Error404NotFoundList'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ErrorPaymentRequired:
      description: Payment Required
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ErrorTransfers402:
      description: 402 - Payment required
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Error402PaymentRequired'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ErrorUnauthorized:
      description: Authentication information is missing or invalid
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Error401Unauthorized'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ErrorUnprocessableEntity:
      description: Error
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Fee:
      description: Single Fee object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Fee'
          examples:
            Fee:
              value:
                id: FEtSD9oNjoCtJaN2C1FwhZ29
                amount: 100
                currency: USD
                display_name: null
                fee_subtype: PLATFORM_FEE
                fee_type: CARD_FIXED
                label: null
                linked_id: TR7m4FqzubzFvPJf4WEmkEEv
                linked_type: TRANSFER
                merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                created_at: '2022-08-15T23:14:03.37Z'
                updated_at: '2022-08-15T23:14:03.37Z'
                tags: {}
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/fees/FEtSD9oNjoCtJaN2C1FwhZ29
                  merchant:
                    href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
                  transfer:
                    href: https://finix.sandbox-payments-api.com/transfers/TR7m4FqzubzFvPJf4WEmkEEv
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    FeeProfile:
      description: Fee profile
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/FeeProfile'
          examples:
            Fee Profile:
              value:
                id: FPq6PQ9pHsab66fKMmjQ7jb5
                tags: {}
                application: APgPDQrLD52TYvqazjHJJchM
                fixed_fee: 100
                ancillary_fixed_fee_primary: null
                ancillary_fixed_fee_secondary: null
                basis_points: 200
                externally_funded_basis_points: null
                externally_funded_fixed_fee: null
                ach_basis_points: 300
                ach_fixed_fee: 30
                charge_interchange: false
                dispute_inquiry_fixed_fee: null
                dispute_fixed_fee: null
                ach_debit_return_fixed_fee: null
                ach_credit_return_fixed_fee: null
                visa_basis_points: null
                visa_fixed_fee: null
                visa_charge_interchange: null
                visa_assessments_basis_points: null
                visa_acquirer_processing_fixed_fee: null
                visa_credit_voucher_fixed_fee: null
                visa_kilobyte_access_fixed_fee: null
                discover_basis_points: null
                discover_fixed_fee: null
                discover_externally_funded_basis_points: null
                discover_externally_funded_fixed_fee: null
                discover_charge_interchange: null
                discover_assessments_basis_points: null
                discover_data_usage_fixed_fee: null
                discover_network_authorization_fixed_fee: null
                diners_club_basis_points: null
                diners_club_fixed_fee: null
                diners_club_charge_interchange: null
                mastercard_basis_points: null
                mastercard_fixed_fee: null
                mastercard_charge_interchange: null
                mastercard_assessments_under1k_basis_points: null
                mastercard_assessments_over1k_basis_points: null
                mastercard_acquirer_fees_basis_points: null
                jcb_basis_points: null
                jcb_fixed_fee: null
                jcb_charge_interchange: null
                american_express_basis_points: null
                american_express_fixed_fee: null
                american_express_externally_funded_basis_points: null
                american_express_externally_funded_fixed_fee: null
                american_express_charge_interchange: null
                american_express_assessment_basis_points: null
                rounding_mode: TRANSACTION
                qualified_tiers: null
                created_at: '2022-01-27T07:37:38.66Z'
                updated_at: '2022-01-27T07:37:38.66Z'
                visa_base_II_system_file_transmission_fixed_fee: null
                visa_base_II_credit_voucher_fixed_fee: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5
                  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'
    FeeProfilesList:
      description: List of fee profiles
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/FeeProfilesList'
          examples:
            List of Fee Profiles:
              value:
                _embedded:
                  fee_profiles:
                    - id: FPq6PQ9pHsab66fKMmjQ7jb5
                      tags: {}
                      application: APgPDQrLD52TYvqazjHJJchM
                      fixed_fee: 100
                      ancillary_fixed_fee_primary: null
                      ancillary_fixed_fee_secondary: null
                      basis_points: 200
                      externally_funded_basis_points: null
                      externally_funded_fixed_fee: null
                      ach_basis_points: 300
                      ach_fixed_fee: 30
                      charge_interchange: false
                      dispute_inquiry_fixed_fee: null
                      dispute_fixed_fee: null
                      ach_debit_return_fixed_fee: null
                      ach_credit_return_fixed_fee: null
                      visa_basis_points: null
                      visa_fixed_fee: null
                      visa_charge_interchange: null
                      visa_assessments_basis_points: null
                      visa_acquirer_processing_fixed_fee: null
                      visa_credit_voucher_fixed_fee: null
                      visa_kilobyte_access_fixed_fee: null
                      discover_basis_points: null
                      discover_fixed_fee: null
                      discover_externally_funded_basis_points: null
                      discover_externally_funded_fixed_fee: null
                      discover_charge_interchange: null
                      discover_assessments_basis_points: null
                      discover_data_usage_fixed_fee: null
                      discover_network_authorization_fixed_fee: null
                      diners_club_basis_points: null
                      diners_club_fixed_fee: null
                      diners_club_charge_interchange: null
                      mastercard_basis_points: null
                      mastercard_fixed_fee: null
                      mastercard_charge_interchange: null
                      mastercard_assessments_under1k_basis_points: null
                      mastercard_assessments_over1k_basis_points: null
                      mastercard_acquirer_fees_basis_points: null
                      jcb_basis_points: null
                      jcb_fixed_fee: null
                      jcb_charge_interchange: null
                      american_express_basis_points: null
                      american_express_fixed_fee: null
                      american_express_externally_funded_basis_points: null
                      american_express_externally_funded_fixed_fee: null
                      american_express_charge_interchange: null
                      american_express_assessment_basis_points: null
                      rounding_mode: TRANSACTION
                      qualified_tiers: null
                      created_at: '2022-01-27T07:37:38.66Z'
                      updated_at: '2022-01-27T07:37:38.66Z'
                      visa_base_II_system_file_transmission_fixed_fee: null
                      visa_base_II_credit_voucher_fixed_fee: null
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                    - id: FPvCQUcnsueN3Bc3zR1qCBG8
                      tags: {}
                      application: APgPDQrLD52TYvqazjHJJchM
                      fixed_fee: 100
                      ancillary_fixed_fee_primary: null
                      ancillary_fixed_fee_secondary: null
                      basis_points: 200
                      externally_funded_basis_points: null
                      externally_funded_fixed_fee: null
                      ach_basis_points: 300
                      ach_fixed_fee: 30
                      charge_interchange: false
                      dispute_inquiry_fixed_fee: null
                      dispute_fixed_fee: null
                      ach_debit_return_fixed_fee: null
                      ach_credit_return_fixed_fee: null
                      visa_basis_points: null
                      visa_fixed_fee: null
                      visa_charge_interchange: null
                      visa_assessments_basis_points: null
                      visa_acquirer_processing_fixed_fee: null
                      visa_credit_voucher_fixed_fee: null
                      visa_kilobyte_access_fixed_fee: null
                      discover_basis_points: null
                      discover_fixed_fee: null
                      discover_externally_funded_basis_points: null
                      discover_externally_funded_fixed_fee: null
                      discover_charge_interchange: null
                      discover_assessments_basis_points: null
                      discover_data_usage_fixed_fee: null
                      discover_network_authorization_fixed_fee: null
                      diners_club_basis_points: null
                      diners_club_fixed_fee: null
                      diners_club_charge_interchange: null
                      mastercard_basis_points: null
                      mastercard_fixed_fee: null
                      mastercard_charge_interchange: null
                      mastercard_assessments_under1k_basis_points: null
                      mastercard_assessments_over1k_basis_points: null
                      mastercard_acquirer_fees_basis_points: null
                      jcb_basis_points: null
                      jcb_fixed_fee: null
                      jcb_charge_interchange: null
                      american_express_basis_points: null
                      american_express_fixed_fee: null
                      american_express_externally_funded_basis_points: null
                      american_express_externally_funded_fixed_fee: null
                      american_express_charge_interchange: null
                      american_express_assessment_basis_points: null
                      rounding_mode: TRANSACTION
                      qualified_tiers: null
                      created_at: '2022-01-27T07:37:36.69Z'
                      updated_at: '2022-01-27T07:37:36.69Z'
                      visa_base_II_system_file_transmission_fixed_fee: null
                      visa_base_II_credit_voucher_fixed_fee: null
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/fee_profiles?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
      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/hal+json:
          schema:
            $ref: '#/components/schemas/FeesList'
          examples:
            List of Fees:
              value:
                _embedded:
                  fees:
                    - id: FEjoBcxx8X3hPVsdzT19SXp9
                      amount: 2
                      currency: USD
                      display_name: null
                      fee_subtype: PLATFORM_FEE
                      fee_type: CARD_BASIS_POINTS
                      label: null
                      linked_id: TRvmcvtpCSj3qNkzz18TLneX
                      linked_type: TRANSFER
                      merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                      created_at: '2022-08-17T16:37:00.99Z'
                      updated_at: '2022-08-17T16:37:00.99Z'
                      tags: {}
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/fees/FEjoBcxx8X3hPVsdzT19SXp9
                        merchant:
                          href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
                        transfer:
                          href: https://finix.sandbox-payments-api.com/transfers/TRvmcvtpCSj3qNkzz18TLneX
                    - id: FEtSD9oNjoCtJaN2C1FwhZ29
                      amount: 100
                      currency: USD
                      display_name: null
                      fee_subtype: PLATFORM_FEE
                      fee_type: CARD_FIXED
                      label: null
                      linked_id: TR7m4FqzubzFvPJf4WEmkEEv
                      linked_type: TRANSFER
                      merchant: MUeDVrf2ahuKc9Eg5TeZugvs
                      created_at: '2022-08-15T23:14:03.37Z'
                      updated_at: '2022-08-15T23:14:03.37Z'
                      tags: {}
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/fees/FEtSD9oNjoCtJaN2C1FwhZ29
                        merchant:
                          href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
                        transfer:
                          href: https://finix.sandbox-payments-api.com/transfers/TR7m4FqzubzFvPJf4WEmkEEv
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/fees?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/fees?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/fees?offset=13360&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    IdentitiesList:
      description: List of Identity objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/IdentitiesList'
          examples:
            List of Identities:
              value:
                _embedded:
                  identities:
                    - id: IDrNRsZ2miEQcmGHCpo4rBQr
                      application: APgPDQrLD52TYvqazjHJJchM
                      entity:
                        title: CEO
                        first_name: dwayne
                        last_name: xbc
                        email: user@example.org
                        business_name: Petes Coffee
                        business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
                        doing_business_as: Petes Coffee
                        phone: '1234567890'
                        business_phone: +1 (408) 756-4497
                        personal_address:
                          line1: 741 Douglass St
                          line2: Apartment 7
                          city: San Mateo
                          region: CA
                          postal_code: '94114'
                          country: USA
                        business_address:
                          line1: 741 Douglass St
                          line2: Apartment 8
                          city: San Mateo
                          region: CA
                          postal_code: '94114'
                          country: USA
                        mcc: '0742'
                        dob:
                          day: 27
                          month: 6
                          year: 1978
                        max_transaction_amount: 12000000
                        amex_mid: null
                        discover_mid: null
                        url: www.PetesCoffee.com
                        annual_card_volume: 12000000
                        has_accepted_credit_cards_previously: true
                        incorporation_date:
                          day: 27
                          month: 6
                          year: 1978
                        principal_percentage_ownership: 50
                        short_business_name: null
                        ownership_type: PRIVATE
                        tax_authority: null
                        tax_id_provided: true
                        business_tax_id_provided: true
                        default_statement_descriptor: Petes Coffee
                      tags:
                        test_key_103: test_val_103
                      created_at: '2022-08-16T18:44:27.46Z'
                      updated_at: '2022-08-16T18:44:27.46Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr
                        verifications:
                          href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/verifications
                        merchants:
                          href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/merchants
                        settlements:
                          href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/settlements
                        authorizations:
                          href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/authorizations
                        transfers:
                          href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/transfers
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/payment_instruments
                        associated_identities:
                          href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/associated_identities
                        disputes:
                          href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/disputes
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/identities/IDf33pdVaTZGXVFNccdKvaPu/associated_identities?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 1
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Identity:
      description: Single Identity object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Identity'
          examples:
            Identity (Buyer):
              value:
                id: IDgWxBhfGYLLdkhxx2ddYf9K
                application: APgPDQrLD52TYvqazjHJJchM
                entity:
                  title: null
                  first_name: John
                  last_name: Smith
                  email: user@example.org
                  business_name: null
                  business_type: null
                  doing_business_as: null
                  phone: '7145677613'
                  business_phone: null
                  personal_address:
                    line1: 741 Douglass St
                    line2: Apartment 7
                    city: San Mateo
                    region: CA
                    postal_code: '94114'
                    country: USA
                  business_address: null
                  mcc: null
                  dob: null
                  max_transaction_amount: 0
                  amex_mid: null
                  discover_mid: null
                  url: null
                  annual_card_volume: 0
                  has_accepted_credit_cards_previously: false
                  incorporation_date: null
                  principal_percentage_ownership: null
                  short_business_name: null
                  ownership_type: PRIVATE
                  tax_authority: null
                  tax_id_provided: false
                  business_tax_id_provided: false
                  default_statement_descriptor: null
                tags:
                  key: value
                created_at: '2022-01-27T07:36:59.91Z'
                updated_at: '2022-01-27T07:36:59.91Z'
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
                  verifications:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/verifications
                  merchants:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/merchants
                  settlements:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/settlements
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/authorizations
                  transfers:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/transfers
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/payment_instruments
                  associated_identities:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/associated_identities
                  disputes:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/disputes
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
            Identity (Merchant):
              value:
                id: IDg6KVYcoRJKdEC5HqKxGMhY
                application: APgPDQrLD52TYvqazjHJJchM
                entity:
                  title: CEO
                  first_name: Jane
                  last_name: Dow
                  email: user@example.org
                  business_name: Finix Ferry
                  business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
                  doing_business_as: Finix Ferry
                  phone: '1234567890'
                  business_phone: +1 (408) 756-4497
                  personal_address:
                    line1: 741 Douglass St
                    line2: Apartment 7
                    city: San Mateo
                    region: CA
                    postal_code: '94114'
                    country: USA
                  business_address:
                    line1: 741 Douglass St
                    line2: Apartment 8
                    city: San Mateo
                    region: CA
                    postal_code: '94114'
                    country: USA
                  mcc: '0742'
                  dob:
                    day: 27
                    month: 6
                    year: 1978
                  max_transaction_amount: 12000000
                  amex_mid: null
                  discover_mid: null
                  url: www.FinixFerry.com
                  annual_card_volume: 12000000
                  has_accepted_credit_cards_previously: true
                  incorporation_date:
                    day: 27
                    month: 6
                    year: 1978
                  principal_percentage_ownership: 50
                  short_business_name: null
                  ownership_type: PRIVATE
                  tax_authority: null
                  tax_id_provided: true
                  business_tax_id_provided: true
                  default_statement_descriptor: Finix Ferry
                tags:
                  test_key_102: test_val_102
                created_at: '2022-08-16T18:44:26.55Z'
                updated_at: '2022-08-16T18:44:26.55Z'
                additional_underwriting_data:
                  annual_ach_volume: 200000
                  average_ach_transfer_amount: 200000
                  average_card_transfer_amount: 200000
                  business_description: BCSB3 vegan cafe
                  card_volume_distribution:
                    card_present_percentage: 30
                    ecommerce_percentage: 60
                    mail_order_telephone_order_percentage: 10
                  credit_check_allowed: true
                  credit_check_ip_address: 42.1.1.113
                  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:
                    business_to_business_volume_percentage: 100
                    business_to_consumer_volume_percentage: 0
                    consumer_to_consumer_volume_percentage: 0
                    other_volume_percentage: 0
                    person_to_person_volume_percentage: 0
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY
                  verifications:
                    href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/verifications
                  merchants:
                    href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/merchants
                  settlements:
                    href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/settlements
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/authorizations
                  transfers:
                    href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/transfers
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/payment_instruments
                  associated_identities:
                    href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/associated_identities
                  disputes:
                    href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/disputes
                  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'
    Merchant:
      description: Single Merchant object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Merchant'
          examples:
            Merchant:
              value:
                id: MUmUL7aBsHkxVLQawJxEXw6N
                application: APgPDQrLD52TYvqazjHJJchM
                identity: IDrH4G2VTfNjn1VFkvhcyMYj
                verification: VIioiAQWmoT6b6p6mqSggKvA
                merchant_profile: MPjBZguwk8oJ9H5ouJo3jaG4
                processor: DUMMY_V1
                processing_enabled: true
                settlement_enabled: true
                gross_settlement_enabled: false
                creating_transfer_from_report_enabled: true
                card_expiration_date_required: true
                card_cvv_required: false
                tags:
                  key_2: value_2
                mcc: null
                mid: FNXeyy4moA2MvW2Ng9yctRyAZ
                merchant_name: John Smith
                settlement_funding_identifier: UNSET
                ready_to_settle_upon: RECONCILIATION
                fee_ready_to_settle_upon: RECONCILIATION
                level_two_level_three_data_enabled: false
                created_at: '2022-08-17T20:33:34.04Z'
                updated_at: '2022-08-17T20:34:01.49Z'
                onboarding_state: APPROVED
                processor_details:
                  mid: FNXeyy4moA2MvW2Ng9yctRyAZ
                  api_key: secretValue
                convenience_charges_enabled: false
                rent_surcharges_enabled: false
                _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/VIioiAQWmoT6b6p6mqSggKvA
            Merchant Created with Card Present Enabled:
              value:
                id: MUnvf2P5BkDjJ3giAAs6LVrM
                application: APeUbTUjvYb1CdPXvNcwW1wP
                identity: IDaVwMrWz9BLz6RHrV6L8FS3
                verification: VI5PsAheSRY9NEVdkFQ4STBD
                merchant_profile: MPmyXg5r5ckg1EgM9swsJEsG
                processor: VANTIV_V1
                processing_enabled: false
                settlement_enabled: false
                gross_settlement_enabled: false
                creating_transfer_from_report_enabled: false
                card_expiration_date_required: true
                card_cvv_required: true
                tags:
                  key_2: value_2
                mcc: null
                mid: null
                merchant_name: Finix Flowers
                settlement_funding_identifier: UNSET
                ready_to_settle_upon: RECONCILIATION
                fee_ready_to_settle_upon: RECONCILIATION
                level_two_level_three_data_enabled: false
                created_at: '2022-06-05T18:13:48.14Z'
                updated_at: '2022-06-05T18:13:48.14Z'
                onboarding_state: PROVISIONING
                processor_details: {}
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchants/MUnvf2P5BkDjJ3giAAs6LVrM
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDaVwMrWz9BLz6RHrV6L8FS3
                  verifications:
                    href: https://finix.sandbox-payments-api.com/merchants/MUnvf2P5BkDjJ3giAAs6LVrM/verifications
                  merchant_profile:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles/MPmyXg5r5ckg1EgM9swsJEsG
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  verification:
                    href: https://finix.sandbox-payments-api.com/verifications/VI5PsAheSRY9NEVdkFQ4STBD
      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/hal+json:
          schema:
            $ref: '#/components/schemas/MerchantProfile'
          examples:
            Merchant Profile:
              value:
                id: MPsdo8WPP5erWzfPwMjYjVy3
                tags: {}
                application: APgPDQrLD52TYvqazjHJJchM
                fee_profile: null
                risk_profile: RPwAziDZginXDWuuiDSaA3wr
                created_at: '2022-08-15T21:37:47.26Z'
                updated_at: '2022-08-15T21:38:24.02Z'
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles/MPsdo8WPP5erWzfPwMjYjVy3
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  risk_profile:
                    href: https://finix.sandbox-payments-api.com/risk_profiles/RPwAziDZginXDWuuiDSaA3wr
      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/hal+json:
          schema:
            $ref: '#/components/schemas/MerchantProfilesList'
          examples:
            List of Merchant Profiles:
              value:
                _embedded:
                  merchant_profiles:
                    - id: MPjBZguwk8oJ9H5ouJo3jaG4
                      tags: {}
                      application: APgPDQrLD52TYvqazjHJJchM
                      fee_profile: null
                      risk_profile: RPnxLQLjV4Rma67zU4m8NnqW
                      created_at: '2022-08-17T20:33:34.04Z'
                      updated_at: '2022-08-17T20:33:34.04Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/merchant_profiles/MPjBZguwk8oJ9H5ouJo3jaG4
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        risk_profile:
                          href: https://finix.sandbox-payments-api.com/risk_profiles/RPnxLQLjV4Rma67zU4m8NnqW
                    - id: MPhphMCVwQ6ioryNXT9fFdpQ
                      tags: {}
                      application: APgPDQrLD52TYvqazjHJJchM
                      fee_profile: null
                      risk_profile: RPv4BsNuXQYqB6sAyXVaiXvQ
                      created_at: '2022-08-16T18:50:51.99Z'
                      updated_at: '2022-08-16T18:51:03.18Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/merchant_profiles/MPhphMCVwQ6ioryNXT9fFdpQ
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        risk_profile:
                          href: https://finix.sandbox-payments-api.com/risk_profiles/RPv4BsNuXQYqB6sAyXVaiXvQ
                    - id: MPnZBXBVKYHBgYXzx7vhznWc
                      tags: {}
                      application: APgPDQrLD52TYvqazjHJJchM
                      fee_profile: null
                      risk_profile: RPpiJkfXqstuuhvX8GbbSCQU
                      created_at: '2022-08-15T21:37:45.87Z'
                      updated_at: '2022-08-15T21:38:23.63Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/merchant_profiles/MPnZBXBVKYHBgYXzx7vhznWc
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        risk_profile:
                          href: https://finix.sandbox-payments-api.com/risk_profiles/RPpiJkfXqstuuhvX8GbbSCQU
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles?offset=1500&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'
    MerchantsList:
      description: List of Merchants objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/MerchantsList'
          examples:
            List of Merchants:
              value:
                _embedded:
                  merchants:
                    - id: MUmUL7aBsHkxVLQawJxEXw6N
                      application: APgPDQrLD52TYvqazjHJJchM
                      identity: IDrH4G2VTfNjn1VFkvhcyMYj
                      verification: VIioiAQWmoT6b6p6mqSggKvA
                      merchant_profile: MPjBZguwk8oJ9H5ouJo3jaG4
                      processor: DUMMY_V1
                      processing_enabled: true
                      settlement_enabled: true
                      gross_settlement_enabled: false
                      creating_transfer_from_report_enabled: true
                      card_expiration_date_required: true
                      card_cvv_required: false
                      tags:
                        key_2: value_2
                      mcc: null
                      mid: FNXeyy4moA2MvW2Ng9yctRyAZ
                      merchant_name: John Smith
                      settlement_funding_identifier: UNSET
                      ready_to_settle_upon: RECONCILIATION
                      fee_ready_to_settle_upon: RECONCILIATION
                      level_two_level_three_data_enabled: false
                      created_at: '2022-08-17T20:33:34.04Z'
                      updated_at: '2022-08-17T20:34:01.49Z'
                      onboarding_state: APPROVED
                      processor_details:
                        mid: FNXeyy4moA2MvW2Ng9yctRyAZ
                        api_key: secretValue
                      convenience_charges_enabled: false
                      rent_surcharges_enabled: false
                      _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/VIioiAQWmoT6b6p6mqSggKvA
                    - id: MUkobdhdxtCL4tzvJobZ7vBH
                      application: APgPDQrLD52TYvqazjHJJchM
                      identity: IDx7GYHa4eiZtqCEAB2suaKt
                      verification: VIvkSfF4m5B6q3CGwtUGgGRi
                      merchant_profile: MPnZBXBVKYHBgYXzx7vhznWc
                      processor: DUMMY_V1
                      processing_enabled: true
                      settlement_enabled: true
                      gross_settlement_enabled: false
                      creating_transfer_from_report_enabled: true
                      card_expiration_date_required: true
                      card_cvv_required: false
                      tags:
                        test_key_102: test_val_102
                      mcc: '0742'
                      mid: FNXdmKNYL1PedUZhopAwg83ZU
                      merchant_name: Petes Coffee
                      settlement_funding_identifier: UNSET
                      ready_to_settle_upon: RECONCILIATION
                      fee_ready_to_settle_upon: RECONCILIATION
                      level_two_level_three_data_enabled: false
                      created_at: '2022-08-15T21:37:45.87Z'
                      updated_at: '2022-08-15T21:38:23.63Z'
                      onboarding_state: APPROVED
                      processor_details:
                        mid: FNXdmKNYL1PedUZhopAwg83ZU
                        api_key: secretValue
                      convenience_charges_enabled: false
                      rent_surcharges_enabled: false
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/merchants/MUkobdhdxtCL4tzvJobZ7vBH
                        identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDx7GYHa4eiZtqCEAB2suaKt
                        verifications:
                          href: https://finix.sandbox-payments-api.com/merchants/MUkobdhdxtCL4tzvJobZ7vBH/verifications
                        merchant_profile:
                          href: https://finix.sandbox-payments-api.com/merchant_profiles/MPnZBXBVKYHBgYXzx7vhznWc
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        verification:
                          href: https://finix.sandbox-payments-api.com/verifications/VIvkSfF4m5B6q3CGwtUGgGRi
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchants?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/merchants?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/merchants?offset=1500&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    NoContent:
      description: No content
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    PaymentInstrument:
      description: Single Payment Instrument object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/PaymentInstrument'
            descriminator:
              propertyName: type
          examples:
            Payment Instrument (Card):
              value:
                id: PIwWisLuZNwPBoLbCgQVTCoY
                application: APgPDQrLD52TYvqazjHJJchM
                fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
                tags:
                  card_name: Business Card
                expiration_month: 12
                expiration_year: 2029
                bin: '400000'
                last_four: '9979'
                brand: VISA
                card_type: UNKNOWN
                name: Amy White
                address:
                  line1: 900 Metro Center Blv
                  line2: null
                  city: San Francisco
                  region: CA
                  postal_code: '94404'
                  country: USA
                address_verification: NO_MATCH
                security_code_verification: UNMATCHED
                created_at: '2022-08-15T23:13:06.13Z'
                updated_at: '2022-08-15T23:13:06.88Z'
                instrument_type: PAYMENT_CARD
                type: PAYMENT_CARD
                currency: USD
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                _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 (Bank Account):
              value:
                id: PI8sdzepdapDehPWKFTcre1m
                application: APgPDQrLD52TYvqazjHJJchM
                fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
                tags:
                  Bank Account: Company Account
                bank_code: '123123123'
                country: USA
                masked_account_number: XXXXX3123
                name: Alice
                account_type: SAVINGS
                bank_account_validation_check: NOT_ATTEMPTED
                created_at: '2022-01-27T07:36:57.62Z'
                updated_at: '2022-01-27T07:36:57.62Z'
                instrument_type: BANK_ACCOUNT
                type: BANK_ACCOUNT
                currency: USD
                identity: IDpYDM7J9n57q849o9E9yNrG
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m/authorizations
                  transfers:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m/transfers
                  verifications:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m/verifications
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
            Payment Instrument (Token):
              value:
                id: PIs4ZXrQB1RjbYJSgkfbcrbM
                application: APgPDQrLD52TYvqazjHJJchM
                fingerprint: FPRw9NoorETQgCjFgwKPvcGsV
                tags: {}
                expiration_month: 12
                expiration_year: 2029
                bin: '495703'
                last_four: '0454'
                brand: VISA
                card_type: UNKNOWN
                name: null
                address:
                  line1: 741 Douglass St
                  line2: Apartment 7
                  city: San Mateo
                  region: CA
                  postal_code: '94114'
                  country: USA
                address_verification: UNKNOWN
                security_code_verification: UNKNOWN
                created_at: '2022-01-27T07:37:27.42Z'
                updated_at: '2022-01-27T07:37:27.42Z'
                instrument_type: PAYMENT_CARD
                type: PAYMENT_CARD
                currency: USD
                identity: IDpYDM7J9n57q849o9E9yNrG
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/authorizations
                  transfers:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/transfers
                  verifications:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/verifications
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
                  updates:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/updates
            Payment Instrument (Apple Pay Web):
              value:
                id: PI4gTM3twQ5XyXfM4rTuFvpo
                application: APgPDQrLD52TYvqazjHJJchM
                fingerprint: FPR88YBDbK4TqYMUNU8t8fbeQ
                tags: {}
                name: John Smith
                expiration_month: 11
                expiration_year: 2024
                bin: '370382'
                last_four: '8576'
                brand: AMERICAN_EXPRESS
                created_at: '2022-04-01T19:41:16.48Z'
                updated_at: '2022-04-01T19:41:16.51Z'
                instrument_type: APPLE_PAY
                type: APPLE_PAY
                currency: USD
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PI4gTM3twQ5XyXfM4rTuFvpo
                  authorizations:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PI4gTM3twQ5XyXfM4rTuFvpo/authorizations
                  transfers:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PI4gTM3twQ5XyXfM4rTuFvpo/transfers
                  verifications:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PI4gTM3twQ5XyXfM4rTuFvpo/verifications
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    PaymentInstrumentToken:
      description: Token response object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/PaymentInstrumentToken'
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    PaymentInstrumentUpdatesList:
      description: List of Update objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/PaymentInstrumentUpdatesList'
          examples:
            Payment Instrument Updates:
              value:
                _embedded:
                  updates:
                    - id: IUgfbYVzbgzZ9hqYCNmqMiXx
                      application: APgPDQrLD52TYvqazjHJJchM
                      merchant: MUucec6fHeaWo3VHYoSkUySM
                      state: SUCCEEDED
                      messages: []
                      created_at: '2022-01-27T07:37:29.94Z'
                      updated_at: '2022-01-27T07:38:02.24Z'
                      payment_instrument: PIe2YvpcjvoVJ6PzoRPBK137
                      trace_id: b576beef-5acf-4fab-aa22-07266523616a
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/updates/IUgfbYVzbgzZ9hqYCNmqMiXx
                        payment_instrument:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                    - id: IUaZCvDxBcdSeCvtVMnM6tBk
                      application: APgPDQrLD52TYvqazjHJJchM
                      merchant: MUucec6fHeaWo3VHYoSkUySM
                      state: SUCCEEDED
                      messages: []
                      created_at: '2022-06-27T16:53:35.84Z'
                      updated_at: '2022-06-27T16:54:02.43Z'
                      payment_instrument: PIe2YvpcjvoVJ6PzoRPBK137
                      trace_id: bbe9656f-3c6d-4eef-912b-600f15da3f49
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/updates/IUaZCvDxBcdSeCvtVMnM6tBk
                        payment_instrument:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                    - id: IUbnw4ZC5EvQcZp6fCw6S1GS
                      application: APgPDQrLD52TYvqazjHJJchM
                      merchant: MUucec6fHeaWo3VHYoSkUySM
                      state: SUCCEEDED
                      messages: []
                      created_at: '2022-08-01T01:25:41.63Z'
                      updated_at: '2022-08-01T01:26:02.82Z'
                      payment_instrument: PIe2YvpcjvoVJ6PzoRPBK137
                      trace_id: 11db0d65-78aa-4fe4-a0c8-a7d26c434dce
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/updates/IUbnw4ZC5EvQcZp6fCw6S1GS
                        payment_instrument:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/updates?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'
    PaymentInstrumentsList:
      description: List of Payment Instrument objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/PaymentInstrumentsList'
          examples:
            List of Payment Instruments:
              value:
                _embedded:
                  payment_instruments:
                    - id: PI5peqd4kzQ6LD3hb3vebj5x
                      application: APgPDQrLD52TYvqazjHJJchM
                      fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
                      tags:
                        Bank Account: Company Account
                      bank_code: '123123123'
                      country: USA
                      masked_account_number: XXXXX3123
                      name: Alice
                      account_type: SAVINGS
                      bank_account_validation_check: NOT_ATTEMPTED
                      created_at: '2022-08-17T20:33:24.57Z'
                      updated_at: '2022-08-17T20:33:24.57Z'
                      instrument_type: BANK_ACCOUNT
                      type: BANK_ACCOUNT
                      currency: USD
                      identity: IDrH4G2VTfNjn1VFkvhcyMYj
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x
                        authorizations:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x/authorizations
                        transfers:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x/transfers
                        verifications:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x/verifications
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj
                    - id: PIwWisLuZNwPBoLbCgQVTCoY
                      application: APgPDQrLD52TYvqazjHJJchM
                      fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
                      tags:
                        card_name: Business Card
                      expiration_month: 12
                      expiration_year: 2029
                      bin: '400000'
                      last_four: '9979'
                      brand: VISA
                      card_type: UNKNOWN
                      name: Amy White
                      address:
                        line1: 900 Metro Center Blv
                        line2: null
                        city: San Francisco
                        region: CA
                        postal_code: '94404'
                        country: USA
                      address_verification: NO_MATCH
                      security_code_verification: UNMATCHED
                      created_at: '2022-08-15T23:13:06.13Z'
                      updated_at: '2022-08-15T23:13:06.88Z'
                      instrument_type: PAYMENT_CARD
                      type: PAYMENT_CARD
                      currency: USD
                      identity: IDgWxBhfGYLLdkhxx2ddYf9K
                      _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
                _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=13100&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
      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/hal+json:
          schema:
            $ref: '#/components/schemas/Processor'
          examples:
            Application Processor:
              value:
                id: PRrEnUtBAWMj35r4wkjycncs
                application: APgPDQrLD52TYvqazjHJJchM
                default_merchant_profile: MPukqLdkiojiX2SauizfaRYr
                application_config: null
                system_config: null
                created_at: '2022-01-27T07:36:34.55Z'
                updated_at: '2022-01-27T07:36:34.46Z'
                processor: DUMMY_V1
                config:
                  key1: value-1
                  key2: value-2
                  canDebitBankAccount: true
                enabled: true
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/processors/DUMMY_V1
                  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'
    ProcessorsList:
      description: List of Processor objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ProcessorsList'
          examples:
            List of Application Processors:
              value:
                _embedded:
                  processors:
                    - id: PRrH5Cy9ZYFUZDha4cuDgipv
                      application: APmuwPBaW8pVcwb4vCTHQH32
                      default_merchant_profile: MP53dza14XzW4VYqRTnQ8Bpw
                      application_config:
                        default_sender_account_number: '123456789012'
                        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
                        default_level_two_level_three_data_enabled: false
                        ach_settlement_delay_days: null
                        allow_split_payouts: false
                        alert_on_unknown_merchants: false
                      system_config: null
                      created_at: '2022-04-01T20:45:28.22Z'
                      updated_at: '2022-04-01T20:45:28.11Z'
                      processor: MASTERCARD_V1
                      config: {}
                      enabled: true
                      _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
                      application: APmuwPBaW8pVcwb4vCTHQH32
                      default_merchant_profile: MPf31wi1tKdVqtrT8PFyPFSg
                      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
                      system_config: null
                      created_at: '2021-10-04T17:46:10.09Z'
                      updated_at: '2021-10-04T17:46:10.00Z'
                      processor: DUMMY_V1
                      config:
                        key1: value-1
                        key2: value-2
                        canDebitBankAccount: true
                      enabled: true
                      _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: 2
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ReversalsList:
      description: List of Reversals
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/TransfersList'
          examples:
            List of Reversals on a Transfer:
              value:
                _embedded:
                  transfers:
                    - id: TR6tJC1MuHgr52KC2orx84oh
                      amount: 100
                      tags:
                        test: refund
                      state: SUCCEEDED
                      trace_id: e47cc3b1-f70f-4873-8fc8-4e3863755d89
                      currency: USD
                      application: APgPDQrLD52TYvqazjHJJchM
                      source: null
                      destination: PIe2YvpcjvoVJ6PzoRPBK137
                      ready_to_settle_at: '2022-08-16T04:00:00.00Z'
                      externally_funded: 'FALSE'
                      fee: 0
                      statement_descriptor: FNX*DUNDER MIFFLIN
                      type: REVERSAL
                      messages: []
                      raw: null
                      created_at: '2022-08-15T23:12:32.53Z'
                      updated_at: '2022-08-15T23:13:13.89Z'
                      idempotency_id: null
                      merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                      subtype: API
                      failure_code: null
                      failure_message: null
                      additional_buyer_charges: null
                      _links:
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: https://finix.sandbox-payments-api.com/transfers/TR6tJC1MuHgr52KC2orx84oh
                        parent:
                          href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP
                        destination:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/transfers/TR6tJC1MuHgr52KC2orx84oh/payment_instruments
                        fee_profile:
                          href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                    - id: TRpjXvjTV4cPwS7KkVJqN753
                      amount: 100
                      tags:
                        test: refund
                      state: SUCCEEDED
                      trace_id: ef1b2012-2ae6-4013-8811-6ec23ead4b8c
                      currency: USD
                      application: APgPDQrLD52TYvqazjHJJchM
                      source: null
                      destination: PIe2YvpcjvoVJ6PzoRPBK137
                      ready_to_settle_at: '2022-08-12T04:00:00.00Z'
                      externally_funded: 'FALSE'
                      fee: 0
                      statement_descriptor: FNX*DUNDER MIFFLIN
                      type: REVERSAL
                      messages: []
                      raw: null
                      created_at: '2022-08-12T22:17:51.46Z'
                      updated_at: '2022-08-12T22:18:08.58Z'
                      idempotency_id: null
                      merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                      subtype: API
                      failure_code: null
                      failure_message: null
                      additional_buyer_charges: null
                      _links:
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: https://finix.sandbox-payments-api.com/transfers/TRpjXvjTV4cPwS7KkVJqN753
                        parent:
                          href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP
                        destination:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/transfers/TRpjXvjTV4cPwS7KkVJqN753/payment_instruments
                        fee_profile:
                          href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals?offset=720&limit=20&sort=created_at,desc&sort=id,desc
                  parent:
                    href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP
                page:
                  offset: 0
                  limit: 20
                  count: 2
                unreversed_amount: 591654
      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/hal+json:
          schema:
            $ref: '#/components/schemas/Settlement'
          examples:
            Settlement:
              value:
                id: STimypRqs5TXoCDRq2swMFUY
                application: APgPDQrLD52TYvqazjHJJchM
                tags: {}
                identity: IDgWxBhfGYLLdkhxx2ddYf9K
                currency: USD
                merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs
                created_at: '2022-08-09T17:06:02.99Z'
                updated_at: '2022-08-09T17:15:25.60Z'
                processor: DUMMY_V1
                type: MERCHANT_REVENUE
                funds_flow: null
                payment_type: null
                total_amount: 2287662
                total_fees: 49305
                total_fee: 49305
                net_amount: 2238357
                destination: null
                status: AWAITING_APPROVAL
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                  funding_transfers:
                    href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/funding_transfers
                  transfers:
                    href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers
                  fees:
                    href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=fee
                  reversals:
                    href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=reverse
                  credits:
                    href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=credit
                  debits:
                    href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=debit
                  disputes:
                    href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/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'
    SettlementsList:
      description: List of `Settlement` objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/SettlementsList'
          examples:
            List of Settlements:
              value:
                _embedded:
                  settlements:
                    - id: STrYmJ27NeLqRfWSXVKJboNy
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        Internal Daily Settlement ID: 21DFASJSAKAS
                      identity: IDuqZpDw28f2KK6YuDk4jNLg
                      currency: USD
                      merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs
                      created_at: '2022-08-17T16:37:02.32Z'
                      updated_at: '2022-08-17T16:39:04.98Z'
                      processor: DUMMY_V1
                      type: MERCHANT_REVENUE
                      funds_flow: null
                      payment_type: null
                      total_amount: 100
                      total_fees: 102
                      total_fee: 102
                      net_amount: -2
                      destination: null
                      status: AWAITING_APPROVAL
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                        funding_transfers:
                          href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/funding_transfers
                        transfers:
                          href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers
                        fees:
                          href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=fee
                        reversals:
                          href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=reverse
                        credits:
                          href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=credit
                        debits:
                          href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=debit
                        disputes:
                          href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=dispute
                    - id: STimypRqs5TXoCDRq2swMFUY
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags: {}
                      identity: IDuqZpDw28f2KK6YuDk4jNLg
                      currency: USD
                      merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs
                      created_at: '2022-08-09T17:06:02.99Z'
                      updated_at: '2022-08-09T17:15:25.60Z'
                      processor: DUMMY_V1
                      type: MERCHANT_REVENUE
                      funds_flow: null
                      payment_type: null
                      total_amount: 2287662
                      total_fees: 49305
                      total_fee: 49305
                      net_amount: 2238357
                      destination: null
                      status: AWAITING_APPROVAL
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                        funding_transfers:
                          href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/funding_transfers
                        transfers:
                          href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers
                        fees:
                          href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=fee
                        reversals:
                          href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=reverse
                        credits:
                          href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=credit
                        debits:
                          href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=debit
                        disputes:
                          href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=dispute
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/settlements/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/settlements/?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/settlements/?offset=460&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Transfer:
      description: Single Transfer object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Transfer'
          examples:
            Transfer:
              value:
                id: TRvypRNBeqM597Zi4DcqJ2Vh
                amount: 662154
                tags:
                  test: sale
                state: PENDING
                trace_id: 61646f46-f3fb-4fba-baae-a875a8bdce72
                currency: USD
                application: APgPDQrLD52TYvqazjHJJchM
                source: PIe2YvpcjvoVJ6PzoRPBK137
                destination: null
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FNX*FINIX FLOWERS
                type: DEBIT
                messages: []
                raw: null
                created_at: '2022-01-27T07:37:09.71Z'
                updated_at: '2022-01-27T07:37:10.01Z'
                idempotency_id: null
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh/disputes
                  source:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPbDSnEPtaT8Nttxj9NJk7eC
            Transfer (Debits a Bank Account):
              value:
                id: TRgqNR5Um4foo5Py6mZqNKKM
                amount: 6031
                tags:
                  order_number: 21DFASJSAKAS
                state: PENDING
                trace_id: 4a845f58-2234-4484-ad0c-5b716160cf56
                currency: USD
                application: APgPDQrLD52TYvqazjHJJchM
                source: PIk3AG7aUSCyNgYpDwCKkwDC
                destination: null
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 603
                statement_descriptor: FNX*FINIX FLOWERS
                type: DEBIT
                messages: []
                raw: null
                created_at: '2022-06-05T22:26:04.94Z'
                updated_at: '2022-06-05T22:26:05.42Z'
                idempotency_id: null
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM/disputes
                  source:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIk3AG7aUSCyNgYpDwCKkwDC
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
            Transfer (with 3D Secure):
              value:
                id: TRvRKrrAmWwFeVsnHbyfGiNi
                amount: 92169
                tags:
                  test: sale
                state: PENDING
                trace_id: 313424d6-229c-4d2e-952f-d0ec13786a1b
                currency: USD
                application: APgPDQrLD52TYvqazjHJJchM
                source: PIe2YvpcjvoVJ6PzoRPBK137
                destination: null
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FNX*FINIX FLOWERS
                type: DEBIT
                messages: []
                raw: null
                created_at: '2022-06-07T18:16:26.30Z'
                updated_at: '2022-06-07T18:16:26.90Z'
                idempotency_id: null
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi/disputes
                  source:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
            Transfer (with Level 2 Processing):
              value:
                id: TRcSMjyDts3rafZt4BmBFNFU
                amount: 1000
                tags:
                  test: sale
                state: PENDING
                trace_id: 68d2c3e1-3b43-4e9f-9dbd-d803c4629b5f
                currency: USD
                application: APgPDQrLD52TYvqazjHJJchM
                source: PIe2YvpcjvoVJ6PzoRPBK137
                destination: null
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FNX*FINIX FLOWERS
                type: DEBIT
                messages: []
                raw: null
                created_at: '2022-06-05T22:32:26.18Z'
                updated_at: '2022-06-05T22:32:26.56Z'
                idempotency_id: null
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU/disputes
                  source:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
            Transfer (with Level 3 Processing):
              value:
                id: TRnka9J9CD4cHv814R87C5g3
                amount: 1000
                tags:
                  test: sale
                state: PENDING
                trace_id: 80e04d43-49ed-44de-a787-a548266d0503
                currency: USD
                application: APgPDQrLD52TYvqazjHJJchM
                source: PIe2YvpcjvoVJ6PzoRPBK137
                destination: null
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FNX*FINIX FLOWERS
                type: DEBIT
                messages: []
                raw: null
                created_at: '2022-06-05T22:34:34.64Z'
                updated_at: '2022-06-05T22:34:35.19Z'
                idempotency_id: null
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3/disputes
                  source:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
            Refunded Transfer:
              value:
                id: TR5TXaE65eu2T9MAWDeNAJve
                amount: 100
                tags:
                  test: refund
                state: PENDING
                trace_id: cd753931-3a39-41b3-bacb-259ef78b3eda
                currency: USD
                application: APgPDQrLD52TYvqazjHJJchM
                source: null
                destination: PIe2YvpcjvoVJ6PzoRPBK137
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FNX*FINIX FLOWERS
                type: REVERSAL
                messages: []
                raw: null
                created_at: '2022-06-05T22:46:03.61Z'
                updated_at: '2022-06-05T22:46:03.74Z'
                idempotency_id: null
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TR5TXaE65eu2T9MAWDeNAJve
                  parent:
                    href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3
                  destination:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TR5TXaE65eu2T9MAWDeNAJve/payment_instruments
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
            Transfer (Created with an EMV Card):
              value:
                id: TRkLSjfcwbxUUsXhmdxKxhMd
                amount: 150
                tags:
                  order_number: chris123transfer
                state: SUCCEEDED
                trace_id: FNXkKp3o2hRyp82hcjWQt2uJ1
                currency: USD
                application: APeUbTUjvYb1CdPXvNcwW1wP
                source: PIi4GW7Grt5PMyAAVWBhShrw
                destination: null
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FIN*FINIX FLOWERS
                type: DEBIT
                messages: []
                raw: null
                card_present_details:
                  emv_data:
                    application_identifier: A0000000031010
                    application_label: Visa Credit
                    application_preferred_name: null
                    application_transaction_counter: '004F'
                    cryptogram: TC F8C706E8A0368D15
                    issuer_code_table_index: null
                    pin_verified: false
                  masked_account_number: '************7564'
                  name: 'AARON/CHRISTOPHER W '
                  brand: VISA
                  entry_mode: CHIP_ENTRY
                  payment_type: CREDIT
                  approval_code: '000036'
                created_at: '2022-06-05T22:48:32.44Z'
                updated_at: '2022-06-05T22:48:33.66Z'
                idempotency_id: null
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                device: DVf2H8sh4LZZC52GTUrwCPPf
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd/disputes
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
            Transfer (Created with a Non-EMV Card):
              value:
                id: TRhQxafAW3W69mccPi42mFF
                amount: 150
                tags:
                  order_number: chris123transfer
                state: SUCCEEDED
                trace_id: FNXgKMsxN9Uv5nyPh9YLsjur4
                currency: USD
                application: APeUbTUjvYb1CdPXvNcwW1wP
                source: PIGBpNc9u2nLDDqUprwyrgA
                destination: null
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FIN*FINIX FLOWERS
                type: DEBIT
                messages:
                  - Unable to find PIN pad with laneId 1
                raw: null
                card_present_details:
                  emv_data: null
                  masked_account_number: '************0011'
                  name: TEST/WORLDPAY
                  brand: UNKNOWN
                  entry_mode: SWIPED
                  payment_type: CREDIT
                  approval_code: '000004'
                created_at: '2022-06-05T22:51:17.25Z'
                updated_at: '2022-06-05T22:51:18.41Z'
                idempotency_id: null
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                device: DVf2H8sh4LZZC52GTUrwCPPf
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF/disputes
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
            Transfer (Created via Manual Entry):
              value:
                id: TRifUPGv1R74gtM4L9EUzfiB
                amount: 150
                tags:
                  order_number: chris123transfer
                state: SUCCEEDED
                trace_id: FNXhci8o1op8FvZoMmqUQjpAH
                currency: USD
                application: APeUbTUjvYb1CdPXvNcwW1wP
                source: PIhE1mNrA6g4FiVpjqC1PT6n
                destination: null
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FIN*FINIX FLOWERS
                type: DEBIT
                messages: []
                raw: null
                card_present_details:
                  emv_data: null
                  masked_account_number: '************0006'
                  name: ''
                  brand: VISA
                  entry_mode: MANUAL_KEY_ENTRY
                  payment_type: CREDIT
                  approval_code: '000059'
                created_at: '2022-06-05T22:55:07.76Z'
                updated_at: '2022-06-05T22:55:08.89Z'
                idempotency_id: null
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                device: DVf2H8sh4LZZC52GTUrwCPPf
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/disputes
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
            Card Present Transfer Refunded:
              value:
                id: TRkWoMAdBwfVgYQpL8csYbtH
                amount: 150
                tags: {}
                state: SUCCEEDED
                trace_id: FNXhYDzG8GLyL2gmE77Ygnjai
                currency: USD
                application: APuZMfMerci2JuLUs7xWpf5G
                source: null
                destination: PIp89SyE68fV5rxRCZUJz39c
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FNXQA*FINIX FLOWERSS
                type: REVERSAL
                messages: []
                raw: null
                created_at: '2022-06-05T22:55:07.76Z'
                updated_at: '2022-06-05T22:55:08.89Z'
                idempotency_id: null
                merchant_identity: ID8W4rxaFN8HsxqugmesLMVo
                device: DVkBqa68V1ZQusodU8o6mB62
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APuZMfMerci2JuLUs7xWpf5G
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TRkWoMAdBwfVgYQpL8csYbtH
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/ID8W4rxaFN8HsxqugmesLMVo
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVkBqa68V1ZQusodU8o6mB62
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TRkWoMAdBwfVgYQpL8csYbtH/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TRkWoMAdBwfVgYQpL8csYbtH/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TRkWoMAdBwfVgYQpL8csYbtH/disputes
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
            Swiped Card Transfer Refunded:
              value:
                id: TR3vLiG6wecEwY3TC3oQiudG
                amount: 100
                tags:
                  order_number: testing123
                state: SUCCEEDED
                trace_id: FNXgm7zyjYEmYwUQ3fktSTkaZ
                currency: USD
                application: APuZMfMerci2JuLUs7xWpf5G
                source: null
                destination: PIiPybsvUSM4fN8sYaMS3qXg
                ready_to_settle_at: null
                externally_funded: UNKNOWN
                fee: 0
                statement_descriptor: FNXQA*FINIX FLOWERS
                type: CREDIT
                messages: []
                raw: null
                card_present_details:
                  emv_data: null
                  masked_account_number: '************0006'
                  name: TEST/WORLDPAY
                  brand: VISA
                  entry_mode: SWIPED
                  payment_type: CREDIT
                  approval_code: '000019'
                created_at: '2022-06-05T22:55:07.76Z'
                updated_at: '2022-06-05T22:55:08.89Z'
                idempotency_id: null
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                device: DVf2H8sh4LZZC52GTUrwCPPf
                subtype: API
                failure_code: null
                failure_message: null
                additional_buyer_charges: null
                _links:
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APuZMfMerci2JuLUs7xWpf5G
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/ID8W4rxaFN8HsxqugmesLMVo
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
                  payment_instruments:
                    href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/payment_instruments
                  reversals:
                    href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/reversals
                  fees:
                    href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/fees
                  disputes:
                    href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/disputes
                  fee_profile:
                    href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
            Transfer (with Buyer Charges):
              value:
                id: AUpaSunWzKyq73A6DKyZ3g8f
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 5200
                tags:
                  test: sale
                state: SUCCEEDED
                currency: USD
                transfer: null
                messages: []
                raw: null
                created_at: '2022-08-01T19:40:17.99Z'
                updated_at: '2022-08-01T19:40:18.16Z'
                trace_id: 767f5042-49ab-48f3-b6ce-5c7c1bbe4b39
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2022-08-08T19:40:17.99Z'
                idempotency_id: null
                additional_buyer_charges:
                  convenience_amount: 100
                  rent_surcharge_amount: 200
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUpaSunWzKyq73A6DKyZ3g8f
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    TransfersList:
      description: List of Transfer objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/TransfersList'
          examples:
            List of Transfers:
              value:
                _embedded:
                  transfers:
                    - id: TRw4MuMkkAZbRJC7362mF1qY
                      amount: 123
                      tags: {}
                      state: FAILED
                      trace_id: 61f0192a-d5e3-4b96-8220-60e63fd45605
                      currency: USD
                      application: APgPDQrLD52TYvqazjHJJchM
                      source: PIdxgKpYuMX3DtnDk3Pes2JK
                      destination: null
                      ready_to_settle_at: null
                      externally_funded: UNKNOWN
                      fee: 0
                      statement_descriptor: FNX*DUNDER MIFFLIN
                      type: DEBIT
                      messages:
                        - RAW MESSAGE
                      raw: null
                      created_at: '2022-08-17T22:08:21.39Z'
                      updated_at: '2022-08-17T22:09:01.30Z'
                      idempotency_id: null
                      merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                      subtype: API
                      failure_code: GENERIC_DECLINE
                      failure_message: The card was declined for an unknown reason.
                        The cardholder needs to contact their issuer for more information.
                      additional_buyer_charges: null
                      _links:
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/payment_instruments
                        reversals:
                          href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/reversals
                        fees:
                          href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/fees
                        disputes:
                          href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/disputes
                        source:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PIdxgKpYuMX3DtnDk3Pes2JK
                        fee_profile:
                          href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                    - id: TR4MCT6kZGm5z7BeZu6HQCeq
                      amount: 13
                      tags: {}
                      state: SUCCEEDED
                      trace_id: a4a807fe-dc25-482d-8fc0-bee7535ed4b6
                      currency: USD
                      application: APgPDQrLD52TYvqazjHJJchM
                      source: null
                      destination: null
                      ready_to_settle_at: '2022-08-16T19:00:01.11Z'
                      externally_funded: 'FALSE'
                      fee: 0
                      statement_descriptor: null
                      type: FEE
                      fee_type: CARD_BASIS_POINTS
                      messages: []
                      raw: null
                      created_at: '2022-08-16T18:46:04.34Z'
                      updated_at: '2022-08-16T18:46:04.34Z'
                      idempotency_id: null
                      merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
                      subtype: PLATFORM_FEE
                      failure_code: null
                      failure_message: null
                      additional_buyer_charges: null
                      _links:
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: https://finix.sandbox-payments-api.com/transfers/TR4MCT6kZGm5z7BeZu6HQCeq
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/transfers/TR4MCT6kZGm5z7BeZu6HQCeq/payment_instruments
                        parent:
                          href: https://finix.sandbox-payments-api.com/transfers/TRi3agaoYJQoS9wFXenMRgA1
                        fee_profile:
                          href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/transfers?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/transfers?offset=21140&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
            List of Settlement Funding Transfers:
              value:
                _embedded:
                  transfers:
                    - id: TRkwxPhCf3qChKFEVGhDjr76
                      amount: 102
                      tags: {}
                      state: FAILED
                      trace_id: d4a6df17-f581-42d0-ac70-ad6770acd5c4
                      currency: USD
                      application: APgPDQrLD52TYvqazjHJJchM
                      source: null
                      destination: PIrFpayBAQcqK35HMQgRfaqD
                      ready_to_settle_at: null
                      externally_funded: UNKNOWN
                      fee: 0
                      statement_descriptor: null
                      type: CREDIT
                      messages: []
                      raw: null
                      created_at: '2022-08-12T21:46:12.97Z'
                      updated_at: '2022-08-12T21:47:06.65Z'
                      idempotency_id: null
                      merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                      subtype: SETTLEMENT_PLATFORM
                      failure_code: null
                      failure_message: null
                      additional_buyer_charges: null
                      _links:
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/payment_instruments
                        reversals:
                          href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/reversals
                        fees:
                          href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/fees
                        disputes:
                          href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/disputes
                        destination:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PIrFpayBAQcqK35HMQgRfaqD
                    - id: TRxb61dJ6PvGcvyS2L2B9SZE
                      amount: 2
                      tags: {}
                      state: SUCCEEDED
                      trace_id: e192bc39-0909-4da9-b4c2-022a84ae3984
                      currency: USD
                      application: APgPDQrLD52TYvqazjHJJchM
                      source: PIm8mdyYcEnYAZLLyw8g59Pw
                      destination: null
                      ready_to_settle_at: null
                      externally_funded: UNKNOWN
                      fee: 0
                      statement_descriptor: null
                      type: DEBIT
                      messages: []
                      raw: null
                      created_at: '2022-08-12T21:46:12.98Z'
                      updated_at: '2022-08-12T21:47:05.26Z'
                      idempotency_id: null
                      merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                      subtype: SETTLEMENT_MERCHANT
                      failure_code: null
                      failure_message: null
                      additional_buyer_charges: null
                      _links:
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/payment_instruments
                        reversals:
                          href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/reversals
                        fees:
                          href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/fees
                        disputes:
                          href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/disputes
                        source:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PIm8mdyYcEnYAZLLyw8g59Pw
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
            List of Settlement Transfers:
              value:
                _embedded:
                  transfers:
                    - id: TR8yiKY6ju988aUZhfqJFjag
                      amount: 100
                      tags: {}
                      state: SUCCEEDED
                      trace_id: 272fe816-2dd1-46ed-a7e7-9041d7a8f0ff
                      currency: USD
                      application: APgPDQrLD52TYvqazjHJJchM
                      source: null
                      destination: null
                      ready_to_settle_at: '2022-08-12T22:15:02.69Z'
                      externally_funded: 'FALSE'
                      fee: 0
                      statement_descriptor: null
                      type: FEE
                      fee_type: CARD_FIXED
                      messages: []
                      raw: null
                      created_at: '2022-08-12T16:56:01.90Z'
                      updated_at: '2022-08-12T16:56:01.90Z'
                      idempotency_id: null
                      merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
                      subtype: PLATFORM_FEE
                      failure_code: null
                      failure_message: null
                      additional_buyer_charges: null
                      _links:
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: https://finix.sandbox-payments-api.com/transfers/TR8yiKY6ju988aUZhfqJFjag
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/transfers/TR8yiKY6ju988aUZhfqJFjag/payment_instruments
                        parent:
                          href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb
                        fee_profile:
                          href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                    - id: TRm9ppvqX43CbwmNzhckf2gb
                      amount: 100
                      tags: {}
                      state: SUCCEEDED
                      trace_id: 381f1f6f-492b-4101-9a57-40001a59813a
                      currency: USD
                      application: APgPDQrLD52TYvqazjHJJchM
                      source: PIe2YvpcjvoVJ6PzoRPBK137
                      destination: null
                      ready_to_settle_at: '2022-08-12T04:00:00.00Z'
                      externally_funded: 'FALSE'
                      fee: 0
                      statement_descriptor: FNX*DUNDER MIFFLIN
                      type: DEBIT
                      messages: []
                      raw: null
                      created_at: '2022-08-12T16:55:47.66Z'
                      updated_at: '2022-08-12T16:56:02.19Z'
                      idempotency_id: null
                      merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                      subtype: API
                      failure_code: null
                      failure_message: null
                      additional_buyer_charges: null
                      _links:
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/payment_instruments
                        reversals:
                          href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/reversals
                        fees:
                          href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/fees
                        disputes:
                          href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/disputes
                        source:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
                        fee_profile:
                          href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                    - id: TRwgubpxAJWbaDZE1kKP6SSi
                      amount: 2
                      tags: {}
                      state: SUCCEEDED
                      trace_id: 5e2dbd9c-1ad1-4e36-8d16-cfedd3bce385
                      currency: USD
                      application: APgPDQrLD52TYvqazjHJJchM
                      source: null
                      destination: null
                      ready_to_settle_at: '2022-08-12T22:15:02.69Z'
                      externally_funded: 'FALSE'
                      fee: 0
                      statement_descriptor: null
                      type: FEE
                      fee_type: CARD_BASIS_POINTS
                      messages: []
                      raw: null
                      created_at: '2022-08-12T16:56:01.90Z'
                      updated_at: '2022-08-12T16:56:01.90Z'
                      idempotency_id: null
                      merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
                      subtype: PLATFORM_FEE
                      failure_code: null
                      failure_message: null
                      additional_buyer_charges: null
                      _links:
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        self:
                          href: https://finix.sandbox-payments-api.com/transfers/TRwgubpxAJWbaDZE1kKP6SSi
                        merchant_identity:
                          href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
                        payment_instruments:
                          href: https://finix.sandbox-payments-api.com/transfers/TRwgubpxAJWbaDZE1kKP6SSi/payment_instruments
                        parent:
                          href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb
                        fee_profile:
                          href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers?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'
    User:
      description: Single `User` object.
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/User'
          examples:
            ROLE_PARTNER User:
              value:
                id: USvVu9MXHz7hVzwDXwbx3UCL
                password: null
                identity: IDpYDM7J9n57q849o9E9yNrG
                enabled: true
                role: ROLE_MERCHANT
                tags: {}
                created_at: '2022-01-27T07:37:14.65Z'
                updated_at: '2022-01-27T07:37:15.47Z'
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL
                  applications:
                    href: https://finix.sandbox-payments-api.com/applications
                  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'
    UsersList:
      description: List of `User` objects.
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/UsersList'
          examples:
            List of Users:
              value:
                _embedded:
                  users:
                    - id: USweC2ufdBEYxpvPuF3G3LUE
                      password: null
                      identity: ID5UsJr9TVJd6cqAA4CCBc9T
                      enabled: true
                      role: ROLE_PARTNER
                      tags: {}
                      created_at: '2021-10-04T17:46:08.78Z'
                      updated_at: '2021-10-04T17:46:09.44Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/users/USweC2ufdBEYxpvPuF3G3LUE
                        applications:
                          href: https://finix.sandbox-payments-api.com/applications
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
                    - id: USwybTufQYV51Nhbr4qf9qcM
                      password: null
                      identity: ID5UsJr9TVJd6cqAA4CCBc9T
                      enabled: true
                      role: ROLE_PARTNER
                      tags: {}
                      created_at: '2021-10-04T17:46:13.13Z'
                      updated_at: '2021-10-04T17:46:13.13Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/users/USwybTufQYV51Nhbr4qf9qcM
                        applications:
                          href: https://finix.sandbox-payments-api.com/applications
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
                    - id: USNQbJQhBkoH59pYgfrUN2u
                      password: null
                      identity: ID6tqssazVPSSzEuVCBjQsoL
                      enabled: true
                      role: ROLE_MERCHANT
                      tags: {}
                      created_at: '2021-10-04T17:46:38.46Z'
                      updated_at: '2021-10-04T17:46:39.04Z'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/users/USNQbJQhBkoH59pYgfrUN2u
                        applications:
                          href: https://finix.sandbox-payments-api.com/applications
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
                _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: 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'
    Verification:
      description: Single Verification object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Verification'
          examples:
            Verification:
              value:
                id: VIioiAQWmoT6b6p6mqSggKvA
                application: APgPDQrLD52TYvqazjHJJchM
                tags:
                  key_2: value_2
                messages: []
                raw: RawDummyMerchantUnderwriteResult
                processor: DUMMY_V1
                state: SUCCEEDED
                created_at: '2022-08-17T20:33:34.25Z'
                updated_at: '2022-08-17T20:34:01.49Z'
                trace_id: 31740c79-7e23-4301-bfa1-fb4f0950b9e4
                payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY
                merchant: MUmUL7aBsHkxVLQawJxEXw6N
                identity: null
                merchant_identity: IDrH4G2VTfNjn1VFkvhcyMYj
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/verifications/VIbXwBuccEcqw7rfZneELCv4
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDnDkihVYnsnsuAJDGG7im9t
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    VerificationsList:
      description: List of Verification objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/VerificationsList'
          examples:
            Merchant Verification:
              value:
                _embedded:
                  verifications:
                    - id: VInHzhoRAnAizVU7jcj2K6bX
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags: {}
                      messages: []
                      raw: RawDummyMerchantUnderwriteResult
                      processor: DUMMY_V1
                      state: SUCCEEDED
                      created_at: '2022-08-15T23:12:56.40Z'
                      updated_at: '2022-08-15T23:12:56.85Z'
                      trace_id: 1c8fb49d-6f1c-40a0-8646-1bcb88047583
                      payment_instrument: null
                      merchant: MUpaGK5dUb2Sb7aGuXhFRNbj
                      identity: null
                      merchant_identity: IDgahPGJ6hangmVJwrMRyZzr
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/verifications/VInHzhoRAnAizVU7jcj2K6bX
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        merchant:
                          href: https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj
                    - id: VIdS8qSW3kZbnK9AsFHJZ81U
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        key: value_2
                      messages: []
                      raw: RawDummyMerchantUnderwriteResult
                      processor: DUMMY_V1
                      state: SUCCEEDED
                      created_at: '2022-08-15T23:12:54.32Z'
                      updated_at: '2022-08-15T23:12:54.65Z'
                      trace_id: 4d12cbe6-032d-4e9d-8291-ce16f4add412
                      payment_instrument: null
                      merchant: MUpaGK5dUb2Sb7aGuXhFRNbj
                      identity: null
                      merchant_identity: IDgahPGJ6hangmVJwrMRyZzr
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/verifications/VIdS8qSW3kZbnK9AsFHJZ81U
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        merchant:
                          href: https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
            Payment Instrument Verification:
              value:
                _embedded:
                  verifications:
                    - id: VIixxYGRVewLFa3GqSzqKPbw
                      application: AP83dL8NE1Q7KfQo9onGg76M
                      tags: {}
                      messages: []
                      raw:
                        validation_details:
                          systems_trace_audit_number: '203518208518'
                          error_result: null
                          transaction_identifier: '287371129315250'
                          approval_code: null
                          action_code: '25'
                          response_code: '5'
                          address_verification_results: I
                          cvv2_result_code: P
                        inquiry_details:
                          systems_trace_audit_number: '203518208518'
                          error_result: null
                          visa_network_info:
                            - card_type_code: D
                              billing_currency_code: 840
                              billing_currency_minor_digits: 2
                              issuer_name: Visa Test Bank
                              card_issuer_country_code: 840
                              fast_funds_indicator: D
                              push_funds_block_indicator: C
                              online_gambing_block_indicator: N
                          ppgs_network_info: []
                      processor: VISA_V1
                      state: SUCCEEDED
                      created_at: '2022-02-04T18:33:14.50Z'
                      updated_at: '2022-02-04T18:33:15.69Z'
                      trace_id: '203518208518'
                      payment_instrument: PImc5nvdnp15atLxEBAGtxJs
                      merchant: null
                      identity: null
                      merchant_identity: null
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/verifications/VIixxYGRVewLFa3GqSzqKPbw
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/AP83dL8NE1Q7KfQo9onGg76M
                        payment_instrument:
                          href: https://finix.sandbox-payments-api.com/payment_instruments/PImc5nvdnp15atLxEBAGtxJs
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/payment_instruments/PImc5nvdnp15atLxEBAGtxJs/verifications/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 1
      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/hal+json:
          schema:
            $ref: '#/components/schemas/Webhook'
          examples:
            Webhook:
              value:
                id: WHN6HuqRqTV3mDCxoFLrRvP
                url: https://example.com
                application: APgPDQrLD52TYvqazjHJJchM
                enabled: false
                authentication:
                  type: NONE
                enabled_events: []
                created_at: '2022-08-15T21:41:30.94Z'
                updated_at: '2022-08-15T21:41:31.01Z'
                _links:
                  self:
                    href: http://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP
                  application:
                    href: http://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'
    WebhooksList:
      description: List of Webhook objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/WebhooksList'
          examples:
            List of Webhooks:
              value:
                _embedded:
                  webhooks:
                    - id: WHdocT8FUQGu73LqByAQ8qyT
                      url: https://webhook.site/dc0ac9f4-a423-4797-a4dc-3acecb39414e
                      application: APgPDQrLD52TYvqazjHJJchM
                      enabled: true
                      authentication:
                        type: NONE
                      enabled_events: []
                      created_at: '2022-08-17T16:33:57.71Z'
                      updated_at: '2022-08-17T16:33:57.71Z'
                      _links:
                        self:
                          href: http://finix.sandbox-payments-api.com/webhooks/WHdocT8FUQGu73LqByAQ8qyT
                        application:
                          href: http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                    - id: WHN6HuqRqTV3mDCxoFLrRvP
                      url: https://example.com
                      application: APgPDQrLD52TYvqazjHJJchM
                      enabled: false
                      authentication:
                        type: NONE
                      enabled_events: []
                      created_at: '2022-08-15T21:41:30.94Z'
                      updated_at: '2022-08-15T21:41:31.01Z'
                      _links:
                        self:
                          href: http://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP
                        application:
                          href: http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                _links:
                  self:
                    href: http://finix.sandbox-payments-api.com/notification/webhooks?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: http://finix.sandbox-payments-api.com/notification/webhooks?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: http://finix.sandbox-payments-api.com/notification/webhooks?offset=1180&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 1197
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    SubscriptionEnrollment:
      description: Single subscription_enrollment resource
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/SubscriptionEnrollment'
          examples:
            Subscription Enrollment:
              value:
                id: SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ
                created_at: '2022-02-02T01:47:08.07Z'
                updated_at: '2022-02-02T01:47:08.07Z'
                created_by: USimz3zSq5R2PqiEBXY6rSiJ
                ended_at: null
                merchant: MU7AxBA6MkF7Tee8veith3nG
                nickname: Security Fee
                started_at: '2022-11-11T16:50:59.89Z'
                subscription_schedule: SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv
                tags:
                  enrollment_info: Security Fee Enrollment
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ
                  merchant:
                    href: https://finix.sandbox-payments-api.com/merchants/MU7AxBA6MkF7Tee8veith3nG
                  schedule:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv
                  amounts:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv/subscription_amounts
    SubscriptionEnrollmentsList:
      description: List of subscription_enrollment objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/SubscriptionEnrollmentList'
          examples:
            List of Subscription Enrollments:
              value:
                _embedded:
                  subscription_enrollments:
                    - id: SUBENROLLMENT_sJdhvD6x91qENUvnr2otgp
                      created_at: '2022-06-08T22:39:24.00Z'
                      updated_at: '2022-06-08T22:39:24.00Z'
                      created_by: USka4562gALVJRD471ddEmPc
                      ended_at: null
                      merchant: MUiysjyBGpiZEZYkzj7d5DhM
                      nickname: Vitameatavegamin Monthly
                      started_at: '2022-07-07T07:00:00.00Z'
                      subscription_schedule: SUBSCHEDULE_5GDvqCTAd6SrmWdsx4dUKx
                      tags: {}
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_sJdhvD6x91qENUvnr2otgp
                        merchant:
                          href: https://finix.sandbox-payments-api.com/merchants/MUiysjyBGpiZEZYkzj7d5DhM
                        schedule:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5GDvqCTAd6SrmWdsx4dUKx
                        amounts:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5GDvqCTAd6SrmWdsx4dUKx/subscription_amounts
                    - id: SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ
                      created_at: '2022-02-02T01:47:08.07Z'
                      updated_at: '2022-02-02T01:47:08.07Z'
                      created_by: USimz3zSq5R2PqiEBXY6rSiJ
                      ended_at: null
                      merchant: MU7AxBA6MkF7Tee8veith3nG
                      nickname: Security Fee
                      started_at: '2022-11-11T16:50:59.89Z'
                      subscription_schedule: SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv
                      tags:
                        enrollment_info: Security Fee Enrollment
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ
                        merchant:
                          href: https://finix.sandbox-payments-api.com/merchants/MU7AxBA6MkF7Tee8veith3nG
                        schedule:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv
                        amounts:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv/subscription_amounts
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=840&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
    SubscriptionAmount:
      description: Single subscription_amount object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/SubscriptionAmount'
          examples:
            Subscription Amount:
              value:
                id: SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN
                created_at: '2022-06-24T17:15:10.68Z'
                updated_at: '2022-06-24T17:15:10.68Z'
                amount_type: FEE
                created_by: UStxEci4vXxGDWLQhNvao7YY
                fee_amount_data:
                  amount: 2500
                  currency: USD
                  label: POS_INSTALLMENT_FEE
                nickname: POS_INSTALLMENT_FEE
                subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
                tags: {}
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN
                  schedule:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
    SubscriptionAmountsList:
      description: List of subscription_amount objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/SubscriptionAmountList'
          examples:
            List of Subscription Amounts:
              value:
                _embedded:
                  subscription_amounts:
                    - id: SUBAMOUNT_cTJQifghT2FLRR7ttJapXH
                      created_at: '2022-08-01T18:04:24.52Z'
                      updated_at: '2022-08-01T18:04:24.52Z'
                      amount_type: FEE
                      created_by: UStxEci4vXxGDWLQhNvao7YY
                      fee_amount_data:
                        amount: 2500
                        currency: USD
                        label: POS_INSTALLMENT_FEE
                      nickname: NEW_POS_INSTALLMENT_FEE
                      subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
                      tags: {}
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_cTJQifghT2FLRR7ttJapXH
                        schedule:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
                    - id: SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN
                      created_at: '2022-06-24T17:15:10.68Z'
                      updated_at: '2022-06-24T17:15:10.68Z'
                      amount_type: FEE
                      created_by: UStxEci4vXxGDWLQhNvao7YY
                      fee_amount_data:
                        amount: 2500
                        currency: USD
                        label: POS_INSTALLMENT_FEE
                      nickname: POS_INSTALLMENT_FEE
                      subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
                      tags: {}
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN
                        schedule:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
    SubscriptionSchedule:
      description: Example response
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/SubscriptionSchedule'
          examples:
            Subscription Schedule (FIXED_TIME_INTERVAL):
              value:
                id: SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV
                created_at: '2022-08-01T17:53:54.63Z'
                updated_at: '2022-08-01T17:53:54.63Z'
                created_by: UStxEci4vXxGDWLQhNvao7YY
                fixed_time_interval_offset:
                  hourly_interval: 24
                  interval_count: 4
                line_item_type: FEE
                nickname: Fixed_Time_Subscription_Schedule
                period_offset: null
                subscription_type: FIXED_TIME_INTERVAL
                tags: {}
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV
                  amounts:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV/subscription_amounts
            Subscription Schedule (PERIODIC_MONTHLY):
              value:
                id: SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8
                created_at: '2022-01-27T07:44:06.18Z'
                updated_at: '2022-01-27T07:44:06.18Z'
                created_by: UStxEci4vXxGDWLQhNvao7YY
                fixed_time_interval_offset: null
                line_item_type: FEE
                nickname: Monthly_Subscription_Schedule
                period_offset:
                  day: 1
                  month: null
                subscription_type: PERIODIC_MONTHLY
                tags: {}
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8
                  amounts:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8/subscription_amounts
            Subscription Schedule (PERIODIC_YEARLY):
              value:
                id: SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru
                created_at: '2022-01-27T07:44:05.81Z'
                updated_at: '2022-01-27T07:44:05.81Z'
                created_by: UStxEci4vXxGDWLQhNvao7YY
                fixed_time_interval_offset: null
                line_item_type: FEE
                nickname: Yearly_Subscription_Schedule
                period_offset:
                  day: 5
                  month: 1
                subscription_type: PERIODIC_YEARLY
                tags: {}
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru
                  amounts:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru/subscription_amounts
    SubscriptionSchedulesList:
      description: List of subscription_schedule objects
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/SubscriptionSchedulesList'
          examples:
            List Subscription Schedules:
              value:
                _embedded:
                  subscription_schedules:
                    - id: SUBSCHEDULE_kfpANfUXxHyW2YBayXD39N
                      created_at: '2022-08-17T04:54:00.31Z'
                      updated_at: '2022-08-17T04:54:00.31Z'
                      created_by: UStxEci4vXxGDWLQhNvao7YY
                      fixed_time_interval_offset:
                        hourly_interval: 24
                        interval_count: 4
                      line_item_type: FEE
                      nickname: Fixed_Time_Subscription_Schedule
                      period_offset: null
                      subscription_type: FIXED_TIME_INTERVAL
                      tags: {}
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kfpANfUXxHyW2YBayXD39N
                        amounts:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kfpANfUXxHyW2YBayXD39N/subscription_amounts
                    - id: SUBSCHEDULE_rhbHGjhydMxsEXw4otBCFz
                      created_at: '2022-07-11T18:39:30.21Z'
                      updated_at: '2022-07-11T18:39:30.21Z'
                      created_by: UStxEci4vXxGDWLQhNvao7YY
                      fixed_time_interval_offset:
                        hourly_interval: 24
                        interval_count: 4
                      line_item_type: FEE
                      nickname: Fixed_Time_Subscription_Schedule
                      period_offset: null
                      subscription_type: FIXED_TIME_INTERVAL
                      tags: {}
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_rhbHGjhydMxsEXw4otBCFz
                        amounts:
                          href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_rhbHGjhydMxsEXw4otBCFz/subscription_amounts
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/?offset=60&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
    BalanceTransfer:
      description: Single balance_transfer object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/BalanceTransfer'
          examples:
            Balance Transfer:
              value:
                id: BT_9SLA5BdQs6Z3xFpmjUoqhM
                created_at: '2022-08-18T06:37:50.67Z'
                updated_at: '2022-08-18T06:37:51.09Z'
                amount: 101
                currency: USD
                description: setup balance transfer for testing
                destination: OPERATING_ACCOUNT
                external_reference_id: '84077657260162531'
                processor_type: LITLE_V1
                reference_id: FNX5ZJEGdPT5odwtRrvxVrYUn
                source: FOR_BENEFIT_OF_ACCOUNT
                state: SUCCEEDED
                tags:
                  test_key_101: test_val_101
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/balance_transfers/BT_9SLA5BdQs6Z3xFpmjUoqhM
      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/hal+json:
          schema:
            $ref: '#/components/schemas/BalanceTransferList'
          examples:
            List of Balance Transfers:
              value:
                _embedded:
                  devices:
                    - id: DVtQV22Ezh7TAYazXFxYFHpb
                      merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                      name: 'Finix  triPOS #1'
                      model: MX915
                      description: Mike Jones
                      serial_number: null
                      idle_message: null
                      enabled: true
                      tags: {}
                      created_at: '2022-08-15T20:22:26.339930Z'
                      updated_at: '2022-08-15T20:22:26.339930Z'
                      configuration_details: null
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/devices/DVtQV22Ezh7TAYazXFxYFHpb
                        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
                    - id: DVmcB1MTxnebU3VoqnfuatS7
                      merchant: MUu56ZGx3Xb6U9gAqKfgNisd
                      name: 'Finix  triPOS #1'
                      model: MX915
                      description: Mike Jones
                      serial_number: null
                      idle_message: null
                      enabled: true
                      tags: {}
                      created_at: '2022-08-15T18:47:55.354154Z'
                      updated_at: '2022-08-15T18:47:55.354154Z'
                      configuration_details: null
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/devices/DVmcB1MTxnebU3VoqnfuatS7
                        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: https://finix.sandbox-payments-api.com/devices/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                  next:
                    href: https://finix.sandbox-payments-api.com/devices/?offset=20&limit=20&sort=created_at,desc&sort=id,desc
                  last:
                    href: https://finix.sandbox-payments-api.com/devices/?offset=8100&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 2
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    InstrumentUpdate:
      description: Single instrument_update object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/InstrumentUpdate'
          examples:
            Instrument Updates:
              value:
                id: IUp9oSWhWUF31DPrJ8CojQeQ
                created_at: '2020-12-02T03:44:42.77Z'
                updated_at: '2020-12-02T03:44:42.81Z'
                idempotency_id: F2022-08-12 15:05:19.211366
                merchant: MUvQQt3RKe7FBZ6j9eMYoo3H
                state: PENDING
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/payment_intrument_updates/IUp9oSWhWUF31DPrJ8CojQeQ
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    File:
      description: Single File object
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/File'
          examples:
            File (Created):
              value:
                id: FILE_abki8bFEjq51eZ5w2pYFik
                status: REQUIRES_UPLOAD
                created_at: '2022-08-16T18:50:25.770825Z'
                updated_at: '2022-08-16T18:50:25.807321Z'
                linked_type: MERCHANT
                linked_to: MU2n7BSovtwYsWYZF6rBnnzk
                extension: null
                display_name: license_file
                type: DRIVERS_LICENSE_FRONT
                platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
                application_id: APgPDQrLD52TYvqazjHJJchM
                tags:
                  test_key_100: test_val_100
                identity_id: null
            File (Uploading):
              value:
                id: FILE_abki8bFEjq51eZ5w2pYFik
                status: PENDING
                created_at: '2022-08-16T18:50:25.770825Z'
                updated_at: '2022-08-16T18:50:25.807321Z'
                linked_type: MERCHANT
                linked_to: MU2n7BSovtwYsWYZF6rBnnzk
                extension: png
                display_name: license_file
                type: DRIVERS_LICENSE_FRONT
                platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
                application_id: APgPDQrLD52TYvqazjHJJchM
                tags:
                  test_key_100: test_val_100
                identity_id: null
            File (Uploaded):
              value:
                id: FILE_abki8bFEjq51eZ5w2pYFik
                status: UPLOADED
                created_at: '2022-08-16T18:50:25.770825Z'
                updated_at: '2022-08-16T18:50:25.807321Z'
                linked_type: MERCHANT
                linked_to: MU2n7BSovtwYsWYZF6rBnnzk
                extension: png
                display_name: license_file
                type: DRIVERS_LICENSE_FRONT
                platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
                application_id: APgPDQrLD52TYvqazjHJJchM
                tags:
                  test_key_100: test_val_100
                identity_id: 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'
    FilesList:
      description: List of File objects
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/FilesList'
          examples:
            List of Files:
              value:
                _embedded:
                  files:
                    - id: FILE_aBDz8kr36yeuwmVvgn9VU9
                      status: UPLOADED
                      created_at: '2022-08-18T06:38:00.719761Z'
                      updated_at: '2022-08-18T06:38:52.223894Z'
                      linked_type: MERCHANT
                      linked_to: MU2n7BSovtwYsWYZF6rBnnzk
                      extension: png
                      display_name: pytest_file
                      type: DRIVERS_LICENSE_FRONT
                      platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
                      application_id: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        test_key_100: test_val_100
                      identity_id: null
                    - id: FILE_abki8bFEjq51eZ5w2pYFik
                      status: REQUIRES_UPLOAD
                      created_at: '2022-08-16T18:50:25.770825Z'
                      updated_at: '2022-08-16T18:50:25.807321Z'
                      linked_type: MERCHANT
                      linked_to: MU2n7BSovtwYsWYZF6rBnnzk
                      extension: null
                      display_name: pytest_file
                      type: DRIVERS_LICENSE_FRONT
                      platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
                      application_id: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        test_key_100: test_val_100
                      identity_id: null
                page:
                  limit: 10
                  next_cursor: FILE_abki8bFEjq51eZ5w2pYFik
      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/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ExternalLink'
          examples:
            External Link:
              value:
                id: EL_dh5YS66GePpkeSVyL4VdBL
                created_at: '2022-03-22T01:07:05.074313Z'
                url: https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIACy1Tl%2BahJzC4xuMTzdUk%2BdDsFeivMG1EUNFHJKqEImAiAm%2FlrPiF1gybEdzgjEqUoftwBL2qxaMtkitWG8UxKUayr6AwghEAIaDDM3NTYzNTU3MDA3MCIM%2BY%2BRbP5bgBMV0WafKtcD7z6X%2FLEz0mkHWYo45w8MZsJRox%2BS8gvWW0ufEcmC9OcA9%2BZSfBdPb4DstQulQZA5OKJ1I2mkqo5zKGcjhQ8uVzhKCEHfdnEB3Tm06ZY4L8sF9WyOV%2FTFbAQ0JzBQw6KPM0ubC0xaNIOnDXvfdzqt7nDLx6vC7Jxo%2FnIrmD37wkFeshib5YDtuU%2F6bBmPQqXU3PgmUODfWDfNj5Bqy6JhK5dqF0S0%2F09ny86v7jNZX%2BaNHc%2FV21mYUHYNSuwyJJLoeVC001dKebzxkXkfTbrKGAxaXz%2F3gVBX4OPwrwKR1nYxly4BtRay7vF8fWIPoJdHhdxiXEHYTNyJA%2FZbeHAjXlvVvvPximI73GzPYWxDj8K7ns%2BrshCRZboISSP0okwp%2FdgMPSa%2B73Z2pUbWdZILKvblgSRitDoL1baXQLd0S22EOHQS%2FXMLIB3wMPnY5ysuMNB%2FCjGLGO%2B1%2BxldCdzMeLIXacqkDG%2BiWxQV%2FPYTzMJor%2FcjvTbTaHI8IY1OKC17Q8Cms06VF9k8%2B1En5E0qSVJDxMRZy0Hdu8BVN%2FEpZvgLlNvLFkV%2FalCjmN4OHT5AOq%2Fb6V9Am%2FbXa7Eu8Z7%2BDiwv2OGz06UwsyRSb0G5iVx57EMAz0WGMMef5JEGOqYBsiwfoTFGtG9%2Ff2ib21I0VadcpBmX90lkty7tLS8VXaDOZFY3b5KZB%2FBWvkKym2YouCgSJTuxO6P2X15NRIm2tY4v7WhsOWQONcOONhuZCsU60fvEsVJnHV46IXGRAov%2BFHqMeOChYxUHoBaDA7UEG2yoXQdeMvk89c8m47fFFKzQq5jwlL5RTC1xgL1MdUespA32Bw5oalBq6bNAPrWI7yN67T75Ng%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220322T010705Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLPYNTLOHA%2F20220322%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=1172b039bd7e807c8c111280e3af1bb289cc70560519793a5749d60ab9e57971
                type: UPLOAD
                expires_at: '2022-03-22T01:22:05.070415Z'
                user_id: USsRhsHYZGBPnQw8CByJyEQW
                file_id: FILE_bJecqoRPasStEPVpvKHtgA
                duration: null
                tags: {}
                expired: true
    ExternalLinksList:
      description: List of external_link objects
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ExternalLinksList'
          examples:
            List of External Links:
              value:
                _embedded:
                  external_links:
                    - id: EL_sVv61JP93htzDFTtNhbsdd
                      created_at: '2022-05-24T06:50:51.94704Z'
                      url: https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEIb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQCRwhQF2A0kHmtOUShU8uI2g1JRbA0fxx%2Bkl5IGtZ6ygwIhAPSKP6KEEHYHhMqD54bqT%2Fzb495zGacrdZBEcGciNfZaKtMECHAQAhoMMzc1NjM1NTcwMDcwIgyA5j6IswvJUsAaiAoqsASHRDILId%2BbaQZiUOu29lOE9FmgXlw8uxpV3IiLMWmn2l4Iq8rTdANxXRVCM%2BWrT53DiBACQrUOSrmokWHfJ0DiizxD%2Fky06kDSbiVrD%2BK9DckqiBlg84N%2F7JKqyNeQUJKrUHtDKoH%2BSM%2FYNTgur%2BaGR07as8NG8qnhO8sJela5yWugYJjw4iJoZp%2BmOn%2BVL0Ry9OjEcoKxXCBDJF8W1ppa%2BRa1zfwpufJGWZYYZUiv31pVleRuCDyVef4p8MejnzRiEHFE4TNgcPYZW%2F97KRjQ9OYWbh7ygDuki9ejVdMICywCHEGLEtP%2Fr5EIU1IjWJUt6pwkjud2hHJ18f8j5U5j%2FFQF7wiTl3FlqqnXrLSHJaVA6fyJWbCTcfR%2B3Hr%2FbTSZWZWctXHO%2ByBYR1D9z9KhD%2FwaO87k0KRBRSggiMjVsgILguTdOeggcg3XyfUg2zRj6GPQF7HfBN%2FtGYoTO7l2IR6NBB7FBiusXzJMQd7IFC8fW%2BbiFlFmZk0IlGIUJcB2cetDEGL3k7McHOx9P7ywsy0f7wGdMTS01JgSOAt9Ic0nlljKj0dItwz1f%2FCIcm1%2FWvCZ2W6g0PbtM9dDEL04j3rIBm7spqqtx8KIj2hZs3cEkp8yr%2Bx%2B%2BZRXbMUnT7zNsEGShQGDVwxKP1sA834ZhF9KkC0RdRZFqvgXnC7Sk02tqSGVIUTzcymCl2jYfgiBfolPVW7cwEoIPOv%2FNEp%2BEHWZ7eJMP%2BiAnyMnXDkaGTCL97GUBjqoAQS5iN2Njmu0X6N5249v6JJ3HaoDqIE3p3A6IjwMK%2Byyx81LLYDkZTLVjo2t9DzPLjUy5TiTGd0mNt0Gp5fJ4vo4V5T2BnRWLTxS3tCrG69lTVWBEZfg9NniNhRwRsRrwW%2B%2BeJGIdt7E7CSciDB6fknhtALrh%2FtNKgqF4ofP8QxZedsz9FICsjt1On3r1BUqBLM9gZKdDvapil9PWDJeiRr24dbivHZfYg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220524T065051Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLGNOGWHOG%2F20220524%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=8d360d38a6752dba12fbebb2a83ad5c129b5fc475bf323f169fa826c6bca1b68
                      type: UPLOAD
                      expires_at: '2022-05-24T07:05:51.934426Z'
                      user_id: USsRhsHYZGBPnQw8CByJyEQW
                      file_id: FILE_bJecqoRPasStEPVpvKHtgA
                      duration: null
                      tags: {}
                      expired: true
                    - id: EL_dh5YS66GePpkeSVyL4VdBL
                      created_at: '2022-03-22T01:07:05.074313Z'
                      url: https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIACy1Tl%2BahJzC4xuMTzdUk%2BdDsFeivMG1EUNFHJKqEImAiAm%2FlrPiF1gybEdzgjEqUoftwBL2qxaMtkitWG8UxKUayr6AwghEAIaDDM3NTYzNTU3MDA3MCIM%2BY%2BRbP5bgBMV0WafKtcD7z6X%2FLEz0mkHWYo45w8MZsJRox%2BS8gvWW0ufEcmC9OcA9%2BZSfBdPb4DstQulQZA5OKJ1I2mkqo5zKGcjhQ8uVzhKCEHfdnEB3Tm06ZY4L8sF9WyOV%2FTFbAQ0JzBQw6KPM0ubC0xaNIOnDXvfdzqt7nDLx6vC7Jxo%2FnIrmD37wkFeshib5YDtuU%2F6bBmPQqXU3PgmUODfWDfNj5Bqy6JhK5dqF0S0%2F09ny86v7jNZX%2BaNHc%2FV21mYUHYNSuwyJJLoeVC001dKebzxkXkfTbrKGAxaXz%2F3gVBX4OPwrwKR1nYxly4BtRay7vF8fWIPoJdHhdxiXEHYTNyJA%2FZbeHAjXlvVvvPximI73GzPYWxDj8K7ns%2BrshCRZboISSP0okwp%2FdgMPSa%2B73Z2pUbWdZILKvblgSRitDoL1baXQLd0S22EOHQS%2FXMLIB3wMPnY5ysuMNB%2FCjGLGO%2B1%2BxldCdzMeLIXacqkDG%2BiWxQV%2FPYTzMJor%2FcjvTbTaHI8IY1OKC17Q8Cms06VF9k8%2B1En5E0qSVJDxMRZy0Hdu8BVN%2FEpZvgLlNvLFkV%2FalCjmN4OHT5AOq%2Fb6V9Am%2FbXa7Eu8Z7%2BDiwv2OGz06UwsyRSb0G5iVx57EMAz0WGMMef5JEGOqYBsiwfoTFGtG9%2Ff2ib21I0VadcpBmX90lkty7tLS8VXaDOZFY3b5KZB%2FBWvkKym2YouCgSJTuxO6P2X15NRIm2tY4v7WhsOWQONcOONhuZCsU60fvEsVJnHV46IXGRAov%2BFHqMeOChYxUHoBaDA7UEG2yoXQdeMvk89c8m47fFFKzQq5jwlL5RTC1xgL1MdUespA32Bw5oalBq6bNAPrWI7yN67T75Ng%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220322T010705Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLPYNTLOHA%2F20220322%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=1172b039bd7e807c8c111280e3af1bb289cc70560519793a5749d60ab9e57971
                      type: UPLOAD
                      expires_at: '2022-03-22T01:22:05.070415Z'
                      user_id: USsRhsHYZGBPnQw8CByJyEQW
                      file_id: FILE_bJecqoRPasStEPVpvKHtgA
                      duration: null
                      tags: {}
                      expired: true
                page:
                  limit: 10
                  next_cursor: EL_dh5YS66GePpkeSVyL4VdBL
    MerchantUpdated:
      description: Single Merchant object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/Merchant'
          examples:
            Merchant Name Updated:
              value:
                id: MUucec6fHeaWo3VHYoSkUySM
                application: APgPDQrLD52TYvqazjHJJchM
                identity: IDpYDM7J9n57q849o9E9yNrG
                verification: VIdikDHXv7x8nWyJg8JZemGx
                merchant_profile: MPzW2oRPtkLxK3fymcMACFi
                processor: DUMMY_V1
                processing_enabled: true
                settlement_enabled: true
                gross_settlement_enabled: false
                creating_transfer_from_report_enabled: true
                card_expiration_date_required: true
                card_cvv_required: false
                tags:
                  key_2: value_2
                mcc: '0742'
                mid: FNX7CwmebftudY7i5mA4qF6XT
                merchant_name: Finix Flowers
                settlement_funding_identifier: UNSET
                ready_to_settle_upon: RECONCILIATION
                fee_ready_to_settle_upon: RECONCILIATION
                level_two_level_three_data_enabled: false
                created_at: '2022-01-27T07:36:58.19Z'
                updated_at: '2022-01-27T07:36:58.46Z'
                onboarding_state: APPROVED
                processor_details:
                  mid: FNX7CwmebftudY7i5mA4qF6XT
                  api_key: secretValue
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
                  verifications:
                    href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM/verifications
                  merchant_profile:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles/MPzW2oRPtkLxK3fymcMACFi
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  verification:
                    href: https://finix.sandbox-payments-api.com/verifications/VIdikDHXv7x8nWyJg8JZemGx
            Merchant Updated to Enable Level 2/Level 3 Processing:
              value:
                id: MUeDVrf2ahuKc9Eg5TeZugvs
                application: APgPDQrLD52TYvqazjHJJchM
                identity: IDuqZpDw28f2KK6YuDk4jNLg
                verification: VI5DBvVQ3ye5PcnUCSSvj84d
                merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
                processor: DUMMY_V1
                processing_enabled: true
                settlement_enabled: true
                gross_settlement_enabled: false
                creating_transfer_from_report_enabled: true
                card_expiration_date_required: true
                card_cvv_required: false
                tags:
                  key_2: value_2
                mcc: '0742'
                mid: FNXw5a7pBKHsCSgCAyQvU2soL
                merchant_name: Finxi Flowers
                settlement_funding_identifier: UNSET
                ready_to_settle_upon: SUCCESSFUL_CAPTURE
                fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
                level_two_level_three_data_enabled: true
                created_at: '2022-01-27T07:37:04.03Z'
                updated_at: '2022-01-27T07:37:06.12Z'
                onboarding_state: APPROVED
                processor_details:
                  mid: FNXw5a7pBKHsCSgCAyQvU2soL
                  api_key: secretValue
                convenience_charges_enabled: true
                rent_surcharges_enabled: true
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                  verifications:
                    href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs/verifications
                  merchant_profile:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles/MP7tbAZ1RpjFycrfBVo6z4Ky
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  verification:
                    href: https://finix.sandbox-payments-api.com/verifications/VI5DBvVQ3ye5PcnUCSSvj84d
            Merchant Updated to Enable Buyer Charges:
              value:
                id: MUeDVrf2ahuKc9Eg5TeZugvs
                application: APgPDQrLD52TYvqazjHJJchM
                identity: IDuqZpDw28f2KK6YuDk4jNLg
                verification: VI5DBvVQ3ye5PcnUCSSvj84d
                merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
                processor: DUMMY_V1
                processing_enabled: true
                settlement_enabled: true
                gross_settlement_enabled: false
                creating_transfer_from_report_enabled: true
                card_expiration_date_required: true
                card_cvv_required: false
                tags:
                  key_2: value_2
                mcc: '0742'
                mid: FNXw5a7pBKHsCSgCAyQvU2soL
                merchant_name: Finix Flowers
                settlement_funding_identifier: UNSET
                ready_to_settle_upon: SUCCESSFUL_CAPTURE
                fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
                level_two_level_three_data_enabled: true
                created_at: '2022-01-27T07:37:04.03Z'
                updated_at: '2022-01-27T07:37:06.12Z'
                onboarding_state: APPROVED
                processor_details:
                  mid: FNXw5a7pBKHsCSgCAyQvU2soL
                  api_key: secretValue
                convenience_charges_enabled: true
                rent_surcharges_enabled: true
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
                  verifications:
                    href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs/verifications
                  merchant_profile:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles/MP7tbAZ1RpjFycrfBVo6z4Ky
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  verification:
                    href: https://finix.sandbox-payments-api.com/verifications/VI5DBvVQ3ye5PcnUCSSvj84d
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    ApplePaySession:
      description: Single apple_pay_session object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ApplePaySession'
          examples:
            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:
        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/hal+json:
          schema:
            $ref: '#/components/schemas/AdjustmentTransfersList'
          examples:
            List of Adjustment Transfers in a Dispute:
              value:
                _embedded:
                  disputes:
                    - id: DIb72obRhTmPdMG1VxDKFLrb
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        test: sale
                      amount: 888888
                      state: PENDING
                      transfer: TRkhvS4GfMKxaHyBBdkPSx6g
                      reason: FRAUD
                      message: null
                      action: null
                      identity: IDuqZpDw28f2KK6YuDk4jNLg
                      created_at: '2022-07-14T19:40:06.52Z'
                      updated_at: '2022-07-14T19:40:06.11Z'
                      occurred_at: '2022-07-14T19:39:00.77Z'
                      respond_by: '2022-07-21T19:40:06.51Z'
                      dispute_details:
                        arn: '123'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        transfer:
                          href: https://finix.sandbox-payments-api.com/transfers/TRkhvS4GfMKxaHyBBdkPSx6g
                        evidence:
                          href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/evidence
                        adjustment_transfers:
                          href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/adjustment_transfers
                    - id: DIuk8T4ayQdmxewz8EDLHe49
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        order_number: 21DFASJSAKAS
                      amount: 888888
                      state: PENDING
                      transfer: TR27JnLR2pKDXjVVcGBKrjwU
                      reason: FRAUD
                      message: null
                      action: null
                      identity: IDpYDM7J9n57q849o9E9yNrG
                      created_at: '2022-06-15T16:14:03.95Z'
                      updated_at: '2022-06-15T16:14:03.64Z'
                      occurred_at: '2022-06-15T16:13:04.09Z'
                      respond_by: '2022-06-22T16:14:03.94Z'
                      dispute_details:
                        arn: '123'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        transfer:
                          href: https://finix.sandbox-payments-api.com/transfers/TR27JnLR2pKDXjVVcGBKrjwU
                        evidence:
                          href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/evidence
                        adjustment_transfers:
                          href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/adjustment_transfers
                    - id: DIs7yQRkHDdMYhurzYz72SFk
                      application: APgPDQrLD52TYvqazjHJJchM
                      tags:
                        order_number: 21DFASJSAKAS
                      amount: 888888
                      state: PENDING
                      transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
                      reason: FRAUD
                      message: null
                      action: null
                      identity: IDpYDM7J9n57q849o9E9yNrG
                      created_at: '2022-01-27T07:43:03.74Z'
                      updated_at: '2022-01-27T07:43:03.48Z'
                      occurred_at: '2022-01-27T07:42:48.56Z'
                      respond_by: '2022-02-03T07:43:03.73Z'
                      dispute_details:
                        arn: '123'
                      _links:
                        self:
                          href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
                        application:
                          href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                        transfer:
                          href: https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky
                        evidence:
                          href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence
                        adjustment_transfers:
                          href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/disputes?offset=0&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 3
    FileDownload:
      description: Example response
      content:
        application/octet-stream:
          schema:
            $ref: '#/components/schemas/FileDownload'
    ComplianceForm:
      description: Example response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ComplianceForm'
          examples:
            Blank Compliance Form:
              value:
                id: cf_fEojUGLjwUiqNTBp68JWq8
                created_at: '2022-06-22T01:20:12.439149Z'
                updated_at: '2022-07-06T17:32:00.328699Z'
                linked_to: MUfnskvHiiDgP7x3TVL2LkG3
                linked_type: MERCHANT
                type: PCI_SAQ_A
                version: '2018.5'
                valid_from: '2022-06-22T01:20:12.978825Z'
                valid_until: '2023-06-22T01:20:12.97883Z'
                tags: {}
                pci_saq_a:
                  name: null
                  signed_at: null
                  user_agent: null
                  ip_address: null
                  is_accepted: false
                  title: null
                due_at: '2022-09-20T01:20:12.430835Z'
                compliance_form_template: cft_wua8ua1yLAcHRK9mx2mF9K
                files:
                  unsigned_file: FILE_fFGMCY4sxGYTqpjnXh54kC
                  signed_file: null
                state: INCOMPLETE
            Complete Compliance Form:
              value:
                id: cf_fEojUGLjwUiqNTBp68JWq8
                created_at: '2022-06-22T01:20:12.439149Z'
                updated_at: '2022-07-06T17:32:00.328699Z'
                linked_to: MUfnskvHiiDgP7x3TVL2LkG3
                linked_type: MERCHANT
                type: PCI_SAQ_A
                version: '2018.5'
                valid_from: '2022-06-22T01:20:12.978825Z'
                valid_until: '2023-06-22T01:20:12.97883Z'
                tags: {}
                pci_saq_a:
                  name: John Booker
                  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: '2022-09-20T01:20:12.430835Z'
                compliance_form_template: cft_wua8ua1yLAcHRK9mx2mF9K
                files:
                  unsigned_file: FILE_fFGMCY4sxGYTqpjnXh54kC
                  signed_file: null
                state: INCOMPLETE
    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\n\
        PIJPXW0HZ9lpO1nb6sog5DiX  | PIdBHpy7BBSxd2z81VdKpVbT | CARD\\_NOT\\_FOUND\n\
        PI0ovZAS9yfEtgDrZnMaiLvi   | PIhXS0jXNTmklyVk91EsohuZ | CONTACT\\_CARDHOLDER\n\
        PInOrrKY3G1U33hGYTQJ8cIY |  | CLOSED\\_ACCOUNT\nPIlkAOt5kTVhuuxxbmOi9qn |\
        \  | INVALID\\_CARD\nPIiRLbbG4i5daypWNzIrq2xD   |  | NO\\_CHANGE\\_FOUND\n\
        PIy5llZGt6VxlDqbcTgATqeH     | \t  | UNKNOWN"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FileDownload'
    AuthorizationUpdated:
      description: Single captured Authorization object
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/AuthorizationCaptured'
          examples:
            Captured Authorization:
              value:
                id: AUcP43nwPk6VBjPQBDRBTH5n
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 108
                tags:
                  test_key_100: test_auth
                state: SUCCEEDED
                currency: USD
                transfer: TRhPwUByCNHQjhNiLdNgveuA
                messages: []
                raw: null
                created_at: '2022-07-20T22:12:02.96Z'
                updated_at: '2022-07-20T22:12:03.76Z'
                trace_id: ab1bebd8-f6a4-4d86-9640-5eebf68c574f
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2022-07-27T22:12:02.96Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUcP43nwPk6VBjPQBDRBTH5n
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  transfer:
                    href: https://finix.sandbox-payments-api.com/transfers/TRhPwUByCNHQjhNiLdNgveuA
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Captured Authorization (with Level 2 Processing):
              value:
                id: AU4AHPn4k7YTQ8YjK3QajeL2
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 1000
                tags:
                  order_number: 21DFASJSAKAS
                state: SUCCEEDED
                currency: USD
                transfer: TRbew5P8bkL3yxz6a6FzfVia
                messages: []
                raw: null
                created_at: '2022-01-27T07:37:20.68Z'
                updated_at: '2022-01-27T07:37:20.86Z'
                trace_id: ab81e66c-dd65-438b-a1dc-6d580b36233c
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2022-02-03T07:37:20.68Z'
                idempotency_id: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUq2Xz5VS46U4hzzhX9WJCxx
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Captured Authorization (with Level 3 Processing):
              value:
                id: AUczPEgnHSSMJ79n9dvp6HHJ
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 108
                tags:
                  order_number: test_auth
                state: SUCCEEDED
                currency: USD
                transfer: TReDoizZYZyyyTrcPzMboz84
                messages: []
                raw: null
                created_at: '2022-07-20T20:52:11.63Z'
                updated_at: '2022-07-20T20:52:12.37Z'
                trace_id: 46a36f58-b496-4b6b-9357-6bb3c340de87
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2022-07-27T20:52:11.63Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUsQsCLRp9ENxrh563w1zZHi
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
            Voided Authorization:
              value:
                id: AU2UkcVZU94rNqonfcLGZRSJ
                application: APgPDQrLD52TYvqazjHJJchM
                amount: 100
                tags:
                  order_number: 21DFASJSAKAS
                state: SUCCEEDED
                currency: USD
                transfer: null
                messages: []
                raw: null
                created_at: '2022-01-27T07:37:28.10Z'
                updated_at: '2022-01-27T07:37:29.15Z'
                trace_id: 710b6745-c424-4101-84e5-4a49cf317dc7
                source: PIe2YvpcjvoVJ6PzoRPBK137
                merchant_identity: IDpYDM7J9n57q849o9E9yNrG
                3ds_redirect_url: null
                is_void: true
                void_state: PENDING
                expires_at: '2022-02-03T07:37:28.10Z'
                idempotency_id: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AU2UkcVZU94rNqonfcLGZRSJ
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
            Captured Card Present Authorization (with an EMV Card):
              value:
                id: AUuCfRve8QG6G1wnPCReiLma
                application: APeUbTUjvYb1CdPXvNcwW1wP
                amount: 150
                tags:
                  test_key_100: test_auth
                state: SUCCEEDED
                currency: USD
                transfer: TRjiUo5CXLmaJp4k9PL7iP8z
                messages: []
                raw: null
                card_present_details:
                  emv_data:
                    application_identifier: A0000000031010
                    application_label: Visa Credit
                    application_preferred_name: ''
                    application_transaction_counter: '0047'
                    cryptogram: TC 4ACED247416CD824
                    issuer_code_table_index: ''
                    pin_verified: false
                    tags: {}
                  masked_account_number: '************7564'
                  name: 'AARON/CHRISTOPHER W '
                  brand: VISA
                  entry_mode: CHIP_ENTRY
                  payment_type: CREDIT
                  approval_code: '000042'
                capture_amount: 150
                created_at: '2019-03-01T03:42:13.59Z'
                updated_at: '2019-03-01T03:49:28.67Z'
                trace_id: 957ce193-b4e4-4a39-88e2-d88a019982d2
                source: PIjnHHLBZvRu6GPEZdFt7E2q
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                device: DVf2H8sh4LZZC52GTUrwCPPf
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2019-03-08T03:42:13.59Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUuCfRve8QG6G1wnPCReiLma
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  transfer:
                    href: https://finix.sandbox-payments-api.com/transfers/TRjiUo5CXLmaJp4k9PL7iP8z
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
            Captured Card Present Authorization (with a Non-EMV Card):
              value:
                id: AUiQyUYxQzhAF5ACAsxdUvYb
                application: APeUbTUjvYb1CdPXvNcwW1wP
                amount: 2500
                tags:
                  ticketNumber: '2348'
                state: SUCCEEDED
                currency: USD
                transfer: TR6eEeW2Fr7hVgfTKgeeG3gy
                messages: []
                raw: null
                card_present_details:
                  emv_data: null
                  masked_account_number: '************0006'
                  name: TEST/WORLDPAY
                  brand: VISA
                  entry_mode: SWIPED
                  payment_type: CREDIT
                  approval_code: '050473'
                capture_amount: 3000
                created_at: '2019-05-01T17:18:54.41Z'
                updated_at: '2019-05-01T17:19:42.46Z'
                trace_id: FNXwyFm3UyQEyAL9cdabYBGWa
                source: PImKxRXq5wQ2r5fK6qQtXady
                merchant_identity: IDsbTBawhnLBAVeinRb84vFR
                device: DVfKLD9GZtsjcJxLtc2yCcfd
                3ds_redirect_url: null
                is_void: false
                void_state: UNATTEMPTED
                expires_at: '2019-05-08T17:18:54.41Z'
                idempotency_id: null
                additional_buyer_charges: null
                failure_code: null
                failure_message: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/authorizations/AUiQyUYxQzhAF5ACAsxdUvYb
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  transfer:
                    href: https://finix.sandbox-payments-api.com/transfers/TR6eEeW2Fr7hVgfTKgeeG3gy
                  device:
                    href: https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd
                  merchant_identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
    OnboardingForm:
      description: A single `onboarding_from` objext.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OnboardingForm'
          examples:
            Onboarding Form:
              value:
                id: obf_bXQj8iSgYwXf432yJcWbKv
                onboarding_data:
                  entity: {}
                  associated_entities: []
                  payment_instruments: {}
                  additional_underwriting_data: {}
                  max_transaction_amount: 100000
                merchant_processors:
                  - processor: LITLE_V1
                onboarding_link:
                  expires_at: '2022-07-11T22:19:32.123Z'
                  link_url: https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_bXQj8iSgYwXf432yJcWbKv&applicationId=APgPDQrLD52TYvqazjHJJchM&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfYlhRajhpU2dZd1hmNDMyeUpjV2JLdiIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS9kb2NzIiwiZXhwaXJlZF9zZXNzaW9uX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS8iLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL2RvY3MiLCJleHAiOjE2NTc1Nzc5NzIsImFwcGxpY2F0aW9uX2lkIjoiQVBnUERRckxENTJUWXZxYXpqSEpKY2hNIiwiaWF0IjoxNjU3NTc2MTcyLCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL3Rlcm1zLWFuZC1wb2xpY2llcyJ9.A_ItGe4ORB-vnUJ2_mrqz6mI1Hu4nSauvBzo5Utk_aQePfuAPL8ZLBWR5JGRyAB8waV6UyTsbEnxPK22s3cGMg
                status: IN_PROGRESS
                created_at: '2022-07-11T21:49:32.11832Z'
                updated_at: '2022-07-11T21:49:32.11832Z'
                tags: {}
    OnboardingFormLink:
      description: A link for users to return to their `onboarding_form` at any time.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OnboardingFormLink'
          examples:
            Onboarding Form 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:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
  schemas:
    Application:
      type: object
      description: ''
      title: ''
      properties:
        id:
          type: string
          example: APxxxxxxxxxxxxxxxxxx
          description: ID of the `Application` resource.
        created_at:
          type: string
          description: Point in time when this object was created.
          format: date-time
        updated_at:
          type: string
          description: Point in time when this object was most recently updated.
          format: date-time
        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.
        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
          description: Details when the `fees` of `Authroizations` submitted under
            the `Application` will be ready to settle.
          nullable: true
        name:
          type: string
          description: The name of the `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
          description: Details when `Authroizations` submitted under the `Application`
            will be ready to settle.
          nullable: true
        settlement_enabled:
          type: boolean
          description: 'Details if settlement processing is enabled for the `Application`. '
        settlement_funding_identifier:
          type: string
          enum:
            - UNSET
          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_profile:
              type: object
              properties:
                href:
                  type: string
            authorizations:
              type: object
              properties:
                href:
                  type: string
            disputes:
              type: object
              properties:
                href:
                  type: string
            identities:
              type: object
              properties:
                href:
                  type: string
            merchants:
              type: object
              properties:
                href:
                  type: string
            owner_identity:
              type: object
              properties:
                href:
                  type: string
            payment_instruments:
              type: object
              properties:
                href:
                  type: string
            processors:
              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
            settlements:
              type: object
              properties:
                href:
                  type: string
            tokens:
              type: object
              properties:
                href:
                  type: string
            transfers:
              type: object
              properties:
                href:
                  type: string
            users:
              type: object
              properties:
                href:
                  type: string
            webhooks:
              type: object
              properties:
                href:
                  type: string
    CreateApplicationRequest:
      type: object
      x-examples: {}
      properties:
        entity:
          type: object
          title: IdentityEntityForm
          description: Information needed to verify the identity of the entity.
          properties:
            amex_mid:
              type: string
              description: Assigned amex_Mid value. If included must be 10 or 11 digits.
              nullable: true
            annual_card_volume:
              type: integer
              format: int64
              description: Approximate annual credit card sales expected to be processed
                in cents by this merchant (max 19 characters).
            business_address:
              type: object
              description: Primary address for the legal entity.
              required:
                - city
                - country
                - line1
                - postal_code
                - region
              nullable: true
              properties:
                city:
                  type: string
                  description: City (max 20 characters).
                  nullable: true
                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
                  description: 3-Letter Country code.
                  nullable: true
                line1:
                  type: string
                  description: First line of the address (max 35 characters).
                  nullable: true
                line2:
                  type: string
                  description: Second line of the address (max 35 characters).
                  nullable: true
                postal_code:
                  type: string
                  description: Zip or Postal code (max 7 characters).
                  nullable: true
                region:
                  type: string
                  description: 2-letter State code.
                  nullable: true
            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:
              type: string
              maxLength: 20
              minLength: 1
              description: Billing description displayed on the buyer's bank or card
                statement (Length must be between 1 and 20 characters).
            discover_mid:
              type: string
              description: Assigned Discover Mid value.
            dob:
              type: object
              format: date
              description: Principal's date of birth.
              properties:
                year:
                  type: integer
                  description: Year of birth (4-digit).
                day:
                  type: integer
                  description: Day of birth (between 1 and 31).
                month:
                  type: integer
                  description: Month of birth (between 1 and 12).
            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).
            has_accepted_credit_cards_previously:
              type: boolean
              description: Defaults to **false** if not passed.
            incorporation_date:
              type: object
              format: date
              description: Date company was founded.
              properties:
                year:
                  type: integer
                  description: Year business was incorporated (4-digit).
                day:
                  type: integer
                  description: Day business was incorporated (between 1 and 31).
                month:
                  type: integer
                  description: Month business was incorporated (between 1 and 12).
            last_name:
              type: string
              description: Full legal last name of the merchant's principal representative
                (max 20 characters).
            max_transaction_amount:
              type: integer
              format: int64
              description: Maximum amount that can be transacted for a single transaction
                in cents (max 12 characters).
            mcc:
              type: string
              description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf))
                the merchant is classified under.
            ownership_type:
              type: string
              enum:
                - PRIVATE
                - PUBLIC
              description: 'Values can be either: <ul><li><strong>PUBLIC</strong>
                to indicate a publicly-traded company.<li><strong>PRIVATE</strong>
                for privately-held businesses.'
            personal_address:
              $ref: '#/components/schemas/Address'
            phone:
              type: string
              description: Principal's phone number (max 10 characters).
            principal_percentage_ownership:
              type: integer
              format: int64
              maximum: 100
              minimum: 0
              description: Percentage of company owned by the principal (min 0; max
                100).
            short_business_name:
              type: string
              maxLength: 16
              minLength: 1
              description: 'The short version of the business name.

                (Defaults to **null**).'
            tax_authority:
              type: string
              description: Used and required when onboarding a `Merchant` with a `MCC`
                of **9311**. The  `tax_authority` is the tax gathering entity (e.g
                San Francisco Water Authority).
            tax_id:
              type: string
              description: Used to verify `tax_id` was provided.
            title:
              type: string
              maxLength: 60
              description: Control person's corporate title or role (i.e. Chief Executive
                Officer, CFO, etc.; max 60 characters).
              nullable: true
            url:
              type: string
              description: Merchant's publicly available website (max 100 characters).
          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
        max_transaction_amount:
          type: integer
          description: Maximum amount that can be processed for a single transaction
            in cents (max 12 characters).
          nullable: true
        name:
          type: string
          description: Merchant's full legal business name (If **INDIVIDUAL_SOLE_PROPRIETORSHIP**,
            enter first name, Full legal last name and middle initial; max 120 characters).
          nullable: true
        tags:
          $ref: '#/components/schemas/Tags'
        user:
          type: string
          example: USxxxxxxxxxxxxxxxxxx
          description: ID of the `User` resource.
      required:
        - user
    ApplicationProfile:
      type: object
      properties:
        id:
          type: string
          example: PPxxxxxxxxxxxxxxxxxx
          description: ID of the `application_profile` resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        application:
          type: string
          description: The ID of the `Application` resource.
        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:
        fee_profile:
          $ref: '#/components/schemas/Id'
        risk_profile:
          $ref: '#/components/schemas/Id'
        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:
          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:
            first:
              type: object
              properties:
                href:
                  type: string
            last:
              type: object
              properties:
                href:
                  type: string
            next:
              type: object
              properties:
                href:
                  type: string
            prev:
              type: object
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
    ApplicationsList:
      type: object
      description: ''
      title: ApplicationsList
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Application` resources.
          properties:
            applications:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Application` resources.'
              items:
                $ref: '#/components/schemas/Application'
        _links:
          $ref: '#/components/schemas/ListLinks'
    CreateAuthorizationRequest:
      type: object
      description: Create an `Authorization` resource.
      properties:
        additional_buyer_charges:
          $ref: '#/components/schemas/AdditionalBuyerCharges'
        additional_purchase_data:
          $ref: '#/components/schemas/AdditionalPurchaseData'
        amount:
          format: int64
          type: integer
          description: The total amount that will be debited in cents (e.g. 100 cents
            to debit $1.00).
        currency:
          $ref: '#/components/schemas/Currency'
        device:
          $ref: '#/components/schemas/Id'
        fraud_session_id:
          $ref: '#/components/schemas/FraudSessionID'
        idempotency_id:
          type: string
          description: A randomly generated value that'll be associated with the request.
          nullable: true
        merchant:
          $ref: '#/components/schemas/Id'
        operation_key:
          $ref: '#/components/schemas/OperationKey'
        source:
          $ref: '#/components/schemas/Id'
        tags:
          $ref: '#/components/schemas/Tags'
        3d_secure_authentication:
          type: object
          description: The information required to create a 3D secure `Authorization`.
          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.
            cardholder_ip_address:
              type: string
              description: Only required for American Express cards. Format is nnn.nnn.nnn.nnn
            electronic_commerce_indicator:
              type: string
              description: 'AUTHENTICATED: Approved by 3D Secure Vendor; ATTEMPTED:
                Issuer or cardholder does not support 3D Secure'
            transaction_id:
              type: string
              description: Only valid for Visa transactions
      required:
        - amount
        - currency
    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/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        3ds_redirect_url:
          type: string
          description: The redirect URL used for 3DS transactions (if supported by
            the processor).
          nullable: true
        additional_buyer_charges:
          $ref: '#/components/schemas/AdditionalBuyerCharges'
        amount:
          type: integer
          minimum: 0
          description: The total amount that will be debited in cents (e.g. 100 cents
            to debit $1.00).
        application:
          type: string
          description: The ID of the `Application` resource the `Authorization` was
            created under.
        card_present_details:
          $ref: '#/components/schemas/CardPresentDetails'
        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`.
        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/FailureCode'
        failure_message:
          $ref: '#/components/schemas/FailureMessage'
        idempotency_id:
          type: string
          description: A randomly generated value that'll be associated with the request.
          nullable: true
        is_void:
          type: boolean
          description: Details if the `Authorization` is void.
        merchant_identity:
          $ref: '#/components/schemas/Id'
        messages:
          type: array
          description: Message field that provides additional details. This field
            is typically **null**.
          items:
            type: string
        raw:
          $ref: '#/components/schemas/Raw'
        source:
          type: string
          example: PIxxxxxxxxxxxxxxxxxx
          description: ID of the `Payment Instrument` where funds get debited.
        state:
          type: string
          enum:
            - CANCELED
            - PENDING
            - FAILED
            - SUCCEEDED
            - UNKNOWN
          description: The state of the `Authorization`.
        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
          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
            device:
              type: object
              description: Link to the `Device` the request was made under.
              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
            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 `Authorization`.
              properties:
                href:
                  type: string
    AuthorizationCaptured:
      type: object
      title: AuthorizationCaptured
      description: A captured authorization
      properties:
        id:
          type: string
          example: AUxxxxxxxxxxxxxxxxxx
          description: The ID of the `Authorization` resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        3ds_redirect_url:
          type: string
          description: The redirect URL used for 3DS transactions (if supported by
            the processor).
          nullable: true
        additional_buyer_charges:
          $ref: '#/components/schemas/AdditionalBuyerCharges'
        amount:
          type: integer
          minimum: 0
          description: The total amount that will be debited in cents (e.g. 100 cents
            to debit $1.00).
        application:
          type: string
          description: The ID of the `Application` resource the `Authorization` was
            created under.
        card_present_details:
          $ref: '#/components/schemas/CardPresentDetails'
        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`.
        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
        external_responses:
          type: array
          nullable: true
          items:
            type: object
            properties:
              body:
                type: string
              content_type:
                type: string
        failure_code:
          $ref: '#/components/schemas/FailureCode'
        failure_message:
          $ref: '#/components/schemas/FailureMessage'
        idempotency_id:
          type: string
          description: A randomly generated value that'll be associated with the request.
          nullable: true
        is_void:
          type: boolean
          description: Details if the `Authorization` is void.
        merchant_identity:
          $ref: '#/components/schemas/Id'
        messages:
          type: array
          description: Message field that provides additional details. This field
            is typically **null**.
          items:
            type: string
        raw:
          $ref: '#/components/schemas/Raw'
        source:
          type: string
          example: PIxxxxxxxxxxxxxxxxxx
          description: ID of the `Payment Instrument` where funds get debited.
        state:
          type: string
          enum:
            - CANCELED
            - PENDING
            - FAILED
            - SUCCEEDED
            - UNKNOWN
          description: The state of the `Transfer`.
        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
          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
            device:
              type: object
              description: Link to the `Device` the request was made under.
              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
            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 `Authorization`.
              properties:
                href:
                  type: string
    AuthorizationsList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _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:
          $ref: '#/components/schemas/ListLinks'
    CreateDevice:
      type: object
      title: CreateDevice
      description: ''
      properties:
        configuration:
          $ref: '#/components/schemas/ConfigurationDetails'
        description:
          type: string
          description: Additional information about device (e.g. self serving terminal).
        model:
          type: string
          enum:
            - BBPOS
            - MX915
            - MX925
            - IPP320
            - IPP350
            - ISC250
            - ISC480
            - ISMP4
            - ANDROID
            - LANE_3000
            - LINK_2500
          description: The model type of the device.
        name:
          type: string
          description: Name of the `Device`.
        tags:
          $ref: '#/components/schemas/Tags'
      required:
        - model
        - name
      x-examples:
        example-1:
          name: 'Finix  triPOS #1'
          model: MX915
          description: John Smith
          configuration:
            allow_debit: true
            prompt_signature: NEVER
            bypass_device_on_capture: true
    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
    Device:
      type: object
      title: Device
      description: '`Device` resource.'
      properties:
        id:
          $ref: '#/components/schemas/Id'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        configuration_details:
          type: object
          title: DeviceConfigDetails
          description: Information used to configure how the `Device` handles transactions.
          nullable: true
          properties:
            allow_debit:
              type: boolean
              description: Allow transaction to be processed on Debit rails. If **false**,
                Debit card transactions will be processed on Credit rails.
            bypass_device_on_capture:
              type: boolean
              description: Sets whether or not the device will be used to capture
                transactions. This field must be set to **true** (defaults to **false**).
              nullable: true
            check_for_duplicate_transactions:
              type: boolean
              description: Sets whether the `Device` will check for duplicate transactions.
            prompt_amount_confirmation:
              type: boolean
              description: Sets if the card holder needs to confirm the amount they
                will pay (defaults to **true**).
            prompt_manual_entry:
              type: boolean
              description: Sets if the device defaults to manual entry as the default
                card input method. (defaults to **false**).
            prompt_signature:
              type: string
              description: 'Sets if the device will prompt the card holder for a signature
                by default. Available values include: <ul><li><strong>ALWAYS</strong><li><strong>NEVER</strong><li><strong>AMOUNT</strong>:
                Used in conjunction with `signature_threshold_amount` so when the
                threshold is reached the signature form appears on the device.'
            signature_threshold_amount:
              type: integer
              format: int64
              description: The threshold to prompt a signature when `prompt_signature`
                is set to **AMOUNT** (defaults to 0).
        connection:
          type: string
          description: Details if the `Device` is connected and online. Only returned
            when `include_connection parameter` provided.
        description:
          type: string
          description: Additional information about device (e.g. self serving terminal).
          nullable: true
        enabled:
          type: boolean
          description: Details if the `Device` resource is enabled. Set to **false**
            to disable the `Device`.
        idle_message:
          type: string
          description: The message that diplays on the device after a period of inactivity.
          nullable: true
        merchant:
          type: string
          example: MUxxxxxxxxxxxxxxxxxx
          description: ID of the `Merchant` resource.
        model:
          type: string
          description: Details the model of the card reader.
        name:
          type: string
          description: Name of the `Device`.
        serial_number:
          type: string
          description: Serial number of the device.
          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
    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/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        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 the `Dispute` was created
            under.
        currency:
          $ref: '#/components/schemas/Currency'
        dispute_details:
          type: object
          additionalProperties: true
          description: Details about the `Dispute` recieved by the `Processor`. May
            be any type of data.
        identity:
          $ref: '#/components/schemas/Id'
        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 dispute occurred.
          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>**INQUIRY**<li>**QUALITY**<li>**FRAUD**
        respond_by:
          type: string
          description: Point in time when dispute has to be resolved and the `Merchant`
            needs to respond by.
          format: date-time
          nullable: true
        state:
          type: string
          enum:
            - INQUIRY
            - PENDING
            - WON
            - LOST
            - ARBITRATION
          description: The current state of the `Dispute`.
        tags:
          $ref: '#/components/schemas/Tags'
        transfer:
          type: string
          example: TRxxxxxxxxxxxxxxxxxx
          description: ID of the `Transfer` resource.
        _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/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        dispute:
          type: string
          description: The ID of the resource.
        state:
          type: string
          enum:
            - PENDING
            - SUCCEEDED
            - CANCELED
            - FAILED
          description: "Result of the evidence uploaded.\n- **PENDING**: The evidence\
            \ file has not yet been submitted to the Processor. No user action is\
            \ required.\n- **SUCCEEDED**: The evidence file has been successfully\
            \ sent to the Processor. No further user action is required.\n- **CANCELED**:\
            \ The evidence file upload was not completed due to user action.\n- **FAILED**:\
            \ An issue occurred. User action is required**. Any of the following issues\
            \ could have occurred:\n  - There was an error in the system and the user\
            \ should retry uploading their evidence file.\n  - There is an issue with\
            \ the file and the user should retry uploading a different file.\n  -\
            \ There is an issue and the user should contact Support."
        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
      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'
    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
    Fee:
      type: object
      title: Fee
      description: An out of flow `fee` that is added to a `settlement`.
      properties:
        id:
          type: string
          example: FExxxxxxxxxxxxxxxxxx
          description: The ID of the `fee` resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        amount:
          type: integer
          description: The amount of the fee in cents.
        currency:
          $ref: '#/components/schemas/Currency'
        display_name:
          type: string
          description: The name of the `fee` object that was include in `display_name`
            when creating the fee.
          nullable: true
        fee_subtype:
          type: string
          enum:
            - CUSTOM
            - APPLICATION_FEE
            - PLATFORM_FEE
          description: Subtype of the `fee`.
        fee_type:
          type: string
          enum:
            - APPLICATION_FEE
            - ACH_BASIS_POINTS
            - ACH_FIXED
            - CARD_BASIS_POINTS
            - CARD_FIXED
            - CARD_INTERCHANGE
            - VISA_BASIS_POINTS
            - VISA_FIXED
            - VISA_INTERCHANGE
            - VISA_ASSESSMENT_BASIS_POINTS
            - VISA_ACQUIRER_PROCESSING_FIXED
            - VISA_CREDIT_VOUCHER_FIXED
            - VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED
            - VISA_BASE_II_CREDIT_VOUCHER_FIXED
            - VISA_KILOBYTE_ACCESS_FIXED
            - DISCOVER_BASIS_POINTS
            - DISCOVER_FIXED
            - DISCOVER_INTERCHANGE
            - DISCOVER_ASSESSMENT_BASIS_POINTS
            - DISCOVER_DATA_USAGE_FIXED
            - DISCOVER_NETWORK_AUTHORIZATION_FIXED
            - DINERS_CLUB_BASIS_POINTS
            - DINERS_CLUB_FIXED
            - DINERS_CLUB_INTERCHANGE
            - MASTERCARD_BASIS_POINTS
            - MASTERCARD_FIXED
            - MASTERCARD_INTERCHANGE
            - MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS
            - MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS
            - MASTERCARD_ACQUIRER_FEE_BASIS_POINTS
            - JCB_BASIS_POINTS
            - JCB_FIXED
            - JCB_INTERCHANGE
            - AMERICAN_EXPRESS_BASIS_POINTS
            - AMERICAN_EXPRESS_FIXED
            - AMERICAN_EXPRESS_INTERCHANGE
            - AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS
            - DISPUTE_INQUIRY_FIXED_FEE
            - DISPUTE_FIXED_FEE
            - QUALIFIED_TIER_BASIS_POINTS_FEE
            - QUALIFIED_TIER_FIXED_FEE
            - CUSTOM
            - ACH_DEBIT_RETURN_FIXED_FEE
            - ACH_CREDIT_RETURN_FIXED_FEE
            - ANCILLARY_FIXED_FEE_PRIMARY
            - ANCILLARY_FIXED_FEE_SECONDARY
            - SETTLEMENT_V2_TRANSFER
          description: The type of `fee`.
        label:
          type: string
          description: The name of the `fee` object that was include in `label` when
            creating the fee.
          nullable: true
        linked_id:
          type: string
          description: ID of the linked resource.
        linked_type:
          type: string
          enum:
            - APPLICATION
            - PLATFORM
            - SUBSCRIPTION
            - TRANSFER
          description: The type of entity the `fee` is linked to (**null** by default).
        merchant:
          type: string
          description: The `Merchant` ID that the fee is being debited from.
        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:
            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
            transfer:
              type: object
              description: Link to the `Transfers` realted to the `Dispute`.
              properties:
                href:
                  type: string
    CreateFeeRequest:
      type: object
      title: ''
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
        currency:
          $ref: '#/components/schemas/Currency'
        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**.
        label:
          type: string
          description: The display name of the `Fee` that can be used for filtering
            purposes.
        linked_id:
          type: string
          description: ID of the linked resource
        linked_type:
          type: string
          enum:
            - APPLICATION
            - PLATFORM
            - SUBSCRIPTION
            - TRANSFER
          description: The type of entity the fee is linked to (**null** by default).
        merchant_id:
          $ref: '#/components/schemas/Id'
        settlement_delay_days:
          type: integer
          description: Delays in days, when the fee will be submitted for settlement.
          nullable: true
        tags:
          $ref: '#/components/schemas/Tags'
      required:
        - amount
        - currency
        - fee_subtype
        - fee_type
        - merchant_id
    FeeProfile:
      type: object
      properties:
        id:
          type: string
          example: FPxxxxxxxxxxxxxxxxxx
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        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 merchant
            for processing an echeck (also called ACH payments) credit return.
          nullable: true
        ach_debit_return_fixed_fee:
          type: integer
          description: A fixed amount in cents that will be charged to the merchant
            for processing an echeck (also called ACH payment) debit return.
          nullable: true
        ach_fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual `Transfer`.
        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_interchange:
          type: boolean
          description: Set to **True** to incur interchange fees for American Express
            `Transfers`.
          nullable: true
        american_express_fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual American Express
            `Transfer`.
          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
        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:
          type: string
          description: The ID of the resource.
        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%)
        charge_interchange:
          type: boolean
          description: Set to **True** to incur interchange fees for card-based `Transfers`.
        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: Assessment 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_interchange:
          type: boolean
          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_fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual Discover `Transfer`.
          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_network_authorization_fixed_fee:
          type: integer
          description: This fee applies to all Discover network `authorizations` and
            replaces the previously assessed Data Transmission.
          nullable: true
        dispute_fixed_fee:
          type: integer
          description: Applied when a `dispute` is created or updated to a **PENDING**
            state.
          nullable: true
        dispute_inquiry_fixed_fee:
          type: integer
          description: Applied when a `dispute` is created or updated to a **INQUIRY**
            state.
          nullable: true
        externally_funded_basis_points:
          type: integer
          description: Percentage-based fee incurred against the full amount of each
            `Transfer` that's card-based and externally funded. Calculated as one
            hundredth of one percent (1 basis point = .0001 or .01%).
          nullable: true
        externally_funded_fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual `Transfer` that's
            card-based and externally funded.
          nullable: true
        fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual card-based `Transfer`.
        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: boolean
          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: "The fee is assessed on a business\u2019s gross MasterCard\
            \ processing volume. This fee varies per acquirer based on MasterCard\u2019\
            s assessed charge as it\u2019s distributed across the acquirer\u2019s\
            \ 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_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
        qualified_tiers:
          type: object
          description: The top of the qualified tier tree.
          nullable: true
        rounding_mode:
          type: string
          enum:
            - TRANSACTION
            - AGGREGATE
          description: <ul><li>Include <strong>AGGREGATE</strong> if you want to round
            after the settlement calculation.<li>By default, rounding happens before
            the sum of the settlement calculation (i.e. round each fee transfer)</ul>
        tags:
          $ref: '#/components/schemas/Tags'
        visa_acquirer_processing_fixed_fee:
          type: integer
          description: Applied 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_assessments_basis_points:
          type: integer
          description: Applies to all Visa credit transactions.
          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_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\u2019\
            s network for settlement."
          nullable: true
        _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
            owner_identity:
              type: object
              properties:
                href:
                  type: string
            processors:
              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
    FeeProfilesList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `fee_profile` objects.
          properties:
            fee_profiles:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`fee_profile` objects.'
              items:
                $ref: '#/components/schemas/FeeProfile'
        _links:
          $ref: '#/components/schemas/ListLinks'
    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'
    IdentitiesList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _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:
                $ref: '#/components/schemas/Identity'
        _links:
          $ref: '#/components/schemas/ListLinks'
    Identity:
      description: ''
      x-examples:
        example-1:
          id: IDpYDM7J9n57q849o9E9yNrG
          application: APgPDQrLD52TYvqazjHJJchM
          entity:
            title: CEO
            first_name: dwayne
            last_name: Sunkhronos
            email: user@example.org
            business_name: Petes Coffee
            business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
            doing_business_as: Petes Coffee
            phone: '1234567890'
            business_phone: +1 (408) 756-4497
            personal_address:
              line1: 741 Douglass St
              line2: Apartment 7
              city: San Mateo
              region: CA
              postal_code: '94114'
              country: USA
            business_address:
              line1: 741 Douglass St
              line2: Apartment 8
              city: San Mateo
              region: CA
              postal_code: '94114'
              country: USA
            mcc: '0742'
            dob:
              day: 27
              month: 6
              year: 1978
            max_transaction_amount: 12000000
            amex_mid: null
            discover_mid: null
            url: www.PetesCoffee.com
            annual_card_volume: 12000000
            has_accepted_credit_cards_previously: true
            incorporation_date:
              day: 27
              month: 6
              year: 1978
            principal_percentage_ownership: 50
            short_business_name: null
            ownership_type: PRIVATE
            tax_authority: null
            tax_id_provided: true
            business_tax_id_provided: true
            default_statement_descriptor: Petes Coffee
          tags:
            Studio Rating: '4.7'
          created_at: '2022-01-27T07:36:52.11Z'
          updated_at: '2022-01-27T07:36:52.00Z'
          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
              ecommerce_percentage: 60
              mail_order_telephone_order_percentage: 10
            credit_check_allowed: true
            credit_check_ip_address: 42.1.1.113
            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:
              business_to_business_volume_percentage: 100
              business_to_consumer_volume_percentage: 0
              consumer_to_consumer_volume_percentage: 0
              other_volume_percentage: 0
              person_to_person_volume_percentage: 0
          _links:
            self:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
            verifications:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/verifications
            merchants:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/merchants
            settlements:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/settlements
            authorizations:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/authorizations
            transfers:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/transfers
            payment_instruments:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/payment_instruments
            associated_identities:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/associated_identities
            disputes:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/disputes
            application:
              href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
      title: ''
      type: object
      properties:
        id:
          type: string
          minLength: 1
          description: The ID of the `Identity` resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        additional_underwriting_data:
          type: object
          description: Additional underwriting data that's required to verify the
            `Identity`.
          nullable: true
          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.113 ).
            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).
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the `Identity`.
        entity:
          type: object
          description: The underwriting details required to verify the `Identity`.
          properties:
            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
                <strong>INDIVIDUAL_SOLE_PROPRIETORSHIP</strong>, pass the owner's
                legal first name, last name and middle initial.
              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_provided:
              type: boolean
              description: Details if the `business_tax_id` was provided.
            business_type:
              description: Include the value that best applies to the merchant.
              type: string
              nullable: true
            default_statement_descriptor:
              type: string
              minLength: 1
              description: The description of the merchant that appears on the buyer's
                bank or card statement.
              nullable: true
            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 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.
              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><strong>PRIVATE</strong>
                for privately-held businesses.'
              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 merchant with a
                <tt>MCC</tt> of <strong>9311</strong>.<li> The <tt>tax_authority</tt>
                is the tax gathering entity (e.g San Francisco Water Authority).
              nullable: true
            tax_id_provided:
              type: boolean
              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).
              nullable: true
            url:
              type: string
              minLength: 1
              description: The URL of the merchant's public website.
              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: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
                  minLength: 1
            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
            transfers:
              type: object
              description: Link to the `Transfer` 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
            application:
              type: object
              description: Link to the `Application` the request was made under.
              properties:
                href:
                  type: string
                  minLength: 1
    AssociatedIdentity:
      description: ''
      x-examples:
        example-1:
          id: IDpYDM7J9n57q849o9E9yNrG
          application: APgPDQrLD52TYvqazjHJJchM
          entity:
            title: CEO
            first_name: dwayne
            last_name: Sunkhronos
            email: user@example.org
            business_name: Petes Coffee
            business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
            doing_business_as: Petes Coffee
            phone: '1234567890'
            business_phone: +1 (408) 756-4497
            personal_address:
              line1: 741 Douglass St
              line2: Apartment 7
              city: San Mateo
              region: CA
              postal_code: '94114'
              country: USA
            business_address:
              line1: 741 Douglass St
              line2: Apartment 8
              city: San Mateo
              region: CA
              postal_code: '94114'
              country: USA
            mcc: '0742'
            dob:
              day: 27
              month: 6
              year: 1978
            max_transaction_amount: 12000000
            amex_mid: null
            discover_mid: null
            url: www.PetesCoffee.com
            annual_card_volume: 12000000
            has_accepted_credit_cards_previously: true
            incorporation_date:
              day: 27
              month: 6
              year: 1978
            principal_percentage_ownership: 50
            short_business_name: null
            ownership_type: PRIVATE
            tax_authority: null
            tax_id_provided: true
            business_tax_id_provided: true
            default_statement_descriptor: Petes Coffee
          tags:
            Studio Rating: '4.7'
          created_at: '2022-01-27T07:36:52.11Z'
          updated_at: '2022-01-27T07:36:52.00Z'
          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
              ecommerce_percentage: 60
              mail_order_telephone_order_percentage: 10
            credit_check_allowed: true
            credit_check_ip_address: 42.1.1.113
            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:
              business_to_business_volume_percentage: 100
              business_to_consumer_volume_percentage: 0
              consumer_to_consumer_volume_percentage: 0
              other_volume_percentage: 0
              person_to_person_volume_percentage: 0
          _links:
            self:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
            verifications:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/verifications
            merchants:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/merchants
            settlements:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/settlements
            authorizations:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/authorizations
            transfers:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/transfers
            payment_instruments:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/payment_instruments
            associated_identities:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/associated_identities
            disputes:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/disputes
            application:
              href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
      title: ''
      type: object
      properties:
        id:
          type: string
          minLength: 1
          description: The ID of the `Identity` resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        application:
          type: string
          minLength: 1
          description: ID of the `Application` associated with the `Identity`.
        entity:
          type: object
          description: The underwriting details required to verify the `Identity`.
          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
                <strong>INDIVIDUAL_SOLE_PROPRIETORSHIP</strong>, pass the owner's
                legal first name, last name and middle initial.
              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_provided:
              type: boolean
              description: Details if the `business_tax_id` was provided.
            business_type:
              description: Include the value that best applies to the merchant.
              type: string
              nullable: true
            default_statement_descriptor:
              type: string
              minLength: 1
              description: The description of the merchant that appears on the buyer's
                bank or card statement.
              nullable: true
            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 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.
              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><strong>PRIVATE</strong>
                for privately-held businesses.'
              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 merchant with a
                <tt>MCC</tt> of <strong>9311</strong>.<li> The <tt>tax_authority</tt>
                is the tax gathering entity (e.g San Francisco Water Authority).
              nullable: true
            tax_id_provided:
              type: boolean
              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).
              nullable: true
            url:
              type: string
              minLength: 1
              description: The URL of the merchant's public website.
              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: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
                  minLength: 1
            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
            transfers:
              type: object
              description: Link to the `Transfer` 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
            application:
              type: object
              description: Link to the `Application` the request was made under.
              properties:
                href:
                  type: string
                  minLength: 1
    CreateIdentityRequest:
      description: ''
      x-examples:
        example-1:
          additional_underwriting_data:
            merchant_agreement_accepted: true
            merchant_agreement_ip_address: 42.1.1.113
            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
            average_ach_transfer_amount: 200000
            annual_ach_volume: 200000
            credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
            refund_policy: MERCHANDISE_EXCHANGE_ONLY
            credit_check_timestamp: '2021-04-28T16:42:55Z'
            credit_check_allowed: true
            merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
            business_description: SB3 vegan cafe
            average_card_transfer_amount: 200000
            credit_check_ip_address: 42.1.1.113
            merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X
              10_14_6)
            card_volume_distribution:
              card_present_percentage: 30
              mail_order_telephone_order_percentage: 10
              ecommerce_percentage: 60
          tags:
            Studio Rating: '4.7'
          entity:
            last_name: Sunkhronos
            max_transaction_amount: 12000000
            has_accepted_credit_cards_previously: true
            default_statement_descriptor: Petes Coffee
            personal_address:
              city: San Mateo
              country: USA
              region: CA
              line2: Apartment 7
              line1: 741 Douglass St
              postal_code: '94114'
            incorporation_date:
              year: 1978
              day: 27
              month: 6
            business_address:
              city: San Mateo
              country: USA
              region: CA
              line2: Apartment 8
              line1: 741 Douglass St
              postal_code: '94114'
            ownership_type: PRIVATE
            first_name: dwayne
            title: CEO
            business_tax_id: '123456789'
            doing_business_as: Petes Coffee
            principal_percentage_ownership: 50
            email: user@example.org
            mcc: '0742'
            phone: '1234567890'
            business_name: Petes Coffee
            tax_id: '123456789'
            business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
            business_phone: +1 (408) 756-4497
            dob:
              year: 1978
              day: 27
              month: 6
            url: www.PetesCoffee.com
            annual_card_volume: 12000000
      type: object
      properties:
        additional_underwriting_data:
          type: object
          description: Addition underwriting details required to verify `Identities`.
          nullable: true
          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
              description: Description of this merchant's business (max 200 characters).
            credit_check_allowed:
              type: boolean
              description: Sets if this merchant has consented and accepted to a credit
                check.
            credit_check_ip_address:
              type: string
              description: The IP address of the merchant when they consented to a
                credit check (e.g., 42.1.1.113 ).
              minLength: 1
            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)).
            card_volume_distribution:
              type: object
              description: The distribution of the merchant's credit card volume The
                sum of `card_volume_distribution` must be 100.
              properties:
                card_present_percentage:
                  type: integer
                  description: The percentage of the merchant's volume that's card
                    present (between 0 and 100).
                mail_order_telephone_order_percentage:
                  type: integer
                  description: The percentage of the merchant's business that is a
                    mail order or telephone order (between 0 and 100).
                ecommerce_percentage:
                  type: integer
                  description: The percentage of the merchant's business that is eCommerce
                    (between 0 and 100).
            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
              description: IP address of the merchant when this merchant accepted
                the merchant agreement (e.g., 42.1.1.113).
              minLength: 1
            merchant_agreement_timestamp:
              type: string
              minLength: 1
              description: Sets if this merchant has consented and accepted to a credit
                check.
            merchant_agreement_user_agent:
              type: string
              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)).
              minLength: 1
            refund_policy:
              type: string
              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)).
              enum:
                - NO_REFUNDS
                - MERCHANDISE_EXCHANGE_ONLY
                - 30_DAYS
            volume_distribution_by_business_type:
              type: object
              description: IP address of the merchant when this merchant accepted
                the merchant agreement (e.g., 42.1.1.113).
              properties:
                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).
                consumer_to_consumer_volume_percentage:
                  type: integer
                  description: Merchant's percentage of volume that is consumer to
                    consumer (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).
                business_to_business_volume_percentage:
                  type: integer
                  description: The percentage of the merchant's volume that's business
                    to business (between 0 and 100).
                person_to_person_volume_percentage:
                  type: integer
                  description: The percentage of the merchant's volume that's person
                    to person (between 0 and 100).
        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:
              type: object
              description: The billing address of the buyer. This field is used for
                identity verification purposes.
              properties:
                city:
                  type: string
                  description: City (max 20 characters).
                country:
                  type: string
                  description: 3-Letter country code (e.g. USA).
                line1:
                  type: string
                  description: First line of the address (max 35 characters).
                line2:
                  type: string
                  description: Second line of the address (max 35 characters).
                postal_code:
                  type: string
                  description: Zip or Postal code (max 7 characters).
                region:
                  type: string
                  description: 2-letter State code.
            phone:
              type: string
              description: Phone number where the buyer can be reached.
        tags:
          $ref: '#/components/schemas/Tags'
    UpdateIdentityRequest:
      x-examples: {}
      type: object
      properties:
        additional_underwriting_data:
          type: object
          description: Additional underwriting data that's required to verify the
            `Identity` of merchants.
          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).
            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.113 ).
            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)).
            card_volume_distribution:
              type: object
              description: The distribution of the merchant's credit card volume The
                sum of `card_volume_distribution` must be 100.
              properties:
                card_present_percentage:
                  type: integer
                  description: The percentage of the merchant's business that's card
                    present (between 0 and 100).
                ecommerce_percentage:
                  type: integer
                  description: The percentage of the merchant's business that's e-commerce
                    (between 0 and 100).
                mail_order_telephone_order_percentage:
                  type: integer
                  description: The percentage of the merchant's business that's mail
                    or telephone order (between 0 and 100).
            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.
              properties:
                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).
                consumer_to_consumer_volume_percentage:
                  type: integer
                  description: Merchant's percentage of volume that is consumer to
                    consumer (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).
                business_to_business_volume_percentage:
                  type: integer
                  description: The percentage of the merchant's volume that's business
                    to business (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
          description: Identifying information about the buyer.
          properties:
            email:
              type: string
              description: The email address of the buyer (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:
              type: object
              description: The billing address of the buyer. This field is used for
                identity verification purposes.
              properties:
                city:
                  type: string
                  description: City (max 20 characters).
                country:
                  type: string
                  description: 3-Letter country code (e.g. USA).
                line1:
                  type: string
                  description: First line of the address (max 35 characters).
                line2:
                  type: string
                  description: Second line of the address (max 35 characters).
                postal_code:
                  type: string
                  description: Zip or Postal code (max 7 characters).
            phone:
              type: string
              description: Phone number where the buyer can be reached.
        tags:
          $ref: '#/components/schemas/Tags'
    CreateAssociatedIdentityRequest:
      x-examples: {}
      type: object
      properties:
        entity:
          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
                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
            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: Details if the `business_tax_id` was provided.
            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:
              type: string
              minLength: 1
              description: The description of the merchant that appears on the buyer's
                bank or card statement.
            dob:
              type: object
              description: 'The control owner''s date of birth.

                '
              properties:
                year:
                  type: integer
                day:
                  type: integer
                month:
                  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 with the
                US.
              properties:
                year:
                  type: integer
                day:
                  type: integer
                month:
                  type: integer
            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.
            ownership_type:
              type: string
              minLength: 1
              description: 'Values can be either:

                <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.

                <li><strong>PRIVATE</strong> for privately-held businesses.'
            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).
            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.
        tags:
          $ref: '#/components/schemas/Tags'
    Merchant:
      type: object
      x-examples:
        example-1:
          id: MUucec6fHeaWo3VHYoSkUySM
          application: APgPDQrLD52TYvqazjHJJchM
          identity: IDpYDM7J9n57q849o9E9yNrG
          verification: VIdikDHXv7x8nWyJg8JZemGx
          merchant_profile: MPzW2oRPtkLxK3fymcMACFi
          processor: DUMMY_V1
          processing_enabled: true
          settlement_enabled: true
          gross_settlement_enabled: false
          creating_transfer_from_report_enabled: true
          card_expiration_date_required: true
          card_cvv_required: false
          tags:
            key_2: value_2
          mcc: '0742'
          mid: FNX7CwmebftudY7i5mA4qF6XT
          merchant_name: Petes Coffee
          settlement_funding_identifier: UNSET
          ready_to_settle_upon: RECONCILIATION
          fee_ready_to_settle_upon: RECONCILIATION
          level_two_level_three_data_enabled: false
          created_at: '2022-01-27T07:36:58.19Z'
          updated_at: '2022-01-27T07:36:58.46Z'
          onboarding_state: APPROVED
          processor_details:
            mid: FNX7CwmebftudY7i5mA4qF6XT
            api_key: secretValue
          _links:
            self:
              href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM
            identity:
              href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
            verifications:
              href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM/verifications
            merchant_profile:
              href: https://finix.sandbox-payments-api.com/merchant_profiles/MPzW2oRPtkLxK3fymcMACFi
            application:
              href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
            verification:
              href: https://finix.sandbox-payments-api.com/verifications/VIdikDHXv7x8nWyJg8JZemGx
      title: Merchant
      properties:
        id:
          type: string
          description: The ID of the resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        application:
          type: string
          description: ID of the `Application` the `Merchant` was created under.
        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.
        creating_transfer_from_report_enabled:
          type: boolean
          description: Set to **true** to automatically create `Transfers` once settlement
            reports get generated.
        convenience_charges_enabled:
          type: boolean
          description: Set to **true** if you want to enable the `Merchant` to accept
            convenience fees and/or service fees.
        fee_ready_to_settle_upon:
          type: string
          description: Details how the `Merchant` settles fees.
        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`.
        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**.
        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.
          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:
            - PROVISIONING
            - APPROVED
            - REJECTED
          description: Details the state of the `Merchant's` onboarding.
        processor:
          type: string
          description: Name of the transaction processor.
        processor_details:
          type: object
          description: Additional details specific to the processor.
          properties:
            api_key:
              type: string
            mid:
              type: string
        processing_enabled:
          type: boolean
          description: Details if transaction processing is enabled for the `Merchant`.
        ready_to_settle_upon:
          type: string
          description: Details how `Authorizations` captured by the `Merchant` are
            settled.
        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 processing is enabled for the `Merchant`.
        settlement_funding_identifier:
          type: string
          description: Include addtional information (like the MID) when submitting
            funding `Tranfers` to processors.
        tags:
          $ref: '#/components/schemas/Tags'
        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:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
            identity:
              type: object
              description: Link to the `Identity` the request was made under.
              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
            merchant_profile:
              type: object
              description: Link to the `merchant_profile` the request was made under.
              properties:
                href:
                  type: string
            application:
              type: object
              description: Link to the `Application` the request was made under.
              properties:
                href:
                  type: string
            verification:
              type: object
              description: Link to the `Verification` that was used to verify the
                `Identity` that the request was made under.
              properties:
                href:
                  type: string
    MerchantProfile:
      type: object
      description: ''
      properties:
        id:
          $ref: '#/components/schemas/Id'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        application:
          type: string
          description: The ID of the resource.
        fee_profile:
          $ref: '#/components/schemas/Id'
        risk_profile:
          $ref: '#/components/schemas/Id'
        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'
    CreateMerchantUnderwritingRequest:
      type: object
      title: MerchantUnderwritingCreate
      properties:
        gateway:
          type: string
          enum:
            - TRIPOS_CLOUD_V1
            - TRIPOS_MOBILE_V1
            - EXPRESS_V1
          description: Name of the gateway that processes the `Merchant's` card present
            transactions. Use `gateway` only to enable a merchantto accept card present
            transactions.
        processor:
          $ref: '#/components/schemas/ProcessorRequest'
        tags:
          $ref: '#/components/schemas/Tags'
      required:
        - processor
    UpdateMerchantRequest:
      type: object
      title: MerchantUpdate
      x-examples: {}
      properties:
        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.
        convenience_charges_enabled:
          type: boolean
          description: Set to **true** if you want to enable the `Merchant` to accept
            convenience fees and/or service fees.
        creating_transfer_from_report_enabled:
          type: boolean
          description: Set to **true** to automatically create `Transfers` once settlement
            reports get generated.
        fee_ready_to_settle_upon:
          type: string
          description: Details how the `Merchant` settles fees.
        gross_settlement_enabled:
          type: boolean
          description: Set to **true** to enable gross settlements.
        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**.
        merchant_name:
          type: string
          description: The legal name saved in the `Merchant` resource.
        processing_enabled:
          type: boolean
          description: Details if transaction processing is enabled for the `Merchant`.
        ready_to_settle_upon:
          type: string
          description: Details how `Authorizations` captured by the `Merchant` are
            settled.
        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 processing is enabled for the `Merchant`.
        settlement_funding_identifier:
          type: string
          description: Include addtional information (like the MID) when submitting
            funding `Tranfers` to processors.
        tags:
          $ref: '#/components/schemas/Tags'
    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'
    PaymentInstrument:
      description: ''
      type: object
      properties:
        id:
          $ref: '#/components/schemas/Id'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        address:
          $ref: '#/components/schemas/Address'
        address_verification:
          type: string
          description: "Additional address information that\u2019s required to verify\
            \ the identity of the merchant."
          enum:
            - POSTAL_CODE_AND_STREET_MATCH
            - STREET_MATCH
            - POSTAL_CODE_MATCH
            - NO_ADDRESS
            - NO_MATCH
            - NOT_SUPPORTED
            - UNKNOWN
        application:
          type: string
          description: The ID of the resource.
        bin:
          type: string
          description: Bank Identification number for the `Payment Instrument`.
        brand:
          type: string
          description: The `brand` of the card saved in the `Payment Instrument`.
        card_name:
          type: string
          description: A custom name you can include to identify the card being used
            (e.g. **Business Card**).
          nullable: true
        card_type:
          type: string
          description: The type of payment card saved in the `Payment Instrument`.
        currency:
          $ref: '#/components/schemas/Currency'
        expiration_month:
          type: integer
          description: Expiration month (e.g. 12 for December).
          minimum: 1
          maximum: 12
        expiration_year:
          type: integer
          description: 4-digit expiration year.
          minimum: 1
        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/Id'
        instrument_type:
          type: string
          enum:
            - BANK_ACCOUNT
            - TOKEN
            - APPLE_PAY
            - VIRTUAL
            - PAYMENT_CARD_PRESENT
            - GOOGLE_PAY
            - VANTIV_OMNI_TOKEN
            - SWIPED_PAYMENT_CARD
            - PAYMENT_CARD
          description: The type of `Payment Instrument`.
        last_four:
          type: string
          description: 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
        online_gambing_block_indicator:
          type: string
          description: Detailes 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
          description: Details the results of the Card Verification Code check.
          enum:
            - MATCHED
            - UNKNOWN
            - UNMATCHED
        tags:
          $ref: '#/components/schemas/Tags'
        type:
          type: string
          enum:
            - BANK_ACCOUNT
            - TOKEN
            - APPLE_PAY
            - VIRTUAL
            - PAYMENT_CARD_PRESENT
            - GOOGLE_PAY
            - VANTIV_OMNI_TOKEN
            - SWIPED_PAYMENT_CARD
            - PAYMENT_CARD
          description: Type of `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 resource that was used in the request.
              properties:
                href:
                  type: string
            authorizations:
              type: object
              description: Link to the `Authorizations` created under the resource.
              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
            application:
              type: object
              description: Link to the `Application` the request was made under.
              properties:
                href:
                  type: string
            identity:
              type: object
              description: Link to the `Identity` the request was made under.
              properties:
                href:
                  type: string
        account_type:
          type: string
          enum:
            - CHECKING
            - SAVINGS
            - CORPORATE
            - CORP_SAVINGS
          description: Details what kind of **BANK_ACCOUNT** is being used.
        bank_account_validation_check:
          type: string
          enum:
            - NOT_ATTEMPTED
            - INCONCLUSIVE
            - INVALID
            - VALID
          default: NOT_ATTEMPTED
          description: Details the results of the bank account validation check if
            `attempt_bank_account_validation_check` is set to **true**.
        bank_code:
          type: string
          description: The routing number of the bank account.
        country:
          $ref: '#/components/schemas/Country'
        masked_account_number:
          type: string
          description: The last 4 digits of the account number used to create the
            `Payment Instrument`.
          nullable: true
    CreatePaymentInstrumentRequest:
      x-examples: {}
      title: ''
      type: object
      properties:
        address:
          type: object
          description: The address of the bank account or card owner.
          properties:
            city:
              type: string
              description: City (max 20 characters).
            region:
              type: string
              description: 2-letter State code.
            postal_code:
              type: string
              description: Zip or Postal code (max 7 characters).
            line1:
              type: string
              description: First line of the address (max 35 characters).
            country:
              type: string
              description: 3 Letter country code (e.g. USA).
        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:
          $ref: '#/components/schemas/Id'
        name:
          type: string
          description: The name of the bank account or card owner.
        number:
          type: string
          description: The card or bank account number (no dashes in between numbers).
        security_code:
          type: string
          description: The 3-4 digit security code of the card (i.e. CVV code).
        tags:
          $ref: '#/components/schemas/Tags'
        type:
          type: string
          enum:
            - BANK_ACCOUNT
            - TOKEN
            - APPLE_PAY
            - GOOGLE_PAY
            - PAYMENT_CARD
          description: Type of `Payment Instrument`.
        third_party_token:
          type: string
          description: Stringified token provided by Google. Required to process Google
            Pay transactions.
        account_number:
          type: string
          description: The bank account number (no dashes in between numbers).
        account_type:
          type: string
          description: The type of bank account.
          enum:
            - CHECKING
            - SAVINGS
            - CORPORATE
            - CORP_SAVINGS
        attempt_bank_account_validation_check:
          type: boolean
          description: Set to **true** if you want to request a bank account validation.
            Default value is **false**.
          default: false
        bank_code:
          type: string
          description: The routing number of the bank account.
        country:
          type: string
          description: 3 Letter country code (e.g. USA).
        token:
          type: string
          description: ID of the `Token` that was returned from the tokenization client
            or hosted fields
        merchant_identity:
          type: string
          description: The `id` of the identity used when registering the business
            with Google Pay through our registration API.
    UpdatePaymentInstrumentRequest:
      x-examples: {}
      title: ''
      description: ''
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/Tags'
    PaymentInstrumentToken:
      type: object
      title: Payment instrument
      properties:
        tags:
          $ref: '#/components/schemas/Tags'
        type:
          type: string
          enum:
            - TOKEN
        id:
          $ref: '#/components/schemas/Id'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        application:
          type: string
          description: The ID of the resource.
        currency:
          $ref: '#/components/schemas/Currency'
        fingerprint:
          type: string
          example: FPRxxxxxxxxxxxxxxxxx
        identity:
          $ref: '#/components/schemas/Id'
        instrument_type:
          type: string
          enum:
            - TOKEN
        payload_type:
          type: string
          enum:
            - SOURCE
            - DESTINATION
        _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
            authorizations:
              type: object
              properties:
                href:
                  type: string
            identity:
              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
            verifications:
              type: object
              description: Link to the `Verification` the request was made under.
              properties:
                href:
                  type: string
    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'
    PaymentInstrumentsList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Payment Instrument` objects.
          properties:
            payment_instruments:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Payment Instrument` objects.'
              items:
                $ref: '#/components/schemas/PaymentInstrument'
        _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/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        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\u2019s 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\u2019s county."
              nullable: true
            default_sender_name:
              type: string
              description: "The sender\u2019s 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\u2019s 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).
        default_merchant_profile:
          $ref: '#/components/schemas/Id'
        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 avalible in.
              items:
                $ref: '#/components/schemas/Country'
            business_application_id:
              $ref: '#/components/schemas/Id'
            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:
          $ref: '#/components/schemas/Id'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        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:
          $ref: '#/components/schemas/Id'
        merchant_id:
          $ref: '#/components/schemas/Id'
        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
        processor:
          type: string
          description: Name of the `Settlement` processor.
        status:
          type: string
          enum:
            - APPROVED
            - AWAITING_APPROVAL
            - CANCELLED
            - PENDING
          description: The status of the `Settlement`. Available values include:<ul><li>**PENDING**<li>**AWAITING_APPROVAL**<li>**APPROVED**.</ul>
            Merchants only receive payouts when `Settlements` are **APPROVED** and
            receive the resulting funding `Transfer` . For more information, see [Payouts](/guides/payouts/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 \n(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'
    Transfer:
      type: object
      description: ''
      x-examples: {}
      properties:
        id:
          type: string
          description: The ID of the `Transfer` resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        additional_buyer_charges:
          $ref: '#/components/schemas/AdditionalBuyerCharges'
        amount:
          $ref: '#/components/schemas/Amount'
        application:
          $ref: '#/components/schemas/Id'
        card_present_details:
          $ref: '#/components/schemas/CardPresentDetails'
        currency:
          $ref: '#/components/schemas/Currency'
        destination:
          type: string
          description: The ID of the destination.
          nullable: true
        device:
          $ref: '#/components/schemas/Id'
        externally_funded:
          type: string
          description: Details if the `Transfer` will be settled externally by card
            processors.
        failure_code:
          $ref: '#/components/schemas/FailureCode'
        failure_message:
          $ref: '#/components/schemas/FailureMessage'
        fee:
          type: integer
          format: int64
          description: The 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`).
        fee_type:
          $ref: '#/components/schemas/FeeType'
        idempotency_id:
          $ref: '#/components/schemas/IdempotencyId'
        merchant_identity:
          $ref: '#/components/schemas/Id'
        messages:
          $ref: '#/components/schemas/Messages'
        raw:
          $ref: '#/components/schemas/Raw'
        ready_to_settle_at:
          type: string
          format: date-time
          description: Timestamp of when the `Transfer` is ready to be settled at.
          nullable: true
        source:
          $ref: '#/components/schemas/Id'
        state:
          type: string
          enum:
            - CANCELED
            - PENDING
            - FAILED
            - SUCCEEDED
            - UNKNOWN
          description: The stauts of the `Transfer`.
        statement_descriptor:
          type: string
          description: The description of the merchant that appears on the buyer's
            bank or card statement.
          nullable: true
        subtype:
          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
            - SYSTEM
          description: Additional information describing the `payment_type`.
        tags:
          $ref: '#/components/schemas/Tags'
        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
          enum:
            - DEBIT
            - CREDIT
            - REVERSAL
            - FEE
            - ADJUSTMENT
            - DISPUTE
            - RESERVE
            - SETTLEMENT
            - UNKNOWN
          description: Type of `Transfer`.
        _links:
          type: object
          additionalProperties: true
          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
            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
            reversals:
              type: object
              description: Link to the `reversals` associated with the `Transfer`.
              properties:
                href:
                  type: string
            self:
              type: object
              description: Link to the resource that was used in the request.
              properties:
                href:
                  type: string
            parent:
              type: object
              description: Link to the original resource that was used in the request.
              properties:
                href:
                  type: string
            source:
              type: object
              description: Link to the `Payment Instrument` the `Transfer` was created
                under.
              properties:
                href:
                  type: string
    CreateTransferRequest:
      type: object
      title: CreateTransferRequest
      description: Create a `transfer`.
      properties:
        additional_buyer_charges:
          $ref: '#/components/schemas/AdditionalBuyerCharges'
        additional_purchase_data:
          $ref: '#/components/schemas/AdditionalPurchaseData'
        adjustment_request:
          type: boolean
          description: Details if the `transfer` was created to adjust funds.
          nullable: true
        amount:
          type: integer
          format: int64
          description: The total amount that will be debited in cents (e.g. 100 cents
            to debit $1.00).
        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 activated device.
          nullable: true
        device_configuration:
          $ref: '#/components/schemas/ConfigurationDetails'
        fee:
          type: integer
          format: int64
          description: The 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`).
        fraud_session_id:
          $ref: '#/components/schemas/FraudSessionID'
        idempotency_id:
          type: string
          description: A randomly generated value that'll be associated with the request.
          nullable: true
        merchant:
          type: string
          description: ID of the `Merchant` the `Transfer` was created under.
          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'll be performed in the transaction.
          nullable: true
        payment_instrument:
          type: object
          title: CardPresentInstrumentForm
          description: 'Details the `Payment Instrument` that the `Transfer` debits
            or credits. '
          properties:
            type:
              type: string
              enum:
                - BANK_ACCOUNT
                - VIRTUAL
                - TOKEN
                - SWIPED_PAYMENT_CARD
                - PAYMENT_CARD_PRESENT
                - PAYMENT_CARD
                - VANTIV_OMNI_TOKEN
              description: The type of `Payment Instrument`.
            available_account_type:
              type: string
              enum:
                - BALANCE
                - LEDGERED
            emv_data:
              type: string
              description: Encrypted card data used to process the transaction.
            emv_data_key_serial_number:
              type: string
              description: Encrypted EMV card data about the key serial number used
                to process the transaction.
            encrypted_emv_data:
              type: string
              description: Encrypted EMV card data. Required if using an encrypted
                device.
            encrypted_emv_format:
              type: integer
              format: int64
              description: EMV encryption format provided from integrated encryption
                devices (defaults to **0**).
            expiration_month:
              type: integer
              format: int64
              description: Expiration month of the `Payment Instrument` (e.g. 12 for
                December).
            expiration_year:
              type: integer
              format: int64
              description: 4-digit expiration year of the `Payment Instrument`.
            first_name:
              type: string
              description: The first name of the `Payment Instrument` owner.
            last_name:
              type: string
              description: The last name of the `Payment Instrument` owner.
            name:
              type: object
              title: Name
              properties:
                first_name:
                  type: string
                  description: The first name of the `Payment Instrument` owner.
                full_name:
                  type: string
                  description: The full name of the `Payment Instrument` owner.
                last_name:
                  type: string
                  description: The last name of the `Payment Instrument` owner.
                value:
                  type: string
            number:
              type: string
              description: Primary card account number (no dashes in between numbers).
        processor:
          type: string
          description: Name of the transaction processor.
        source:
          type: string
          description: ID of the `Payment Instrument` where funds get debited.
        statement_descriptor:
          type: string
          description: The description of the transaction that appears on the buyer's
            bank or card statement.
          nullable: true
        tags:
          $ref: '#/components/schemas/Tags'
        3d_secure_authentication:
          type: object
          description: The 3D secure information for an authorization.
          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.
            cardholder_ip_address:
              type: string
              description: Only required for American Express cards. Format is nnn.nnn.nnn.nnn
            electronic_commerce_indicator:
              type: string
              description: 'AUTHENTICATED: Approved by 3D Secure Vendor; ATTEMPTED:
                Issuer or cardholder does not support 3D Secure'
            transaction_id:
              type: string
              description: Only valid for Visa transactions
      required:
        - amount
        - currency
    TransfersList:
      type: object
      description: ''
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Transfer` objects.
          properties:
            transfers:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Transfer` objects.'
              items:
                $ref: '#/components/schemas/Transfer'
        _links:
          $ref: '#/components/schemas/ListLinks'
    User:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `User` object.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        enabled:
          type: boolean
          description: Details if 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
        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`](#tag/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
    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'
    Verification:
      type: object
      properties:
        id:
          type: string
          description: The ID of the `Verification` attempt (begins with `VIXXX`).
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        application:
          type: string
          description: ID of the `Application` the `Merchant` was created under.
        identity:
          type: string
          description: ID of the `Identity` that created the `Merchant`.
          nullable: true
        merchant:
          type: string
          description: ID of the `Merchant` resource.
          nullable: true
        merchant_identity:
          type: string
          description: ID of the `Identity` associated with the `Merchant`.
          nullable: true
        messages:
          type: array
          description: Provides additional details about the verification (e.g why
            it failed). This field is usually **null**.
          items:
            type: object
        payment_instrument:
          type: string
          description: The `Payment Instrument` that'll be used to settle the `Merchant's`
            processed funds.
          nullable: true
        processor:
          type: string
          description: Name of the verification processor.
        raw:
          $ref: '#/components/schemas/Raw'
        state:
          type: string
          description: The status of the `Verification` request.
          enum:
            - PENDING
            - SUCCEEDED
            - FAILED
        tags:
          $ref: '#/components/schemas/Tags'
        trace_id:
          type: string
          description: Trace ID of the `Verification`. The processor sends back the
            `trace_id` so you can track the verification end-to-end.
        _links:
          type: object
          additionalProperties: true
          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
            merchant:
              type: object
              description: Link to the `Merchant` that was used in the request.
              properties:
                href:
                  type: string
            application:
              type: object
              description: Link to the `Application` that was used in the request.
              properties:
                href:
                  type: string
    CreateVerificationRequest:
      type: object
      title: CreateVerificationRequest
      x-examples: {}
      properties:
        identity:
          type: string
          description: ID of the `Identity` resource associated with the `Merchant`.
        merchant:
          type: string
          description: The ID of the `Merchant`.
        processor:
          $ref: '#/components/schemas/ProcessorRequest'
        tags:
          $ref: '#/components/schemas/Tags'
    VerificationsList:
      type: object
      x-examples:
        example-1:
          _embedded:
            verifications:
              - id: VIukL5raxiXaa4LqhUwvGxA3
                application: APgPDQrLD52TYvqazjHJJchM
                tags: {}
                messages: []
                raw: RawDummyMerchantUnderwriteResult
                processor: DUMMY_V1
                state: SUCCEEDED
                created_at: '2022-03-23T04:46:22.10Z'
                updated_at: '2022-03-23T04:47:01.79Z'
                trace_id: 2b727689-d48e-4b8a-9b86-5fc88ee519b0
                payment_instrument: null
                merchant: MUucec6fHeaWo3VHYoSkUySM
                identity: null
                merchant_identity: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/verifications/VIukL5raxiXaa4LqhUwvGxA3
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant:
                    href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM
              - id: VIdikDHXv7x8nWyJg8JZemGx
                application: APgPDQrLD52TYvqazjHJJchM
                tags:
                  key_2: value_2
                messages: []
                raw: RawDummyMerchantUnderwriteResult
                processor: DUMMY_V1
                state: SUCCEEDED
                created_at: '2022-01-27T07:36:58.21Z'
                updated_at: '2022-01-27T07:36:58.46Z'
                trace_id: 86e00b16-8b94-44fb-bb0f-d5c32c887133
                payment_instrument: null
                merchant: MUucec6fHeaWo3VHYoSkUySM
                identity: null
                merchant_identity: null
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/verifications/VIdikDHXv7x8nWyJg8JZemGx
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant:
                    href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM
          _links:
            self:
              href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM/verifications?offset=0&limit=20&sort=created_at,desc&sort=id,desc
          page:
            limit: 20
            next_cursor: VIdikDHXv7x8nWyJg8JZemGx
      properties:
        _embedded:
          type: object
          description: List of `Verifications`.
          properties:
            verifications:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Verification` resources.'
              items:
                $ref: '#/components/schemas/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/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        application:
          type: string
          description: The ID of the `Application` resource the `Webhook` was created
            under.
        authentication:
          type: object
          description: The authentication settings 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><strong>true</strong>:
            Events are being sent to the `url`.<li><strong>false</strong>: Events
            are not being sent.'
        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'
    UpdateAuthorizationRequest:
      title: AuthorizationUpdate
      type: object
      properties:
        additional_purchase_data:
          $ref: '#/components/schemas/AdditionalPurchaseData'
        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`.
        fee:
          type: integer
          format: int64
          description: The 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`).
        tags:
          $ref: '#/components/schemas/Tags'
        void_me:
          type: boolean
          description: Set to **True** to void the `Authorization`.
    Tags:
      type: object
      title: tags
      description: Key value pair for annotating custom meta data (e.g. order numbers).
      additionalProperties:
        type: string
    UpdateTransferRequest:
      title: TransferUpdate
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/Tags'
    CreateReversalRequest:
      type: object
      title: Refund a Transfer
      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`.
        tags:
          $ref: '#/components/schemas/Tags'
        device:
          type: string
          description: The ID of the `Device` used to process the transaction.
        amount:
          type: integer
          description: The amount of the sale.
        currency:
          $ref: '#/components/schemas/Currency'
        operation_key:
          type: string
          description: Describes the operation to be performed in the transaction.
            Use **CARD_PRESENT_UNREFERENCED_REFUND** for refunds where the card isn't
            avalible.
          example: CARD_PRESENT_UNREFERENCED_REFUND
          nullable: true
    CreateWebhookRequest:
      title: WebhookCreate
      type: object
      properties:
        authentication:
          type: object
          description: The authentication settings 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. Null if bearer
                is not being used.
              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.
        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'
    CreateSubscriptionScheduleRequest:
      description: ''
      type: object
      x-examples: {}
      title: ''
      properties:
        fixed_time_interval_offset:
          type: object
          description: Specifies when the Fee is charged
          required:
            - hourly_interval
            - interval_count
          nullable: true
          properties:
            hourly_interval:
              type: integer
              description: Hourly increments between recurring charges
            interval_count:
              type: integer
              description: Number of recurring charges
        line_item_type:
          type: string
          minLength: 1
          description: Subscription Schedule type. For subscriptions, the type is
            **FEE**.
          enum:
            - FEE
        nickname:
          $ref: '#/components/schemas/NickName'
        period_offset:
          type: object
          description: Specifies when the Fee is charged. This field is null for **FIXED_TIME_INTERVAL**
            subscription schedules
          nullable: true
          properties:
            day:
              type: integer
              description: Specifies the day when the Subscription Schedule starts.
            month:
              type: integer
              description: Specifies the month when the Subscription Schedule starts.
                If the Subscription Schedule is **PERIODIC_MONTHLY**, the month field
                can be left null
              nullable: true
        subscription_type:
          type: string
          enum:
            - FIXED_TIME_INTERVAL
            - PERIODIC_MONTHLY
            - PERIODIC_YEARLY
          description: 'Specify the type of schedule:

            - **FIXED\_TIME\_INTERVAL**: Charges a Merchant on a fixed hourly interval.

            - **PERIODIC\_MONTHLY**: Charges a Merchant once a month on a specific
            day.

            - **PERIODIC\_YEARLY**: Charges a Merchant once a year on a specific day
            and month.'
          example: FIXED_TIME_INTERVAL
        tags:
          $ref: '#/components/schemas/Tags'
      required:
        - line_item_type
        - nickname
        - subscription_type
    UpdateSubscriptionScheduleRequest:
      title: SubscriptionScheduleUpdate
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/Tags'
    SubscriptionSchedule:
      description: ''
      type: object
      x-examples: {}
      properties:
        id:
          type: string
          minLength: 1
          description: ID of the `Subscription Schedule`.
          example: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        created_by:
          type: string
          minLength: 1
          description: '`User` ID who created the schedule.'
        fixed_time_interval_offset:
          type: object
          description: Specifies when the `Fee` is charged.
          nullable: true
          properties:
            hourly_interval:
              type: integer
              description: Hourly increments between recurring charges.
            interval_count:
              type: integer
              description: Number of recurring charges.
        line_item_type:
          type: string
          minLength: 1
          description: '`Subscription Schedule` type. For subscriptions, the type
            is **FEE**.'
          enum:
            - FEE
        nickname:
          $ref: '#/components/schemas/NickName'
        period_offset:
          type: object
          description: Specifies when the `Fee` is charged. This field is **null**
            for **FIXED_TIME_INTERVAL** `Subscription Schedules`.
          nullable: true
          properties:
            day:
              type: integer
              description: Specifies the day when the `Subscription Schedule` starts.
            month:
              type: integer
              description: Specifies the month when the `Subscription Schedule` starts.
                If the `Subscription Schedule` is **PERIODIC_MONTHLY**, the month
                field can be left **null**.
              nullable: true
        subscription_type:
          type: string
          minLength: 1
          enum:
            - PERIODIC_MONTHLY
            - PERIODIC_YEARLY
            - FIXED_TIME_INTERVAL
          description: '`Subscription Schedule` type.'
        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
            amounts:
              type: object
              description: Link to the `subscription_amounts` related to the request.
              properties:
                href:
                  type: string
                  minLength: 1
    SubscriptionSchedulesList:
      title: SubscriptionSchedulesList
      type: object
      x-examples: {}
      description: '`Subscription Schedule` resource.'
      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 `subscription_schedule` objects.
          properties:
            subscription_schedules:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`subscription_schedule` objects.'
              items:
                $ref: '#/components/schemas/SubscriptionSchedule'
        _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
              properties:
                href:
                  type: string
            next:
              type: object
              properties:
                href:
                  type: string
            last:
              type: object
              properties:
                href:
                  type: string
    SubscriptionAmount:
      description: ''
      type: object
      x-examples:
        example-1:
          id: SUBAMOUNT_uKg6g5SL5mbAUcbt7PkDDq
          created_at: '2022-01-27T07:44:08.16Z'
          updated_at: '2022-01-27T07:44:08.16Z'
          amount_type: FEE
          created_by: UStxEci4vXxGDWLQhNvao7YY
          fee_amount_data:
            amount: 2500
            currency: USD
            label: POS_INSTALLMENT_FEE
          nickname: POS_INSTALLMENT_FEE
          subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
          tags:
            order_number: '124'
          _links:
            self:
              href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_uKg6g5SL5mbAUcbt7PkDDq
            schedule:
              href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
      title: ''
      properties:
        id:
          type: string
          minLength: 1
          description: ID of the `Subscription Amount`.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        amount_type:
          type: string
          enum:
            - FEE
          example: FEE
          description: '`Subscription Amount` type. The only type supported as of
            now is **FEE**.'
        created_by:
          type: string
          minLength: 1
          description: The ID of the `User` that created the `Subscription Amount`.
        fee_amount_data:
          type: object
          description: The amount and currency of this `Subsciption Amount`.
          properties:
            amount:
              type: integer
              description: A positive integer in cents representing how much to charge
                on a recurring basis
            currency:
              $ref: '#/components/schemas/Currency'
            label:
              type: string
              minLength: 1
              description: The display name of the `Subscription Amount` that can
                be used for filtering purposes.
        nickname:
          $ref: '#/components/schemas/NickName'
        subscription_schedule:
          type: string
          minLength: 1
          description: ID of the `Subscription Schedule`.
        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
            schedule:
              type: object
              description: Link to the `subscription_schedules` realted to the request.
              properties:
                href:
                  type: string
                  minLength: 1
    CreateSubscriptionAmountRequest:
      description: ''
      type: object
      x-examples:
        example-1:
          amount_type: string
          fee_amount_data:
            currency: AED
            amount: 0
            label: string
          nickname: super important thing
          tags:
            property1: string
            property2: string
      properties:
        amount_type:
          type: string
          minLength: 1
          description: '`Subscription Amount` type. For subscriptions, the type is
            **FEE**.'
        fee_amount_data:
          type: object
          description: The amount and currency of this `Subsciption Amount`.
          required:
            - amount
            - currency
          properties:
            amount:
              type: integer
              description: A positive integer in cents representing how much to charge
                on a recurring basis.
            currency:
              $ref: '#/components/schemas/Currency'
            label:
              type: string
              minLength: 1
              description: The display name of the `Subscirption Amount` that can
                be used for filtering purposes.
        nickname:
          $ref: '#/components/schemas/NickName'
        tags:
          $ref: '#/components/schemas/Tags'
      required:
        - amount_type
        - fee_amount_data
    UpdateSubscriptionAmountRequest:
      $ref: '#/components/schemas/CreateSubscriptionAmountRequest'
    SubscriptionAmountList:
      title: SubscriptionAmountList
      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 `subscription_amount` objects.
          properties:
            subscription_amounts:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`subscription_amount` objects.'
              items:
                $ref: '#/components/schemas/SubscriptionAmount'
        _links:
          $ref: '#/components/schemas/ListLinks'
    SubscriptionEnrollment:
      description: ''
      type: object
      x-examples:
        example-1:
          id: SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV
          created_at: '2022-01-27T07:44:09.08Z'
          updated_at: '2022-01-27T07:44:09.08Z'
          created_by: UStxEci4vXxGDWLQhNvao7YY
          ended_at: null
          merchant: MUucec6fHeaWo3VHYoSkUySM
          nickname: Security Fee
          started_at: '2022-11-11T16:50:59.89Z'
          subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
          tags:
            enrollment_info: Security Fee Enrollment
          _links:
            self:
              href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV
            merchant:
              href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM
            schedule:
              href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
            amounts:
              href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts
      properties:
        id:
          type: string
          minLength: 1
          description: ID of the `subscription_enrollment`.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        created_by:
          type: string
          minLength: 1
          description: ID of the `User` who created the `subscription_enrollment`.
        ended_at:
          type: string
          description: When the `subscription_enrollment` will end in **DateTime**
            format.
          nullable: true
        merchant:
          type: string
          minLength: 1
          description: ID of the `Merchant` resource.
        nickname:
          $ref: '#/components/schemas/NickName'
        started_at:
          type: string
          minLength: 1
          description: When the `subscription_enrollment` will begin in **DateTime**
            format.
        subscription_schedule:
          type: string
          minLength: 1
          description: ID of the `Subscription Schedule`.
        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
            merchant:
              type: object
              description: Link to the `Merhcant` resource that was used in the request.
              properties:
                href:
                  type: string
                  minLength: 1
            schedule:
              type: object
              description: Link to the `subscription_schedules` used in the request.
              properties:
                href:
                  type: string
                  minLength: 1
            amounts:
              type: object
              description: Link to the `subscription_amounts` used in the request.
              properties:
                href:
                  type: string
                  minLength: 1
    CreateSubscriptionEnrollmentRequest:
      description: ''
      type: object
      x-examples:
        example-1:
          merchant: MUucec6fHeaWo3VHYoSkUySM
          started_at: '2022-11-11T16:50:59.891Z'
          nickname: Security Fee
          tags:
            enrollment_info: Security Fee Enrollment
      properties:
        ended_at:
          type: string
          minLength: 1
          description: When the `subscription_enrollment` will end in **DateTime**
            format. If left **null**, the Fee will continue in perpetuity and won't
            end.
          nullable: true
        merchant:
          minLength: 1
          type: string
          description: ID of the `Merchant` resource.
        nickname:
          type: string
          minLength: 1
          description: Human readable name.
        started_at:
          type: string
          minLength: 1
          description: When the `subscription_enrollment` will begin in **DateTime**
            format. The start date must be a future date.
        tags:
          $ref: '#/components/schemas/Tags'
      required:
        - merchant
        - nickname
        - started_at
    UpdateSubscriptionEnrollmentRequest:
      title: SubscriptionEnrollmentUpdate
      type: object
      description: ID of the `subscription_enrollment`.
      properties:
        id:
          type: string
          description: ID of the `subscription_enrollment`.
    SubscriptionEnrollmentList:
      title: SubscriptionEnrollmentList
      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 `Subscription Enrollment` resources.
          properties:
            subscription_enrollments:
              type: array
              minItems: 0
              uniqueItems: true
              description: '`Subscription Enrollment` resources.'
              items:
                $ref: '#/components/schemas/SubscriptionEnrollment'
        _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
    NickName:
      type: string
      title: NickName
      description: Human readable name.
      example: super important thing
    CreatedAt:
      type: string
      title: CreatedAt
      format: date-time
      description: Timestamp of when the object was created.
    UpdatedAt:
      type: string
      title: UpdatedAt
      format: date-time
      description: Timestamp of when the object was last updated.
    CreateFeeProfileRequest:
      title: FeeProfileCreate
      type: object
      properties:
        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 merchant
            for processing an echeck (also called ACH payments) credit return.
          nullable: true
        ach_debit_return_fixed_fee:
          type: integer
          description: A fixed amount in cents that will be charged to the merchant
            for processing an echeck (also called ACH payment) debit return.
          nullable: true
        ach_fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual `Transfer`.
        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_interchange:
          type: boolean
          description: Set to **True** to incur interchange fees for American Express
            `Transfers`.
          nullable: true
        american_express_fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual American Express
            `Transfer`.
          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
        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:
          type: string
          description: The ID of the resource.
        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%).
        charge_interchange:
          type: boolean
          description: Set to **True** to incur interchange fees for card-based `Transfers`.
        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: Assessment 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_interchange:
          type: boolean
          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_fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual Discover `Transfer`.
          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_network_authorization_fixed_fee:
          type: integer
          description: This fee applies to all Discover network `authorizations` and
            replaces the previously assessed Data Transmission.
          nullable: true
        dispute_fixed_fee:
          type: integer
          description: Applied when a `dispute` is created or updated to a **PENDING**
            state.
          nullable: true
        dispute_inquiry_fixed_fee:
          type: integer
          description: Applied when a `dispute` is created or updated to a **INQUIRY**
            state.
          nullable: true
        externally_funded_basis_points:
          type: integer
          description: Percentage-based fee incurred against the full amount of each
            `Transfer` that's card-based and externally funded. Calculated as one
            hundredth of one percent (1 basis point = .0001 or .01%).
          nullable: true
        externally_funded_fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual `Transfer` that's
            card-based and externally funded.
          nullable: true
        fixed_fee:
          type: integer
          description: Fee in cents incurred for each individual card-based `Transfer`.
        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: boolean
          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: "The fee is assessed on a business\u2019s gross MasterCard\
            \ processing volume. This fee varies per acquirer based on MasterCard\u2019\
            s assessed charge as it\u2019s distributed across the acquirer\u2019s\
            \ 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_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
        qualified_tiers:
          type: object
          description: The top of the qualified tier tree.
          nullable: true
        rounding_mode:
          type: string
          enum:
            - TRANSACTION
            - AGGREGATE
          description: <ul><li>Include <strong>AGGREGATE</strong> if you want to round
            after the settlement calculation.<li>By default, rounding happens before
            the sum of the settlement calculation (i.e. round each fee transfer)</ul>
        tags:
          $ref: '#/components/schemas/Tags'
        visa_acquirer_processing_fixed_fee:
          type: integer
          description: Applied 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_assessments_basis_points:
          type: integer
          description: Applies to all Visa credit transactions.
          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_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\u2019\
            s network for settlement."
          nullable: true
      required:
        - application
    CreateProcessorRequest:
      description: ''
      type: object
      x-examples: {}
      properties:
        config:
          type: object
          description: Configure the details of how a `Processor` handles transactions.
          properties:
            canDebitBankAccount:
              type: boolean
              description: Details if a `Processor` can debit bank accounts.
        tags:
          $ref: '#/components/schemas/Tags'
        type:
          type: string
          minLength: 1
          description: The type of processor. Use **DUMMY_V1** for sandbox.
      required:
        - type
      title: ''
    ProcessorRequest:
      description: 'Set the acquiring processor. Avalible values include: <ul><li><strong>DUMMY_V1</strong></li><li><strong>LITLE_V1</strong></li><li><strong>MASTERCARD_V1</strong></li><li><strong>VISA_V1</strong></li><li><strong>NMI_V1</strong></li><li><strong>VANTIV_V1</strong></li></ul>Use
        <strong>DUMMY_V1</strong> or  <strong>null</strong> to use your sandbox. For
        more details on which processor to use, reach out to your Finix point of contact
        or email <a href="/guides/getting-started/support-at-finix/">Finix Support</a>.'
      type: string
      x-examples: {}
      title: ''
      nullable: true
    LogRef:
      title: LogRef
      type: object
      properties:
        logref:
          type: string
    Address:
      title: Address
      type: object
      description: Principal's personal home address. This field is used for `Identity`
        verification purposes.
      nullable: true
      properties:
        city:
          type: string
          description: City (max 20 characters).
          nullable: true
        country:
          $ref: '#/components/schemas/Country'
        line1:
          type: string
          description: First line of the address (max 35 characters).
          nullable: true
        line2:
          type: string
          description: Second line of the address (max 35 characters).
          nullable: true
        postal_code:
          type: string
          description: Zip or Postal code (max 7 characters).
          nullable: true
        region:
          type: string
          description: 2-letter State code.
          nullable: true
    Country:
      title: 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
      description: "The sender\u2019s country."
      nullable: true
    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
    Id:
      title: Id
      type: string
      description: The ID of the resource.
      x-examples:
        example-1: string
      nullable: true
    Amount:
      type: integer
      title: Amount
      description: The total amount that will be debited in cents (e.g. 100 cents
        to debit $1.00).
      format: int64
    FeeType:
      title: FeeType
      type: string
      enum:
        - APPLICATION_FEE
        - ACH_BASIS_POINTS
        - ACH_FIXED
        - CARD_BASIS_POINTS
        - CARD_FIXED
        - CARD_INTERCHANGE
        - VISA_BASIS_POINTS
        - VISA_FIXED
        - VISA_INTERCHANGE
        - VISA_ASSESSMENT_BASIS_POINTS
        - VISA_ACQUIRER_PROCESSING_FIXED
        - VISA_CREDIT_VOUCHER_FIXED
        - VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED
        - VISA_BASE_II_CREDIT_VOUCHER_FIXED
        - VISA_KILOBYTE_ACCESS_FIXED
        - DISCOVER_BASIS_POINTS
        - DISCOVER_FIXED
        - DISCOVER_INTERCHANGE
        - DISCOVER_ASSESSMENT_BASIS_POINTS
        - DISCOVER_DATA_USAGE_FIXED
        - DISCOVER_NETWORK_AUTHORIZATION_FIXED
        - DINERS_CLUB_BASIS_POINTS
        - DINERS_CLUB_FIXED
        - DINERS_CLUB_INTERCHANGE
        - MASTERCARD_BASIS_POINTS
        - MASTERCARD_FIXED
        - MASTERCARD_INTERCHANGE
        - MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS
        - MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS
        - MASTERCARD_ACQUIRER_FEE_BASIS_POINTS
        - JCB_BASIS_POINTS
        - JCB_FIXED
        - JCB_INTERCHANGE
        - AMERICAN_EXPRESS_BASIS_POINTS
        - AMERICAN_EXPRESS_FIXED
        - AMERICAN_EXPRESS_INTERCHANGE
        - AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS
        - DISPUTE_INQUIRY_FIXED_FEE
        - DISPUTE_FIXED_FEE
        - QUALIFIED_TIER_BASIS_POINTS_FEE
        - QUALIFIED_TIER_FIXED_FEE
        - CUSTOM
        - ACH_DEBIT_RETURN_FIXED_FEE
        - ACH_CREDIT_RETURN_FIXED_FEE
        - ANCILLARY_FIXED_FEE_PRIMARY
        - ANCILLARY_FIXED_FEE_SECONDARY
        - SETTLEMENT_V2_TRANSFER
      description: The type of fee.
    Raw:
      title: Raw
      description: Raw response from the processor.
      x-examples: {}
      type: object
      nullable: true
    IdempotencyId:
      title: IdempotencyId
      type: string
      description: ID to [idempotently](#section/Idempotency-Requests) identifty the
        transfer.
      nullable: true
    Messages:
      title: Messages
      type: array
      items:
        type: string
      description: Message field that provides additional details. This field is typically
        **null**.
    CreateBalanceTransferRequest:
      title: CreateBalanceTransferRequest
      x-stoplight:
        id: h8wur5bbt1lx3
      type: object
      description: Create a `balance_transfer` resource.
      x-examples:
        example-1:
          description: string
          tags:
            property1: string
            property2: string
          destination: FOR_BENEFIT_OF_ACCOUNT
          currency: AED
          amount: 0
          source: OPERATING_ACCOUNT
          processor_type: LITLE_V1
      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 avalible 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/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        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/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        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
    CreateFileRequest:
      type: object
      x-examples: {}
      properties:
        display_name:
          type: string
          description: The name of the `File` you'll create.
        linked_to:
          type: string
          description: The resource ID that you want linked to the `File` (e.g. Merchant
            ID).
        tags:
          $ref: '#/components/schemas/Tags'
        type:
          type: string
          description: 'The type of document. | Available values include: <br>Identity
            Verification<ul><li> **DRIVERS\_LICENSE\_FRONT**<li>**DRIVERS\_LICENSE\_BACK**<li>**IDENTIFICATION\_CARD\_FRONT**<li>**IDENTIFICATION\_CARD\_BACK**</ul>Bank
            account validation<ul><li>**BANK\_STATEMENT**</ul>Business Verification<ul><li>**TAX\_DOCUMENT**<li>**BUSINESS\_REGISTRATION**<li>**BUSINESS\_ADDRESS\_VERIFICATION**</ul>Additional<ul><li>**OTHER**<li>**PCI\_DOCUMENT**<li>**PASSPORT**<ul>'
          enum:
            - DRIVERS_LICENSE_FRONT
            - DRIVERS_LICENSE_BACK
            - IDENTIFICATION_CARD_FRONT
            - IDENTIFICATION_CARD_BACK
            - BANK_STATEMENT
            - TAX_DOCUMENT
            - BUSINESS_REGISTRATION
            - BUSINESS_ADDRESS_VERIFICATION
            - OTHER
            - PCI_DOCUMENT
            - PASSPORT
    File:
      type: object
      x-examples: {}
      title: File
      properties:
        id:
          type: string
          description: The ID of the `File` resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        application_id:
          type: string
          description: The ID of the `Application` that the `File` was created under.
        display_name:
          type: string
          description: 'The name of the `File` object. If you don''t provide a name,
            Finix will name the object with the convention: **FILE_(file_id)**.'
        extension:
          description: The extension of the file.
          type: string
          nullable: true
        identity_id:
          type: string
          description: ID of the `Identity` that created the `File`.
          nullable: true
        linked_to:
          type: string
          description: The resource ID the `File` is linked to.
        linked_type:
          type: string
          description: Autofills to **Merchant**.
        platform_id:
          type: string
          description: The ID of the `Platform` that the `File` was created under.
        status:
          type: string
          description: 'The status of the file''s review. The statuses available includes:<br><li><strong>REQUIRES_UPLOAD</strong>:
            A file still needs to be uploaded to the file object.<br><li><strong>PENDING</strong>:
            Finix''s underwriting team is still reviewing the uploaded files.<br><li><strong>INVALID</strong>:
            The file couldn''t be read.<br><li><strong>UPLOADED</strong>: The file
            has been uploaded to the resource.'
        tags:
          $ref: '#/components/schemas/Tags'
        type:
          type: string
          description: The type of 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:
        example-1:
          type: UPLOAD
          duration: 15
      title: CreateExternalLinkRequest
      properties:
        duration:
          type: integer
          description: Set how long (in minutes) the external link should be active
            for. The link can be active for up to 7 days in the future.
        tags:
          $ref: '#/components/schemas/Tags'
        type:
          type: string
          description: <ul><li>Set to <strong>UPLOAD</strong> to create a link that
            can be used to upload files to Finix.<li>Set to <strong>DOWNLOAD</strong>
            to create a link where the uploaded file can be downloaded from.<li>Set
            to <strong>VIEW</strong> to create a link that displays the file in browser.
          enum:
            - UPLOAD
            - DOWNLOAD
            - VIEW
    ExternalLink:
      type: object
      x-examples: {}
      properties:
        id:
          type: string
          description: The ID of the `external_Link` resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        duration:
          type: string
          description: Details how long the `url` will be avalible for users to upload
            files to.
          nullable: true
        expired:
          type: boolean
          description: <ul><li>If <strong>TRUE</strong> the link has expired<br><li>If
            <strong>FALSE</strong>, the link is active and files can still be uploaded
            or downloaded from the link.
        expires_at:
          type: string
          description: The timestamp that the external link expires at.
        file_id:
          type: string
          description: The `File` ID the `external_link` is related to.
        tags:
          $ref: '#/components/schemas/Tags'
        type:
          type: string
          description: Sets if the link is for uploading or downloading files from
            Finix.
        url:
          type: string
          description: The URL you can share with merchants to **UPLOAD** or **DOWNLOAD**
            files depending on the request sent.
        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'
    AdditionalPurchaseData:
      title: AdditionalPurchaseData
      x-stoplight:
        id: 1dey3tmn0hj6l
      type: object
      description: Additional information about the purchase. Used for Level 2 and
        Level 3 Processing.
      properties:
        customer_reference_number:
          type: string
          description: The customer reference for the purchase (max 17 characters).
        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)
        discount_amount:
          type: integer
          description: The amount in cents of the discount for the order.
        invoice_reference_number:
          type: string
          description: The order's invoice number (max 15 characters)
        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 in cents of the line item excluding tax.
              amount_including_sales_tax:
                type: integer
                description: Total cost in cents of the line item including 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).
              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)
              item_discount_amount:
                type: integer
                description: 'Item discount amount in cents

                  '
              merchant_product_code:
                type: string
                description: Merchant defined product code (max 12 characters).
              quantity:
                type: integer
                description: The number of items purchased. Must be greater than 0.
              unit_of_measure:
                type: string
                description: The unit of measure of the purchased item (max 3 characters).
        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)
        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.\
            \ \n\nFor non-taxable transactions either set `sales_tax` to 0 or omit\
            \ from payload and also set `tax_exempt` to **True**."
        ship_from_postal_code:
          type: string
          description: The postal code from where order is shipped (10 characters)
        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.
    ApplePaySessionRequest:
      type: object
      x-examples:
        example-1:
          display_name: Finix Test Merchant
          domain: www.finixtestmerchant.com
          merchant_identity: IDmULj61C8ke6Y7qQiKENJ7
          validation_url: https://apple-pay-gateway-cert.apple.com/paymentservices/paymentSession
      title: ApplePaySessionRequest
      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.
    ApplePaySession:
      type: object
      x-examples:
        example-1:
          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
      properties:
        id:
          type: string
          description: The ID of the `apple_pay_session` resource.
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        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
      title: ApplePaySession
    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
    DisputeAdjustmentTransfersList:
      $ref: '#/components/schemas/TransfersList'
    ConfigurationDetails:
      title: ConfigurationDetails
      x-stoplight:
        id: czqjwiv5qz0zl
      type: object
      description: Configure the details of the activated device.
      properties:
        allow_debit:
          type: boolean
          description: Allow transaction to be processed on Debit rails. If `false`,
            Debit card transactions will be processed on Credit rails.
        allow_partial_approvals:
          type: boolean
          description: Determines if a transaction can be partially approved (Usually
            **null**).
        bypass_device_on_capture:
          type: boolean
          description: Sets whether the device will be used to capture `Authorizations`.
            The device is required to be connected if `bypass_device_on_capture` is
            set to false. (defaults to true).
        cashback_options:
          type: object
          properties:
            manual_entry:
              type: object
              properties:
                amount_increment:
                  type: integer
                maximum_amount:
                  type: integer
            selection_amounts:
              type: string
        check_for_duplicate_transactions:
          type: boolean
          description: Sets whether the device will check for duplicate transactions.
        is_cash_back_allowed:
          type: boolean
          description: Sets whether the device will allow cash back.
        is_gift_supported:
          type: string
          description: Sets whether the device will allow gifting funds.
        is_manual_entry_allowed:
          type: boolean
          description: Sets whether the device will process payment details entered
            manually.
        market_code:
          type: string
          description: Used by the processor to handle the `transfer`. Usually **null**.
        prompt_amount_confirmation:
          type: boolean
          description: Sets if the card holder needs to confirm the amount they will
            pay (defaults to **true**).
        prompt_manual_entry:
          type: boolean
          description: Sets if the device defaults to manual entry as the default
            card input method. (defaults to **false**).
        prompt_signature:
          type: string
          description: 'Sets if the device will prompt the card holder for a signature
            by default. Available values include:<ul><li><strong>ALWAYS</strong><li><strong>NEVER</strong><li><strong>AMOUNT</strong>:
            Used in conjunction with `signature_threshold_amount` so when the threshold
            is reached the signature form appears on the device.'
        signature_threshold_amount:
          type: integer
          description: The threshold to prompt a signature when `prompt_signature`
            is set to **AMOUNT** (defaults to 0).
        tip_options:
          type: object
          properties:
            type:
              type: string
            other_options:
              type: string
            tip_selections:
              type: string
    CardPresentDetails:
      title: CardPresentDetails
      x-stoplight:
        id: jbenxkas8ukf2
      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 EMV application processing the transaction.
            application_label:
              type: string
              description: EMV card label.
            application_preferred_name:
              type: string
              description: Alternate EMV application name (if provided).
              nullable: true
            application_transaction_counter:
              type: string
              description: Transaction number for the EMV application.
            cryptogram:
              type: string
              description: Encrypted card infromation used to process the transaction.
            issuer_code_table_index:
              type: string
              description: The alphabet code table (according to ISO 8859) used by
                the EMV application (if provided).
              nullable: true
            pin_verified:
              type: boolean
              description: Details if the cardholder's PIN number was verified.
            tags:
              $ref: '#/components/schemas/Tags'
        entry_mode:
          type: string
          description: Details how the card was entered to process the transaction.
          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).
    UploadFileRequest:
      title: UploadFileRequest
      x-stoplight:
        id: 8f3scdwv78xcg
      type: object
      properties:
        file:
          type: string
          format: binary
          description: Path to the file you want to upload<br>(e.g. **/Users/Desktop/finix_file.png**).
    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.
        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
    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.
    FailureCode:
      title: FailureCode
      x-stoplight:
        id: lo8jqmipa7376
      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](/docs/guides/developers/errors/#failure-codes).
      nullable: true
    FailureMessage:
      title: FailureMessage
      x-stoplight:
        id: cgilf858039yi
      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
    FraudSessionID:
      title: FraudSessionID
      x-stoplight:
        id: x00www7a3mlv6
      type: string
      description: The `fraud_session_session` ID you want to review for fraud. For
        more info, see [Fraud Detection](/docs/guides/payments/fraud-detection/).
    OperationKey:
      type: string
      title: OperationKey
      x-stoplight:
        id: mkamr5b4a6hd5
      enum:
        - PUSH_TO_CARD
        - PULL_FROM_CARD
        - CARD_PRESENT_DEBIT
        - CARD_PRESENT_UNREFERENCED_REFUND
        - SALE
        - UNREFERENCED_REFUND
        - MERCHANT_CREDIT_ADJUSTMENT
        - MERCHANT_DEBIT_ADJUSTMENT
        - CARD_PRESENT_AUTHORIZATION
      description: Details the operation that'll be performed in the transaction (Card
        present transactions only) .
      nullable: true
    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.
    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
    ComplianceForm:
      type: object
      x-examples: {}
      properties:
        id:
          type: string
          description: ID of the `compliance_form`.
        type:
          type: string
          description: 'Type of `compliance_form`. There is one available value: **PCI_SAQ_A**.'
          enum:
            - PCI_SAQ_A
        state:
          type: string
          description: The state of the `compliance_form`.
          enum:
            - PENDING
            - COMPLETED
            - INVALID
            - INCOMPLETE
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        due_at:
          type: string
          description: Timestamp of when the `compliance_form` must be completed by.
          format: date-time
        linked_to:
          type: string
          description: The ID of the `merchant` linked to the `compliance_form`.
        linked_type:
          type: string
          description: The type of resource this `compliance_form` is linked to.
        pci_saq_a:
          type: object
          description: Details used to fille out the PCI Self-Assessment Questionnaire
            (SAQ).
          properties:
            name:
              type: string
              description: Name of the person completing (aka attesting to) the `compliance_form`.
              nullable: true
            signed_at:
              type: string
              description: Timestamp of the person attesting to this `compliance_form`.
              nullable: true
            user_agent:
              type: string
              description: User agent of the person attesting to this `compliance_form`.
              nullable: true
            ip_address:
              type: string
              description: IP address of the person attesting to this `compliance_form`.
              nullable: true
            is_accepted:
              type: boolean
              description: If all `pci_saq_a` fields are all submitted, `is_accepted`
                updates to **true**.
              nullable: true
            title:
              type: string
              description: Title or role of the person completing (aka attesting to)
                the `compliance_form`.
              nullable: true
        files:
          type: object
          description: Details about the `File` resoruce where the `compliance_form`
            was uploaded.
          properties:
            unsigned_file:
              type: string
              description: ID of the `File` resource that has the `compliance_form`.
            signed_file:
              type: string
              description: '<ul><li>Autofills to <strong>null</strong>.</li>

                <li>When a <kbd>compliance_form</kbd> is attested, <kbd>signed_file</kbd>
                will contain a <kbd>File</kbd> corresponding to the signed version
                of the form.</li></ul>'
              nullable: true
        valid_from:
          type: string
          description: Timestamp of when the `compliance_form` becomes active and
            valid.
          format: date-time
        valid_until:
          type: string
          description: Timestamp of when the `compliance_form` is no longer active
            and valid.
        compliance_form_template:
          type: string
          description: Template linked to this `compliance_form`.
        tags:
          $ref: '#/components/schemas/Tags'
    UpdateComplianceFormRequest:
      type: object
      x-examples: {}
      properties:
        pci_saq_a:
          type: object
          description: Details used to fille out the PCI Self-Assessment Questionnaire.
          properties:
            name:
              type: string
              description: Name of the person completing (aka attesting to) the `compliance_form`.
            signed_at:
              type: string
              description: Timestamp of the person attesting to this `compliance_form`.
            user_agent:
              type: string
              description: User agent of the person attesting to this `compliance_form`.
            ip_address:
              type: string
              description: IP address of the person attesting to this `compliance_form`.
            title:
              type: string
              description: "Title or role of the person completing (aka attesting\
                \ to)\n                the `compliance_form`."
    CreateOnboardingFormRequest:
      type: object
      x-examples: {}
      title: CreateOnboardingFormRequest
      properties:
        onboarding_data:
          type: object
          description: The prefilled information of the user that's being onboarded.
            For more information, see [Prefilling Fields](/guides/onboarding/onboarding-form/#prefilling-fields).
          properties:
            entity:
              type: object
              description: The `entity` information saved in the `Identity` of the
                user.
            associated_entities:
              type: array
              description: The `entities` saved in the `associated_identities` of
                the user. For more information, see [Create an Associated Identity](/guides/onboarding/onboarding-form/#prefilling-fields).
              items:
                type: object
            additional_underwriting_data:
              type: object
              description: Additional underwriting data about the user.
            payment_instruments:
              type: object
              description: The `Payment Instrument` that'll be used to payout the
                user. For more information, see [Payouts](/guides/payouts/).
            max_transaction_amount:
              type: integer
              description: Maximum 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`.
        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:
          type: object
          description: The information of the initial onboarding link. This is only
            provided when creating an `onboarding_form`.
          properties:
            return_url:
              type: string
              description: The URL users get sent to after completing the onboarding
                flow.
            expired_session_url:
              type: string
              description: The URL users get sent to if the bearer token expires.
            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](https://finix-hosted-content.s3.amazonaws.com/flex/v2/finix-terms-of-service.html).
            fee_details_url:
              type: string
              description: The URL of the page where you display the fees related
                to processing payments (for more info, see [Displaying Processing
                Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).
            expiration_in_minutes:
              type: string
              description: How long (in minutes) the link should be valid for. Defaults
                to 60 minutes.
    OnboardingForm:
      type: object
      x-examples: {}
      title: OnboardingForm
      properties:
        id:
          type: string
          description: The ID of the `onboarding_form` resource.
        onboarding_data:
          type: object
          description: The prefilled information of the user that's being onboarding.
            See [Prefilling Fields](/guides/onboarding/onboarding-form/) below.
          properties:
            entity:
              type: object
              description: The `entity` information saved in the `Identity` of the
                user.
            associated_entities:
              type: array
              description: The `entities` saved in the `associated_identities` of
                the user. For more information, see [Create an Associated Identity](/api/#operation/createAssociatedIdentity).
              items:
                type: object
            payment_instruments:
              type: object
              description: The `Payment Instrument` that'll be used to payout the
                user. For more information, see [Payouts](/guides/payouts).
            additional_underwriting_data:
              type: object
              description: Additional underwriting data about the user.
            max_transaction_amount:
              type: integer
              description: Maximum 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`.
        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:
          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/onboarding/onboarding-form/#get-an-onboarding-form-url).
            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.
        status:
          type: string
          description: Status of the `onboarding_from`.
          enum:
            - IN_PROGRESS
            - COMPLETED
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        tags:
          $ref: '#/components/schemas/Tags'
    CreateOnboardingFormLinkRequest:
      type: object
      x-examples: {}
      properties:
        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.
        return_url:
          type: string
          description: The URL users get sent to after completing the onboarding flow.
        fee_details_url:
          type: string
          description: The URL of the page where you display the fees related to processing
            payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).
        expired_session_url:
          type: string
          description: The URL users get sent to if the bearer token expires.
        expiration_in_minutes:
          type: integer
          description: How long (in minutes) the link is valid for.
      title: CreateOnboardingFormLinkRequest
    OnboardingFormLink:
      type: object
      x-examples:
        example-1:
          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
      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/onboarding/onboarding-form/#get-an-onboarding-form-url).
        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 at any time.
      title: OnboardingFormLink
    AdditionalBuyerCharges:
      title: AdditionalBuyerCharges
      x-stoplight:
        id: 8t8auxc19wmuw
      type: object
      description: Object detailing any [Buyer Charges](/guides/payments/buyer-charges)
        that got included in the `Authorization`.
      nullable: true
      properties:
        convenience_amount:
          type: number
          description: Include the convenience fee the merchant is charging the buyer
            for the transaction when creating a `Transfer` or an `Authorization`.
          nullable: true
        rent_surcharge_amount:
          type: number
          description: Include the rent surcharge the merchant is charging the buyer
            for the transaction when creating a `Transfer` or an `Authorization`.
          nullable: true
    UpdateMerchantProfileRequest:
      title: UpdateMerchantProfileRequest
      x-stoplight:
        id: 9cuj94a54fwqp
      type: object
      properties:
        fee_profile:
          type: string
          description: ID of the `fee_profile`.
        risk_profile:
          type: string
          description: ID of the `risk_profile`.
        tags:
          $ref: '#/components/schemas/Tags'
    UpdateDeviceRequest:
      title: UpdateDeviceRequest
      x-stoplight:
        id: w6o14ff8xpu3w
      type: object
      properties:
        action:
          type: string
          enum:
            - DEACTIVATE
            - ACTIVATE
            - CANCEL
          description: The action you want to perform on the device. Use **DEACTIVATE**
            to deactivate 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'
        idle_message:
          type: string
          description: Message to display on the idle screen.
    ListAuthorizationsQueryParams:
      type: object
      properties:
        amount:
          description: Filter by an amount equal to the given value.
          type: integer
        amount.gt:
          description: Filter by an amount greater than.
          type: integer
        amount.gte:
          description: Filter by an amount greater than or equal.
          type: integer
        amount.lt:
          description: Filter by an amount less than.
          type: integer
        amount.lte:
          description: Filter by an amount less than or equal.
          type: integer
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        idempotency_id:
          description: Filter by `idempotency_id`.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
        sort:
          description: Specify key to be used for sorting the collection.
          type: string
        state:
          description: Filter by Transaction state.
          type: string
        updated_at.gte:
          description: Filter where `updated_at` is after the given date.
          type: string
        updated_at.lte:
          description: Filter where `updated_at` is before the given date.
          type: string
        trace_id:
          description: Filter by `trace_id`.
          type: string
        is_void:
          description: Filter by `idempotency_id`.
          type: string
        instrument_bin:
          description: Filter by Bank Identification Number (BIN). The BIN is the
            first 6 digits of the masked number.
          type: string
        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 number\t\
            instrument_account_last4=9444 BIN."
          type: string
        instrument_brand_type:
          description: Filter by card brand. Available card brand types can be found
            in the drop-down.
          type: string
        merchant_identity_id:
          description: Filter by `Identity` ID.
          type: string
        merchant_identity_name:
          description: Filter Transactions by `Identity` name. The name is not case-sensitive.
          type: string
        instrument_name:
          description: Filter Transactions by `Payment Instrument` name.
          type: string
        instrument_type:
          description: 'Filter Transactions by `Payment Instrument` type. Available
            instrument types include: Bank Account or Payment Card.'
          type: string
        merchant_id:
          description: Filter by `Merchant` ID.
          type: string
        merchant_mid:
          description: Filter by Merchant Identification Number (MID).
          type: string
        instrument_card_last4:
          description: Filter by the payment card last 4 digits.
          type: string
        merchant_processor_id:
          description: Filter by `Processor` ID.
          type: string
        type:
          description: Type of the `Authorization`.
          type: string
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
    ListBalanceTransfersQueryParams:
      type: object
      properties:
        limit:
          description: The numbers of items to return.
          type: integer
        offset:
          description: The number of items to skip before starting to collect the
            result set.
          type: integer
        pageNumber:
          description: The page number to list.
          type: integer
        pageSize:
          description: The size of the page.
          type: integer
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        updated_at.gte:
          description: Filter where `updated_at` is after the given date.
          type: string
        updated_at.lte:
          description: Filter where `updated_at` is before the given date.
          type: string
        idempotency_id:
          description: Filter by `idempotency_id`.
          type: string
        amount:
          description: Filter by an amount equal to the given value.
          type: integer
        description:
          description: Filter by the `Description` value .
          type: string
        destination:
          description: Filter by the `Payment Instrument` saved in `Destination`.
          type: string
        external_reference_id:
          description: Filter by the value saved in `external_reference_id`.
          type: string
        reference_id:
          description: Filter by the value saved in `reference_id`.
          type: string
        source:
          description: Filter by the `Payment Instrument` saved in `source`.
          type: string
    GetDeviceQueryParams:
      type: object
      properties:
        include_connection:
          description: Specifies whether the connection information should be included.
          type: boolean
    ListDisputesQueryParams:
      type: object
      properties:
        sort:
          description: Specify key to be used for sorting the collection.
          type: string
        offset:
          description: The number of items to skip before starting to collect the
            result set.
          type: integer
        limit:
          description: The numbers of items to return.
          type: integer
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        updated_at.gte:
          description: Filter where `updated_at` is after the given date.
          type: string
        updated_at.lte:
          description: Filter where `updated_at` is before the given date.
          type: string
    ListDisputeEvidenceQueryParams:
      type: object
      properties:
        limit:
          description: The numbers of items to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListFeeProfilesQueryParams:
      type: object
      properties:
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
    ListIdentitiesQueryParams:
      type: object
      properties:
        sort:
          description: Specify key to be used for sorting the collection.
          type: string
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
        id:
          description: Filter by `id`.
          type: string
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        default_statement_descriptor:
          description: Filter by the `default_statement_descriptor`.
          type: string
        business_name:
          description: Filter by the full business name. Partial business names are
            not supported.
          type: string
        business_type:
          description: Filter by the business type. Partial business types are not
            supported.
          type: string
        email:
          description: Filter by the email address or email domain. Partial emails
            are not supported.
          type: string
        first_name:
          description: Filter by the first name of the person associated to the `Identity`.
          type: string
        last_name:
          description: Filter by the last name of the person associated to the `Identity`.
          type: string
        title:
          description: Filter by the title if available.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListIdentityAssociatedIdentitiesQueryParams:
      type: object
      properties:
        limit:
          description: The number of entries to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListMerchantProfilesQueryParams:
      type: object
      properties:
        id:
          description: Filter by `id`.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
    ListMerchantsQueryParams:
      type: object
      properties:
        id:
          description: Filter by `id`.
          type: string
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
        sort:
          description: Specify key to be used for sorting the collection.
          type: string
    ListMerchantVerificationsQueryParams:
      type: object
      properties:
        limit:
          description: The number of entries to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListPaymentInstrumentsQueryParams:
      type: object
      properties:
        account_last4:
          description: Filter by the last 4 digits of the account if available.
          type: string
        account_routing_number:
          description: Filter by the account routing number if available.
          type: string
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        application:
          description: Filter by `Application` ID.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
        bin:
          description: Filter by Bank Identification Number (BIN). The BIN is the
            first 6 digits of the masked number.
          type: string
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        expiration_month:
          description: Filter by the expiration month associated with the `Payment
            Instrument` if applicable. This filter only applies to payment cards.
          type: string
        expiration_year:
          description: Filter by the 4 digit expiration year associated with the Payment
            Instrument if applicable. This filter only applies to payment cards.
          type: string
        last_four:
          description: Filter by the last 4 digits of the `Payment Instrument` card.
            This filter only applies to payment cards.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
        name:
          description: Filter by the name.
          type: string
        owner_identity_id:
          description: Filter by the owner id of the associated `Identity`.
          type: string
        type:
          description: Filter by the `Payment Instrument` type.
          type: string
    ListPaymentInstrumentUpdatesQueryParams:
      type: object
      properties:
        limit:
          description: The number of entries to return.
          type: integer
        offset:
          description: The number of items to skip before starting to collect the
            result set.
          type: integer
        pageSize:
          description: The size of the page.
          type: integer
    ListPaymentInstrumentVerificationsQueryParams:
      type: object
      properties:
        limit:
          description: The number of entries to return.
          type: integer
        offset:
          description: The number of items to skip before starting to collect the
            result set.
          type: integer
        pageNumber:
          description: The page number to list.
          type: integer
        pageSize:
          description: The size of the page.
          type: integer
    ListSettlementsQueryParams:
      type: object
      properties:
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        updated_at.gte:
          description: Filter where `updated_at` is after the given date.
          type: string
        updated_at.lte:
          description: Filter where `updated_at` is before the given date.
          type: string
        id:
          description: Filter by `id`.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListSettlementFundingTransfersQueryParams:
      type: object
      properties:
        limit:
          description: The numbers of items to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListSettlementTransfersQueryParams:
      type: object
      properties:
        limit:
          description: The numbers of items to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListTransfersQueryParams:
      type: object
      properties:
        sort:
          description: Specify key to be used for sorting the collection.
          type: string
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
        amount:
          description: Filter by an amount equal to the given value.
          type: integer
        amount.gte:
          description: Filter by an amount greater than or equal.
          type: integer
        amount.gt:
          description: Filter by an amount greater than.
          type: integer
        amount.lte:
          description: Filter by an amount less than or equal.
          type: integer
        amount.lt:
          description: Filter by an amount less than.
          type: integer
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        idempotency_id:
          description: Filter by `idempotency_id`.
          type: string
        id:
          description: Filter by `id`.
          type: string
        state:
          description: Filter by Transaction state.
          type: string
        ready_to_settle_at.gte:
          description: Filter by `ready_to_settle_at`.
          type: string
        ready_to_settle_at.lte:
          description: Filter by `ready_to_settle_at`.
          type: string
        statement_descriptor:
          description: Filter by `statement_descriptor`.
          type: integer
        trace_id:
          description: Filter by `trace_id`.
          type: string
        updated_at.gte:
          description: Filter where `updated_at` is after the given date.
          type: string
        updated_at.lte:
          description: Filter where `updated_at` is before the given date.
          type: string
        instrument_bin:
          description: Filter by Bank Identification Number (BIN). The BIN is the
            first 6 digits of the masked number.
          type: string
        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 number\t\
            instrument_account_last4=9444 BIN."
          type: string
        instrument_brand_type:
          description: Filter by card brand. Available card brand types can be found
            in the drop-down.
          type: string
        merchant_identity_id:
          description: Filter by `Identity` ID.
          type: string
        merchant_identity_name:
          description: Filter Transactions by `Identity` name. The name is not case-sensitive.
          type: string
        instrument_name:
          description: Filter Transactions by `Payment Instrument` name.
          type: string
        instrument_type:
          description: 'Filter Transactions by `Payment Instrument` type. Available
            instrument types include: Bank Account or Payment Card'
          type: string
        merchant_id:
          description: Filter by `Merchant` ID.
          type: string
        merchant_mid:
          description: Filter by Merchant Identification Number (MID).
          type: string
        instrument_card_last4:
          description: Filter by the payment card last 4 digits.
          type: string
        merchant_processor_id:
          description: Filter by `Processor` ID.
          type: string
        type:
          description: 'Filter by `Transfer` type. Available type filters include:
            All, Debits, Refunds, or Credits.'
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListTransferReversalsQueryParams:
      type: object
      properties:
        limit:
          description: The number of entries to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListVerificationsQueryParams:
      type: object
      properties:
        limit:
          description: The numbers of items to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListWebhooksQueryParams:
      type: object
      properties:
        limit:
          description: The numbers of items to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    DownloadInstrumentUpdateQueryParams:
      type: object
      properties:
        format:
          description: Specify the format you'd like to download the response in (JSON
            is the only other format available for download).
          type: string
    ListFilesQueryParams:
      type: object
      properties:
        sort:
          description: Specify key to be used for sorting the collection.
          type: string
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
        id:
          description: Filter by `id`.
          type: string
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        updated_at.gte:
          description: Filter where `updated_at` is after the given date.
          type: string
        updated_at.lte:
          description: Filter where `updated_at` is before the given date.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListExternalLinksQueryParams:
      type: object
      properties:
        sort:
          description: Specify key to be used for sorting the collection.
          type: string
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        limit:
          description: The numbers of items to return.
          type: integer
        id:
          description: Filter by `id`.
          type: string
        created_at.gte:
          description: Filter where `created_at` is after the given date.
          type: string
        created_at.lte:
          description: Filter where `created_at` is before the given date.
          type: string
        updated_at.gte:
          description: Filter where `updated_at` is after the given date.
          type: string
        updated_at.lte:
          description: Filter where `updated_at` is before the given date.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
    ListDisputesAdjustmentsQueryParams:
      type: object
      properties:
        limit:
          description: The numbers of items to return.
          type: integer
        after_cursor:
          description: Return every resource created after the cursor value.
          type: string
        before_cursor:
          description: Return every resource created before the cursor value.
          type: string
  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