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.
|✔ 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:|
|✔ Fixed Amount|
|✔ Toggle Charging After Tax Application|
|✔ Toggle Tax Application To Charge|
|✔ Set Billing Calculation Methods:|
|✔ 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:|
|✔ 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:
|✔ Cloud Slider|
|✔ 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|
|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.
|1. Log in to our client area and download the module.|
|2. Extract the downloaded file into the main WHMCS directory. |
The content of the package should look like this.
|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'.
|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 our client area → 'My Products'.
|5. Now, set up the 'storage' folder as recursively writable.|
This folder is available at 'your_whmcs/modules/addons/PaymentGatewayCharges/' .
|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.
|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'.
|8. Congratulations, you have just successfully installed Payment Gateway Charges For WHMCS!|
You can now access your module from 'Addons' → 'Payment Gateway Charges'.
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.
|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' .
|Here you can define the following settings:
|Billing types explanation:|
|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.|
|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.
|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.
|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.
|Next, press the 'Add Rule' button.|
|Here you can name the rule and define a charge for the gateway in a percent form, fixed amount or both.|
| 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).
|You can also set negative amounts. Then, a discount will be applied to a chosen gateway instead of charging an additional fee.|
|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).|
|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.
|Now, you need to add your first step. Press the 'Add Step' button.|
|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.
|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.
|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.
|Next, press the 'Add Condition' button.|
|You can select one of several conditions that will determine the activation of the rule.|
Choose between the following types:
|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.
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.
|You can also toggle multiple 'chargeable' statuses at once by selecting items and using bulk action.|
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.
|You can also toggle multiple 'chargeable' statuses at once by selecting clients and using bulk action.|
|In this section you can customize the basics of the module's settings such as:
|In the logs section you can see which invoices have been calculated with additional discounts or charges resulting from the module's configuration.|
|Note that you can also delete multiple logs at once.|
|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.
|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!
| 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.
|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.