Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

List All Merchants

List all of the Merchant resources that have been created.

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

Example Response:

Copy
Copied
{
  "_embedded" : {
    "merchants" : [ {
      "id" : "MUht1bsAEcihT9HA55Tet5dk",
      "created_at" : "2022-10-07T22:21:13.07Z",
      "updated_at" : "2022-10-07T22:22:01.49Z",
      "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" : "IDoZy2xjNQyWCkN5nKZbVp6x",
      "level_two_level_three_data_enabled" : false,
      "mcc" : "0742",
      "merchant_name" : "Finix Flowers",
      "merchant_profile" : "MPh4vD8hWCtqHeJ8JgG4Tsva",
      "mid" : "FNXeJeV8TvpUxYFrKisyJ5oAs",
      "onboarding_state" : "APPROVED",
      "processing_enabled" : true,
      "processor" : "DUMMY_V1",
      "processor_details" : {
        "mid" : "FNXeJeV8TvpUxYFrKisyJ5oAs",
        "api_key" : "secretValue"
      },
      "ready_to_settle_upon" : "RECONCILIATION",
      "rent_surcharges_enabled" : false,
      "settlement_enabled" : true,
      "settlement_funding_identifier" : "UNSET",
      "tags" : {
        "key_2" : "value_2"
      },
      "verification" : "VIr27e4C5AWxgvLnyGJmdZQe",
      "_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"
        },
        "verification" : {
          "href" : "https://finix.sandbox-payments-api.com/verifications/VIr27e4C5AWxgvLnyGJmdZQe"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        }
      }
    }, {
      "id" : "MUraH1GUvARUVDmAJCv9hkEg",
      "created_at" : "2022-10-06T22:57:13.50Z",
      "updated_at" : "2022-10-06T22:58:01.65Z",
      "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" : "IDcZWVkKZanAg8jdw9BEqsg1",
      "level_two_level_three_data_enabled" : false,
      "mcc" : null,
      "merchant_name" : "Daphne Finix",
      "merchant_profile" : "MPeGKayo2Puh3AbQG3rdEGST",
      "mid" : "FNXkjwf48VntrMD2aEyLERmJF",
      "onboarding_state" : "APPROVED",
      "processing_enabled" : true,
      "processor" : "DUMMY_V1",
      "processor_details" : {
        "mid" : "FNXkjwf48VntrMD2aEyLERmJF",
        "api_key" : "secretValue"
      },
      "ready_to_settle_upon" : "RECONCILIATION",
      "rent_surcharges_enabled" : false,
      "settlement_enabled" : true,
      "settlement_funding_identifier" : "UNSET",
      "tags" : { },
      "verification" : "VI42gcaKgiXTPTkDsJpU8iRR",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUraH1GUvARUVDmAJCv9hkEg"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDcZWVkKZanAg8jdw9BEqsg1"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUraH1GUvARUVDmAJCv9hkEg/verifications"
        },
        "merchant_profile" : {
          "href" : "https://finix.sandbox-payments-api.com/merchant_profiles/MPeGKayo2Puh3AbQG3rdEGST"
        },
        "verification" : {
          "href" : "https://finix.sandbox-payments-api.com/verifications/VI42gcaKgiXTPTkDsJpU8iRR"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        }
      }
    }, {
      "id" : "MU2ySgzwhM3QqMFvdqNVb9C5",
      "created_at" : "2022-09-06T17:42:54.87Z",
      "updated_at" : "2022-09-06T17:42:57.86Z",
      "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" : "IDfbnaExTXXSfF5g1HgA4nSk",
      "level_two_level_three_data_enabled" : false,
      "mcc" : null,
      "merchant_name" : "dwayne Sunkhronos",
      "merchant_profile" : "MPpZrKYDtRCxcpbPo9n4jewk",
      "mid" : "FNXpvZ8ekeEoqYtz7dmBVQr5x",
      "onboarding_state" : "APPROVED",
      "processing_enabled" : true,
      "processor" : "DUMMY_V1",
      "processor_details" : {
        "mid" : "FNXpvZ8ekeEoqYtz7dmBVQr5x",
        "api_key" : "secretValue"
      },
      "ready_to_settle_upon" : "RECONCILIATION",
      "rent_surcharges_enabled" : false,
      "settlement_enabled" : true,
      "settlement_funding_identifier" : "UNSET",
      "tags" : {
        "key" : "value_2"
      },
      "verification" : "VI585uzrL392bcuukHM1ou9n",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MU2ySgzwhM3QqMFvdqNVb9C5"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDfbnaExTXXSfF5g1HgA4nSk"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MU2ySgzwhM3QqMFvdqNVb9C5/verifications"
        },
        "merchant_profile" : {
          "href" : "https://finix.sandbox-payments-api.com/merchant_profiles/MPpZrKYDtRCxcpbPo9n4jewk"
        },
        "verification" : {
          "href" : "https://finix.sandbox-payments-api.com/verifications/VI585uzrL392bcuukHM1ou9n"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/merchants/"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/merchants/?after_cursor=MU2ySgzwhM3QqMFvdqNVb9C5"
    }
  },
  "page" : {
    "limit" : 100,
    "next_cursor" : "MU2ySgzwhM3QqMFvdqNVb9C5"
  }
}

HTTP Request

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