Personal tools
Namespaces

Variants
Actions

Payment Gateway Charges For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Additional Options)
Line 4: Line 4:
 
=About [https://www.modulesgarden.com/products/whmcs/payment-gateway-charges Payment Gateway Charges For WHMCS]=
 
=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 />
+
|style="padding: 10px 0px 5px 0px;"|'''Payment Gateway Charges For WHMCS''' allows you to charge additional fees and set up discounts for the 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 />
+
With this module you can easily set products, addons, domains as well as other items which require an additional fee, and select clients who will be exempt from fees and discounts.<br />
−
You can also select clients that will be exempt from fees and discounts.
+
On top of that, you will also be empowered to define multiple steps of charges as well as discounts which shall be taken depending on the invoice amount.<br />
 +
Finally, the module will enable you to lay down your own conditions for the application of charges and discounts involving client groups, countries and currencies.  
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
 
*'''Features:'''
 
*'''Features:'''
−
{|
+
{|  
−
|style="padding: 10px 0px 0px 30px;"|✔ Set Different Rates For Different Payment Gateways (Percentage Or Fixed)
+
|style="padding: 10px 0px 0px 30px;"|✔ Display Charge Or Discount Rates Depending On Available Gateways
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Different Discounts For Different Payment Gateways (Percentage Or Fixed)
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Calculated Rates For Chosen Gateways
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Minimum Invoice Value To Charge Payments And Discounts
+
|style="padding: 0px 0px 0px 30px;"|✔ Create Multiple Billing Rules For Gateways
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Include/Exclude From Charges And Discounts Certain Clients
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Calculation Method For Charge Or Discount Per Rule:
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Include/Exclude From Charges Certain Products, Addons, Domains And Other
+
|style="padding: 0px 0px 0px 45px;"|✔ Percentage
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Automatic Conversion Of Charges And Discounts In Different Currencies
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed Amount
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ PayPal Subscription Charging
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Charging After Tax Application
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Impose Tax On Charges
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Tax Application To Charge
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Impose Charge After Tax
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Billing Calculation Methods:
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Impose Charge Before Tax And Charge Tax
+
|style="padding: 0px 0px 0px 45px;"|✔ Standard
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Billing Type
+
|style="padding: 0px 0px 0px 45px;"|✔ Alternative (e.g. PayPal)
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 45px;"|✔ Standard - Exclusive Charge
+
|style="padding: 0px 0px 0px 30px;"|✔ Create Multiple Steps With Minimum Invoice Value To Apply Fees And Discounts
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 45px;"|✔ PayPal - Inclusive Charge
+
|style="padding: 0px 0px 0px 30px;"|✔ Create Multiple Rule Activation Conditions For:
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Display Charge Rates Depending On Available Gateways
+
|style="padding: 0px 0px 0px 45px;"|✔ All Clients
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 10px 30px;"|✔ Display Calculated Price For Each Available Gateways
+
|style="padding: 0px 0px 0px 45px;"|✔ Chosen Clients
 
|}
 
|}
−
*'''Supported Order Form Templates:'''
+
{|  
−
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Chosen Client Groups
−
|style="padding: 10px 0px 0px 30px;"|✔ Ajaxcart
+
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Boxes
+
|style="padding: 0px 0px 0px 45px;"|✔ Clients Or Groups With Specific Currencies
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Cart
+
|style="padding: 0px 0px 0px 45px;"|✔ Clients Or Groups With Specific Countries
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Cloud Slider
+
|style="padding: 0px 0px 0px 30px;"|✔ Perform Bulk Actions To Mark As Chargeable:
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Comparison
+
|style="padding: 0px 0px 0px 45px;"|✔ Clients
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Modern
+
|style="padding: 0px 0px 0px 45px;"|✔ Products
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Premium Comparison
+
|style="padding: 0px 0px 0px 45px;"|✔ Addons
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Pure Comparison
+
|style="padding: 0px 0px 0px 45px;"|✔ TLDs
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Slider
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Visibility Of Charge Rates In Client Area
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Standard Cart
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Charge Format Displayed On Invoice
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Supreme Comparison
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Div Tag For Custom Order Template Integration
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Universal Slider
+
|style="padding: 0px 0px 10px 30px;"|✔ Access Module Logs
 
|}
 
|}
−
{|
+
*'''Supported Order Form Templates:'''
−
|style="padding: 0px 0px 0px 30px;"|✔ Verticalsteps
+
{|  
 +
|style="padding: 10px 0px 0px 30px;"|✔ Boxes
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 10px 30px;"|✔ Web20cart
+
|style="padding: 0px 0px 0px 30px;"|✔ Cloud Slider
 +
|}
 +
{|
 +
|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;"|✔ Standard Cart
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supreme Comparison
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Universal Slider
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Other Custom Templates
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
−
{|
+
{|  
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports All Payment Gateways
+
|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;"|✔ 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;"|✔ Integrated Which All Order Form Templates
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|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 PHP 5.4 Up To PHP 7
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
 
|}
 
|}
−
{|
+
{|  
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7.1 And Later
 
|}
 
|}
  
Line 124: Line 146:
 
{|
 
{|
 
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Payment Gateway Charges For WHMCS.''' <br />
 
|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 />
+
We will guide you step by step through the whole installation and configuration process. <br/><br/>
 +
'' '''Note:''' If you are using Payment Gateway Charges For WHMCS in any version '''prior to v2.x''', [https://www.docs.modulesgarden.com/Payment_Gateway_Charges_1.X_For_WHMCS read about it here].''
 
|}
 
|}
 
{|
 
{|
Line 130: Line 153:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC1.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/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. Extract the downloaded file into the main WHMCS directory.''' <br/>
−
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
The content of the package should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC2.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 />
+
|style="padding: 0px 0px 15px 15px;"|'''3. When installing Payment Gateway Charges For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
−
The content of PHP version files should look like this.  
+
The file is located in '' 'your_whmcs/modules/addons/PaymentGatewayCharges/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:tyesrte.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC3.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 />
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
−
File is located in '' 'modules/addons/gateway_charges_functions/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''  
+
Enter your license key between the 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:GC3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC4.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 />
+
|style="padding: 0px 0px 15px 15px;"|'''5. Now, set up the '' 'storage' '' folder as recursively writable.'''<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'. ''
+
This folder is available at '' 'your_whmcs/modules/addons/PaymentGatewayCharges/' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC4_4.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
 
|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.
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Payment Gateway Charges' '' and press the '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC5.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
 
|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'. ''
+
To do so, click on the '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Payment Gateway Charges!'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. Congratulations, you have just successfully installed Payment Gateway Charges For WHMCS!'''<br />
−
You can access your module at '' 'Addons' '' → '' 'Payment Gateway Charges'. ''
+
You can now access your module from '' 'Addons' '' → '' 'Payment Gateway Charges'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PGC7.png]]
 
|}
 
|}
  
