POST
/
merchant
/
list
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",
  "user_agent": "<string>",
  "search": "<string>",
  "external_user_id": "<string>",
  "status": "<string>"
}'
{
  "id": 10,
  "name": "Uber",
  "logo": "https://storage.googleapis.com/knot-api/merchants/8pflGg1roAFAbdEl03zpl2dlYh54ZTmtq3yQ5NdO.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.

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
Example:

"card_switcher"

platform
enum<string>

Platform for which the merchants are available.

Available options:
ios,
android,
web
Example:

"ios"

user_agent
string

User's user_agent. This property is not maintained. It is recommended to use platform.

Name of a specific merchant.

external_user_id
string

Your unique internal user identifier. Deprecated soon.

status
string

Status of the user's lifecycle in connecting to the merchant across all sessions. Deprecated soon.

Response

200
application/json
Successful request.
id
integer

Unique ID of the merchant (across all environments).

Example:

10

name
string

Name of the merchant.

Example:

"Uber"

Logo of the merchant.

Example:

"https://storage.googleapis.com/knot-api/merchants/8pflGg1roAFAbdEl03zpl2dlYh54ZTmtq3yQ5NdO.png"