Personal tools
Namespaces

Variants
Actions

Payment Gateway Charges For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(About Payment Gateway Charges For WHMCS)
(Disabling Payment Gateway For Specified Product Group)
Line 267: Line 267:
 
|}
 
|}
  
==Disabling Payment Gateway For Specified Product Group==
+
==Disabling Payment Gateway For Specific Product Group==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|If you want to disable payment gateway for a specified product group, follow these simple steps.<br />
+
|style="padding: 10px 0px 15px 15px;"|If you want to disable payment gateway for a specifc product group, follow these simple steps.<br />
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit product group you want to disable payment gateway for.
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit product group you want to disable payment gateway for.
 
|}
 
|}

Revision as of 09:35, 27 July 2015

Contents

About Payment Gateway Charges For WHMCS

Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconvenience caused.

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

With this module you can easily set up products, addons, domains and other, which require an additional fee.
You can also choose which of clients will be exempt from fees and discounts.

  • 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
✔ PayPal Subscription Charging
✔ Apply Taxes On Charges
✔ Display/Hide Information About Additional Charges And Discounts During Ordering
✔ Add Payment Gateway Charge Before Or After Applying Tax On Item
✔ Hide Charges For Payment Gateways Disabled In Product Group
✔ Integration With The Following Order Form Templates: Ajaxcart, Boxes, Cart, Comparison, Modern, Slider, Verticalsteps and Web20cart
  • General Info:
✔ Easy Integration Which Automatically Adjusts To Each Order Form Template
✔ Multi-Language Support
✔ 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 client area 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 in '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.

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

GC5.png
6. In the 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 'Addons' 'Payment Gateway Charges' .

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

Integration Code

Integration described below is not obligatory.

Module allows your customers to view charges for using payment gateways when ordering.
We implemented easy integration codes and the displayed instruction of which can be easily adjusted to each order form template.

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.
The provided directory is just an example of one of the available templates.

Underneath you will find as specific information on the code insertion as possible.
As soon as you enter any part of integration, its status will change from 'Undone' to 'Done' in the addon.

GC18.png

Table of Charges on Cart

To display charges table in order form, add the below integration code.

Open the template you are using (we opened 'modern' template as an example).

GC8.1.png
Correctly placed code in 'modern' order form template is presented on the following screen.
GC8.png
In the client area it should look like on the screen below.
GC9.png

Credits Integration

These integration codes will remove charge when a client pays through credits.

Open the 'viewinvoice.tpl' file and place the below codes at the very top of that file.

GC9.1.png

PayPal Subscription integration

You can also integrate PayPal subscription, it allows you to pay automatically for recurring payments via PayPal.

In order to do so, follow instructions from 'Integration Code' tab shown on the screen below.

GC19.png
When you integrate it properly, new button will show up on the client area invoice page, but only for product with recurring pricing.
GC20.png

Configuration

Gateway Charges

Proceed to the addon itself, you will be moved directly to its configuration. Firstly you will have to setup charges for each active in your system gateway.

Find a list of active gateways and setup charges for all of them or only for those you wish.

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

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.
Once you have set up the configuration, press 'Save Changes' button.

GC10.png

Additional Options

Find tab 'Additional Options', you may manage there your additional charges.
GC11.png
Available options:
  1. Set minimum value of invoice to charge or place discount, type value in 'Minimum Invoice Value'
  2. Edit accordingly 'Charge Description' and 'Discount Description' to change their description displayed on invoice
  3. Impose taxes on charges by marking 'Tax Payment Charge' checkbox
  4. Tick 'Charge After Taxing' if you want to apply charge to already taxed product.

To confirm changes, press 'Save Changes'.

GC21.png

Management of Clients

In order to enable/disable charges for specific clients move to 'Client' section.
GC13.png
Here you can exclude clients from being charged.

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.

GC14.png

Management of Items

To enable/disable charges for products and actions, proceed to 'Items' section.
GC15.png
In order to disable charges for products or addons, mark checkboxes next to the chosen ones and press 'Save Changes'.
GC16.png
In order to enable charges for domain actions or items, mark checkboxes next to the chosen entries and press 'Save Changes'.
GC17.png
Marked 'Other Invoice Item Types' applies charges to all other invoice types, which were not described above.
GC17x.png

Automatic Conversion of Charges

This functionality will make you forget about all the problems with currencies. Module automatically calculates the value basing on your default currency.

1. 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.
2. Exactly the same as above applies to Minimum Invoice Value which currency is also automatically calculated.
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

If you want to disable payment gateway for a specifc product group, follow these simple steps.

Go to 'Setup' 'Products/Services' 'Products/Services' and edit product group you want to disable payment gateway for.

GC22.png
Unmark checkbox next to payment gateway you want to disable and press 'Save Changes' button.
GC23.png
As you can see on the following screen, payment gateway was disabled for products from group you edited.
GC24.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. Promotion codes: the charge is counted from bare prices, promotion is not included.

Common Problems

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