Line 188: Line 211:
 
|}
 
|}
  
−
==Integration Code==
+
==Gateways Settings==
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''Integration described below is not obligatory.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|Once you access the addon, you will be moved directly to its configuration. Here you can decide for which gateways the additional charges or discounts will be applied, according to their settings and rules.<br/>
−
Module allows your customers to view charges for using payment gateways when ordering.<br />
+
Start by selecting '' 'Settings' ''.<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]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC8.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/>
+
|style="padding: 0px 0px 15px 15px;"|Here you can define the following settings:
−
Open the template you are using (we opened '' 'modern' '' template as an example).
+
*'''Status''' - toggle to enable or disable charges for a chosen payment gateway
 +
*'''Charge After Taxing''' - if enabled, the charge will be applied to an already taxed item
 +
*'''Apply Tax To Charge''' - enable to impose taxes on charges. ''Note: taxes will not be applied for discount rules''
 +
*'''Billing Type''' - choose between '' 'Standard' '' or '' 'Alternative (e.g. PayPal model)' '' - the differences are explained in the further part of documentation
 +
*'''Show In Charges Table''' - if enabled, the charges and discounts configured in the rules of this gateway will be displayed in the table at the checkout.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC8.1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC9.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 15px 15px;"|'''Billing types explanation:'''<br/>
 +
*'''''Standard''''' - when this type is selected, the total fee will be calculated in a standard manner, taking account of the full amount charged for the products in the cart.<br/>
 +
*'''''Alternative (e.g. PayPal model)''''' - when this method is selected, the fee will be calculated in such a way so that it matches e.g. the PayPal's method of charge calculation.<br/>''Note: when this option is selected, the 'Alternative' billing type will be applied to every activated payment gateway, not only PayPal.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC8.png]]
+
|style="padding: 0px 0px 10px 15px;"|Please notice at the table below that the final price which a client is obliged to pay and the amount that will be sent e.g. to PayPal slightly vary between the two presented methods.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC8.2.png]]
+
|style="padding: 0px 0px 15px 15px;"|
 +
