Payment Gateway Charges 1.X For WHMCS - Revision history

Gregor: Created page with "
2018-02-13T08:14:42Z

Created page with "<meta name="keywords" content="payment gateway charges for whmcs, payment gateway charges configuration, whmcs payment gateway charges management, whmcs payment gateway charge..."

New page
<meta name="keywords" content="payment gateway charges for whmcs, payment gateway charges configuration, whmcs payment gateway charges management, whmcs payment gateway charges installation, whmcs payment gateway charges common problems, about whmcs payment gateway charges, whmcs payment gateway charges documentation, whmcs payment gateway charges faq, whmcs payment gateway charges help, whmcs payment gateway charges guide, whmcs payment gateway charges wiki, whmcs payment gateway charges tutorial, whmcs payment gateway charges tips, whmcs payment gateway charges wiki"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Payment Gateway Charges For WHMCS Module."></meta>

=About [https://www.modulesgarden.com/products/whmcs/payment-gateway-charges Payment Gateway Charges For WHMCS]=
{|
|style="padding: 10px 0px 5px 0px;"|'''Payment Gateway Charges For WHMCS''' allows you to charge additional fees and set up discounts for usage of a chosen payment gateway.<br />
With this module you can easily set products, addons, domains and other items which require an additional fee.<br />
You can also select clients that will be exempt from fees and discounts.
|}

'''Features:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Set Different Rates For Different Payment Gateways (Percentage Or Fixed)
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Set Different Discounts For Different Payment Gateways (Percentage Or Fixed)
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Set Minimum Invoice Value To Charge Payments And Discounts
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Include/Exclude From Charges And Discounts Certain Clients
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Include/Exclude From Charges Certain Products, Addons, Domains And Other
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Automatic Conversion Of Charges And Discounts In Different Currencies
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ PayPal Subscription Charging
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Impose Tax On Charges
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Impose Charge After Tax
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Impose Charge Before Tax And Charge Tax
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Choose Billing Type
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Standard - Exclusive Charge
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ PayPal - Inclusive Charge
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Display Charge Rates Depending On Available Gateways
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Display Calculated Price For Each Available Gateways
|}
'''Supported Order Form Templates:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Ajaxcart
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Boxes
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Cart
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Cloud Slider
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Comparison
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Modern
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Premium Comparison
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Pure Comparison
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Slider
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Standard Cart
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supreme Comparison
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Universal Slider
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Verticalsteps
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Web20cart
|}
'''General Info:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Supports All Payment Gateways
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports Mass Payment Functionality
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Easy Integration Which Automatically Adjusts To Each Order Form Template
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
|}
{|
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
|}

=Installation=
{|
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Payment Gateway Charges For WHMCS.''' <br />
We will guide you step by step through the whole installation and configuration process. <br />
|}
{|
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC1.png]]
|}
{|
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC2.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
The content of PHP version files should look like this.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:tyesrte.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Payment Gateway Charges For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
File is located in '' 'modules/addons/gateway_charges_functions/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC3.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area'' → 'My Products'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC4.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Payment Gateway Charges' '' and press '' 'Activate' '' button.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC5.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
To do so click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC6.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Payment Gateway Charges!'''<br />
You can access your module at '' 'Addons' '' → '' 'Payment Gateway Charges'. ''
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:GC7.png]]
|}

=Configuration and Management=
{|
|style="padding: 10px 0px 30px 15px;"|'''Payment Gateway Charges For WHMCS allows your customers to manage additional charges in your WHMCS system.'''<br />
In this short guide we will present you the possibilities of our module.
|}

==Integration Code==
{|
|style="padding: 10px 0px 10px 15px;"|'''Integration described below is not obligatory.'''<br />
Module allows your customers to view charges for using payment gateways when ordering.<br />
We implemented easy integration codes and the displayed instruction of which can be easily adjusted to each order form template.<br />
<br/>
''Note! Please insert the codes to the template you are using, if you use more than one template then insert the codes to all of them. <br/> The provided directory is just an example of one of the available templates.<br />''
<br/>
Underneath you will find as specific information on the code insertion as possible. <br/>
As soon as you enter any part of integration, its status will change from '' 'Undone' '' to '' 'Done' '' in the addon.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC18.png]]
|}
===Table of Charges on Cart===
{|
|style="padding: 0px 0px 20px 15px;"|To display charges table on order form, add the below integration code.<br/>
Open the template you are using (we opened '' 'modern' '' template as an example).
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC8.1.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Correctly placed codes in '' 'modern' '' order form template are presented on the following screens.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC8.png]]
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC8.2.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|In the client area it should look like on the screen below.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:GC9.png]]
|}

===Credits Integration===
{|
|style="padding: 0px 0px 15px 15px;"|These integration codes will remove charge when a client pays through credits.<br />

Open the '' 'viewinvoice.tpl' '' file and insert the below codes at the very top of that file. Remember to alter the file of the used by you template!<br/> On the screen there is a shown location of the file in template '' 'Six'.''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC9.1.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Properly inserted code should look like that:
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:GC19.png]]
|}

===PayPal Subscription Integration===
{|
|style="padding: 0px 0px 15px 15px;"|PayPal subscription is integrated automatically, there is no need for you to add any codes.<br/> '' 'PayPal' '' button that is shown on the invoice below allows your clients to pay automatically for recurring payments via PayPal. <br />
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:GC20.png]]
|}

==Configuration==
===Gateway Charges===
{|
|style="padding: 10px 0px 15px 15px;"|Proceed to the addon itself, you will be moved directly to its configuration. Firstly you will have to set charges for each active in your system gateway.<br/>
Find a list of active gateways and set charges for all of them or only for those you wish.<br/>
|}
{|
|style="padding: 0px 0px 15px 15px;"|To set additional charge for a payment gateway, simply enter desired values in a corresponding column.<br />
You can add percentage value of invoice amount or fixed amount to charge. Fixed amount will be charged in the default currency of the client.<br/>
Once you have set up the configuration, press '' 'Save Changes' '' button.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC10.png]]
|}

===Additional Options===
{|
|style="padding: 0px 0px 15px 15px;"|Find tab'' 'Additional Options', '' you may configure there your personal charges' options. <br/>
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC2_11.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|
#'''Minimum Invoice Value''' - set minimum value of invoice to charge or place discount
#'''Tax Payment Charge''' - tick to impose taxes on charges
#'''Charge After Taxing''' - if selected, charge will be applied to an already taxed item
#'''Hide Gateway Charges Table''' - if selected, the box with details of additional payments with our module on the order form will not be visible for a client
#'''Charge After Applying Promo Code''' - if checked, your promotion codes will be taken into consideration before calculating the final price.
#:''See [http://www.docs.modulesgarden.com/Payment_Gateway_Charges_1.X_For_WHMCS#Tips Tips] section to read about exceptions!''
#'''Billing type''' - choose between ''Standard'' (exclusive charge) or ''PayPal billing'' type (inclusive charge) - see below to note the differences
#:''Underneath you can find some examples illustrating difference in charging with both types.''
Do not forget to press '' 'Save Changes'. ''
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''Billing types explanation:'''<br/>
'''''Standard (exclusive to cart total)''''' - when this type is selected, then full amount charged for product and fee paid to a payment gateway is counted in a standard way;<br/>
'''''PayPal (inclusive to final total)''''' - when PayPal method is selected, charge amount is already included in the fee when calculating the final amount.
:''Note: when this method is selected such billing type is applied to every activated payment gateway, not only to the PayPal ones.''
|}
{|
|style="padding: 0px 0px 10px 15px;"|Please see at the below table any calculations done during counting the final price to pay by the client and the amount that will be given to PayPal and note the difference<br/> between the two available methods.
|}
{|
|style="padding: 0px 0px 15px 15px;"|
'''Product Price:''' $124 <br/>
'''Gateway Fee:''' 5%<br/>
{| class="wikitable"
| style="padding: 0px 10px 0px 15px;"|'''Method'''
|style="padding: 0px 10px 0px 15px;"|'''Base Fee'''
|style="padding: 0px 10px 0px 15px;"|'''Full Amount'''
|style="padding: 0px 10px 0px 15px;"|'''PayPal Fee'''
|-
| style="padding: 0px 10px 0px 15px;"|'''Standard'''
|style="padding: 0px 10px 0px 15px;"|124 * 0,05 = 6,2
|style="padding: 0px 10px 0px 15px;"|124 + 6,2 = 130,2$
|style="padding: 0px 10px 0px 15px;"|130,2 * 0,05 = 6,51$
|-
| style="padding: 0px 10px 0px 15px;"|'''PayPal'''
|style="padding: 0px 10px 0px 15px;"|(124/0,95) - 124 = 6,53
|style="padding: 0px 10px 0px 15px;"|124 + 6,53 = 130,53$
|style="padding: 0px 10px 0px 15px;"|130,53 * 0,05 = 6,53$
|}
|}
{|
|style="padding: 20px 0px 20px 25px;"|[[File:GC2_21.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Underneath you can see an exemplary order summary view after additional options (charges description) has been provided in English.php language file<br/> and with standard billing type selected.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:GC21_1.png]]
|}

