Welcome to the Loyalty Redemption APIs documentation. Here, you'll find a comprehensive guide to using our APIs for managing loyalty points, coupons, and card freebies within your application.
There are two typical workflows that you can use these APIs in. You can use either of the two to have a successful redemption of points.
a. Validation -> Redemption
- Use a validation API (within the context of points or coupons).
- When validated, use the relevant redemption API.
This works best if you need to use the API for a dashboard that interfaces with customers directly.
b. Hold -> Redemption
- Use a hold API (within the context of points on coupons). The Hold API does validation before putting the points or coupon on hold regardless, so you don't need to do a validation step before hold.
- Use the relevant redemption API.
The hold feature can be configured at the Froogal dashboard to have either no timeout or a set duration of timeout.
This works best when there's multiple POS's which can potentially conflict, and you intend on keeping a hold duration before redemption.
OTP API in Redemption
The OTP Send and Validate APIs can be used to send and validate OTPs in any of the above workflows, in the event that you need to enforce customer validation. Typically, the OTP send API is used after the points are put on hold. The OTP validate API is then used, followed by the redeem API.
Alternatively, you can also use the pair of OTP APIs immediately before something is put on hold.