Personal tools
Namespaces

Variants
Actions

Payment Gateway Charges For WHMCS

From ModulesGarden Wiki
Revision as of 10:09, 27 August 2013 by Peter (Talk | contribs)

Jump to: navigation, search

Contents

About Payment Gateway Charges For WHMCS

Payment Gateway Charges For WHMCS is a fully featured addon module created in order to manage additional charges.
  • Features:
✔ Set Different Rates For Different Payment Gateways (Percentage Or Fixed)
✔ Set Different Discounts For Different Payment Gateways (Percentage Or Fixed)
✔ Set Minimum Invoice Value To Charge Payments And Discounts
✔ Include/Exclude From Charges And Discounts Certain Clients
✔ Include/Exclude From Charges Certain Products, Addons, Domains And Other
✔ Automatic Conversion Of Charges And Discounts In Different Currencies
✔ Display/Hide Information About Additional Charges During Ordering
  • Additionally:
✔ Supports WHMCS V5 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.

1. Log in to your clientarea and download Payment Gateway Charges For WHMCS.
GC1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

GC2.png
3. When you install Payment Gateway Charges for the first time you have to rename 'license_RENAME.php' file.

File is located at 'modules/addons/gateway_charges_functions/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

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

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

GC4.png
5. Now you have to activate the module in your WHMCS system.

Login to your WHMCS admin area. Go to 'Setup' 'Addon Modules' . Afterwards find 'Payment Gateway Charges' and press 'Activate' button.

GC5.png
6. In next step you need to permit access to this module.

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

GC6.png
7. You have just successfully installed Payment Gateway Charges!

You can access your module at 'Addon' 'Payment Gateway Charges' .

GC7.png

Configuration and Management

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

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

Integration Code

In order to enable your customers to view charges for using payment gateways when ordering, you have to edit your 'viewcart.tpl' file.

File is located at 'your_whmcs/templates/orderforms/modern/viewcart.tpl' . To proceed find the class below:

<div class="signupfields padded">

Place the following code:

{$gatewayChargesTable}

Exactly after:

</table>
</div>

Code should be placed around line 264 as presented on the following screen.

GC8.png
In the client area it should look like on the screen below.
GC9.png

Configuration

To set additional charge for payment gateway, simply enter desired values in coresponding column.

You can add fixed amount and/or percentage value of invoice to charge. When you are finished, click on 'Save Changes' button.

GC10.png
In order to set minimum value of invoice to charge or place discount, type value in 'Minimum Invoice Value' as shown on screen below.

Afterwards press 'Save Changes' .

GC11.png
To change charge and discount description displayed on invoice, edit accordingly 'Charge Description' and 'Discount Description' textboxes as presented on the screen below.

Next, click 'Save Changes' button.

File:GC12.png

Management of Clients

In order to enable/disable charges for specific clients go to 'Client' tab as shown on the following screen.
GC13.png
Here you can exclude clients from charge.

To do so, mark checkbox next to client ID and press 'Save Changes' .

GC14.png

Management of Items

To enable/disable charges for products and actions, go to 'Items' tab as presented on the following screen.
GC15.png
In order to disable charges for product or addons, mark checkbox next to it and press 'Save Changes' .
GC16.png
In order to enable charges for domain actions and items, mark checkbox next to it and press 'Save Changes' .
GC17.png

Tips

1. For your convenience, payments gateway charges are enabled by default for clients, products and addons. Charges for domains and other are disabled by default.
2. Module automatically calculates fixed amount discount depending on the currency selected by the customer. Example:

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

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Payment Gateway Charges For WHMCS