''' ''E.g.:'' ''' <br/>
 +
'''Product Price:''' $124.00 <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;"|'''Total Amount With Charge'''
 +
|-
 +
| style="padding: 0px 10px 0px 15px;"|'''Standard'''
 +
|style="padding: 0px 10px 0px 15px;"|124 * 0.05 = $6.20
 +
|style="padding: 0px 10px 0px 15px;"|124 + 6,20 = $130.20
 +
|-
 +
| style="padding: 0px 10px 0px 15px;"|'''Alternative'''
 +
|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 0px 20px 15px;"|In the client area it should look like on the screen below.
 
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC9.png]]
+
|style="padding: 0px 0px 10px 15px;"|So, the total amount to be paid by the client would be $130.20 for the standard method and $130.53 for the alternative, PayPal method.
 +
Now, let us see in reverse how these total fee amounts would look like if both were the result of calculations using an alternative method only.<br/>
 +
This will help you better understand why it is advised to choose the alternative method for some payment gateways like PayPal.
 
|}
 
|}
−
 
−
===Credits Integration===
 
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|These integration codes will remove charge when a client pays through credits.<br />
+
|style="padding: 0px 0px 15px 15px;"|
−
<!--'''The second integration code''' will alter MASSPAY workflow.<br />
+
{| class="wikitable"
−
It will allow your client to create MASSPAY from selected invoices and still pay charge depending on the chosen payment gateway for MASSPAY.<br />
+
| style="padding: 0px 10px 0px 15px;"|'''Total Calculation Method'''
−
For instance, your client has two invoices created with payment gateway A charge and one invoice created with payment gateway B charge.<br />
+
|style="padding: 0px 10px 0px 15px;"|'''5% Fee From Total Amount With Charge'''
−
Mass payment for these invoices will change payment gateways charges on the selected invoices to chosen payment gateway C charge.-->
+
|-
−
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 10px 0px 15px;"|'''From Standard'''
 +
|style="padding: 0px 10px 0px 15px;"|130.20 * 0,05 = $6.51
 +
|-
 +
| style="padding: 0px 10px 0px 15px;"|'''From Alternative'''
 +
|style="padding: 0px 10px 0px 15px;"|130.53 * 0.05 = $6.53
 
|}
 
|}
−
{|
 
−
|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 10px 15px;"|So, if you are using PayPal and want to receive a full $124.00 amount for a product with a 5% gateway fee, a payment of '''$130.53''' should be sent to PayPal gateway.<br/>$6.53 will cover PayPal fees which is 5% of the total amount to be paid by the client. <br/>
 +
In case of the '''$130.20''' amount calculated using the standard method, the 5% PayPal fee would be $6.51, which, after deducting from the total, would result in $123.69 amount for the product itself.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC19.png]]
+
|style="padding: 0px 0px 30px 15px;"|
 +
{| class="wikitable"
 +
| style="padding: 0px 10px 0px 15px;"|'''Method'''
 +
|style="padding: 0px 10px 0px 15px;"|'''Amount With Charge'''
 +
|style="padding: 0px 10px 0px 15px;"|'''5% Fee'''
 +
|style="padding: 0px 10px 0px 15px;"|'''Amount Which Would Be Received'''
 +
|-
 +
| style="padding: 0px 10px 0px 15px;"|'''Standard'''
 +
|style="padding: 0px 10px 0px 15px;"|$130.20
 +
|style="padding: 0px 10px 0px 15px;"|$6.51
 +
|style="padding: 0px 10px 0px 15px;"|130.20 - 6.51 = $123.69
 +
|-
 +
| style="padding: 0px 10px 0px 15px;"|'''Alternative'''
 +
|style="padding: 0px 10px 0px 15px;"|$130.53
 +
|style="padding: 0px 10px 0px 15px;"|$6.53
 +
|style="padding: 0px 10px 0px 15px;"|130.53 - 6.53 = $124.00
 +
|}
 
|}
 
|}
  
−
===PayPal Subscription Integration===
+
===Gateways Rules===
 
{|
 
{|
−
|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: 10px 0px 15px 15px;"|In the rules section, you can set a percentage or a fixed amount of billed charges or discounts.<br/>
 +
To set the rules, first press '' 'Show Rules' '' located next to the chosen payment gateway.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC11.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/>
+
|style="padding: 0px 0px 20px 15px;"|Next, press the '' 'Add Rule' '' button.
−
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 />
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC12.png]]
−
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]]
+
|style="padding: 0px 0px 20px 15px;"|Here you can name the rule and define a charge for the gateway in a percent form, fixed amount or both.
 
