API Reference
For Publishers

Create or Update the Merchant using the partner-provided merchant ID

put
https://api-sandbox.cardlytics.com/api/v1/partner/merchants/

Create or update merchant information. The external_merchant_id in the path must match the merchantId in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to 67890

Partner-provided merchant identifier

Body Params

Merchant object that needs to be inserted or updated

string
required
length ≥ 1

Partner-provided merchant identifier

string
required
length ≥ 1

Registered name of the merchant or brand

string

Any Parent of this merchant

number

ISO 18245 4-digit MCC code

merchantSubCategories
array of objects

List of merchant sub-category objects

merchantSubCategories
paymentChannels
array of strings
required
length ≥ 1

Indicates if this merchant accepts payments online or instore

paymentChannels*
paymentSubChannels
array of strings

Payment sub-channels (PayAtPump or Convenience)

paymentSubChannels
string

Merchant Website URL

merchantApps
array of strings

List of Online Apps used by Merchant

merchantApps
stores
array of objects
required
length ≥ 1

One or more store objects for this merchant

stores*
Responses

400

Bad Request – possible client errors:

  • Invalid input (schema validation failure)
  • ID mismatch
500

Internal Server Error – An unexpected error occurred while processing the request

Updated 6 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago