Overview

The Cashback Rewards API is used to:

• Provide a summary of the cashback rewards earned by tier levels within specific time frames
• Identify cashback rewards in accountholder statements
• Categorize cashback rewards by merchant
• Disclose the cashback percentages for which accountholders are eligible on purchases

Also found in this section is the Cashback Reward Summary API which provides accountholders the following:

• A summary of how much cashback rewards they’ve earned based off their tier level within specific time frames
• Cashback rewards in their statements
• Categorized cashback rewards earned for different merchants

Cashback Rewards API Endpoints

Retrieve List of Process Rules

This endpoint retrieves a list of process rules to determine customer cashback percentage incentives for which accountholders are eligible.

API Call Structure

GET /programs/{programCode}/cashbackReward/businessProcessRules

Request Parameters

Cashback Reward Summary

This API provides accountholders the following:

• A summary of how much cashback rewards they’ve earned based off their tier level within specific time frames
• Cashback rewards in their statements
• Categorized cashback rewards earned for different merchants

API Call Structure

GET /programs/{programCode}/accounts/{accountIdentifier}/cashbackReward/summary

Cashback Reward Summary

This API provides accountholders the following:

• A summary of how much cashback rewards they’ve earned based off their tier level within specific time frames
• Cashback rewards in their statements
• Categorized cashback rewards earned for different merchants

API Call Structure

GET /programs/{programCode}/accounts/{accountIdentifier}/cashbackReward/summary

Request Parameters

Sample Response Body

{
   "categories":[
      {
         "rewardAmount":0,
         "categoryName":"string",
         "categoryType":0,
         "categoryCode":"string"
      }
   ],
   "rewardAmount":0,
   "hasPurchased":true,
   "responseDetails":[
      {
         "code":0,
         "subCode":0,
         "description":"string",
         "url":"string"
      }
   ]
}