List Merchants

Changed on Nov 3, 2026

Retrieve a list of available merchants.

post/merchant/list

Request

Base URL
https://development.knotapi.com
URL
https://development.knotapi.com/merchant/list
Auth
HTTP basic

Request body

Product for which the merchants are available. Use ach_switcher to list the merchants where a user can switch a bank account.

platform'ios' | 'android' | 'web'

Platform for which the merchants are available.

country'US' | 'CA'

Country for which the merchants are available (ISO 3166-1 alpha-2, upper case). Omit the field to use your default country. A country that is not enabled for your account returns a 403.

searchstring

Name of a specific merchant.

external_user_idstring

Your unique identifier for the user. The values of the status parameter returned in the response when sending external_user_id can be found here.

Example request

{
  "type": "card_switcher",
  "platform": "ios",
  "country": "CA"
}

Response

Successful request.

Example response

[
  {
    "id": 10,
    "name": "Uber",
    "category": "Transportation",
    "logo": "https://knot.imgix.net/merchants/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png",
    "popular": true,
    "min_sdk_version": "2.0.5"
  }
]

Changes

Nov 3, 2026f10ecfa12c00 Revision changes
- warning
  added the new CANCELLABLE_SUBSCRIPTION_NOT_FOUND enum value to the response property for the response status
- warning
  added the new CANCELLABLE_SUBSCRIPTION_NOT_FOUND enum value to the response property for the response status
- warning
  added the new CANCELLABLE_SUBSCRIPTION_NOT_FOUND enum value to the response property for the response status
- warning
  added the new ENVIRONMENT_MISMATCH enum value to the response property for the response status
- warning
  added the new ENVIRONMENT_MISMATCH enum value to the response property for the response status
- warning
  added the new ENVIRONMENT_MISMATCH enum value to the response property for the response status
- warning
  added the new INSUFFICIENT_ROLE enum value to the response property for the response status
- warning
  added the new INSUFFICIENT_ROLE enum value to the response property for the response status
- warning
  added the new INSUFFICIENT_ROLE enum value to the response property for the response status
- warning
  added the new INSUFFICIENT_SCOPE enum value to the response property for the response status
- warning
  added the new INSUFFICIENT_SCOPE enum value to the response property for the response status
- warning
  added the new INSUFFICIENT_SCOPE enum value to the response property for the response status
- warning
  added the new INVALID_ACCESS_TOKEN enum value to the response property for the response status
- warning
  added the new INVALID_ACCESS_TOKEN enum value to the response property for the response status
- warning
  added the new INVALID_ACCESS_TOKEN enum value to the response property for the response status
- warning
  added the new MULTIPLE_CANCELLABLE_SUBSCRIPTIONS_FOUND enum value to the response property for the response status
- warning
  added the new MULTIPLE_CANCELLABLE_SUBSCRIPTIONS_FOUND enum value to the response property for the response status
- warning
  added the new MULTIPLE_CANCELLABLE_SUBSCRIPTIONS_FOUND enum value to the response property for the response status
- warning
  added the new RATE_LIMIT_EXCEEDED enum value to the response property for the response status
- warning
  added the new RATE_LIMIT_EXCEEDED enum value to the response property for the response status
- warning
  added the new RATE_LIMIT_EXCEEDED enum value to the response property for the response status
- warning
  added the new REQUEST_LOG_ERROR enum value to the response property for the response status
- warning
  added the new REQUEST_LOG_ERROR enum value to the response property for the response status
- warning
  added the new REQUEST_LOG_ERROR enum value to the response property for the response status
- warning
  added the new REQUEST_LOG_NOT_FOUND enum value to the response property for the response status
- warning
  added the new REQUEST_LOG_NOT_FOUND enum value to the response property for the response status
- warning
  added the new REQUEST_LOG_NOT_FOUND enum value to the response property for the response status
- warning
  added the new REQUEST_LOG_QUERY_TIMEOUT enum value to the response property for the response status
- warning
  added the new REQUEST_LOG_QUERY_TIMEOUT enum value to the response property for the response status
- warning
  added the new REQUEST_LOG_QUERY_TIMEOUT enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_ALREADY_EXISTS enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_ALREADY_EXISTS enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_ALREADY_EXISTS enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_ERROR enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_ERROR enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_ERROR enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_LIMIT_REACHED enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_LIMIT_REACHED enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_LIMIT_REACHED enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_NOT_FOUND enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_NOT_FOUND enum value to the response property for the response status
- warning
  added the new WEBHOOK_ENDPOINT_NOT_FOUND enum value to the response property for the response status
- info
  added the new optional request property
- info
  added the new ach_switcher enum value to the request property
- info
  added the new cancel enum value to the request property
- info
  added the non-success response with the status

Operation history