Redeem Voucher
Redeem a voucher for a loyalty program member. The status of the voucher gets updated to redeemed and the use date gets updated to the current date.
51.0
No
POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
membershipNumber | String | The loyalty program membership number. | Required | 51.0 |
programName | String | The loyalty program name. | Required | 51.0 |
voucherCode | String | The voucher code to be redeemed. | Required | 51.0 |
voucherNumber | String | The auto-generated voucher number. | Optional | 55.0 |
Note: The voucher definition associated with the voucher code must be active to redeem the voucher.
Note: Use this query parameter if multiple vouchers exist with the same voucher code.
The request body is available in version 53.0 and later.
JSON Example
JSON example to redeem vouchers using contactId or accountID.
Provide contactId to redeem the voucher. If accountID is provided, then the associated contactId is fetched and the voucher is redeemed
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
contactID | String | ID of the contact associated with the account. | Optional | 62.0 |
currencyIsoCode | String | Three-letter ISO 4217 currency code of the monetary currency in which the voucher is redeemed. | Optional | 55.0 |
redeemAmount | Double | The value of the voucher to be redeemed. Specify a value when a member hasn’t redeemed the full value of the voucher. This value is only applicable for vouchers issued using Fixed Value voucher definitions. A value isn’t required when the member has redeemed the complete value of the voucher in a single transaction. | Optional | 53.0 |
| action | ReservationAction | The action to change the status of a voucher. Valid values are Reserve, Reinstate, or Redeem. If you don’t specify an action, the default behavior changes voucher status from Issued to Redeemed. | Required when changing the voucher status from Issued to Reserved, or from Reserved to Issued or Redeemed. Otherwise it is optional. | 62.0 |
| reservedValue | Currency | Specify the amount reserved for partially redeemable vouchers. | Optional | 62.0 |
| reservationKey | String | Specify the key used to redeem or reinstate a reserved voucher. | Optional | 62.0 |
Note: If you don’t specify a value to be redeemed for the fixed-value voucher, the voucher status changes to Redeemed, and the remaining value becomes zero.
Redeem Voucher Output (available in version 53.0 and later)
This table lists HTTP response code descriptions that are unique to this resource.
| HTTP Response Code | Error Code | Description |
|---|---|---|
| 400 | INVALID_API_INPUT | The voucher is expired. Specify a voucher that hasn’t expired. |
| 400 | INVALID_API_INPUT | The voucher is canceled. Specify a voucher that hasn’t canceled. |
| 400 | INVALID_API_INPUT | Specify a valid voucher code and try again. |
| 400 | INVALID_API_INPUT | Specify a valid loyalty program name and try again. |
| 400 | INVALID_API_INPUT | Specify a valid loyalty program membership number and try again. |
| 400 | INVALID_API_INPUT | The voucher definition is inactive. Specify a voucher that’s associated with an active voucher definition. |
| 409 | ALREADY_REDEEMED_VOUCHER | The voucher is redeemed. Specify a voucher that hasn’t redeemed. |
| 500 | MULTIPLE_VOUCHERS | Duplicate vouchers for this voucher code. Either specify a different voucher code or ask your Salesforce admin for help. |
| 500 | UNKOWN_EXCEPTION | The voucher redemption failed. Try again or ask your Salesforce admin for help. |
See Also