logo
API docs by Redocly

Kard (1.31)

Download OpenAPI specification:Download

E-mail: dev@getkard.com URL: http://www.getkard.com/ License: Apache 2.0 Terms of Service
Find out how what Kard Financial has to offer!

Introduction

This API definition is intended to assist Kard's customers interactions with our API.

Reference

Audit Code Definitions

Code Description
3005 Customer is claiming cashback is incorrect - INCORRECT CASHBACK CLAIM
3006 Transaction is missing the cashback award - MISSING CASHBACK AWARD
8001 Other - check audit description

Resolution Code Definitions

Code Description
5001 Transaction will be deleted
5002 Settlement amount will be adjusted
5003 Return amount will be adjusted
5004 Reward dispute resolved
5005 Transaction will be marked for writeoff
5006 Transaction will be marked as rejected
5007 Transaction will be resent through webhook
5008 Transaction will be resent through daily file
5009 No change needed
9001 Ineligible item in purchase
9002 Return was made
9003 User ineligible for offer (usually because of participation through another program)
9004 Redemption limit hit (if offer has a set number of redemptions and it isn't handled programmatically)
9005 Transaction not captured

Client Credentials Flow Explained:

Client Credentials Flow, the simplest of all of the OAuth 2.0 grants, is suitable for machine-to-machine authentication where a specific user’s permission to access data is not required. The issuer will be provided client_id and client_secret by Kard.

Issuer client sends a POST request with following headers to the Token URL in the Authentication section below to retrieve the access_token:

  • Content-Type: application/x-www-form-urlencoded
  • Authorization: Basic {base64 encoded copy of ‘client_id:client_secret’}

The access_token will be the value used for the Authorization header field for all subsequent API requests to Kard.

Offers

Offers Endpoint

Get Affiliate Offers

Request Affiliate offers provided by Kard

Authorizations:
Token
header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "logoUrl": "https://assets.getkard.com/public/logos/merchant.jpg",
  • "type": "AFFILIATE",
  • "exclusions": "No exclusions",
  • "_id": "5f985a39796cb042f0826f8b",
  • "bannerImgUrl": "https://assets.getkard.com/public/banners/merchant.jpg",
  • "name": "merchantName",
  • "merchantBaseURL": "https://www.merchant.com",
  • "description": "Description of merchant",
  • "createdDate": "2020-10-27T17:34:49.964Z",
  • "lastModified": "2021-02-25T19:35:47.147Z",
  • "offers": [
    ]
}

Audit

Audit Endpoint

Create Audit Request

Request a particular cardlinked transaction to be audited via audit code.

Authorizations:
Token
header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server
Request Body schema: application/json

Audit payload

transactionId
required
string

Cardlinked Transaction ID

transactionAmountInCents
number

Transaction amount in cents

referringPartnerUserId
string

User ID

merchantId
string

Internal Kard Merchant ID

merchantName
required
string

Merchant name

auditCode
required
number
Enum: 3005 3006 8001

Audit Code

auditDescription
required
string

Audit Description

submitterName
string

Submitter Name

preferredContactEmail
required
string

Preferred Contact Email

issuer
required
string

Issuer Name

Responses

Request samples

Content type
application/json
{
  • "transactionId": "53wo-jnBX-WwZc-gpgR",
  • "transactionAmountInCents": 2600,
  • "referringPartnerUserId": "5e135a5a2b1f4c0008c9df79",
  • "merchantId": "5e27318c9b346f00087fbb32",
  • "merchantName": "Caribbean Goodness",
  • "auditCode": 8001,
  • "auditDescription": "duplicate transaction",
  • "submitterName": "Submitter Name",
  • "preferredContactEmail": "someone@company.com",
  • "issuer": "Bank of You"
}

Response samples

Content type
application/json
{
  • "_id": "5eb2d4a39ce24e00081488c4",
  • "transactionId": "some cardlinked transaction id",
  • "transactionAmountInCents": 2600,
  • "referringPartnerUserId": "5e135a5a2b1f4c0008c9df79",
  • "merchantId": "5e27318c9b346f00087fbb32",
  • "merchantName": "Caribbean Goodness",
  • "auditCode": 8001,
  • "status": "NEW",
  • "auditDescription": "duplicate",
  • "submitterName": "Submitter Name",
  • "preferredContactEmail": "someone@company.com"
}

