Redeem a Voucher

Introduction

The Rest Tender API is a part of the Rest Basket API that is used to record a tender on the basket. Note that this API is not responsible for “taking payment” – only for recording the effect of a payment in the basket.

Service URL: POST /baskets/{basketReference}/tenders/redeemVoucher[?returnBasket=true]

Tokens:

basketReference – The basket reference of the basket to redeem the voucher against

Request Body:

IRedeemVoucherRequest:

voucherTypeId – String – The ID of the voucher type to use to redeem the voucher – Required

voucherValue – Long – The value of the voucher to redeem – Optional, depending on the voucher configuration

serialNumber – String – The serial number of the voucher to redeem – Optional, depending on the voucher configuration

Remarks:

Redeems a voucher in the context of a basket. The exact behaviour of the redemption will depend on the configuration associated with the voucher type.

Currently vouchers which trigger promotions and which are used as a “tender” are supported.

If the returnBasket flag is true, the updated basket will be returned

Example Request:

{
    "voucherTypeId": "MY-VT",
    "serialNumber": 12345,
}