Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Redeem Voucher

Represents the response for the redeem voucher POST method.
Sample Response: Reserve
1{
2  "reservationKey": "key1",
3  "reservedValue": 16.34,
4  "status": "Reserved"
5  "currencyIsoCode": "EUR"
6}
Sample Response: Reinstate - Reserved to Issued
1{
2  "remainingAmount": 98.32,
3  "status": "Issued"
4}
Sample Response: Reinstate - Reserved to Expired
1{
2  "status": "Expired"
3}
Sample Response: Redeem
1{
2  "remainingAmount": 98.32,
3  "status": "Redeemed",
4  "currencyIsoCode": "EUR"
5}
Property Name Type Description Filter Group and Version Available Version
remainingAmount Double The voucher value after redemption.

If the complete value of the voucher is redeemed, the remaining amount is zero.

Note

Small, 53.0 53.0
currencyIsoCode String The ISO code of the currency. Small, 53.0 53.0
status VoucherStatus (Enum) Specifies the status of the voucher. Small, 62.0 62.0
reservationKey String Specifies the key used to redeem or reinstate a reserved voucher. Small, 62.0 62.0
reservedValue Currency Specifies the amount reserved for partially redeemable vouchers. Small, 62.0 62.0