Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
CashbackReward

Get Cashback Reward Inquiry

Provides accountholders the following:

  • Eligibility for redemption
  • List of redeemable items
  • Redeemable amount
  • Account identifier
  • Finished period amount
  • Unfinished period amount
  • Total redeemed amount
  • Period in months
  • Yearly capable amount
  • Next redemption generation date
  • Remaining capable amount
  • Accrued cycle months
get/programs/{programCode}/accounts/{accountIdentifier}/cashbackReward/inquiry

Path parameters

programCodestring required

The program code for the cashback reward context.

accountIdentifierstring required

The unique identifier for the account. Required.

Headers

X-GD-RequestIdstring required

The unique request identifier for tracking and logging.

Response

OK

eligibleForRedeemboolean

Indicates whether the account is eligible to redeem cashback rewards.

redeemableAmountnumber double

The total amount currently available for redemption.

accountIdentifierstring nullable

The unique identifier for the account associated with the cashback reward inquiry.

finishedPeriodAmountnumber double

The total cashback reward amount for finished periods.

unFinishedPeriodAmountnumber double

The total cashback reward amount for unfinished periods.

totalRedeemedAmountnumber double

The total amount of cashback rewards that have already been redeemed.

periodInMonthsinteger

The number of months in the cashback reward period.

yearlyCapableAmountnumber double

The maximum amount eligible for cashback rewards per year.

nextRedemptionGenerationDatestring date-time nullable

The date when the next redemption will be generated, if applicable.

remainingCapableAmountnumber double

The remaining amount eligible for cashback rewards in the current period or year.

accruedCycleMonthsinteger

The number of months accrued in the current reward cycle.