Get Eligible Offers

GET

/rewards/merchant/offers/user/:referringPartnerUserId

GET

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

Play

200Retrieved

1 [
2   {
3     "_id": "5e27318c9b346f00087fbb5c",
4     "category": "Food & Beverage",
5     "commissionType": "PERCENT",
6     "createdDate": "2022-01-01T05:00:00Z",
7     "expirationDate": "2022-01-01T05:00:00Z",
8     "isLocationSpecific": false,
9     "isTargeted": true,
10     "lastModified": "2022-01-01T05:00:00Z",
11     "merchant": {
12       "_id": "123jbsdiertonb089586",
13       "acceptedCards": [
14         "VISA",
15         "MASTERCARD",
16         "AMERICAN EXPRESS",
17         "DISCOVER"
18       ],
19       "category": "Food & Beverage",
20       "description": "Some Merchant description",
21       "name": "Some Merchant",
22       "type": "CARDLINKED",
23       "websiteURL": "http://www.somemerchant.com",
24       "imgUrl": "http://images.somemerchant.com",
25       "bannerImgUrl": "http://banner.somemerchant.com"
26     },
27     "name": "Some offer",
28     "offerType": "INSTORE",
29     "redeemableOnce": true,
30     "source": "NATIONAL",
31     "startDate": "2022-01-01T05:00:00Z",
32     "terms": "some terms",
33     "totalCommission": 4.3,
34     "bannerImgUrl": "www.banner.com",
35     "imgUrl": "www.image.com",
36     "issuersCommission": 1.8,
37     "maxRewardAmount": 20,
38     "maxTransactionAmount": 20,
39     "minRewardAmount": 5,
40     "minTransactionAmount": 5,
41     "usersCommission": 2.5
42   }
43 ]

Retrieve national offers data that a specified user is eligible for. 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 offers to be returned [1 - 200], (default = 200)

merchantIdstringOptional

Merchant ID in Kard’s system

offerTypeenumOptional

Type of offer (whether it is run online or in-store)

Allowed values:

categoryenumOptional

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

isTargetedbooleanOptional

True returns targeted offers, false returns targeted and non-targeted offers

startDateSortenumOptional

Sort offer start dates chronologically (1 for ascending, -1 for descending)

Allowed values:

expirationDateSortenumOptional

Sort offer expiration dates chronologically (1 for ascending, -1 for descending)

Allowed values:

merchantNameSortenumOptional

Sort merchant names (1 for A-Z, -1 for Z-A)

Allowed values:

Response

This endpoint returns a list of objects.

_idstring

Offer ID in Kard’s system

categoryenum

Category of merchant associated with offer

commissionTypeenum

Type of commission on offer (% or a flat $)

Allowed values:

createdDatedatetime

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

expirationDatedatetime

Expiration date of offer if applicable (UTC)

isLocationSpecificboolean

True if offer is valid only for specific locations, false if valid for all locations. Note, this field is usually false

isTargetedboolean

True returns targeted offers, false returns targeted and non-targeted offers

lastModifieddatetime

Last modified date in Kard’s system (UTC)

merchantobject

namestring

Name of offer

offerTypeenum

Type of offer (whether it is run online or in-store)

Allowed values:

redeemableOnceboolean

True if offer is redeemable only once, false if not

sourceenum

Source of merchant associated with offer

Allowed values:

startDatedatetime

Beginning date of offer (UTC)

termsstring

Terms and conditions on offer

totalCommissiondouble

Offer commission going to issuer and user summed up

bannerImgUrlstringOptional

Banner image URL asset containing attribution tokens

imgUrlstringOptional

Image URL asset containing attribution tokens

issuersCommissiondoubleOptional

Commission going to the issuer

maxRewardAmountintegerOptional

Maximum Reward Amount, if available on offer

maxTransactionAmountintegerOptional

Maximum Transaction Amount allowed to redeem offer, if available on offer

minRewardAmountintegerOptional

Minimum Reward Amount, if available on offer

minTransactionAmountintegerOptional

Minimum Transaction Amount required to redeem offer, if available on offer

usersCommissiondoubleOptional

Commission going to user

Get Eligible Offers

Path parameters

Headers

Query parameters

Response

Errors