API ReferenceRewardsMerchants

Get Merchants

Deprecated

Retrieve ALL national and local merchant data regardless of whether a user is eligible to see them. This endpoint is a legacy endpoint and will no longer be maintained soon. Instead, use Get Eligible Merchants to retrieve national merchant data and build your targeted offers UX experience. Local merchants and offers details can be found by calling the Get Eligible Locations endpoint with the includeLocal query parameter.
Required scopes: rewards:read

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

Page number [>= 0], (default = 0)

limitintegerOptional

Maximum number of merchants [1 - 200], (default = 200)

sourceenumOptional
Merchant source
Allowed values:
categoryenumOptional

Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)

Response

This endpoint returns a list of objects.
_idstring
Merchant ID in Kard's system
acceptedCardslist of enums
Allowed values:
categoryenum
Category of merchant
createdDatedatetime

Created date of merchant in Kard’s system (UTC)

descriptionstring

Merchant description - usually a blurb outlining more details about the merchant

imgUrlstring
Merchant image asset URL
lastModifieddatetime

Last modified date of merchant in Kard’s system (UTC)

namestring
Merchant name
offerslist of objects
Offers associated to the merchant
sourceenum
Merchant source
Allowed values:
websiteURLstring
Merchant's URL website
bannerImgUrlstring or null
Merchant banner image asset URL

Errors