Redeem confirmation page

This page should confirm the reward the customer is about to redeem, the point cost, and any restrictions that apply. Use this page to prevent failed redemptions before the customer submits.

What to show

  • Reward title

  • Points required

  • Description (if present)

  • Redemption instructions (if present)

  • Fine print (if present)

  • Business fine print (if present)

  • Location being used for redemption

  • Redemption limits (if present)

  • Required level / required attributes (if present)

  • Current point balance

  • Projected balance after redemption (current balance − points required)

When to disable the Redeem button (pre‑submit)

Disable redemption if any of the following are true:

  • can_redeem = false

  • user_redemption_limit_info.has_met_limit = true

  • must_redeem_at_home_location = true and the customer is not at their home location

Always show the reason in the UI when you can infer it (required level, required attributes, limit reached, etc.).

Additionally, if offering a location selection when redeeming, please only include locations at which the perk is available.

Submit Redemption

Once the customer confirms their redemption, use the Transaction endpointarrow-up-right to submit the redemption request. This will process the transaction and deduct the appropriate points from the customer's account.

Successful redemption

When the redemption succeeds:

  • Show a success state

  • If a voucher is returned, show:

    • Redirect to the voucher detail view (recommended)

    • Voucher code / identifier

    • Redemption instructions

    • Expiration date (if present)

Error handling (customer‑safe copy)

These are common redemption‑time errors and recommended customer‑safe messages:

  • pv_txn_insufficient_points “You don’t have enough points to redeem this reward.”

  • pv_perk_redemption_limit_reached “You’ve reached the redemption limit for this reward.”

  • pv_txn_perk_not_active “This reward is no longer available.”

  • pv_perk_not_available “This reward is not available right now.”

  • pv_txn_ineligible_loc “This reward isn’t available at this location.”

  • pv_txn_loc_not_home_loc “This reward must be redeemed at your home location.”

  • pv_no_coupons_left “This reward is currently unavailable. Please try again later.”

  • pv_txn_user_not_active “You must join the loyalty program before redeeming rewards.”

  • pv_txn_user_inactive “Your account is inactive. Please contact support.”

  • pv_txn_user_banned “Your account is not eligible to redeem rewards.”

  • pv_txn_biz_not_active “This loyalty program is no longer active.”

Last updated

Was this helpful?