This document outline the basic installation, configuration and the basic usage of the WHMCS Gift Card Module v2.
The usage guide can be found here. http://wiki.codebox.ca/doku.php?id=whmcs-gift_card_v2_usage
Upload all the files in the modules folder to your WHMCS installation. modules/addons/giftcard & modules/servers/giftcard
No template upload is needed
The module includes English as the base language. If you wish to translate it to your own language. Make a copy of the english.php in /modules/addons/giftcard/lang/ to your associated language.
Log into your WHMCS admin and enable the module by going to Setup → Addon Module → Gift Card Module Admin → Activate
Once activated, click on Configure and fill in the license key and make any settings adjustment.
Important!! If your WHMCS is less than version 7.2, then make sure you have selected the proper APIuser with API access.
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.
Note: The product and product is hidden because the module doesn't use the WHMCS system to checkout the order. However, it does use WHMCS's order system + API to manage the orders. Therefore, the Product Placeholder is needed for invoice iteming.
The module will create the following two email templates into your WHMCS. Gift Card Available and Gift Card Sending Template
Gift Card Available - This template is used for the Welcome Email for the Product Placeholder.
Gift Card Sending Template - This template is used when your customer want to send out the gift card to their friends via email.
If you have updated the name of Gift Card Sending Template, make sure you go back to the Module Configuration in Setup → Addon Modules → Configure and update to the new name accordingly to the Send GC Template dropdown
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
With our seamless template setup, there is no template modification needed. To enable the Gift Card menu in your navigation bar goto the Configuration of the Module and use the following options
1) Display Gift Card in Service - This adds a new link in the Services sub-menu in the default navigation bar
2) Display menu in navigation menu - This will add a new Gift Card sub-menu into the navigation bar
3) Display My Gift Card - This will display a My Gift Card link in the Gift Card sub-menu
4) Display Redemption Link - This will display a Redemption link in the Gift Card sub-menu
5) Display Buy Gift Card - This will display a Buy Gift Card in the Gift Card sub-menu
6) Search Sub Card - This will display a Search Sub Card in the Gift Card sub-menu
If 2) is disabled, then 3-6 will not show up.
If you want to modify the links of these menu items, you can open and edit modules\addons\giftcard\hooks.php
Your WHMCS should now be ready to be used. Here are some basic usage
If you want to generate Cards for your customers to use. This is great for if you want to generate small amount of cards for promotion.
Addons → Gift Card Module Admin → Card Management → Generate Cards
If you want to modify the your Listing line up, simply goto Card Management Tab
Hit Save when done.
Upon loading the Module home, you will be greeted with a basic overview of your card statuses.
The module includes comprehensive tools to let you manage your Cards efficiently.
Card Overview Tab
In this tab you have 5 tools available
1) Pending, 2) Approved, 3)Unredeem, 4) Redeem, 5) Search, 6) Run Fraud Check
1-4 will list all the cards under those statuses. With 5 you can perform a deeper search down to the user and card.
The Fraud Check will allow you to check which customer have purchase gift cards in the last 7 days, 30 days, 6 months and year. (Sub cards are not counted)
The frontend will require the client to be logged in to function. You may wish to enable your WHMCS to allow client registration in Setup → General Settings → Other → Allow Client Registration
The module work in this workflow
The following is the associated page and the template mapping. The templates can be located in module/addons/giftcard/templates
Checkout /gcFoward,tpl, gcGeneral.tpl - This is the checkout process
GC Listing and Cart /gcIndex.tpl, gcIndexLogin.tpl. gcIndexOrder.tpl - This is will show the gift card listing that is available for purchase
Manage GC /gcManage.tpl - This page serves as the gift card management
My Gift Cards /gcMy.tpl - This page will list all your purchased gift cards
My Sub Cards /gcMysubcards.tpl - This page will list all sub cards
Redemption Page /gcRedeem.tpl - This is the gift card redemption page
GC Split Form /gcSplit.tpl - This page is for splitting of the gift card
Sub Card Search /gcSubsearch.tpl - This page will allow your client to search for a sub card's origin. Will only work if the card is bought by the client
Warning Code: CP11 - License error, please check your license
No matching Gift Card in the database, please create it manually - This error relates to a missing Gift Card entry in the gift card table. You will need to create a new card, assign it to the user then update the Domain field under the Service tab.
v2.1 (August 14, 2017) - Implemented self-contained module format to simply install and maintenance
v2.0 (August 11, 2017) - Initial Release