Personal tools
Namespaces

Variants
Actions

Payment Gateway Charges For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

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 and TLDs that should 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
✔ Toggle Charging After Promo Code Application
✔ Set Billing Calculation Methods:
✔ Standard
✔ Alternative (e.g. PayPal)
✔ PayPalV2
✔ 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
✔ Other:
✔ Adding Funds To Credit Deposit
✔ Late Fee Invoice Items
✔ Custom Invoice Items
✔ 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.6 Up To PHP 7.2
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.2 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 our client area and download the module.
PGC1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.

PHP56 72.png
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.

The content of your PHP version files should look like this.

PGC2.png
4. 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
5. 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 our client area → 'My Products'.

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

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

PGC4 4.png
7. 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
8. 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
9. 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
  • Charge After Applying Promo Code - enable to charge once the final price has been lowered by a promo code
  • Billing Type - choose between 'Standard' , 'Alternative (e.g. PayPal model)' or 'PayPalV2' - 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.
    This method is based on the following calculation formula:
    Final Amount = (Initial Amount / ( 1 - (Percentage / 100)) - Initial Amount) + Fixed Amount
  • PayPalV2 model - when this method is selected, the method will be based on the following calculation formula:
    Final Amount = ( Initial Amount + Fixed Amount ) / ( 1 - ( Percent / 100 ))

Note: when one of these PayPal methods is selected, then this billing type will be applied to every activated payment gateway, not only PayPal.

Let's see how the 'Standard' and 'Alternative (e.g. PayPal model)' calculation methods differ in practice.

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.
Note: the following example does not include a comparison with the 'PayPalV2' method which was introduced in the 3.0.1 version of the module.

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.

If you encounter a validation error when adding a condition, make sure that there are no conflicts with conditions configured under this or other rules.

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

Other Options

Enable or disable gateway charges and discounts for selected options
  • Adding Funds To Credit Deposit - if set to chargeable, the charge will be calculated when adding funds to the client's credit deposit
  • Late Fee Invoice Items - if this option is set to chargeable, then the charge will be calculated for late fee items on the invoice as well
  • Custom Invoice Items - if this option is set to chargeable, the charge will be calculated for all added to a custom invoice items

Note: Again, all available options are set to 'chargeable' by default.

PGC26 1.png
You can also toggle multiple 'chargeable' statuses at once by selecting items and using bulk action.
PGC26 2.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 existing 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.
  • Charge Format - 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
    • :percentage: - the percentage of billed charges or discounts
    • :fixedAmount: - the fixed amount of billed charges or discounts
  • 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. More information you can find here.
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

Custom Template Integration

To add an integration to your custom template, first you need to choose the place where you want the charges table to be placed.
It is recommended to position it under a unique tag, e.g.:
div#a_unique_element_in_which_the_table_will_be_located

Now, go to the module settings and select 'Use Charges Table Tag' from the 'Select Template' dropdown menu.
Next, put the name of your chosen tag in the 'Charges Table Tag' field, and save settings.

PGC32.png
Next, you need to learn the name of your custom orderform template.
Note that you can find all orderforms templates in 'yourWHMCS/templates/orderforms/' location.

For this example we will assume that your custom oderform template is simply named as 'custom_template' .

Now, you need to edit the 'script.tpl' file located in the 'yourWHMCS/modules/addons/PaymentGatewayCharges/templates/client/default/pages/charge/assets/' .
Update the following lines with the name of your 'custom_template' oderform.

1. The code between lines 10-19 to update the charge values:

{/literal}{elseif $template eq 'custom_template'}{literal}
    $('div#where_the_charge_price_value_is_replaced').html(data.data.string);

2. The code between lines 42-75 provides you with a possibility to define table display:

{/literal}{elseif $template eq 'custom_template'}{literal}
    $('input[name=applycredit]').on('change', function(event){ // event to check if the 'Apply Credit' value has been changed
          mgLoadCharge();
    });
    $('input[name=paymentmethod]').on('change', function(event){ // event to check if the 'Payment Method' has been changed
          mgLoadCharge();
    });
    $('select[name=country]').on('change', function(event){ // event to check if the 'Country' value has been changed
          mgLoadCharge();
    });

After completing this procedure and applying the right code, you should have a working layout in your client area.

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.

4. In case there is more than one rule that matches a single client, the one with the most precise conditions, concerning that client, will be taken into account when calculating the final discount.
5. If you are an experienced administrator, you may take advantage of an extra (hidden) tab 'Debug Logs'. See details of performed calculations with information on used conditions and the 'before' and 'after' prices.

In order to enter the debug logs section, you need to manually add to 'your_whmcs/your_admin_path/' URL:

addonmodules.php?module=PaymentGatewayCharges&mg-page=DebugLogs
6. Note that you may always change the default translations to more friendly names. Just open the english.php file, find lines:
 $_LANG['InvoiceItemTextCharge'] = 'Payment Gateway Charge';
 $_LANG['addonCA']['charge']['chargeCheckout'] = 'Gateway Charge';
 $_LANG['addonCA']['charge']['discountCheckout'] = 'Gateway Discount';
 $_LANG['addonCA']['charge']['paymentGatewayCharges'] = 'Payment Gateway Charges';

and change the content here: ='your_friendly_name' in any of the above if you only wish.
See below how a custom naming may present:

PGC33.png
PGC34.png

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.
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Payment Gateway Charges For WHMCS