| Purpose | Set up the Cloudbeds Booking Engine to collect gift certificate, gift card, or voucher codes from guests during online booking. |
| Best for | Property administrators, managers, and owners configuring gift certificate or gift card workflows. |
| Use this when | You want guests to enter a gift certificate, gift card, or voucher code while making a reservation through Booking Engine Plus. |
| Requirements | The Custom Fields feature must be included in your Cloudbeds package, the gift code field must be configured for reservations and displayed on the Internet Booking Engine, you must have your own gift certificate or voucher codes, and Bank Transfer must be enabled for the Booking Engine. |
| Expected result | Guests can enter their gift code in Additional Information during the Guest Details step and use the Gift Card / Voucher Code payment option when completing the reservation. |
| Limitations | Cloudbeds does not natively create, validate, or redeem gift certificates or gift cards. The custom field collects the code on the reservation; validation and redemption must be handled manually or through a supported third-party integration. |
Introduction
Use this workflow to collect a gift certificate, gift card, or voucher code from guests who make reservations through the Cloudbeds Booking Engine. The code entered by the guest is displayed within the reservation in Cloudbeds PMS.
The setup combines two separate configurations: a custom guest field that collects the gift code during the Guest Details step, and the Bank Transfer payment option with custom JavaScript that displays a Gift Card / Voucher Code payment choice at checkout.
For questions about gift card or gift certificate options in Cloudbeds PMS, contact our Support Team.
Table of contents
- Gift certificate or gift card integrations
- Before you start
- Set up gift certificates or gift cards for Booking Engine reservations
- Review the Booking Engine gift card flow
Gift certificate or gift card integrations
Cloudbeds supports gift card workflows through third-party integrations, but Cloudbeds PMS does not natively create vouchers or gift cards. Properties can integrate with VoucherCart, Gift Up!, or Aiva by Myma.ai, or use the custom-field workflow described in this article.
Before choosing an automatic gift card redemption workflow, consider the following:
- If a guest enters an incorrect gift card code during the reservation, the booking is still created, but the balance on the folio does not change.
- If the gift card does not cover the full reservation or deposit value, a credit card will not be captured as part of this booking flow. The property must contact the guest directly for the additional charges.
If this flow does not meet your property's needs, do not implement the Booking Engine workflow. Charge gift cards manually through VoucherCart, Gift Up!, or Aiva instead.
Before you start
Confirm the following requirements before setting up the gift certificate or gift card workflow.
Before continuing:
- The Custom Fields feature must be included in your Cloudbeds package.
- You must have your own gift certificate or voucher codes to offer to guests.
- The custom field used for the gift code must apply to Reservation and be displayed on the Internet Booking Engine so guests can enter the code during booking.
- When using the custom-field workflow without an integration, your property is responsible for tracking and validating the codes.
Set up gift certificates or gift cards for Booking Engine reservations
Complete the following three steps in order. First, create a field for the guest's code. Then enable Bank Transfer for the Booking Engine, and finally add the JavaScript that changes the payment option displayed to the guest.
Step 1 - Create the custom field
Create a Custom Field where guests can enter their gift certificate or voucher code. Follow How to create a custom field.
Configure the field so it applies to Reservation and is displayed on the Internet Booking Engine. This configuration is what makes the gift code input appear under Additional Information during the Guest Details step.
Set the gift code field as optional. If it is required, guests who do not have a gift certificate or voucher code will not be able to confirm their reservation.
Do not use Gift Card as the custom field name. The word card triggers an error because the system interprets the field as an attempt to collect credit card details. Use a name such as Gift Certificate Code, Gift Code, or Voucher Code instead.
Step 2 - Enable Bank Transfer under Payment Options
Bank Transfer is required for this workflow even though guests will see the customized Gift Card / Voucher Code option instead.
- From the Main Menu
, click Finance
- On the Payment Options tab, click Bank Transfer.
- Activate Bank Transfer and select Booking Engine under Where do you want to allow this payment type?
- Click Save.
The Finance page should show Bank Transfer activated and Booking Engine selected as an allowed payment location.
Step 3 - Add the code in the JavaScript section
Once the custom field is created and Bank Transfer is enabled for the Booking Engine, add the corresponding code in the JavaScript section of Booking Engine Plus.
- From the Main Menu
- Click the Customize tab.
- Copy and paste the following code into the JavaScript field:
<script>
window.addEventListener('on-booking-engine-ready', (e) => {
const { eventSystem } = e.detail;
eventSystem.dispatchEvent("custom-payment-option-change", {
id: "cb-bank-id",
name: {
"en": "Gift Card / Voucher Code",
"pt-br": "Cartão Presente / Código de Voucher",
"fr": "Carte Cadeau / Code Bon",
"es": "Tarjeta de Regalo / Código de Voucher",
"de": "Geschenkkarte / Gutscheincode"
},
instructions: {
"en": "Already filled in your Gift Card or Voucher number in the previous step? Select this option to proceed.",
"pt-br": "Já preencheu o número do seu Cartão Presente ou Voucher na etapa anterior? Selecione esta opção para continuar.",
"fr": "Vous avez déjà saisi votre número de Carte Cadeau ou Bon à l'étape précédente ? Sélectionnez cette option pour continuer.",
"es": "¿Ya completaste el número de tu Tarjeta de Regalo o Voucher en el paso anterior? Selecciona esta opción para continuar.",
"de": "Haben Sie Ihre Geschenkkarten- oder Gutscheinnummer bereits im vorherigen Schritt ausgefüllt? Wählen Sie diese Option, um fortzufahren."
}
});
});
</script>- Click Save.
Before saving, confirm that the code appears in the JavaScript field on the Customize tab.
Review the Booking Engine gift card flow
After saving the setup, open the Booking Engine and test the full reservation flow. The custom field and the JavaScript serve different purposes, and both are needed for the experience described in this article.
- The custom field created under Guests → Custom Fields, configured for Reservation, and displayed on the Internet Booking Engine creates the gift code input under Additional Information during the Guest Details step. This field collects the code and stores it with the reservation.
- The JavaScript added under Booking Engine → Customize → JavaScript changes the Bank Transfer payment option shown at checkout to Gift Card / Voucher Code.
These two configurations work together, but they are not automatically linked. The custom field only captures the gift code as reservation data. Cloudbeds does not validate or redeem the code as part of this setup. Validation and redemption must be completed manually or handled by a third-party integration such as VoucherCart, Gift Up!, or Aiva.
During the Guest Details step, confirm that the gift code field appears under Additional Information before the guest continues to payment.
The following example shows the guest entering the gift code during Guest Details and continuing through the Booking Engine flow before selecting the customized Gift Card / Voucher Code payment option.
If Bank Transfer is the only payment option enabled on the Booking Engine, only the gift card instructions are displayed. The guest does not need to select a payment option.
Next Operational Step
After confirming the Booking Engine flow, process the submitted gift code according to your property's integration or manual validation process. The custom field collects the code, but validation and redemption must be handled manually or by the third-party integration used by your property.
Comments
The code snippet above to change the name of the Bank Transfer field does not appear to be functioning properly with the updated Booking Engine. Is this a known issue?
Hello, Devin March!
Thank you very much for reporting this issue. We have already escalate it to the corresponding team, so they can take a closer look at this as soon as possible.
We will be following up accordingly to apply the necessary changes to the article.
Kind regards!
Juss Reyes, was this code issue resolved?
Hello, Dale McIntyre,
The code should work for the Classic Version of the Booking Engine.
Could you please provide us with more details about your specific request, so we can escalate it to our Support Team for dedicated assistance?
We look forward to hearing from you.
Thank you!
Please sign in to leave a comment.