List All Merchants

attention

This API is available for Finix Flex and Finix Core customers.

List all Merchants.

Copy
Copied
curl https://finix.sandbox-payments-api.com/merchants/ \
    -H "Content-Type: application/vnd.json+api" \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e

Example Response:

Copy
Copied
{
  "_embedded" : {
    "merchants" : [ {
      "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" : "Dunder Mifflin",
      "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"
      },
      "_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"
        }
      }
    }, {
      "id" : "MUsuBPk1nGQs8rTDTskpSJhE",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "identity" : "IDqXfTAYjLL4Lyce4Xq33g9k",
      "verification" : "VIco8fUzD9J8wd9Fu31HPPPw",
      "merchant_profile" : "MPaQ2okfbvfcBqdkTRn9xUNu",
      "processor" : "DUMMY_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" : false,
      "tags" : {
        "parent_merchant" : "MUucec6fHeaWo3VHYoSkUySM"
      },
      "mcc" : null,
      "mid" : null,
      "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-01-27T07:37:02.21Z",
      "updated_at" : "2022-01-27T07:37:02.07Z",
      "onboarding_state" : "PROVISIONING",
      "processor_details" : { },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUsuBPk1nGQs8rTDTskpSJhE"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUsuBPk1nGQs8rTDTskpSJhE/verifications"
        },
        "merchant_profile" : {
          "href" : "https://finix.sandbox-payments-api.com/merchant_profiles/MPaQ2okfbvfcBqdkTRn9xUNu"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "verification" : {
          "href" : "https://finix.sandbox-payments-api.com/verifications/VIco8fUzD9J8wd9Fu31HPPPw"
        }
      }
    }, {
      "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"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/merchants?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 3
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/merchants/