Skip to navigation
Cards

Rewards

Show a customer’s ThankYou® points balance and let them redeem for cash back, travel, and gift cards.

View as Markdown

Overview

The Rewards API surfaces a customer’s ThankYou® Points balance and the ways they can redeem them. Use it to show reward progress inside your app, highlight redemption options, and let customers redeem points without leaving your experience.

What you can do

Show a points balance — Display current, pending, and expiring points.

Present redemption options — List cash back, statement credit, travel, and gift card options with their point costs.

Redeem on behalf of the customer — Submit a redemption once the customer confirms.

Get a points balance

1

Authenticate

Obtain an access token with the rewards:read scope.

2

Request the balance

Call the endpoint with the customer’s cardRef or rewards account reference.

3

Highlight expiring points

Use the expiring block to nudge customers to redeem before points lapse.

{
  "rewardsRef": "rw_90233",
  "program": "ThankYou® Rewards",
  "pointsBalance": 48210,
  "pendingPoints": 1250,
  "expiring": { "points": 3000, "date": "2026-12-31" },
  "estimatedCashValue": 482.10,
  "currency": "USD"
}

Redemption options

OptionDescription
CASH_BACKDeposit to a linked checking or savings account
STATEMENT_CREDITApply value against a credit card balance
TRAVELRedeem toward flights, hotels, and more
GIFT_CARDConvert points to partner gift cards

Point values can vary by redemption type. Return the estimatedCashValue alongside each option so customers can compare before they redeem.

Security requirements

Reading a balance requires the rewards:read scope. Submitting a redemption requires customer confirmation and the appropriate write scope. See the Authentication guide.