post https://{host}/v2/coupon/bulk/redeem
Lets you redeem one or more coupons of a customer.
A maximum of 20 coupons can be redeemed in a single API request.
Query parameter
| Parameter | Description |
|---|---|
| source | Registered source of the customer. |
| accountId | Account ID for sources with multiple accounts. Required for multi-source accounts. |
Body parameter
| Parameter | Description |
|---|---|
| redemptionRequestList | List of coupons to redeem. |
| code | Coupon code to redeem. |
| redemptionTime | Date and time of redemption in YYYY-MM-DD HH:MM:SS format. |
| transactionNumber | Transaction number for which the coupon(s) needs to be redeemed. |
| billAmount | Transaction amount for which the coupon is redeemed. |
| user | Details of the customer that redeems the coupon(s). |
| id | Unique ID of the customer. |
| mobile* | Unique mobile number of the customer. |
| email* | Unique email ID of the customer. |
| externalId* | Unique external ID of the customer. |
*Any one of the customer identifiers is mandatory.
Response parameter
| Parameter | Description |
|---|---|
| entityId | Unique identifier for the entity. |
| result.id | Unique ID of the result. |
| result.currencyInput | Indicates if currency input is present. |
| result.localToBaseCurrencyExchangeRate | Exchange rate from local currency to base currency. |
| result.code | Code associated with the result. |
| result.discountCode | Code indicating the type of discount. |
| result.seriesCode | Code associated with the series. |
| result.isAbsolute | Indicates if the value is absolute. |
| result.couponValue | Value of the coupon. |
| result.redemptionStatus.statusCode | Status code object containing status details. |
| result.redemptionStatus.message | Message indicating the status of coupon processing. |
| result.redemptionStatus.code | Code indicating the status of coupon processing. |
| result.redemptionStatus.success | Indicates if the coupon processing was successful. |
| result.discountType | Type of discount provided. |
| result.discountValue | Value of the discount provided. |
| result.discountUpto | Maximum value up to which the discount is applicable. |
| totalCount | Total count of items in the response. |
| failureCount | Count of items that failed. |