Installation Guide

Key Features

• Integration with WHMCS native ordering/invoicing system
• Native Provision module included
• No template fiddling!
• Integration with WHMCS Email Marketer and Emails
• Powerful API system for script integrations
• Multi-currency Support
• Gift Cards can be dividable to small sub-cards
• Selling price vs face value
• Multiple expiration dates on gift cards
• Card can be emailed out to friends and family!
• Single use gift cards for Promotional Purpose (New in v2.4)
• Restrict which WHMCS Client Group can buy or redeem the gift card (New in v2.5)
• Cashier Mode - Allow for variable value Gift Card to be purchased (New in v2.5)
• SMS/Phone Validation - Force the customer to perform a validation before a Gift Card is activated (New in v2.6)
• Voucher Mode - Sell your services as a redeemable voucher (New in v2.7)
• Domain Voucher Mode - Sell domain renewal voucher (New in v2.8)

Installation

File Uploads

Upload all the files in the modules folder to your WHMCS installation. modules/addons/giftcard & modules/servers/giftcardprovision

Template Uploads

No template upload is needed

Language Uploads

The module includes English as the base language. If you wish to translate it to your enabled language in WHMCS. Make a copy of the english.php in /modules/addons/giftcard/lang/ to your associated language. For example, french.php. The filename must match to the ones in the WHMCS/lang/french.php

Configuration

Activation

Log into your WHMCS admin and enable the module by going to Setup → Addon Modules → Gift Card Module Admin → Activate

Once activated, click on Configure and fill in the license key and make any settings adjustment.

WHMCS Product Setup

During the initial module activation, the wizard will create a new Product Group and Product (Product Placeholder) in your WHMCS install. Both of these are hidden by default and it does not need to be shown to your customers. 

There are few things you would want to adjust before continuing.

1. Update the Product groups (Gift Card Group) to only allow certain type of payment. This important as you don't want to allow fraud to happen with gift cards

2. Updating the Product,

• You may want to change the Product Name as this will be listed in the invoice item.
• Make sure the Welcome Email is matched with the Welcome email (Gift Card Available) the module had created during activation.
• Tax, on or off? Some countries require Gift cards purchase to be taxed
• Pricing, leaving it as 0.00. They will be adjusted accordingly during checkout
• Module Settings → Module Name → Gift Card Provision Module

If you have updated the name of product placeholder, make sure you go back to the Module Configuration in Setup → Addon Modules → Configure and update to the new Product name accordingly to the Generic Product ID dropdown

WHMCS Email Template Setup

The module will create the following two email templates into your WHMCS. Gift Card Available and Gift Card Sending Template

Gift Card Listing

In order for the module to work in the front end, you must have at least one Gift Card available for purchase.

To add a Card for sale, navigate to

Addons → Gift Card Module Admin → Card Management → Create New Listing

To understand what each option does, simply mouseover each option.

HTML codes: <p><br><b><strong><strike> can be used in the Card Description field

Instant Redemption (New in v2.73)

Instant redemption allows for the buyer of the gift card to automatically redeem the gift card credits onto the account upon successful payment. This is useful for when you want to allow discount for purchasing credit on your WHMCS.

Hide Apply Credit (New in v2.73)

This option is useful tool to combat "infinite free money" loop in conjunction with the Instant Redemption option. 

In order for this to work, you must disable WHMCS's Automatic Credit Use.

Setup → General Settings → Credit → Automatic Credit Use

Once this is enabled, the client will no longer see the apply credit button on the invoice upon checking out. 

Buy Limit (Credit) (New in v2.73)

This is another tool to combat "infinite free money" loop.

Once the limitation is set for the Gift Card, any client with more than the set amount of credit in the account balance will not be able to proceed with the Gift Card purchase.

Voucher Mode (New in v2.7)

With Voucher Mode, it allows for a new style of card code (Voucher) to redeem a product in a one to one manner. There are two types of Vouchers available: New Service Voucher & Renewal Voucher. You can map each individual voucher for sale to a specific product in your WHMCS. You can set the length of the service the 

New Service Voucher

For vouchers set to New Service, the voucher redeemer can obtain a new service available in your WHMCS. The billing cycle for these type of voucher falls in line with the billing cycle available in WHMCS. 

With New Service Vouchers, you may require the redeemer to input a value (either a hostname or domain name) before a redemption is allowed. The input will be used in the domain field of the service. 

If you need additional value to be inputted by the user, please refer to the Advance Voucher Redemption Guide

Renewal Service Voucher

For vouchers set to Renewal, the voucher redeemer can extend their existing service within their account. The billing cycle for these type of vouchers are in line with the WHMCS billing cycle except for One Time. An additional cycle called Lifetime is available for renewal vouchers. When a user redeem a Lifetime voucher, their existing service will be updated to a One Time service and no further billing will occur for this service.

Cashier Mode (New in v2.5)

With Cashier Mode, you can allows for the customer to create their own Gift Card with their defined card value.

There are 4 options for Cashier Mode

Restriction Group (New in v2.5)

with the Restriction Group feature. You can now restrict which client in which WHMCS Client Group to be able to Purchase and/or Redeem Gift Card in a particular Gift Card Listing

To utilize this function.

1. Create a new Restriction Group (Gift Card Addon → Card Management → Restriction Group) Figure 1

2. Once created, go back to the Restriction Group and Edit

3. Now you will be able to select which group is allow to buy/redeem for this Restriction Group

4. Once you have the Restriction Group ready. Go back to Card Management then you will now see the new group you created in the Restriction Group option dropdown (Figure 2) for each Card Listing. You can now adjust accordingly

Menus (Client Area)

With our seamless template setup, there is no template modification needed. To enable the Gift Card menu in your navigation bar go to the Configuration of the Module and use the following options

If 2) is disabled, then 3-6 will not show up.

Frontend Workflow

The module work in this workflow