|}
 
|}
−
 
−
===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:PGC13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC2_11.png]]
+
|style="padding: 0px 0px 15px 15px;"|'' '''Important: ''' At least one gateway condition must be added to the rule for it to work. You can find a description of adding conditions to rules [https://www.docs.modulesgarden.com/Payment_Gateway_Charges_For_WHMCS#Gateways_Conditions here].<br/>The following examples assume that gateway conditions have already been created.''<br/><br/>
 +
 
 +
The result of the above rule will be a 5% charge of the product price (which in this example is $100.00) with additional $1.00 charge for the selected ''2Checkout'' payment gateway (using '' 'Standard' '' billing type method).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC14.png]]
−
#'''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_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/>
+
|style="padding: 0px 0px 20px 15px;"|You can also set negative amounts. Then, a discount will be applied to a chosen gateway instead of charging an additional fee.  
−
*'''''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 20px 25px;"|[[File:PGC15.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|
+
|style="padding: 0px 0px 30px 15px;"|The result of the above rule will be a 5% discount of the product price (which in this example is $100.00) with additional $1.00 reduction for the selected ''2Checkout'' payment gateway (using '' 'Standard' '' billing type method).
−
'''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: 0px 0px 30px 25px;"|[[File:PGC16.png]]
 
|}
 
|}
 +
 +
====Steps Rules====
 
{|
 
{|
−
|style="padding: 20px 0px 20px 25px;"|[[File:GC2_21.png]]
+
|style="padding: 10px 0px 15px 15px;"|You can also add additional steps to your rules and define above which minimum amount on the invoice the additional fee or set discount will be applied.<br/>
 +
To start, press '' 'Show Steps' '' next to the created rule.
 
|}
 
|}
 
{|
 
{|
−
|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 20px 25px;"|[[File:PGC17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC21_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|Now, you need to add your first step. Press the '' 'Add Step' '' button.
 
|}
 
|}
−
 
−
==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:PGC18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC13.png]]
+
|style="padding: 0px 0px 15px 15px;"|To create a rule, enter the percentage or fixed amount of the desired charge or discount.<br/>
 +
Then, specify the minimum required amount that will trigger the rule.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Here you can exclude clients from being charged.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC19.png]]
−
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]]
+
|style="padding: 0px 0px 20px 15px;"|You can create as many steps as you want. Each of these step rules will be activated only after the minimum invoice amount has been achieved.<br/>
 +
'' '''Note''' that only one step rule can be active at a time. Also, if none of the step rules is met, then the main rule created in the previous section will be applied. In this example, it is the rule for orders below $50.00 amount.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PGC20.png]]
 
|}
 
|}
  
−
==Management of Items==
+
====Gateways Conditions====
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|To enable/disable charges for products and addons, proceed to'' 'Items' '' section.
+
|style="padding: 10px 0px 15px 15px;"|You can also specify multiple conditions that will affect activation of the rule.<br/>'' '''Note''' that '''at least one''' condition has to be created to make the rule applicable.''<br/>
 +
Start by choosing the '' 'Show Conditions' '' button next to the selected rule.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC21.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 15px;"|Next, press the '' 'Add Condition' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC22.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 15px 15px;"|You can select one of several conditions that will determine the activation of the rule.<br/>
 +
Choose between the following types:
 +
*'''User:'''  
 +
**'''Client''' - activate the rule only for a selected client
 +
*'''Group:'''
 +
**'''Clients Group:''' - activate the rule for selected client groups
 +
**'''Currency''' - you can also specify which currency should be used by the selected group
 +
**'''Country''' - optionally, choose from countries that the selected group of clients should come from
 +
*'''All''' - by choosing this condition, you will make the rule applicable to all of your customers. '''Optionally''' you can also add to this rule:
 +
**'''Currency''' - the rule will be triggered for every client with the selected currency
 +
**'''Country''' - apply the rule for every client from the selected country
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC23.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 20px 15px;"|'''Important:''' some conditions may be combined with one another to provide more possibilities for triggering the rule, but they should not overlap.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC17x.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PGC24.png]]
 
|}
 
|}
  
−
==Automatic Conversion of Charges==
+
==Management of Items==
 
