Introduction

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

Reference

Audit Code Defintions

Code Description
1001 There is more than one transactions with a positive value and the same transaction ID - LIKELY DUPLICATE
1002 There is more than one transactions with a negative value (return), same transaction ID and same time stamp - LIKELY DUPLICATE
2001 The total value of the returns for a transaction ID are greater than the original transaction - RETURNS EXCEED PURCHASE AMOUNT
3001 Settled amount is different to authorized amount and there is no reject code as justification - SETTLED AND AUTHORIZED AMOUNTS DIFFER NO EXPLANATION PROVIDED
3002 Settled amount is different from paid amount- SETTLED AND PAID AMOUNTS DIFFER
3003 Settled transaction has not been paid after 60 days - UNPAID AGED SETTLED TRANSACTION
3004 Authorized transaction has not been settled after 150 days - UNSETTLED AGED AUTHORIZED TRANSACTION
3005 Customer is claiming cashback is incorrect - INCORRECT CASHBACK CLAIM
4001 Transaction is missing one or many key fields - TRANSACTION MISSING KEY FIELDS
4002 Webhook authorized transaction doesn't have a corresponding transaction in the daily file - MISSING AUTHORIZED IN DAILY FILE
4003 Webhook settled transaction doesn't have a corresponding transaction in the daily file - MISSING SETTLED IN DAILY FILE
4004 Authorized transaction in the daily file doesn't have a corresponding transaction in the webhooks - MISSING AUTHORIZED IN WEBHOOK
4005 Settled transaction in the daily file doesn't have a corresponding transaction in the webhook - MISSING SETTLED IN WEBHOOK
8001 Other - check audit description

Resolution Code Defintions

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
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)

Authentication

main_auth

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://rewards-api.auth.us-east-1.amazoncognito.com/oauth2/token?grant_type=client_credentials
Scopes:
  • audit:read -

    read audit

  • audit:write -

    create audit

  • transaction:write -

    transaction write

  • user:write -

    user write

  • user:delete -

    user delete

  • cardlinked:read -

    cardlinked read

  • affiliate:read -

    affiliate read

Token

Security Scheme Type API Key
Header parameter name: Authorization

Secret

Security Scheme Type API Key
Header parameter name: Notify-Signature

Offers

Offers Endpoint

Get Affiliate Offers

Request Affiliate offers provided by Kard

Authorizations:
Token (affiliate:read)
query Parameters
issuer
required
string

Name of issuer

Responses

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "type": "AFFILIATE",
  • "exclusions": "No exclusions",
  • "_id": "5f985a39796cb042f0826f8b",
  • "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": [
    ]
}

Merchants

Merchants Endpoint

Get Affiliate Merchants

Request Affiliate Merchants provided by Kard

Authorizations:
Token (affiliate:read)
query Parameters
status
string

Status of merchants

page
string

Number of pages of results

limit
string

Limit number of results

Responses

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "type": "AFFILIATE",
  • "exclusions": "No exclusions",
  • "_id": "5f985a39796cb042f0826f8b",
  • "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": [
    ]
}

InStore

InStore Offers Endpoint

Get InStore Reward By Id

Request an InStore reward for given Id

Authorizations:
Token (cardlinked:read)
path Parameters
id
required
string

The offer id

Responses

Response samples

Content type
application/json
{
  • "_id": "5e27318c9b346f00087fbb5c",
  • "name": "Some merchant",
  • "source": "LOCAL",
  • "description"": "N/A",
  • "status": "ACTIVE",
  • "websiteURL": "N/A",
  • "googleId": "ChIJif_mso9t1oYRWQ44Xj_T2hs",
  • "address": {
    },
  • "phone": "(123) 456-7890",
  • "operationHours": {
    },
  • "acceptedCards": [
    ],
  • "processorMapping": [
    ],
  • "presenterMids": [
    ],
  • "category": "Food & Beverage",
  • "location": {
    },
  • "optInRequired": false,
  • "type": "CARDLINKED",
  • "offer": {
    },
  • "createdDate": "2020-01-21T17:14:52.166Z",
  • "lastModified": "2021-03-12T05:00:58.456Z"
}

Get InStore Rewards

Request InStore rewards

Authorizations:
Token (cardlinked:read)
query Parameters
issuer
required
string

Name of issuer

lat
number [ -90 .. 90 ]

latitude

long
number [ -180 .. 180 ]

longitude

distance
number [ 0 .. 15 ]

distance from longitude and latitude

city
string

city to be searched

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 to be searched

zipCode
string

Zipcode to b