post https://{host}/v2/coupon/redeem
This API allows you to redeem active coupons of a loyalty customer. You can pass multiple coupons at once.
Body parameter
| Parameter | Description |
|---|---|
| billAmount | The total amount of the bill. |
| transactionNumber | The unique number associated with the transaction. |
| user | Details of the customer. |
| user.mobile | Mobile number of the customer. |
| redemptionTime | Date and time of redemption in YYYY-MM-DD HH:MM:SS format. |
| redemptionRequestList | List containing coupon details for redemption. |
| redemptionRequestList[].code | Coupon code to be redeemed. |
Response parameters
| Parameter | Description |
|---|---|
| id | Unique ID of the redemption. |
| warnings | List of warnings related to the redemption. |
| appendedErrorMessage | Appended error message, if any. |
| code | Code of the redeemed coupon. |
| discountCode | Discount code associated with the coupon. |
| seriesCode | Series code associated with the coupon. |
| isAbsolute | Indicates if the coupon value is absolute. |
| couponValue | Value of the coupon. |
| status | Status indicating success or failure. |
| code | Response code associated with the status. |
| message | Message explaining the redemption status. |
| id | Unique ID of the customer. |
| firstName | First name of the customer. |
| lastName | Last name of the customer. |
| fields | Additional fields associated with the profile. |
| type | Type of the identifier (e.g., mobile). |
| value | Value of the identifier. |
| commChannels | Communication channels for the customer. |
| userId | Unique user ID of the customer. |
| accountId | Account ID associated with the customer. |
| autoUpdateTime | Time of the last auto update for the profile. |