---
title: "Get Cashback Reward Inquiry"
method: GET
path: "/programs/{programCode}/accounts/{accountIdentifier}/cashbackReward/inquiry"
tags: ["CashbackReward"]
---

# Get Cashback Reward Inquiry

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

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetCashbackRewardInquiryResponse — Represents the response returned after inquiring about cashback reward redemption eligibility and details. Contains redemption eligibility, redeemable items, amounts, period and cycle information, and account identifiers. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `eligibleForRedeem` boolean — Indicates whether the account is eligible to redeem cashback rewards.
  - `redeemableRedemptionList` RedemptionItem[], nullable — The list of redeemable redemption items, each representing a cashback reward period or transaction.
    - `cashBackRewardBusinessProcessKey` integer — The unique key for the cashback reward business process associated with this redemption item.
    - `startDate` string, date-time, nullable — The start date of the cashback reward period for this item.
    - `endDate` string, date-time, nullable — The end date of the cashback reward period for this item.
    - `creditDebit` integer, nullable — Indicates whether the item is a credit or debit (typically 1 for credit, -1 for debit).
    - `cashBackRewardAmount` number, double, nullable — The total cashback reward amount for this item.
    - `redeemableAmount` number, double, nullable — The amount available for redemption for this item.
    - `redeemedAmount` number, double, nullable — The amount that has already been redeemed for this item.
    - `redeemedDate` string, date-time, nullable — The date when the cashback reward was redeemed, if applicable.
    - `expirationDate` string, date-time, nullable — The expiration date for redeeming this cashback reward item, if applicable.
  - `redeemableAmount` number, double — The total amount currently available for redemption.
  - `accountIdentifier` string, nullable — The unique identifier for the account associated with the cashback reward inquiry.
  - `finishedPeriodAmount` number, double — The total cashback reward amount for finished periods.
  - `unFinishedPeriodAmount` number, double — The total cashback reward amount for unfinished periods.
  - `totalRedeemedAmount` number, double — The total amount of cashback rewards that have already been redeemed.
  - `periodInMonths` integer — The number of months in the cashback reward period.
  - `yearlyCapableAmount` number, double — The maximum amount eligible for cashback rewards per year.
  - `nextRedemptionGenerationDate` string, date-time, nullable — The date when the next redemption will be generated, if applicable.
  - `remainingCapableAmount` number, double — The remaining amount eligible for cashback rewards in the current period or year.
  - `accruedCycleMonths` integer — The number of months accrued in the current reward cycle.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)
