Redeem Coupon

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.

ParameterTypeDescription
customerobjPass any registered identifier type.
Supported identifiers:
mobile, email, id, external_id, card_number, card_external_id
idlongCoupon id that needs to be redeemed.
codestringCoupon code that need to be redeemed.
validation_codestringValidation code is required for the orgs that use validation based redemption.
numberstringTransaction number against which the coupon needs to be redeemed.
amountdoubleTransaction amount against which the coupon is redeemed.
custom_fieldsobjCoupon redemption level custom fields.
namestringName of the custom field.
valuestringCustom field value.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!