Skip to main content
POST
/
merchant
/
list
cURL
curl --request POST \
  --url https://development.knotapi.com/merchant/list \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "card_switcher",
  "platform": "ios",
  "search": "<string>",
  "external_user_id": "<string>"
}'
{
  "id": 45,
  "name": "Walmart",
  "category": "Online shopping",
  "logo": "https://knot.imgix.net/merchants/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.

Body

application/json

The input parameters required for retrieving merchants.

​
type
enum<string>
required

Product for which the merchants are available.

Available options:
card_switcher,
transaction_link,
shopping,
vault
Example:

"card_switcher"

​
platform
enum<string>

Platform for which the merchants are available. Providing this parameter in the request will return the min_sdk_version parameter in the response.

Available options:
ios,
android,
web
Example:

"ios"

​
search
string

Name of a specific merchant.

​
external_user_id
string
deprecated

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.

Response

Successful request.

  • Option 1
  • Option 2

Without min_sdk_version parameter.

​
id
integer

Static unique ID of the merchant (across all environments). This ID remains constant and does not change.

Example:

10

​
name
string

Name of the merchant.

Example:

"Uber"

​
category
string

Category of the merchant.

Example:

"Transportation"

Logo URL for the merchant.

Example:

"https://knot.imgix.net/merchants/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png"