Versions Compared

Old Version 1

changes.mady.by.user Dev

Saved on

compared with

New Version 2

changes.mady.by.user Dev

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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)

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

This addon module will allow you to provide your customers with support pin numbers for easy verification.

Key Features

  • 5 types of pin: (Main pin, 3rd party pin, temporary pin, Service Pin (1.30), Domain Pin (1.32))
  • Variable length and pin combo (numeric vs alphanumeric)
  • Adjustable pin code valid period
  • Autogenerate when a code expires
  • Easy to install, no template code modification needed
  • WHMCS Six template compatible
  • Easily translatable using WHMCS language files
  • Display in the sidebar, navigation menu, homepage panel
  • Allow customer to request temporary support pin (New in 1.34)

Main pin 

is intended for all general purpose verification. Such as billing modification, account changes… etc

3rd party pin

is intended for the account holder providing account support access to a 3rd party individual without providing the main account. Such as contacting your company for support.

Temporary pin 

is intended for providing quick verification if the account owner can't login but still have email access. Temporary keys are generated by your company staff and it is emailed to the customer's email

Service Pin

is intended for all purpose pin for a particular service a customer have

Domain Pin

is intended for all purpose pin for a particular domain a customer have

Requirements

Make sure you have the ioncube10 loader installed for your web server. If you are running ioncube 5 or prior loader then you can either run easyapache to rebuild the ioncube extension automatically or download and modify the loader manually

You must be using a template that's build off of the six template engine as it utilizes the sidebar function.

Installation Instructions

Copy all the files into your WHMCS modules/addons directory. No template modification is needed

Language Files

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/

customerpin

giftcard/lang/ to your associated language. For example, french.php. The filename must match to the ones in the WHMCS/lang/french.php

Template Files

There are no template modification. The support pins will be displayed in the sidebar of the template.

Starting the module

Configuration

Activation

Log into your WHMCS admin and enable the module by going to Enable the module like you would for any other WHMCS module. WHMCS Admin → Setup → Addon Modules → Gift Card Module Admin → Activate

Image Modified

Once activated you can set the options below

Modifying the email template

Upon installation of this module, a new email template will be installed onto your WHMCS. You can view and edit the template named WHMCS Customer Pin Template

Module Config Options

There are several options you can set with the mod. Here is a quick breakdown.

OptionExplainationRequest Pin PageThis will allow client to request temporary support pin for non-login validationRequest Pin Time IntervalThe number of seconds the client can request a temporary support pin email againShow Request Pin LinkThis will insert a Request Support Pin link for non-logged in client to the Client AreaDate display formatChange the display format for the pin expiry datePer Service PinEnable Service Support PinDisable Per Account PinEnabling this will disable the Account Support Pin when Per Service Pin is enabled. Otherwise no effectAllow 3rd party support pinThis will enable the customer's ability to generate a 3rd party support codeMain pin styleSet the main account's pin either numeric (0-9) or alphanumeric (A-z0-9)Main pin lengthThe length of the main pinMain pin valid durationThe number of days the pin is valid for until it get regenerated againTemp pin valid durationThe number of minutes the temporary pin is valid for (it will not regenerate, it is has to be sent manually)3rd party optionsSame as the main pin optionsEmail Template IDThe name the email template the module will use to send out the temporary pin (The name must be exact)Display optionsThese options will determine which template page the module will display on

, 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

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.

Request Pin Page

If your WHMCS template is not based on Six, then you can add a link manually to your template to link to the Request Pin Page

Code Block
languagexml
index.php?m=customerpin&action=requestpin

Table of Contents
maxLevel2
minLevel2
absoluteUrltrue