{|
 
{|
−
|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 />
+
|style="padding: 10px 0px 15px 15px;"|To enable or disable gateway charges and discounts for products, addons or TLDs, go to the '' 'Items' '' section.<br/>Then, select the category of items and simply toggle the '' 'chargeable' '' status next to the selected item.<br/>
−
'''1.''' Module automatically calculates fixed amount discount depending on the currency selected by the customer. '''Example:'''<br />
+
'' '''Note:''' For convenience, all new and already existing items are set to 'chargeable' by default.''
−
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 />
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC25.png]]
−
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 20px 15px;"| You can also toggle multiple '' 'chargeable' '' statuses at once by selecting items and using bulk action.
 
|}
 
|}
 
{|
 
{|
−
|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 30px 25px;"|[[File:PGC26.png]]
 
|}
 
|}
 +
 +
==Management of Clients==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC23.png]]
+
|style="padding: 10px 0px 15px 15px;"|To enable or disable gateway charges and discounts for your  customers, go to the '' 'Clients' '' section.<br/>Then, simply toggle the '' 'chargeable' '' status next to the selected client.<br/>
 +
'' '''Note:''' For convenience, all new and already clients items are set to 'chargeable' by default.''
 
|}
 
|}
 
{|
 
{|
−
|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 20px 25px;"|[[File:PGC27.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC24.png]]
+
|style="padding: 0px 0px 20px 15px;"| You can also toggle multiple '' 'chargeable' '' statuses at once by selecting clients and using bulk action.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PGC28.png]]
 
|}
 
|}
  
−
=Tips=
+
==Settings==
 
{|
 
{|
−
|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: 10px 0px 15px 15px;"|In this section you can customize the basics of the module's settings such as:
 +
* '''Show Charge''' - toggle to show charge on the order for a client. Click [https://www.docs.modulesgarden.com/images/6/66/PGC29_1.png here] to see the example.
 +
* '''Show Charges Table''' - if toggled on, the box with gateways details of additional payments on the order form will be visible for a client. Click [https://www.docs.modulesgarden.com/images/5/57/PGC29_2.png here] to see the example.
 +
* '''Format Charge''' - here you can define the format of the discount or charges displayed on the invoice. Click [https://www.docs.modulesgarden.com/images/e/ef/PGC29_3.png here] to see the example.<br/>You can use these variables to define it:
 +
** ''':mainText:''' - by default displayed as '' 'Payment Gateway Charge' '' or '' 'Payment Gateway Discount' '' depending on the gateway rule configuration.<br/>You can change the displayed text in a language file by editing '' 'InvoiceItemTextCharge' '' and '' 'InvoiceItemTextDiscount' '' records.
 +
** ''':gatewayName:''' - the name of the payment gateway to which a charge or discount was applied.
 +
** ''':discount:''' - the calculated discount amount
 +
** ''':price:''' - the calculated charge amount. ''Note: if applied, this amount will also include the tax''.
 +
** ''':priceWithoutTax:''' - the calculated charge amount without any tax applied
 +
** ''':tax1:''' - calculated level 1 tax of the charge
 +
** ''':tax2:''' - calculated level 2 tax of the charge
 +
** ''':fullTax:''' - the sum of calculated level 1 and level 2 tax of the charge
 +
* '''Select Order Template''' -  choose the order templates you use to determine where the charges table is displayed.<br/>If you are using custom template, please select '' 'Use Charges Table Tag' '' and set the field below.
 +
* '''Charges Table Tag''' - if you are using custom template, here you can determine where the charges table will be displayed.<br/>In that case, define the custom tag element from your template, after which the charges table will appear, e. g. ''div#creditCardInputFields''.<br/>'' '''Note''' that the provided tag name should be unique in your template! Otherwise, the integration may be injected into uncontrolled positions.''
 
|}
 
|}
 
{|
 
{|
−
|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/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:PGC29.png]]
−
''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.''
+
 
|}
 
|}
 +
 +
==Logs==
 
{|
 
{|
−
|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:
+
|style="padding: 10px 0px 20px 15px;"|In the logs section you can see which invoices have been calculated with additional discounts or charges resulting from the module's configuration.
−
$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/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGC30.png]]
−
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 20px 15px;"|Note that you can also delete multiple logs at once.
 
|}
 
|}
 
{|
 
{|
−
|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 30px 25px;"|[[File:PGC31.png]]
 
|}
 
|}
 +
 +
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|[[File:GC_24.png]]
+
|style="padding: 10px 0px 10px 15px;"|1. For your convenience, payment gateway charges are enabled by default for clients, products, addons and domains.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|There are two possible ways:<br/>
+
|style="padding: 0px 0px 10px 15px;"|2. Taxes will not be applied to gateway discount rules even if '' 'Apply Tax To Charge' '' option is enabled.
−
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:
+
|style="padding: 0px 0px 30px 15px;"|3. You can easily change all names of module elements displayed in the client area, admin area or invoices in a language file.<br/>
−
<nowiki>$LANG['client_header']    = ''; </nowiki>
+
To do so, go to the '' 'your_whmcs/modules/addons/PaymentGatewayCharges/langs' '' directory, open the language file (e.g. ''english.php'') and edit desired records.
−
 
