rewards

Get Eligible Merchants

Retrieve national merchants data that a specified user has eligible national offers at. Call this endpoint to build out 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.<br/> <b>Required scopes:</b> rewards:read

get/rewards/merchant/user/{referringPartnerUserId}

Request

  • Base URL: https://rewards-api.getkard.com
  • URL: https://rewards-api.getkard.com/rewards/merchant/user/{referringPartnerUserId}
  • Auth: HTTP bearer

Path parameters

referringPartnerUserIdstring required

Referring partner user ID from issuer that specifies user

Query parameters

pageinteger

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

limitinteger

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

category'Arts & Entertainment' | 'Baby, Kids & Toys' | 'Books & Digital Media' | 'Clothing, Shoes & Accessories' | 'Computers, Electronics & Software' | 'Convenience' | 'Gas' | 'Department Stores' | 'Food & Beverage' | 'Health & Beauty' | 'Home & Garden' | 'Miscellaneous' | 'Occasions & Gifts' | 'Pets' | 'Sports & Outdoors' | 'Supplies & Services' | 'Travel'

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

Response

Response with status 200

_idstring required

The unique identifier for a document in the database

namestring required

Merchant name

descriptionstring required

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

websiteURLstring required

Merchant's URL website

category'Arts & Entertainment' | 'Baby, Kids & Toys' | 'Books & Digital Media' | 'Clothing, Shoes & Accessories' | 'Computers, Electronics & Software' | 'Convenience' | 'Gas' | 'Department Stores' | 'Food & Beverage' | 'Health & Beauty' | 'Home & Garden' | 'Miscellaneous' | 'Occasions & Gifts' | 'Pets' | 'Sports & Outdoors' | 'Supplies & Services' | 'Travel' required

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

acceptedCardsCommonsAcceptedCards[] required
source'NATIONAL' | 'LOCAL' required

Source of the merchant associated to the location

createdDatestring date-time required

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

lastModifiedstring date-time required

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

imgUrlstring required

<b>[Deprecated — Please use imgUrl on the offer object which contain attribution tokens]</b>. Merchant image asset URL

bannerImgUrlstring

<b>[Deprecated — Please use bannerImgUrl on the offer object which contain attribution tokens]</b>. Merchant banner image asset URL

Changes

No recorded changes to this operation across all 1 revision of this API.