Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Merchants

List Merchants

Retrieve a list of Merchant resources.

get/merchants

Query parameters

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

application_idstring
Example:APc9vhYcPsRuTSpKD9KpMtPe

Filter by Application ID.

country'USA' | 'CAN'
Example:USA

Filter by the Merchant's country (ISO 3166 alpha-3).

currency'USD' | 'CAD'
Example:USD

Filter by the Merchant's currencies (ISO 4217).

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

idstring

Filter by id.

identity_business_namestring
Example:finix%20flowers

Filter by the business_name of the Merchant's identity (exact match).

identity_business_name.likestring
Example:finix

Filter by the business_name of the Merchant's identity (partial match).

identity_doing_business_asstring
Example:finix%20flowers

Filter by the doing_business_as of the Merchant's identity (exact match).

identity_doing_business_as.likestring
Example:finix

Filter by the doing_business_as of the Merchant's identity (partial match).

identity_first_namestring
Example:jonathan

Filter by the first_name of the Merchant's identity (exact match).

identity_first_name.likestring
Example:jon

Filter by the first_name of the Merchant's identity (partial match).

identity_idstring
Example:ID6ZC4KedcaCwECQcWr7SM4m

Filter by the Merchant's identity.

identity_last_namestring
Example:williams

Filter by the last_name of the Merchant's identity (exact match).

identity_last_name.likestring
Example:will

Filter by the last_name of the Merchant's identity (partial match).

identity_role'APPLICATION_OWNER' | 'RECIPIENT' | 'SELLER'
Example:SELLER

Filter by the identity_roles of the Merchant's identity.

mccstring

Filter by the Merchant's mcc.

merchant_namestring
Example:finix%20flowers

Filter by the Merchant's merchant_name (exact match).

merchant_name.likestring
Example:finix

Filter by the Merchant's merchant_name (partial match).

processing_enabledboolean
Example:true

Filter by whether the Merchant's processing is enabled (processing_enabled).

processor_type'FINIX_V1' | 'DUMMY_V1'
Example:DUMMY_V1

Filter by the Merchant's processor.

settlement_enabledboolean
Example:true

Filter by whether the Merchant's settlements are enabled (settlement_enabled).

limitinteger
Example:10

The numbers of items to return.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

verification_idstring
Example:VI7jopNSiaVMXWKkhxt6dJm7

Filter by the Merchant's verification.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Merchant resources

Example response

{
  "_embedded": {
    "List of Merchants": [
      {
        "termination_details": {
          "terminated_at": "2024-09-16T13:11:36.72Z"
        }
      }
    ]
  }
}