Get Audit Request Status

Request an update on created audit request. The resolutionCode, resolutionDescription and resolutionTimeStamp will not be avaialbe until the audit has been CLOSED.

Note: You can also expect to receive this response body via a POST request sent to your transactionAuditWebhook endpoint.

Authorizations:
Token
path Parameters
id
required
string

The audit request id

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
{
  • "_id": "5eb2d4a39ce24e00081488c4",
  • "transactionId": "some id",
  • "transactionAmount": 2600,
  • "transactionTimeStamp": "2020-04-22T15:15:47.389Z",
  • "referringPartnerUserId": "5e135a5a2b1f4c0008c9df79",
  • "merchantId": "5e27318c9b346f00087fbb32",
  • "merchantName": "Caribbean Goodness",
  • "auditCode": 8001,
  • "auditDescription": "duplicate",
  • "status": "CLOSED",
  • "resolutionCode": 5001,
  • "resolutionDescription": "Dupe found",
  • "resolutionTimeStamp": "2020-05-07T15:15:47.797Z",
  • "submitterName": "Submitter Name"
}

Incoming Transactions

Incoming Transaction Endpoint

Endpoint that receives a transaction to be processed via Kard's services

Authorizations:
TokenSecret
header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server
Request Body schema: application/json

Transaction Payload Sent by Issuer

Array (non-empty)
transactionId
required
string

Transaction Id

referringPartnerUserId
required
string

User Id sent from issuer

amount
required
number

Transaction Amount in Cents

status
required
string
Enum: "APPROVED" "SETTLED" "REVERSED" "DECLINED" "RETURNED"

Transaction Status

currency
required
string

Currency of Transaction

description
required
string

Description of Transaction - Includes Merchant Name

description2
string

Description of Transaction - Includes Other Identifying Merchant Information

coreProviderId
string

Name of Processor

mcc
required
string

Merchant Category Code

transactionDate
required
string

Timestamp for REVERSED, RETURNED, DECLINED; REQUIRED for REVERSED, RETURNED, DECLINED status. Date string should be in ISO format i.e.'YYYY-MM-DDThh:mm:ss.sTZD' where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. 1994-11-05T08:15:30-05:00 OR 1994-11-05T08:15:30Z

authorizationDate
required
string

Timestamp for APPROVED transaction, REQUIRED if APPROVED status. Date string should be in ISO format i.e.'YYYY-MM-DDThh:mm:ss.sTZD' where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. 1994-11-05T08:15:30-05:00 OR 1994-11-05T08:15:30Z

settledDate
required
string

Timestamp for SETTLED transaction, REQUIRED if SETTLED status. Date string should be in ISO format i.e.'YYYY-MM-DDThh:mm:ss.sTZD' where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. 1994-11-05T08:15:30-05:00 OR 1994-11-05T08:15:30Z

merchantId
required
string

Acquirer Merchant ID (MID)

merchantStoreId
string

Merchant Store Id

cardPresence
string

Card Information Available

merchantName
required
string

Merchant Name

merchantAddrCity
required
string

Merchant Address City

merchantAddrState
required
string
Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY"

Merchant Address State

merchantAddrZipcode
string

Merchant Address Zipcode

merchantAddrCountry
string

Merchant Address Country

merchantAddrStreet
required
string

Merchant Address Street

merchantLat
string

Merchant Address Latitude

merchantLong
string

Merchant Address Latitude

panEntryMode
string

Pan Entry Mode

cardBIN
required
string

Must be a valid BIN of 6 digits. If over 6 digits, send first 6

cardLastFour
required
string

Last Four Digits of Credit Card

googleId
string

Google Id

Responses

Request samples

Content type
application/json
{
  • "transactionId": "asdlkfjalksdf0t-dsfdfsdfsdkajsldkf",
  • "referringPartnerUserId": "6FHt5b6Fnp0qdomMEy5AN6PXcSJIeX69",
  • "status": "APPROVED",
  • "amount": 1000,
  • "currency": "USD",
  • "merchantName": "ADVANCEAUTO",
  • "description": "ADVANCEAUTO",
  • "description2": "ADVANCEAUTO",
  • "authorizationDate": "2021-07-02T17:47:06Z"
}