+
−
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>
+
 
|}
 
|}
  
Line 459: Line 487:
 
|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/>
 
|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/>
 
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/>
+
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/>
 +
|}
 +
==Migration==
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|  Note that while using the 1.X version of our module, no data can be migrated. This is due to the fact that we did not implement the migration from any of the previous versions of Payment Gateway Charges, so the module needs to be configured from scratch.<br />
 +
'' '''Note:''' Remember that if you wish to switch to the latest version, you need to reissue your license first.''
 
|}
 
|}
  
 
=Common Problems=
 
=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.'''
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. In the current version, if a promotional code is used by the client, the amount of charge will not be changed as it will continue to be calculated from the basing item price.<br/>The ability to recalculate the charge after using a promo code will be restored in future versions.
 
|}
 
|}

Revision as of 17:06, 15 February 2018

Contents

About Payment Gateway Charges For WHMCS

Payment Gateway Charges For WHMCS allows you to charge additional fees and set up discounts for the usage of a chosen payment gateway.

With this module you can easily set products, addons, domains as well as other items which require an additional fee, and select clients who will be exempt from fees and discounts.
On top of that, you will also be empowered to define multiple steps of charges as well as discounts which shall be taken depending on the invoice amount.
Finally, the module will enable you to lay down your own conditions for the application of charges and discounts involving client groups, countries and currencies.

  • Features:
✔ Display Charge Or Discount Rates Depending On Available Gateways
✔ Display Calculated Rates For Chosen Gateways
✔ Create Multiple Billing Rules For Gateways
✔ Choose Calculation Method For Charge Or Discount Per Rule:
✔ Percentage
✔ Fixed Amount
✔ Toggle Charging After Tax Application
✔ Toggle Tax Application To Charge
✔ Set Billing Calculation Methods:
✔ Standard
✔ Alternative (e.g. PayPal)
✔ Create Multiple Steps With Minimum Invoice Value To Apply Fees And Discounts
✔ Create Multiple Rule Activation Conditions For:
✔ All Clients
✔ Chosen Clients
✔ Chosen Client Groups
✔ Clients Or Groups With Specific Currencies
✔ Clients Or Groups With Specific Countries
✔ Perform Bulk Actions To Mark As Chargeable:
✔ Clients
✔ Products
✔ Addons
✔ TLDs
✔ Toggle Visibility Of Charge Rates In Client Area
✔ Define Charge Format Displayed On Invoice
✔ Define Div Tag For Custom Order Template Integration
✔ Access Module Logs
  • Supported Order Form Templates:
✔ Boxes
✔ Cloud Slider
✔ Modern
✔ Premium Comparison
✔ Pure Comparison
✔ Standard Cart
✔ Supreme Comparison
✔ Universal Slider
✔ Other Custom Templates
  • General Info:
✔ Supports All Payment Gateways
✔ Supports Mass Payment Functionality
✔ Integrated Which All Order Form Templates
✔ Multi-Language Support
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.1 And Later

Installation

This tutorial will show you how to successfully install and configure Payment Gateway Charges For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Note: If you are using Payment Gateway Charges For WHMCS in any version prior to v2.x, read about it here.

1. Log in to your client area and download the module.
PGC1.png
2. Extract the downloaded file into the main WHMCS directory.

The content of the package should look like this.

PGC2.png
3. When installing Payment Gateway Charges For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'your_whmcs/modules/addons/PaymentGatewayCharges/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

PGC3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between the quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products'.

PGC4.png
5. Now, set up the 'storage' folder as recursively writable.

This folder is available at 'your_whmcs/modules/addons/PaymentGatewayCharges/' .

PGC4 4.png
6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules'. Afterwards, find 'Payment Gateway Charges' and press the 'Activate' button.

PGC5.png
7. In the next step you need to permit access to this module.

To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

PGC6.png
8. Congratulations, you have just successfully installed Payment Gateway Charges For WHMCS!

You can now access your module from 'Addons' → 'Payment Gateway Charges'.

PGC7.png

Configuration and Management

Payment Gateway Charges For WHMCS allows your customers to manage additional charges in your WHMCS system.

In this short guide we will present you the possibilities of our module.

Gateways Settings

Once you access the addon, you will be moved directly to its configuration. Here you can decide for which gateways the additional charges or discounts will be applied, according to their settings and rules.

Start by selecting 'Settings' .

PGC8.png
Here you can define the following settings:
  • Status - toggle to enable or disable charges for a chosen payment gateway
  • Charge After Taxing - if enabled, the charge will be applied to an already taxed item
  • Apply Tax To Charge - enable to impose taxes on charges. Note: taxes will not be applied for discount rules
  • Billing Type - choose between 'Standard' or 'Alternative (e.g. PayPal model)' - the differences are explained in the further part of documentation
  • Show In Charges Table - if enabled, the charges and discounts configured in the rules of this gateway will be displayed in the table at the checkout.
PGC9.png
Billing types explanation:
  • Standard - when this type is selected, the total fee will be calculated in a standard manner, taking account of the full amount charged for the products in the cart.
  • Alternative (e.g. PayPal model) - when this method is selected, the fee will be calculated in such a way so that it matches e.g. the PayPal's method of charge calculation.
    Note: when this option is selected, the 'Alternative' billing type will be applied to every activated payment gateway, not only PayPal.
Please notice at the table below that the final price which a client is obliged to pay and the amount that will be sent e.g. to PayPal slightly vary between the two presented methods.

E.g.:
Product Price: $124.00
Gateway Fee: 5%

Method Base Fee Total Amount With Charge
Standard 124 * 0.05 = $6.20 124 + 6,20 = $130.20
Alternative (124/0.95) - 124 = $6.53 124 + 6,53 = $130.53
So, the total amount to be paid by the client would be $130.20 for the standard method and $130.53 for the alternative, PayPal method.

Now, let us see in reverse how these total fee amounts would look like if both were the result of calculations using an alternative method only.
This will help you better understand why it is advised to choose the alternative method for some payment gateways like PayPal.

Total Calculation Method 5% Fee From Total Amount With Charge
From Standard 130.20 * 0,05 = $6.51
From Alternative 130.53 * 0.05 = $6.53
So, if you are using PayPal and want to receive a full $124.00 amount for a product with a 5% gateway fee, a payment of $130.53 should be sent to PayPal gateway.
$6.53 will cover PayPal fees which is 5% of the total amount to be paid by the client.

In case of the $130.20 amount calculated using the standard method, the 5% PayPal fee would be $6.51, which, after deducting from the total, would result in $123.69 amount for the product itself.

Method Amount With Charge 5% Fee Amount Which Would Be Received
Standard $130.20 $6.51 130.20 - 6.51 = $123.69
Alternative $130.53 $6.53 130.53 - 6.53 = $124.00

Gateways Rules

In the rules section, you can set a percentage or a fixed amount of billed charges or discounts.

To set the rules, first press 'Show Rules' located next to the chosen payment gateway.

PGC11.png
Next, press the 'Add Rule' button.
PGC12.png
Here you can name the rule and define a charge for the gateway in a percent form, fixed amount or both.
PGC13.png
Important: At least one gateway condition must be added to the rule for it to work. You can find a description of adding conditions to rules here.
The following examples assume that gateway conditions have already been created.

The result of the above rule will be a 5% charge of the product price (which in this example is $100.00) with additional $1.00 charge for the selected 2Checkout payment gateway (using 'Standard' billing type method).

PGC14.png
You can also set negative amounts. Then, a discount will be applied to a chosen gateway instead of charging an additional fee.
PGC15.png
The result of the above rule will be a 5% discount of the product price (which in this example is $100.00) with additional $1.00 reduction for the selected 2Checkout payment gateway (using 'Standard' billing type method).
PGC16.png

Steps Rules

You can also add additional steps to your rules and define above which minimum amount on the invoice the additional fee or set discount will be applied.

To start, press 'Show Steps' next to the created rule.

PGC17.png
Now, you need to add your first step. Press the 'Add Step' button.
PGC18.png
To create a rule, enter the percentage or fixed amount of the desired charge or discount.

Then, specify the minimum required amount that will trigger the rule.

PGC19.png
You can create as many steps as you want. Each of these step rules will be activated only after the minimum invoice amount has been achieved.

Note that only one step rule can be active at a time. Also, if none of the step rules is met, then the main rule created in the previous section will be applied. In this example, it is the rule for orders below $50.00 amount.

PGC20.png

Gateways Conditions

You can also specify multiple conditions that will affect activation of the rule.
Note that at least one condition has to be created to make the rule applicable.

Start by choosing the 'Show Conditions' button next to the selected rule.

PGC21.png
Next, press the 'Add Condition' button.
PGC22.png
You can select one of several conditions that will determine the activation of the rule.

Choose between the following types:

  • User:
    • Client - activate the rule only for a selected client
  • Group:
    • Clients Group: - activate the rule for selected client groups
    • Currency - you can also specify which currency should be used by the selected group
    • Country - optionally, choose from countries that the selected group of clients should come from
  • All - by choosing this condition, you will make the rule applicable to all of your customers. Optionally you can also add to this rule:
    • Currency - the rule will be triggered for every client with the selected currency
    • Country - apply the rule for every client from the selected country
PGC23.png
Important: some conditions may be combined with one another to provide more possibilities for triggering the rule, but they should not overlap.
PGC24.png

Management of Items

To enable or disable gateway charges and discounts for products, addons or TLDs, go to the 'Items' section.
Then, select the category of items and simply toggle the 'chargeable' status next to the selected item.

Note: For convenience, all new and already existing items are set to 'chargeable' by default.

PGC25.png
You can also toggle multiple 'chargeable' statuses at once by selecting items and using bulk action.
PGC26.png

Management of Clients

To enable or disable gateway charges and discounts for your customers, go to the 'Clients' section.
Then, simply toggle the 'chargeable' status next to the selected client.

Note: For convenience, all new and already clients items are set to 'chargeable' by default.

PGC27.png
You can also toggle multiple 'chargeable' statuses at once by selecting clients and using bulk action.
PGC28.png

Settings

In this section you can customize the basics of the module's settings such as:
  • Show Charge - toggle to show charge on the order for a client. Click here to see the example.
  • Show Charges Table - if toggled on, the box with gateways details of additional payments on the order form will be visible for a client. Click here to see the example.
  • Format Charge - here you can define the format of the discount or charges displayed on the invoice. Click here to see the example.
    You can use these variables to define it:
    • :mainText: - by default displayed as 'Payment Gateway Charge' or 'Payment Gateway Discount' depending on the gateway rule configuration.
      You can change the displayed text in a language file by editing 'InvoiceItemTextCharge' and 'InvoiceItemTextDiscount' records.
    • :gatewayName: - the name of the payment gateway to which a charge or discount was applied.
    • :discount: - the calculated discount amount
    • :price: - the calculated charge amount. Note: if applied, this amount will also include the tax.
    • :priceWithoutTax: - the calculated charge amount without any tax applied
    • :tax1: - calculated level 1 tax of the charge
    • :tax2: - calculated level 2 tax of the charge
    • :fullTax: - the sum of calculated level 1 and level 2 tax of the charge
  • Select Order Template - choose the order templates you use to determine where the charges table is displayed.
    If you are using custom template, please select 'Use Charges Table Tag' and set the field below.
  • Charges Table Tag - if you are using custom template, here you can determine where the charges table will be displayed.
    In that case, define the custom tag element from your template, after which the charges table will appear, e. g. div#creditCardInputFields.
    Note that the provided tag name should be unique in your template! Otherwise, the integration may be injected into uncontrolled positions.
PGC29.png

Logs

In the logs section you can see which invoices have been calculated with additional discounts or charges resulting from the module's configuration.
PGC30.png
Note that you can also delete multiple logs at once.
PGC31.png

Tips

1. For your convenience, payment gateway charges are enabled by default for clients, products, addons and domains.
2. Taxes will not be applied to gateway discount rules even if 'Apply Tax To Charge' option is enabled.
3. You can easily change all names of module elements displayed in the client area, admin area or invoices in a language file.

To do so, go to the 'your_whmcs/modules/addons/PaymentGatewayCharges/langs' directory, open the language file (e.g. english.php) and edit desired records.

Update Instructions

Essential guidance through the process of updating the module is offered here.

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!
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.

Migration

Note that while using the 1.X version of our module, no data can be migrated. This is due to the fact that we did not implement the migration from any of the previous versions of Payment Gateway Charges, so the module needs to be configured from scratch.

Note: Remember that if you wish to switch to the latest version, you need to reissue your license first.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. In the current version, if a promotional code is used by the client, the amount of charge will not be changed as it will continue to be calculated from the basing item price.
The ability to recalculate the charge after using a promo code will be restored in future versions.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Payment_Gateway_Charges_For_WHMCS&oldid=37133"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Payment Gateway Charges For WHMCS