v2.0
OpenAPI 3.1.1

Redemptions 2.0 (New) API - Mobile

The Redemptions 2.0 protocol has been designed to replace the legacy Redemptions 1.0 endpoints. The new protocol allows for the following features:

  • Single-scan flow support
  • Batching of redemptions to occur in a single API call
  • Stacked discounting
  • Proportional breakdown of discounted items
  • Item qualifier recycling
  • Enhance flexibility to redemption rules and processing orders

The Redemptions 2.0 protocol is not backward compatible with the legacy Redemptions 1.0 endpoints. Configurations within the Punchh platform are required, so please contact your Punchh representative for help before starting development.

Redemptions 2.0 API endpoints

All mobile endpoints are related to CRUD operations to a guest's discount basket. The discount basket is a persistent object that will be created by mobile/web for which available discounts can be selected to redeem in an upcoming transaction. The following endpoints enable different discount basket operations.

For more information, see Online Ordering Module 5: Redemptions.

Server:https://SERVER_NAME_GOES_HERE.punchh.com
Client Libraries