Response samples

Content type
application/json
"Incoming Transaction event successfully queued for processing"

Users

Users Endpoint

Create User Request

Create a User in Kard's system

Authorizations:
Token
header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server
Request Body schema: application/json

Audit payload

email
required
string

Email of user; email or userName is required

userName
required
string

Username of user from issuer; email or userName is required

referringPartnerUserId
required
string

Unqiue user id of user from issuer

externalPartnerUserId
string

Partner unique user id, might be equal to referringPartnerUserId

firstName
string

First name of user

lastName
string

Last name of user

zipCode
required
string

Zipcode of user

object

User Card Information (REQUIRED for Matching)

enrolledRewards
Array of strings
Items Enum: "CARDLINKED" "AFFILIATE"

If field is not supplied, user will automatically be enrolled in all programs in use

Responses

Request samples

Content type
application/json
{
  • "email": "someone@email.com",
  • "userName": "some_user_name",
  • "referringPartnerUserId": "1234567890",
  • "externalPartnerUserId": "1234567890",
  • "firstName": "John",
  • "lastName": "Doe",
  • "zipCode": "10028",
  • "cardInfo": {
    },
  • "enrolledRewards": [
    ]
}

Response samples

Content type
application/json
"New user event sent for processing"

Add Card To User

Send a request to Kard's services to create a card that a user will use to make purchases

Authorizations:
Token
path Parameters
id
required
string

The id of the user which is the referringPartnerUserId

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server
Request Body schema: application/json

Create User Card Payload

referringPartnerUserId
required
string

Unique user id of user from issuer

required
object (cardInfo)

Responses

Request samples

Content type
application/json
{
  • "referringPartnerUserId": "1234567890",
  • "cardInfo": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "5e135a5a2b1f4c0008c9df79",
  • "email": "someone@email.com",
  • "userName": "some_user_name",
  • "firstName": "John",
  • "lastName": "Doe",
  • "zipCode": "10028",
  • "referringPartner": "Name_Of_Issuer",
  • "referringPartnerUserId": "1234567890",
  • "enrolledRewards": [
    ],
  • "cards": [
    ],
  • "createdDate": "2020-10-27T17:34:49.964Z",
  • "lastModified": "2020-10-27T17:34:49.964Z",
  • "__v": 0
}

Delete User Request

Delete a User in Kard's system

Authorizations:
Token
path Parameters
id
required
string

The referringPartnerUserId issued by the Issuer

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
"Successfully deleted User"

Update User Request

Update a User in Kard's system

Authorizations:
Token
header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server
Request Body schema: application/json

User payload

email
string

Email of user; email or userName is required

userName
string

Username of user from issuer; email or userName is required

firstName
string

First name of user

lastName
string

Last name of user

zipCode
string

Zipcode of user

referringPartnerUserId
required
string

Unqiue user id of user from issuer

externalPartnerUserId
string

Partner unique user id, might be equal to referringPartnerUserId

enrolledRewards
Array of strings
Items Enum: "CARDLINKED" "AFFILIATE"

An empty array will unenroll user from all programs

Responses

Request samples

Content type
application/json
{
  • "email": "someone@email.com",
  • "userName": "some_user_name",
  • "firstName": "John",
  • "lastName": "Doe",
  • "zipCode": "10028",
  • "referringPartnerUserId": "1234567890",
  • "externalPartnerUserId": "1234567890",
  • "enrolledRewards": [
    ]
}

Response samples

Content type
application/json
{
  • "email": "someone@email.com",
  • "userName": "some_user_name",
  • "firstName": "John",
  • "lastName": "Doe",
  • "zipCode": "10028",
  • "referringPartnerUserId": "1234567890",
  • "cardInfo": {
    },
  • "enrolledRewards": [
    ]
}

Earned Rewards

Issuer Earned Rewards Webhook

Issuer Earned Reward Webhook

Endpoint that receives Kard's earned reward notification

Authorizations:
Secret
header Parameters
Content-Type
required
string
Example: application/json
Notify-Signature
required
string
Example: signature created from issuer secret