==Management of Clients==
{|
|style="padding: 10px 0px 20px 15px;"|In order to enable/disable charges for specific clients move to '' 'Client' '' section.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC13.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|Here you can exclude clients from being charged.<br />
To do so, mark checkbox next to client ID and press '' 'Save Changes', '' consequently such client will not be additionally charged for using a specific payment gateway.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:GC14.png]]
|}

==Management of Items==
{|
|style="padding: 10px 0px 20px 15px;"|To enable/disable charges for products and addons, proceed to'' 'Items' '' section.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC15.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|In order to '''disable''' charges for products or addons, mark checkboxes next to the chosen ones and press '' 'Save Changes'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC16.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|In order to '''enable''' charges for domain actions or items, mark checkboxes next to the chosen entries and press '' 'Save Changes'. ''<br />
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC17.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Marked '' 'Other Invoice Item Types' '' applies charges to all other invoice types, which were not described above.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:GC17x.png]]
|}

==Automatic Conversion of Charges==
{|
|style="padding: 10px 0px 30px 15px;"|This functionality will make you forget about all the problems with currencies. Module automatically calculates the value basing on your default currency.<br />
'''1.''' Module automatically calculates fixed amount discount depending on the currency selected by the customer. '''Example:'''<br />
When your default payment gateway currency is USD and you set fixed amount discount at -1.00, your customer who prefers to pay in USD will receive $1 discount.<br />
If you have other payment gateway currency, let's say EUR, and the same fixed amount discount -1.00, your customer who prefers to pay in EUR will receive about 0.75€ discount.<br />
'''2.''' Exactly the same as above applies to Minimum Invoice Value which currency is also automatically calculated.<br />
'''3.''' Percentage value is collected separately for each currency based on the values specified in the '' 'Pricing' '' section of each product, addon, domain or other.
|}

