Redeem Voucher Input
Input representation for voucher redemption.
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
| 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.