This API allows you to redeem coupons issued to the loyalty customer. For all redeem coupon APIs event notification is only initiated when a redemption request contains a single coupon. If the request includes multiple coupons, the event will not be triggered.
Parameter | Type | Description |
|---|---|---|
customer | obj | Pass any registered identifier type. |
id | long | Coupon id that needs to be redeemed. |
code | string | Coupon code that need to be redeemed. |
validation_code | string | Validation code is required for the orgs that use validation based redemption. |
number | string | Transaction number against which the coupon needs to be redeemed. |
amount | double | Transaction amount against which the coupon is redeemed. |
custom_fields | obj | Coupon redemption level custom fields. |
name | string | Name of the custom field. |
value | string | Custom field value. |