Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
CashbackReward

Get Cashback Reward Summary

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
get/programs/{programCode}/accounts/{accountIdentifier}/cashbackReward/summary

Path parameters

programCodestring required

The program code for the cashback reward context.

accountIdentifierstring required

Unique identifier for the account.

Query parameters

startDatestring

The start date for the summary period. Optional.

endDatestring

The end date for the summary period. Optional.

Headers

X-GD-RequestIdstring required

The unique request identifier for tracking and logging.

Response

OK

rewardAmountnumber double

The total cashback reward amount earned by the user.

hasPurchasedboolean

Indicates whether the user has made a qualifying purchase for cashback rewards.

featureEnrollDatestring date-time nullable

The date when the cashback reward feature was enrolled, if applicable.

Example response

{
  "categories": [
    {
      "categoryName": "Gas",
      "categoryType": 1,
      "categoryCode": "Gas"
    }
  ]
}