Get Eligible Offers

GET

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
offerType"INSTORE" or "ONLINE"Optional
Type of offer (whether it is run online or in-store)
Allowed values: INSTOREONLINE
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
startDateSort"1" or "-1"Optional
Sort offer start dates chronologically (1 for ascending, -1 for descending)
Allowed values: 1-1
expirationDateSort"1" or "-1"Optional
Sort offer expiration dates chronologically (1 for ascending, -1 for descending)
Allowed values: 1-1
merchantNameSort"1" or "-1"Optional
Sort merchant names (1 for A-Z, -1 for Z-A)
Allowed values: 1-1

Response

This endpoint returns a list of objects.
_idstring
Offer ID in Kard's system
categoryenum
Category of merchant associated with offer
commissionType"FLAT" or "PERCENT"
Allowed values: FLATPERCENT
Type of commission on offer (% or a flat $)
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
offerType"INSTORE" or "ONLINE"
Allowed values: INSTOREONLINE
Type of offer (whether it is run online or in-store)
redeemableOnceboolean
True if offer is redeemable only once, false if not
source"NATIONAL" or "LOCAL"
Allowed values: NATIONALLOCAL
Source of merchant associated with offer
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

Errors

Built with