Vouchers page

When customers redeem their points, they receive a voucher that can be displayed within your mobile app. You can create a dedicated page for showcasing vouchers and each voucher's details.

Use the User Voucher endpoint for customer‑facing voucher lists and details. This endpoint returns user‑friendly fields (title, description, fine print, image) and is ordered the same way we show vouchers in Perkville.

Caching (recommended)

Cache voucher lists and voucher details locally in the app. This avoids unnecessary API calls when users move back and forth between screens.

• Refresh the cache after a redemption is completed.

• Refresh if a voucher is marked as used.

• Otherwise, use a short TTL or background refresh.

What to show for each voucher

At minimum, display:

• Title

• Status (USED, UNUSED, EXPIRED, etc.)

• Created date

• Expiration date (if present)

• Point cost

• Redemption instructions / details (if present)

• Location (if present)

• Image (if present)

Displaying codes/urls

We recommend displaying values in the following priority:

• reward_url to an external site

• QR code of the external_coupon_code

• Barcode of the voucher_id

Allowed actions

Using User Vouchers endpoint:

• Customers can mark a voucher as USED via a PATCH request.

• A voucher can only be marked as USED if its current status is UNUSED.

If the voucher is already USED, EXPIRED, VOIDED, or PROCESSING, the “Mark as used” action should be disabled