API ReferenceRewardsOffers

Get Eligible Offers

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

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 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
bannerImgUrlstring or null
Banner image URL asset containing attribution tokens
imgUrlstring or null
Image URL asset containing attribution tokens
issuersCommissiondouble or null
Commission going to the issuer
maxRewardAmountinteger or null
Maximum Reward Amount, if available on offer
maxTransactionAmountinteger or null
Maximum Transaction Amount allowed to redeem offer, if available on offer
minRewardAmountinteger or null
Minimum Reward Amount, if available on offer
minTransactionAmountinteger or null
Minimum Transaction Amount required to redeem offer, if available on offer
usersCommissiondouble or null
Commission going to user

Errors