Get Eligible Merchants

GET

/rewards/merchant/user/:referringPartnerUserId

GET

1 curl -G https://rewards-api.getkard.com/rewards/merchant/user/{referringPartnerUserId} \
2      -H "Authorization: Bearer <token>" \
3      -d limit=1 \
4      -d page=0

Play

200Retrieved

1 [
2   {
3     "_id": "5e27318c9b346f00087fbb5c",
4     "acceptedCards": [
5       "AMERICAN EXPRESS",
6       "MASTERCARD",
7       "VISA",
8       "DISCOVER"
9     ],
10     "category": "Food & Beverage",
11     "createdDate": "2022-03-12T05:00:58.456Z",
12     "description": "N/A",
13     "lastModified": "2022-03-12T05:00:58.456Z",
14     "name": "Some merchant",
15     "offers": [
16       {
17         "_id": "5e27318c9b346f00087fbb5b",
18         "commissionType": "PERCENT",
19         "createdDate": "2022-03-12T05:00:58.456Z",
20         "expirationDate": "2022-03-12T05:00:58.456Z",
21         "isLocationSpecific": false,
22         "isTargeted": true,
23         "lastModified": "2022-03-12T05:00:58.456Z",
24         "merchantId": "5e27318c9b346f00087fbb5c",
25         "name": "Some offer",
26         "offerType": "INSTORE",
27         "optInRequired": false,
28         "redeemableOnce": true,
29         "startDate": "2022-01-01T05:00:00Z",
30         "terms": "Not all cards are eligible and not all transactions can be monitored. For debit cards, run transaction as credit, do not use PIN. Offer valid from 12/19/2018. Maximum individual reward 250 dollars. The business may change or end the Offer at any time up to the point of purchase without notice.",
31         "totalCommission": 9.5,
32         "bannerImgUrl": "https://www.someoffer.com/banner",
33         "imgUrl": "https://www.someoffer.com/image.png",
34         "issuersCommission": 3.5,
35         "maxRewardAmount": 20,
36         "maxTransactionAmount": 20,
37         "merchantLocationIds": [
38           "12abc45ef"
39         ],
40         "minRewardAmount": 5,
41         "minTransactionAmount": 5,
42         "usersCommission": 6
43       }
44     ],
45     "source": "NATIONAL",
46     "websiteURL": "https://www.somemerchant.com",
47     "imgUrl": "https://www.somemerchant.com/image.png",
48     "bannerImgUrl": "https://www.somemerchant.com/bannerImage.png",
49     "type": "CARDLINKED"
50   }
51 ]

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.
Required scopes: rewards:read

Path parameters

referringPartnerUserIdstringRequired

Referring partner user ID from issuer that specifies user

Query parameters

pageintegerOptional

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

limitintegerOptional

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

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

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

imgUrlstringDeprecated

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

bannerImgUrlstringOptionalDeprecated

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

Get Eligible Merchants

Path parameters

Headers

Query parameters

Response

Errors