Finix Payments Merchants API

openapi: 3.0.2
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:
  responses:
    Merchant:
      description: Single Merchant object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Merchant'
          examples:
            Merchant:
              value:
                id: MUucec6fHeaWo3VHYoSkUySM
                created_at: '2022-01-27T07:36:58.19Z'
                updated_at: '2022-10-06T20:25:24.06Z'
                application: APgPDQrLD52TYvqazjHJJchM
                card_cvv_required: false
                card_expiration_date_required: true
                convenience_charges_enabled: false
                creating_transfer_from_report_enabled: true
                default_partial_authorization_enabled: false
                fee_ready_to_settle_upon: RECONCILIATION
                gross_settlement_enabled: false
                identity: IDpYDM7J9n57q849o9E9yNrG
                level_two_level_three_data_enabled: false
                mcc: '4900'
                merchant_name: Bobs Burgers
                merchant_profile: MPzW2oRPtkLxK3fymcMACFi
                mid: FNXh6htoPnfwmgGdvaG4L67Q1
                onboarding_state: APPROVED
                processing_enabled: true
                processor: DUMMY_V1
                processor_details:
                  mid: FNXh6htoPnfwmgGdvaG4L67Q1
                  api_key: secretValue
                ready_to_settle_upon: RECONCILIATION
                rent_surcharges_enabled: false
                settlement_enabled: true
                settlement_funding_identifier: UNSET
                surcharges_enabled: false
                tags:
                  key_2: value_2
                verification: VIxfDrRKZZzkCDDbeCT15oDN
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchants/MUht1bsAEcihT9HA55Tet5dk
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDoZy2xjNQyWCkN5nKZbVp6x
                  verifications:
                    href: https://finix.sandbox-payments-api.com/merchants/MUht1bsAEcihT9HA55Tet5dk/verifications
                  merchant_profile:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles/MPh4vD8hWCtqHeJ8JgG4Tsva
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  verification:
                    href: https://finix.sandbox-payments-api.com/verifications/VIr27e4C5AWxgvLnyGJmdZQe
            Merchant - Card Present Enabled:
              value:
                id: MUu56ZGx3Xb6U9gAqKfgNisd
                created_at: '2019-03-01T01:57:19.95Z'
                updated_at: '2019-05-15T18:10:03.00Z'
                application: APeUbTUjvYb1CdPXvNcwW1wP
                card_cvv_required: false
                card_expiration_date_required: true
                convenience_charges_enabled: false
                creating_transfer_from_report_enabled: false
                default_partial_authorization_enabled: false
                fee_ready_to_settle_upon: RECONCILIATION
                gross_settlement_enabled: false
                identity: IDsbTBawhnLBAVeinRb84vFR
                level_two_level_three_data_enabled: false
                mcc: '4900'
                merchant_name: Finix Flowers
                merchant_profile: MPcMKhfF9rhWT2JWeUKzQVy2
                mid: '4445029863321'
                onboarding_state: REJECTED
                processing_enabled: true
                processor: VANTIV_V1
                processor_details:
                  acceptor_id: '874767464'
                  default_terminal_id: X6600507601
                  mid: '4445029863321'
                  account_token: 811D0B76DEC8CCD1903D2772B68DA0CACA84BF56B5A6EE61EC05FE126EA63EF1B979A401
                  account_id: '1056772'
                  merchant_ident_string: '4445029863321'
                  id: '193448212'
                  vantiv_merchant_id: '4445029863321'
                ready_to_settle_upon: RECONCILIATION
                rent_surcharges_enabled: false
                settlement_enabled: true
                settlement_funding_identifier: UNSET
                surcharges_enabled: false
                tags:
                  key_2: value_2
                verification: VImHURoSqEvAf9haPD6zeHJx
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
                  identity:
                    href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
                  verifications:
                    href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd/verifications
                  merchant_profile:
                    href: https://finix.sandbox-payments-api.com/merchant_profiles/MPcMKhfF9rhWT2JWeUKzQVy2
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
                  verification:
                    href: https://finix.sandbox-payments-api.com/verifications/VImHURoSqEvAf9haPD6zeHJx
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    Error406NotAcceptable:
      description: Not Acceptable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error406NotAcceptable'
          examples: {}
    ErrorUnprocessableEntity:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
    ErrorNotFound:
      description: Object does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error404NotFoundList'
    Verification:
      description: Single Verification object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Verification'
          examples:
            Payment Instrument - Verify a Card’s CVV:
              value:
                id: VIvZKP8XKzxyJaxJsfAEHbw6
                created_at: '2022-10-11T00:46:48.68Z'
                updated_at: '2022-10-11T00:46:48.72Z'
                application: APgPDQrLD52TYvqazjHJJchM
                identity: null
                merchant: MUgWbPVvtKbzjKNNGKqdQYV7
                merchant_identity: ID2CGJmjqyYaQAu6qyuvGeWK
                messages: []
                payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY
                payment_instrument_verification_details:
                  push_to_card_domestic: NOT_SUPPORTED
                  push_to_card_cross_border: NOT_SUPPORTED
                  card_type: CREDIT
                  billing_currency: USD
                  issuer_country: USA
                processor: DUMMY_V1
                raw: RawDummyMerchantUnderwriteResult
                state: SUCCEEDED
                tags:
                  card_name: Personal Card
                trace_id: a7355d05-95b0-4b44-938d-bf0a99f19c17
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/verifications/VIvZKP8XKzxyJaxJsfAEHbw6
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant:
                    href: https://finix.sandbox-payments-api.com/merchants/MUgWbPVvtKbzjKNNGKqdQYV7
            Payment Instrument - Verify a Card’s Address:
              value:
                id: VI46ua15as1tnsWgZCFmdF9F
                created_at: '2023-02-25T20:00:33.94Z'
                updated_at: '2023-02-25T20:01:22.34Z'
                application: APgPDQrLD52TYvqazjHJJchM
                identity: null
                merchant: MUgWbPVvtKbzjKNNGKqdQYV7
                merchant_identity: ID2CGJmjqyYaQAu6qyuvGeWK
                messages: []
                payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY
                payment_instrument_verification_details:
                  push_to_card_domestic: NOT_SUPPORTED
                  push_to_card_cross_border: NOT_SUPPORTED
                  card_type: CREDIT
                  billing_currency: USD
                  issuer_country: USA
                processor: DUMMY_V1
                raw: RawDummyMerchantUnderwriteResult
                state: SUCCEEDED
                tags:
                  card_name: Personal Card
                trace_id: 3374bc71-d43b-4af4-b1f8-7719a2a9e320
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/verifications/VI46ua15as1tnsWgZCFmdF9F
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant:
                    href: https://finix.sandbox-payments-api.com/merchants/MUgWbPVvtKbzjKNNGKqdQYV7
            Payment Instrument - Verify Push-to-Card Eligibility:
              value:
                id: VI8fgzLc9BnY1A996vPcWnu1
                created_at: '2023-01-01T10:51:06.18Z'
                updated_at: '2023-01-01T10:52:15.97Z'
                application: APgPDQrLD52TYvqazjHJJchM
                identity: null
                merchant: MUgWbPVvtKbzjKNNGKqdQYV7
                merchant_identity: ID2CGJmjqyYaQAu6qyuvGeWK
                messages: []
                payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY
                payment_instrument_verification_details:
                  push_to_card_domestic: FAST_FUNDS
                  push_to_card_cross_border: NOT_SUPPORTED
                  card_type: CREDIT
                  billing_currency: USD
                  issuer_country: USA
                processor: DUMMY_V1
                raw: RawDummyMerchantUnderwriteResult
                state: SUCCEEDED
                tags:
                  card_name: Personal Card
                trace_id: 05886388-bcb3-479f-ac31-e5404a92e1ab
                _links:
                  self:
                    href: https://finix.sandbox-payments-api.com/verifications/VI8fgzLc9BnY1A996vPcWnu1
                  application:
                    href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                  merchant:
                    href: https://finix.sandbox-payments-api.com/merchants/MUgWbPVvtKbzjKNNGKqdQYV7
      headers:
        finix-apiuser-role:
          $ref: '#/components/headers/finix-apiuser-role'
        date:
          $ref: '#/components/headers/date'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
    MerchantUpdated:
      description: Single Merchant object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Merchant'
          examples:
            Merchant - Level 2/3 Processing:
              value:
                id: MUeDVrf2ahuKc9Eg5TeZugvs
                created_at: '2022-01-27T07:37:04.03Z'
                updated_at: '2022-01-27T07:37:06.12Z'
                application: APgPDQrLD52TYvqazjHJJchM
                card_cvv_required: false
                card_expiration_date_required: true
                convenience_charges_enabled: true
                creating_transfer_from_report_enabled: true
                default_partial_authorization_enabled: false
                fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
                gross_settlement_enabled: false
                identity: IDuqZpDw28f2KK6YuDk4jNLg
                level_two_level_three_data_enabled: true
                mcc: '4900'
                merchant_name: Finix Flowers
                merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
                mid: FNXw5a7pBKHsCSgCAyQvU2soL
                onboarding_state: APPROVED
                processing_enabled: true
                processor: DUMMY_V1
                processor_details:
                  mid: FNXw5a7pBKHsCSgCAyQvU2soL
                  api_key: secretValue
                ready_to_settle_upon: SUCCESSFUL_CAPTURE
                rent_surcharges_enabled: false
                settlement_enabled: false
                settlement_funding_identifier: UNSET
                surcharges_enabled: false
                tags:
                  key_2: value_2
                verification: VI5DBvVQ3ye5PcnUCSSvj84d
                _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 - Buyer Charges:
              value:
                id: MUeDVrf2ahuKc9Eg5TeZugvs
                created_at: '2022-01-27T07:37:04.03Z'
                updated_at: '2022-01-27T07:37:06.12Z'
                application: APgPDQrLD52TYvqazjHJJchM
                card_cvv_required: false
                card_expiration_date_required: true
                convenience_charges_enabled: true
                creating_transfer_from_report_enabled: true
                default_partial_authorization_enabled: false
                fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
                gross_settlement_enabled: false
                identity: IDuqZpDw28f2KK6YuDk4jNLg
                level_two_level_three_data_enabled: true
                mcc: '4900'
                merchant_name: Finix Flowers
                merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
                mid: FNXw5a7pBKHsCSgCAyQvU2soL
                onboarding_state: APPROVED
                processing_enabled: true
                processor: DUMMY_V1
                processor_details:
                  mid: FNXw5a7pBKHsCSgCAyQvU2soL
                  api_key: secretValue
                ready_to_settle_upon: SUCCESSFUL_CAPTURE
                rent_surcharges_enabled: true
                settlement_enabled: true
                settlement_funding_identifier: UNSET
                surcharges_enabled: true
                tags:
                  key_2: value_2
                verification: VI5DBvVQ3ye5PcnUCSSvj84d
                _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 - Disable a Merchant:
              value:
                id: MUeDVrf2ahuKc9Eg5TeZugvs
                created_at: '2022-01-27T07:37:04.03Z'
                updated_at: '2022-01-27T07:37:06.12Z'
                application: APgPDQrLD52TYvqazjHJJchM
                card_cvv_required: false
                card_expiration_date_required: true
                convenience_charges_enabled: true
                creating_transfer_from_report_enabled: true
                default_partial_authorization_enabled: false
                fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
                gateway: null
                gross_settlement_enabled: false
                identity: IDuqZpDw28f2KK6YuDk4jNLg
                level_two_level_three_data_enabled: true
                mcc: '4900'
                merchant_name: Finix Flowers
                merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
                mid: FNXw5a7pBKHsCSgCAyQvU2soL
                onboarding_state: APPROVED
                processing_enabled: false
                processor: DUMMY_V1
                processor_details:
                  mid: FNXw5a7pBKHsCSgCAyQvU2soL
                  api_key: secretValue
                ready_to_settle_upon: SUCCESSFUL_CAPTURE
                rent_surcharges_enabled: true
                settlement_enabled: true
                settlement_funding_identifier: UNSET
                surcharges_enabled: false
                tags:
                  key_2: value_2
                verification: VI5DBvVQ3ye5PcnUCSSvj84d
                _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'
    ErrorForbidden403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error403ForbiddenList'
    ErrorUnauthorized:
      description: Authentication information is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error401Unauthorized'
    MerchantsList:
      description: List of Merchants objects
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MerchantsList'
          examples:
            List of Merchants:
              value:
                _embedded:
                  merchants:
                  - id: MUk3936kZweevCrjyHLN1vsu
                    created_at: '2022-10-10T05:20:18.12Z'
                    updated_at: '2022-10-10T05:21:01.42Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    convenience_charges_enabled: false
                    creating_transfer_from_report_enabled: true
                    default_partial_authorization_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    gross_settlement_enabled: false
                    identity: IDx2ZETjYiWkbitkYdFt1yLF
                    level_two_level_three_data_enabled: false
                    mcc: '4900'
                    merchant_name: Finix Flowers
                    merchant_profile: MPnXB4UBGtSUfxwA41z2Hqid
                    mid: FNXqeJt93ojP2cn1VUYtXANCF
                    onboarding_state: APPROVED
                    processing_enabled: true
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNXqeJt93ojP2cn1VUYtXANCF
                      api_key: secretValue
                    ready_to_settle_upon: RECONCILIATION
                    rent_surcharges_enabled: false
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    surcharges_enabled: false
                    tags:
                      key_2: value_2
                    verification: VItUgbe9V8vpgSaJAriLDxER
                    _links:
                      self:
                        href: https://finix.sandbox-payments-api.com/merchants/MUk3936kZweevCrjyHLN1vsu
                      identity:
                        href: https://finix.sandbox-payments-api.com/identities/IDx2ZETjYiWkbitkYdFt1yLF
                      verifications:
                        href: https://finix.sandbox-payments-api.com/merchants/MUk3936kZweevCrjyHLN1vsu/verifications
                      merchant_profile:
                        href: https://finix.sandbox-payments-api.com/merchant_profiles/MPnXB4UBGtSUfxwA41z2Hqid
                      application:
                        href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: https://finix.sandbox-payments-api.com/verifications/VItUgbe9V8vpgSaJAriLDxER
                  - id: MU951dfkbH7nqVm4G91yb2au
                    created_at: '2022-09-21T17:46:06.29Z'
                    updated_at: '2022-09-21T17:46:09.45Z'
                    application: APgPDQrLD52TYvqazjHJJchM
                    card_cvv_required: false
                    card_expiration_date_required: true
                    convenience_charges_enabled: false
                    creating_transfer_from_report_enabled: true
                    default_partial_authorization_enabled: false
                    fee_ready_to_settle_upon: RECONCILIATION
                    gross_settlement_enabled: false
                    identity: ID4YPdRriet29ZhaiVa6qhJ5
                    level_two_level_three_data_enabled: false
                    mcc: '4900'
                    merchant_name: Petes Coffee
                    merchant_profile: MPo85BavSYVrkDn57BLh1JTs
                    mid: FNXkitpwdmgMJ8Vz9FxKBCSza
                    onboarding_state: APPROVED
                    processing_enabled: true
                    processor: DUMMY_V1
                    processor_details:
                      mid: FNXkitpwdmgMJ8Vz9FxKBCSza
                      api_key: secretValue
                    ready_to_settle_upon: RECONCILIATION
                    rent_surcharges_enabled: false
                    settlement_enabled: true
                    settlement_funding_identifier: UNSET
                    surcharges_enabled: false
                    tags:
                      key: value_2
                    verification: VIrjCZHf8v8arhbgPTikKmpp
                    _links:
                      self:
                        href: https://finix.sandbox-payments-api.com/merchants/MU951dfkbH7nqVm4G91yb2au
                      identity:
                        href: https://finix.sandbox-payments-api.com/identities/ID4YPdRriet29ZhaiVa6qhJ5
                      verifications:
                        href: https://finix.sandbox-payments-api.com/merchants/MU951dfkbH7nqVm4G91yb2au/verifications
                      merchant_profile:
                        href: https://finix.sandbox-payments-api.com/merchant_profiles/MPo85BavSYVrkDn57BLh1JTs
                      application:
                        href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
                      verification:
                        href: https://finix.sandbox-payments-api.com/verifications/VIrjCZHf8v8arhbgPTikKmpp
                _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=1660&limit=20&sort=created_at,desc&sort=id,desc
                page:
                  offset: 0
                  limit: 20
                  count: 1669
      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:
    MerchantsList:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageCursor'
        _embedded:
          type: object
          description: List of `Merchant` objects.
          properties:
            merchants:
              type: array
              minItems: 0
  

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