Personal tools
Namespaces

Variants
Actions

MX Registrar For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Installation)
(→‎Configuration and Management)
Line 106: Line 106:
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Payment Gateway Charges For WHMCS allows your customers to manage charges in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|MX Registrar allows you to manage your TLDs in your WHMCS system.
 
In this short guide we will present you the possibilities of our module.  
 
In this short guide we will present you the possibilities of our module.  
 
|}
 
|}
−
 
+
==Management of TLDs==
−
==Integration Code==
+
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''Integration described below is not obligatory.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|Adding new TLD is quite simple, to add it go to '' 'Setup' '' →'' 'Products/Services' '' → '' 'Domain Pricing' ''.<br />
−
Module allows your customers to view charges for using payment gateways when ordering.<br />
+
Enter your TLD and choose '' 'MX Registrar' '' from Auto Registration dropdown menu as shown on the screen below.<br />
−
We implemented easy integration which automatically adjusts displayed instructions to each order form template.<br />
+
Here you can also decide whether to offer your customers DNS Management, Email Fowarding, ID Protection and EPP Code. Then press '' 'Save Changes' ''.
−
Depending on the selected order form template, this section will automatically present you with information where and how place the code.<br />
+
−
You will even see a number of line, near which you must modify the code!
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MX8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Correctly placed code in '' 'modern' '' order form template is presented on the following screen.
+
|style="padding: 0px 0px 20px 15px;"|As you can see '' 'Open Pricing' '' field has appeared. Click on it and set up your pricing.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MX9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In the client area it should look like on the screen below.
+
|style="padding: 0px 0px 20px 15px;"|In newly opened window you can set your prices. Remember to save the changes!
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MX10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can also integrate PayPal subscription, it allows you to pay automatically for recurring payments via PayPal. <br />
+
|style="padding: 0px 0px 20px 15px;"|All that remains is adding new entry to file '' 'additionaldomainfields.php' '', it is located in '' 'your_whmcs/includes/additionaldomainfields.php' ''.<br />
−
In order to do so follow instruction from '' 'Integration Code' '' tab marked on the screen below.
+
At the end of file add this code:
 +
$additionaldomainfields[".'''your_tld'''"][] = array
 +
(
 +
    "Name" => "<a href=\'http://'''your_whmcs'''/modules/registrars/MX Registrar/tos.php\'>Customer Service Agreement</a>",
 +
    "Type" => "tickbox",
 +
    "Required" => true,
 +
);
 +
Where '' 'your_tld' '' is domain TLD your added earlier and '' 'your_whmcs' '' is address to your WHMCS.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MX11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|When you integrate it properly, new button will show up on client area invoice page, but only for product with recurring pricing.
+
|style="padding: 0px 0px 30px 15px;"|That's all! Simple isn't it? If you would like to set pricing for more TLDs simply repeat steps shown in '' 'Management of TLDs' '' as many times as you need.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC20.png]]
+
−
|}
+
−
 
+
−
==Configuration==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|To set additional charge for payment gateway, simply enter desired values in coresponding column.<br />
+
−
You can add fixed amount and/or percentage value of invoice to charge.
+
−
When you are finished, click on '' 'Save Changes' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC10.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|In order to set minimum value of invoice to charge or place discount, type value in '' 'Minimum Invoice Value' '' as shown on screen below.<br />
+
−
Afterwards press'' 'Save Changes' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC11.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|To change charge and discount description displayed on invoice, edit accordingly '' 'Charge Description' '' and '' 'Discount Description' '' textboxes as presented on the screen below.<br />
+
−
Next, click '' 'Save Changes' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC12.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|You can enable tax applying for charges by marking '' 'Tax' '' checkbox, afterwards press '' 'Save Changes' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC21.png]]
+
−
|}
+
−
 
+
−
==Management of Clients==
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|In order to enable/disable charges for specific clients go to '' 'Client' '' tab as shown on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Here you can exclude clients from charge.<br />
+
−
To do so, mark checkbox next to client ID and press '' 'Save Changes' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC14.png]]
+
−
|}
+
−
 
+
−
==Management of Items==
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|To enable/disable charges for products and actions, go to'' 'Items' '' tab as presented on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC15.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|In order to '''disable''' charges for product or addons, mark checkbox next to it and press '' 'Save Changes' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GC16.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|In order to '''enable''' charges for domain actions and items, mark checkbox next to it and press '' 'Save Changes' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GC17.png]]
+
−
|}
+
−
 
+
−
 
+
−
==Automatic Conversion of Charges==
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|This functionality will make you forget about all the problems with currencies. Module automatically calculates the value based on your default currency.<br />
+
−
'''1.''' Module automatically calculates fixed amount discount depending on the currency selected by the customer. '''Example:'''<br />
+
−
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.
+
 
|}
 
|}
  

Revision as of 12:55, 23 September 2013

Contents

About Payment Gateway Charges For WHMCS

MX Registrar 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
✔ Integration With The Following Order Form Templates: Ajaxcart, Boxes, Cart, Comparison, Modern, Slider, Verticalsteps and Web20cart
  • Additionally:
✔ 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 MX Registrar For WHMCS.

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

1. Log in to your clientarea and download MX Registrar For WHMCS.
MX1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

MX2.png
3. When you install MX Registrar for the first time you have to rename 'license_RENAME.php' file.

File is located at 'modules/registrars/MXregistrar/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

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

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

Login to your WHMCS admin area. Go to 'Setup' → 'Products/Servers' → 'Domain Registrars' . Afterwards find 'MX Registrar' and press 'Activate' button.

MX5.png
6. In next step you need to configure it.

To do so enter username, password, server url and certificate file name, afterwards press 'Save Changes' .
Certificate file have to be placed in /var/www/whmcs/modules/registrars/MXregistrar/.

MX6.png
7. You have just successfully installed MX Registrar!
MX7.png

Configuration and Management

MX Registrar allows you to manage your TLDs in your WHMCS system.

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

Management of TLDs

Adding new TLD is quite simple, to add it go to 'Setup' → 'Products/Services' → 'Domain Pricing' .

Enter your TLD and choose 'MX Registrar' from Auto Registration dropdown menu as shown on the screen below.
Here you can also decide whether to offer your customers DNS Management, Email Fowarding, ID Protection and EPP Code. Then press 'Save Changes' .

MX8.png
As you can see 'Open Pricing' field has appeared. Click on it and set up your pricing.
MX9.png
In newly opened window you can set your prices. Remember to save the changes!
MX10.png
All that remains is adding new entry to file 'additionaldomainfields.php' , it is located in 'your_whmcs/includes/additionaldomainfields.php' .

At the end of file add this code: 

$additionaldomainfields[".your_tld"][] = array
(
   "Name" => "<a href=\'http://your_whmcs/modules/registrars/MX Registrar/tos.php\'>Customer Service Agreement</a>",
   "Type" => "tickbox",
   "Required" => true,
);

Where 'your_tld' is domain TLD your added earlier and 'your_whmcs' is address to your WHMCS.

MX11.png
That's all! Simple isn't it? If you would like to set pricing for more TLDs simply repeat steps shown in 'Management of TLDs' as many times as you need.

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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=MX_Registrar_For_WHMCS&oldid=6222"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
MX Registrar For WHMCS