Newer Version Available
Redeem Voucher Output
- 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. | 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 |