You are here:
Voucher Redemption
Use the Redeem Voucher API to redeem the vouchers that advocates and their referred friends use. Integrate the Redeem Voucher API with one or more of your external systems where vouchers are redeemed. For example, you can integrate the API with the ecommerce site and POS system where customers use their voucher.
Required Editions
| Available in: Lightning Experience |
| Available in: Enterprise, Performance, Unlimited, and Developer Editions with Referral Marketing |
Redeem Voucher Business API
To learn about the Redeem Voucher API’s resource, request body, and response body, see Redeem Vouchers in the Referral Marketing Developer Guide.
Redeem Vouchers Issued to Advocates
To redeem a voucher that’s used by an advocate, run the API with the code of the redeemed voucher and the advocate’s membership number or Loyalty Program Member ID.
Redeem Vouchers Issued to Referred Friends
To redeem a voucher that’s used by a referred friend, run the API with the code of the redeemed voucher and the referred friend’s Contact ID.
What Happens After Vouchers are Redeemed
| Redemption Scenario | What Happens |
|---|---|
| A single use voucher is redeemed | The status of the voucher is changed to Redeemed and the use date is updated to the current date. |
| A partially redeemable voucher wasn’t redeemed for its full amount | The redeemed value of the voucher is updated with the specified redemption amount and the remaining value of the voucher is automatically calculated. |
| A partially redeemable voucher was completely redeemed during the second use | The status of the voucher is changed to Redeemed and the use date is updated to the current date. The redeemed amount is updated with the value that was redeemed across the two purchases and the remaining value is updated to zero. |
What Happens to Vouchers That Are Past Their Expiration Date
An automated process expires unredeemed and partially redeemed vouchers that are past their expiration date daily. The automated process can expire up to two million vouchers in a day.
If your brand requires to expire more than two million vouchers in a day, the admin can design a batch Apex job to expire the vouchers that the automated process didn’t expire.
