Redeem Voucher Input

Input representation for voucher redemption.

JSON example

1{ 
2  "action": "Reserve", 
3  "reservationKey": "key1", 
4  "reservedValue": 50.57, 
5  "redeemAmount": 50.57, 
6  "currencyIsoCode": "Yen" 
7}

Properties

Name	Type	Description	Required or Optional	Available Version
`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. 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. Note	Optional	53.0
action	ReservationAction	Specify whether to redeem, reserve, or reinstate the voucher. The values for this property could be Reserve, Reinstate, or Redeem.	Required	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

Loyalty Management Developer Guide