Responses

Response samples

Content type
application/json
Example
{
  • "user": {
    },
  • "reward": {
    },
  • "card": {
    },
  • "transaction": {
    },
  • "postDineInLinkURL": "http://www.somemerchant.com/postdineinlinkurl",
  • "error": { }
}

Merchant

Get Rewards Merchant

Request Rewards Merchants

Authorizations:
Token
query Parameters
page
number >= 0

Number of pages to be returned

limit
number [ 1 .. 200 ]

Number of results to be returned

source
string
Enum: "NATIONAL" "LOCAL"

Source of merchant

category
string
Enum: "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. Use Url Encode for non single word categories. Food & Beverage should be Food%20%26%20Beverage

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Eligible Rewards Merchant

Request national rewards merchants that a specified user has eligible national offers from. Local Merchants can be pulled via Get Rewards Merchants using: /rewards/merchant?source=LOCAL

Authorizations:
Token
path Parameters
referringPartnerUserId
required
string

Referring partner user id from issuer.

query Parameters
page
number >= 0

Number of pages to be returned

limit
number [ 1 .. 200 ]

Number of results to be returned

category
string
Enum: "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. Use Url Encode for non single word categories. Food & Beverage should be Food%20%26%20Beverage

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Rewards Merchant By Id

Request Rewards Merchants for given Id

Authorizations:
Token
path Parameters
id
required
string

The merchant id

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
{
  • "_id": "5e27318c9b346f00087fbb5c",
  • "name": "Some merchant",
  • "source": "NATIONAL",
  • "description"": "N/A",
  • "imgUrl": "https://www.somemerchant.com/image.png",
  • "websiteURL": "https://www.somemerchant.com",
  • "acceptedCards": [
    ],
  • "category": "Food & Beverage",
  • "optInRequired": false,
  • "type": "CARDLINKED",
  • "offers": [
    ]
}

Location

Get Location By Id

Request Location for given Id

Authorizations:
Token
path Parameters
id
required
string

The location id

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
{
  • "_id": "5e27318c9b346f00087fbb5c",
  • "merchantId": "5e27318c9b346f00087fbb5c",
  • "name": "Location Name",
  • "locationType": "INSTORE",
  • "source": "NATIONAL",
  • "address": {
    },
  • "geoLocation": {
    },
  • "phone": "(123) 456-7890",
  • "operationHours": {
    },
  • "category": "Food & Beverage"
}

Get Locations By Merchant Id

Request Location for given Merchant Id

Authorizations:
Token
path Parameters
id
required
string

The merchant id

page
number >= 0

Page number

limit
number [ 1 .. 200 ]

Maximum number of locations

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
{
  • "_id": "5e27318c9b346f00087fbb5c",
  • "merchantId": "5e27318c9b346f00087fbb5c",
  • "name": "Location Name",
  • "locationType": "INSTORE",
  • "address": {
    },
  • "geoLocation": {
    },
  • "phone": "(123) 456-7890",
  • "category": "Food & Beverage",
  • "operationHours": {
    }
}

Get Locations

Request Locations. Please note, Longitude and Latitude is prioritized over State, City and Zipcode.

Authorizations:
Token
query Parameters
page
number >= 0

Page number

limit
number [ 1 .. 200 ]

Maximum number of locations

locationName
string

Name of location

googleId
string

GoogleId from location

city
string

City of location; REQUIRES state field

state
string
Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY"

State of location; REQUIRES city field

zipCode
string

Zipcode of location, cannot provide State, City, Longitude, Latitude when using Zipcode

createdDateStart
string
Example: createdDateStart=2022-01-01T05:00:00Z

Time in string format for createdDate search (UTC)

createdDateEnd
string
Example: createdDateEnd=2022-01-01T05:00:00Z

Time in string format for createdDate search (UTC)

locationNameSort
number
Enum: 1 -1

Sort location names

citySort
number
Enum: 1 -1

Sort city names

stateSort
number
Enum: 1 -1

Sort state names

longitude
number [ -180 .. 180 ]

Longitude to search locations from, must provide latitude

latitude
number [ -90 .. 90 ]

