Newer Version Available

This content describes an older version of this product. View Latest

Redeem Voucher Input

Input representation for voucher redemption.
JSON example
1{
2   "currencyIsoCode" : "Yen",
3   "redeemAmount" : 1.5
4}
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