==Disabling Payment Gateway for Specific Product Group==
{|
|style="padding: 10px 0px 15px 15px;"|If you want to disable payment gateway for a specifc product group, follow these simple steps.<br />
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit product group you want to disable payment gateway for.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC22.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|Unmark checkbox next to payment gateway you want to disable and press '' 'Save Changes' '' button.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:GC23.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|As you can see on the following screen, payment gateway was disabled for products from group you edited.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:GC24.png]]
|}

=Tips=
{|
|style="padding: 10px 0px 10px 15px;"|1. For your convenience, payments gateway charges are enabled by default for clients, products and addons.<br/> Charges for domains and other are disabled by default.
|}
{|
|style="padding: 0px 0px 5px 15px;"|2. Promotion codes: if the option '' 'Charge After Applying Promo Code' '' is enabled in the addon, you need to remember about one thing. <br/>
''If the promotion code is created for a bundle of items (e.g. a product ordered with an addon) then all '''required''' items must be chargeable to allow the promotion <br/>before being charged with the gateway charge. In case at least one of the required items in the ordered package is not chargeable, the promotion will be applied after charging the price.''
|}
{|
|style="padding: 0px 0px 5px 15px;"|3. Charge/Discount Charges visible names are included in language file of the module (e.g. english.php), there are used two variables which you can use to alter displayed names of the two options.<br/> The mentioned variables are:
$LANG['mg_chtpl_charged'] = 'Payment Gateway Charge';
$LANG['mg_chtpl_discount'] = 'Payment Gateway Discount';
|}
{|
|style="padding: 0px 0px 5px 15px;"|4. It is advised that '' 'Auto Apply Credits' '' option should be disabled due to the possibility of problems occurrence.<br/>
Charge is not automatically added and calculated when auto applying credits.<br/>
Problems may occur when a client does not have sufficient credits for both the basic payment and the charge.
|}
{|
|style="padding: 0px 0px 5px 15px;"|5. In case administrator deletes a hosting product that has been invoiced but later on the payment gateway is changed then such hosting product is treated as of '' 'Other' '' type on the invoice.
|}
{|
|style="padding: 0px 0px 10px 15px;"|6. It is possible to either hide or change the header above the available payment gateways visible to the client.
|}
{|
|style="padding: 0px 0px 10px 15px;"|[[File:GC_24.png]]
|}
{|
|style="padding: 0px 0px 30px 15px;"|There are two possible ways:<br/>
1. To change the line, edit the module english.php lang file. Find line:
$LANG['client_header'] = 'Payment Gateway Charges';
Change the text as you need or leave empty space between quotation marks:
<nowiki>$LANG['client_header'] = ''; </nowiki>

2. To delete the line, edit your currently used template.<br/> Depending on the used cart, adequate template must be found and edited.<br/>
Templates are located in: ''/modules/addons/gateway_charges_functions/templates/''<br/>
Full list of files:
boxes.tpl
ajaxcart.tpl
cart.tpl
comparison.tpl
default.tpl
modern.tpl
slider.tpl
standard_cart.tpl
*verticalsteps.tpl<br/>
<br/>
Find variable that describes this language line and comment the line including it out:
{$lang.client_header}

Usually this is:
<nowiki><h2 {if $hideChargesTable}style="display: none;"{/if}>{$lang.client_header}</h2></nowiki>
or
<nowiki><h2>{$lang.client_header}</h2></nowiki>
|}

=Update Instructions=
{|
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
|}

=Common Problems=
{|
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
|}