| Previous Topic | Next Topic | |
|---|---|---|
| POS Module 6c: Voiding Redemptions - Concepts (Redemptions 1.0) | POS Module 7: Check-in |
POS API Certification Tutorial - Module 6c: Voiding Redemptions - Example Scenarios (Redemptions 1.0)
Prerequisites
- You must have read the scenario assumptions.
- Review Module 6c: Voiding Redemptions - Concepts.
- Review Module 6b: Process/Create Redemption - Example Scenarios.
General Tasks for Voiding Single and Multiple Redemptions
1. After successfully creating a redemption with the Create Redemption API, get the redemption_id from the Create Redemption API response.
2. Using the redemption_id, pass the required parameters in the Void Redemption API. If you are voiding multiple redemptions, use the Void Multiple Redemptions API.
Tip: When voiding Punchh coupons and promo codes, send the redemption_code parameter along with the transaction_no. Email is not a required parameter when voiding Punchh coupons and promo codes using the redemption code. Before voiding Punchh coupons and promo codes, show a message on the POS that the reward will not be credited back to the guest account and whether the guest wants to proceed with the Yes and No options.
Possible Scenario
The following scenario is based on the assumptions here.
Story Line
Monica has earned $4 in rewards and wants to use them on her next visit. She orders an $8 avocado toast and a $4 iced latte, and Rachel looks up Monica’s account via phone number and makes sure that the rewards in her account can be applied to her purchase. Rachel asks her to confirm if she wants to use her rewards today, which she says she does. So, Rachel processes and creates the redemption, which brings Monica’s check to $8.
However, Monica suddenly remembers that her credit card is running a special cash-back promotion and that she needs to use that card to maximize the benefits. She asks Rachel if she can use the rewards at a later visit.
Rachel enters the redemption ID that is generated after processing the redemption at the POS. The POS uses the Void Redemption API with the redemption_id as one of the parameters to cancel the redemption and returns Monica’s reward to her account. Monica pays $12 for the order using her credit card and gets 12 points for this transaction.
Code Sample (Direct API Integration)
The following code sample contains the API request and response for the transaction between the POS and Punchh based on this story line. After Rachel successfully looks up Monica's account using her phone number (212-555-6578) and Monica redeems her rewards on the POS, Monica decides to cancel the redemption. Rachel cancels the redemption on the POS by calling the Void Redemption API with the following information:
- Email: 2125556578-619@phone.punchh.com
- Redemption ID: 717344
| Request Body | Response Body |
| API endpoint name: Void Redemption DELETE {server-name}/api/pos/redemptions { "phone": "2125556578", "email": "2125556578-619@phone.punchh.com", "redemption_id": "717344" } |
{} |