Allows you to sell and redeem gift vouchers
To use this capability add
Gift vouchers allow you to sell fixed value monetary amounts in the form of a gift card which can be redeemed later as a form of payment against a new order.
The request above was made with the following request body:
The UUID on the request body is optional but recommended if you're requesting from a source of poor network connectivity. If the connection fails or you do not receive a response, you can repeat the same request with the same UUID and it will respond with the same booking object without duplicating the gift voucher.
The gift voucher object is described as:
The gift voucher object schema described above will be returned on every endpoint in this section. Only the values may change.
You can update a gift voucher before and after it has been confirmed as long as it hasn't been redeemed or within the cancellation cutoff window. To know if the booking can be updated check the
gift.cancellablefield. If the gift can be cancelled, it can also be updated. It's generally preferred to update a gift rather than cancelling it and recreating it.
An example of the confirmation request above looks like this:
"fullName": "Oliver Morgan",
"emailAddress": "[email protected]",
"locales": ["en-GB", "en-US", "en"],
Once the gift is confirmed, the delivery options of both the voucher and/or ticket are populated. An example of the values is shown below:
//... inside the "voucher" object
deliveryValuegiven under QRCODE can be typed online to redeem the gift voucher, alternatively the PDF can also be provided and the guest can give this to the recipient.
Note you can only cancel a gift voucher if
This endpoint will fetch the gift voucher with the provided UUID from the system.
When using this endpoint you must include one of the following parameters:
The results aren't paginated as the result set will never be too long because of the required filters.
Redeem Gift Voucher
With a confirmed gift code it's possible to redeem it by adding a
giftPaymentfield to the booking either on the reservation step or after in a
Note that if you use the
octo/cartMulti-booking Cart capability then the request and response parameters are identical for the
If the code is valid, currency matches the order currency, and the gift card is still valid with sufficient credit then it'll be applied to the booking.
giftPaymentobject will then be included on the booking object response like so:
//... rest of the booking object
It could be that the gift card has sufficient credit to cover the whole order, which case you'll be able to confirm immediately. Alternatively you may need to add a card payment also. Check out the Card Payment capability for this.
Last modified 1yr ago