Latitude to search locations from, must provide longitude

radius
number [ 1 .. 50 ]

Radius to search for locations in miles, defaults to 10. Must provide longitude & latitude

source
string
Enum: "NATIONAL" "LOCAL"

Source of location

category
string
Enum: "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. Use Url Encode for non single word categories. Food & Beverage should be Food%20%26%20Beverage

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Eligible Locations

Request national and local locations that a specified user has eligible offers at. Please note, Longitude and Latitude is prioritized over State, City and Zipcode.

Authorizations:
Token
path Parameters
referringPartnerUserId
required
string

Referring partner user id from issuer.

query Parameters
page
number >= 0

Page number

limit
number [ 1 .. 200 ]

Maximum number of locations

locationName
string

Name of location

googleId
string

GoogleId from location

city
string

City of location; REQUIRES state field

state
string
Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY"

State of location; REQUIRES city field

zipCode
string

Zipcode of location, cannot provide State, City, Longitude, Latitude when using Zipcode

createdDateStart
string
Example: createdDateStart=2022-01-01T05:00:00Z

Time in string format for createdDate search (UTC)

createdDateEnd
string
Example: createdDateEnd=2022-01-01T05:00:00Z

Time in string format for createdDate search (UTC)

locationNameSort
number
Enum: 1 -1

Sort location names

citySort
number
Enum: 1 -1

Sort city names

stateSort
number
Enum: 1 -1

Sort state names

longitude
number [ -180 .. 180 ]

Longitude to search locations from, must provide latitude

latitude
number [ -90 .. 90 ]

Latitude to search locations from, must provide longitude

radius
number [ 1 .. 50 ]

Radius to search for locations in miles, defaults to 10. Must provide longitude & latitude

category
string
Enum: "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. Use Url Encode for non single word categories. Food & Beverage should be Food%20%26%20Beverage

includeLocal
boolean

When this parameter is included, the API response will include Local Offers alongside National Offers. If omitted, the response will only contain national offers.

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Offer

Get Rewards Offers

Request Rewards Offers

Authorizations:
Token
query Parameters
page
number >= 0

Page number

limit
number [ 1 .. 200 ]

Maximum number of offers

name
string

Name of merchant for offer

offerType
string
Enum: "INSTORE" "ONLINE"

Type of offer

merchantId
string

Internal Kard Merchant ID

startDateStart
string
Example: startDateStart=2022-01-01T05:00:00Z

Time in string format for startDate search (UTC)

startDateEnd
string
Example: startDateEnd=2022-01-01T05:00:00Z

Time in string format for startDate search (UTC)

expirationDateStart
string
Example: expirationDateStart=2022-01-01T05:00:00Z

Time in string format for expirationDate search (UTC)

expirationDateEnd
string
Example: expirationDateEnd=2022-01-01T05:00:00Z

Time in string format for expirationDate search (UTC)

startDateSort
number
Enum: 1 -1

Sort start date

expirationDateSort
number
Enum: 1 -1

Sort expiration date

merchantNameSort
number
Enum: 1 -1

Sort merchant name

source
string
Enum: "NATIONAL" "LOCAL"

Source of merchant

category
string
Enum: "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. Use Url Encode for non single word categories. Food & Beverage should be Food%20%26%20Beverage

isTargeted
boolean

true if targeted offer, false if global

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Eligible Rewards Offers

Request national rewards offers that a specified user is eligible for.

Authorizations:
Token
path Parameters
referringPartnerUserId
required
string

Referring partner user id from issuer.

query Parameters
page
number >= 0

Page number

limit
number [ 1 .. 200 ]

Maximum number of offers

offerType
string
Enum: "INSTORE" "ONLINE"

Type of offer

merchantId
string

Internal Kard Merchant ID

startDateSort
number
Enum: 1 -1

Sort start date

expirationDateSort
number
Enum: 1 -1

Sort expiration date

merchantNameSort
number
Enum: 1 -1

Sort merchant name

category
string
Enum: "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. Use Url Encode for non single word categories. Food & Beverage should be Food%20%26%20Beverage

isTargeted
boolean

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

header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string
Example: access_token from authorization server

Responses

Response samples

Content type
application/json
[]