Finix Merchants API

openapi: 3.2.0
info:
  title: Finix Authorizations Merchants API
  description:
    $ref: api-descriptions/main.md
  contact:
    name: Finix
    url: https://finix.com
    email: support@finixpayments.com
  version: '2022-02-01'
servers:
- description: Sandbox server to be used for testing and development
  url: https://finix.sandbox-payments-api.com
security:
- BasicAuth: []
tags:
- name: Merchants
  description:
    $ref: api-descriptions/tags/merchants.md
paths:
  /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 seller. `Merchants` must be created under an [`Identity`](/api/tag/Identities).


        A bank account must be associated with the previously created `Identity` before a `Merchant` can be successfully onboarded and verified.'
      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
      parameters:
      - schema:
          type: string
          default: '2018-01-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
      x-python-method-name: create
  /merchants:
    get:
      tags:
      - Merchants
      description: 'Retrieve a list of `Merchants`. '
      summary: List Merchants
      operationId: listMerchants
      parameters:
      - $ref: '#/components/parameters/QueryIdFilter'
      - $ref: '#/components/parameters/QueryAfterCursor'
      - $ref: '#/components/parameters/QueryBeforeCursor'
      - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
      - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
      - $ref: '#/components/parameters/QueryLimit'
      - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
      - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
      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 \"Finix-Version: 2022-02-01\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: list
      x-returns-list: true
  /merchants/{merchant_id}:
    parameters:
    - description: ID of `Merchant`.
      required: true
      in: path
      name: merchant_id
      schema:
        type: string
    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/json\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
      x-python-method-name: get
    put:
      tags:
      - Merchants
      description: "Update a `Merchant` to: \n- Change the `Identity` information saved with the underlying processor\n- [Enable Level 2/3 processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/)\n- Enable [buyer charges](/guides/payments/making-a-payment/buyer-charges/)\n- Disable a `Merchant` so the seller can't create new `Transfers` and `Authorizations`."
      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
      parameters:
      - schema:
          type: string
          default: '2018-01-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
      x-python-method-name: update
  /merchants/{merchant_id}/verifications:
    parameters:
    - description: ID of `Merchant` object.
      required: true
      in: path
      name: merchant_id
      schema:
        type: string
    post:
      tags:
      - Merchants
      description: 'Verify a `Merchant` if the `onboarding_state` for a `Merchant` returns **FAILED**, or if the correct the seller needs to update the saved in their information `Identity`.


        Related Guides: [Onboarding Process](/guides/onboarding/onboarding-process/#reverify-a-merchant)'
      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-java-method-name: create_merchant_verification
      parameters:
      - schema:
          type: string
          default: '2018-01-01'
          example: '2022-02-01'
        in: header
        name: Finix-Version
        description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
      x-python-method-name: create_merchant_verification
components:
  schemas:
    PageCursor:
      title: PageCursor
      x-stoplight:
        id: 8v9on8n2939z2
      type: object
      properties:
        limit:
          type: integer
          description: The number of entries to return.
        next_cursor:
          type:
          - string
          - 'null'
          description: The cursor to use for the next page of results.
      description: Details the page that's returned.
    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
    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
    Raw:
      title: Raw
      description: Raw response from the processor.
      x-examples: {}
      type:
      - object
      - 'null'
    UpdateMerchantRequest:
      type: object
      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 transactions 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
          enum:
          - MID_AND_DATE
          - MID_AND_MERCHANT_NAME
          - UNSET
          default: UNSET
          description: 'Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors.

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

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

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


            These details appear alongside the seller''s payout in their bank account as a description of the deposit.'
        tags:
          $ref: '#/components/schemas/Tags'
        surcharge_fees_enabled:
          type: boolean
          description: Set to **true** if you want to enable a `Merchant` to accept surcharge fees.
    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
    CreateVerificationRequest:
      type: object
      properties:
        merchant:
          type: string
          description: '- The ID of the `Merchant`.

            - Must be included when `verify_payment_card` is set to **true**.'
        processor:
          type: string
          enum:
          - DUMMY_V1
          - MASTERCARD_V1
          - VISA_V1
          default: DUMMY_V1
          description: 'Set the acquiring processor. Avalible values include: <ul><li><strong>DUMMY_V1</strong></li><li><strong>MASTERCARD_V1</strong></li><li><strong>VISA_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>.'
        security_code:
          type: string
          description: The ID of the `Merchant`.
        verify_payment_card:
          type: boolean
          description: '- Set to **true** to verify card details with the card issuer.

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

            - When set to **true**, `merchant` must also be included with your request.'
        tags:
          $ref: '#/components/schemas/Tags'
        address:
          $ref: '#/components/schemas/Address'
        identity:
          type: string
          description: ID of the `Identity` resource associated with the `Merchant`.
    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: ''
    CreateMerchantUnderwritingRequest:
      type: object
      title: MerchantUnderwritingCreate
      properties:
        gateway:
          type: string
          enum:
          - TRIPOS_CLOUD_V1
          - TRIPOS_MOBILE_V1
          - DATACAP_V1
          description: Name of the gateway that processes the `Merchant's` card present transactions. Use `gateway` only to enable a merchant to accept card present transactions.
        processor:
          $ref: '#/components/schemas/ProcessorRequest'
        tags:
          $ref: '#/components/schemas/Tags'
      required:
      - processor
    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
          - 'null'
          description: ID of the `Identity` that created the `Merchant`.
        merchant:
          type:
          - string
          - 'null'
          description: ID of the `Merchant` resource.
        merchant_identity:
          type:
          - string
          - 'null'
          description: ID of the `Identity` associated with the `Merchant`.
        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
          - 'null'
          description: The `Payment Instrument` that's used to settle the `Merchant's` processed funds.
        payment_instrument_verification_details:
          type: object
          description: Details the verification results of `Payment Instruments`.
          properties:
            push_to_card_domestic:
              type: string
              description: Details if the `Payment Instrument` supports push and pull from card, domestically. For more details, see [Push to Card](/guides/push-pull/).
              enum:
              - FAST_FUNDS
              - NON_FAST_FUNDS
              - NOT_SUPPORTED
              - UNKNOWN
            push_to_card_cross_border:
              type: string
              description: Details if the `Payment Instrument` supports push and pull from card, cross-border. For more details, see [Push to Card](/guides/push-pull/).
              enum:
              - FAST_FUNDS
              - NON_FAST_FUNDS
              - NOT_SUPPORTED
              - UNKNOWN
            card_type:
              type: string
              description: The type of card. Same value as `Payment Instrument#type`.
              enum:
              - CREDIT
              - DEBIT
              - HSA_FSA
              - NON_RELOADABLE_PREPAID
              - RELOADABLE_PREPAID
              - UNKNOWN
            billing_currency:
              $ref: '#/components/schemas/Currency'
            issuer_country:
              $ref: '#/components/schemas/Country'
        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
          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
    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: '4900'
          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 `Merchant` 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.
        gateway:
          type:
          - string
          - 'null'
          description: Name of the gateway that routes the `Merchant's` transactions to the processor.
          enum:
          - TRIPOS_MOBILE_V1
          - TRIPOS_CLOUD_V1
          - DATACAP_V1
        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
          - 'null'
          description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
        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
          - 'null'
          description: MID of the `Merchant`.
        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 transactions captured by the `Merchant` are settled.
          enum:
          - RECONCILIATION
          - SUCCESSFUL_CAPTURE
          - PROCESSOR_WINDOW
        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: 'Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors.

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

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

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


            These details appear alongside the seller''s payout in their bank account as a description of the deposit.'
          enum:
          - UNSET
          - MID_AND_DATE
          - MID_AND_MERCHANT_NAME
          default: UNSET
        surcharges_enabled:
          type: boolean
          default: false
          description: Set to **true** if you want to enable a `Merchant` to accept surcharge fees. For more details, see [Buyer Charges](/guides/payments/modify/buyer-charges/).
        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
    CreatedAt:
      type: string
      title: CreatedAt
      format: date-time
      description: Timestamp of when the object was created.
    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
      - 'null'
      x-examples: {}
      title: ''
    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
    ErrorGeneric:
      type: object
      properties:
        total:
          type: integer
        _embedded:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                additional

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finix/refs/heads/main/openapi/finix-merchants-api-openapi.yml