Personal tools

Actions Registrar For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About Registrar For WHMCS Registrar For WHMCS is a domain registrar module that enables automation of TLDs provisioning in your WHMCS.

With our product your customers will be able to manage their domains, nameservers and DNS records directly in your WHMCS client area.

  • Module Features:
✔ Disable Auto Renewal After Successful Domain Registration
✔ Disable Auto Renewal After Successful Domain Renewal
✔ Send Email Notification Upon Domain Transfer Request
✔ Create Support Ticket Upon Domain Transfer Request
✔ Synchronize Domain Expiration Date And Status
  • Admin Area Features:
✔ Register/Transfer/Renew Domain
✔ Modify Contact Details
✔ Enable ID Protection
✔ Get EPP Code
✔ Update Nameservers
✔ Lock/Unlock Registrar
✔ Toggle Domain Auto Renewal
  • Client Area Features:
✔ Enable/Disable Domain Auto Renewal
✔ Register And Manage Nameservers
✔ Enable ID Protection
✔ Lock/Unlock Registrar
✔ Update Contact Details
✔ Manage DNS Records
✔ Get EPP Code
  • General Info:
✔ Supports All TLDs & gTLDs Available In API
✔ Supports PHP 7.1 Up To PHP 7.4
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.8 And Later
✔ Easy Module Upgrade To Open Source Version


This tutorial will show you how to successfully install Registrar 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. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.

PHP71 74.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 73.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

4. When you install Registrar For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/registrars/namecom/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

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

6. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' 'Products/Services' 'Domain Registrars' .
Afterwards, find '' and press the 'Activate' button.

7. In the next step you need to set up access to API.

To do so, fill the 'Username' and 'API Token' fields with your API access details. Next, confirm the changes by pressing the 'Save' button.
You can also set up advanced configuration that will be explained in detail in further sections of this documentation.

8. Congratulations, you have just successfully installed Registrar For WHMCS!

Configuration and Management Registrar For WHMCS allows you to sell TLDs from via the WHMCS system.

Additionally, Registrar For WHMCS allows your customers to manage their domains directly in your WHMCS client area.

Management of TLDs

Adding new TLD is a fairly easy task. To do so, go to 'Setup' 'Products/Services' 'Domain Pricing'.

Enter your TLD and choose 'Namecom' from the 'Auto Registration' dropdown menu as shown on the screen below.
Here you can also decide whether to offer your customers features like DNS Management, ID Protection or get EPP code. Afterward, press the 'Save Changes' button.

As you can see, the 'Open Pricing' field has appeared. Click on it to define your pricing.
In the newly opened window you can set up your prices. Remember to save the changes afterwards.
That's it! Your customers can now start ordering new .com domains.


As you can notice on the following screen, ordering domain looks exactly the same like alike ordering other domains.

Domain Management

In the admin area, move to the client's summary page and click on the 'Domains' tab to manage all different aspects of the domain.

Along with the basic actions like 'Register', 'Renew' and 'Transfer' you can also modify contact details, get EPP code or enable ID protection.

Additionally, you can lock any of your client's domains to prevent it from being transferred without the client's authorization.

To do so, simply tick the box near the 'Registrar Lock ' option and press 'Save Changes'.

You can also disable/enable auto renewal through checking/unchecking the 'Disable Auto Renewal' box.

Confirm changes through clicking on the 'Save Changes' button.

NC13 5.png

Transfer Management

Due to the lack of domain transfer functionality in API, we have implemented a few workarounds.

All transfer requests will appear in WHMCS To-Do list. You can access it from 'Utilities' 'To-Do List'.
Additionally, you can set up email notifications for admins and support tickets created on behalf of the customer who ordered domain transfer.


Support Ticket

In order to enable ticket creation upon domain transfer request, follow the steps below.

First, create a new support department by moving to 'Setup' 'Support' 'Support Departments' and pressing 'Add New Department'.

Afterward, enter the name of the support department and its email address.

Additionally, you can check the boxes next to those admins who shall be assigned to this specific department.
Next, press 'Add New Department'.

Now, let us configure registrar to create tickets in the previously created department.

Go to 'Setup' 'Product/Services' 'Domain Registrars' and press 'Configure' next to your registrar.

Next, mark the 'Support Ticket' checkbox and select the previously created department from the 'Support Department' dropdown menu.
Finally, click on 'Save Changes'.


Email Notification

You can also set up email notification that will be sent to the admins upon transfer request.

When you configure the registrar for the first time, a new exemplary email template is also created on your Email Templates list.
Note: This feature was added in the 1.2.0 module version since WHMCS no longer supports the manual creation of 'Admin Messages' email templates types.

To start with, edit the exemplary notification email template and adjust it to your needs.
To do so, go to 'Setup' 'Email Templates' , find the ' Domain Transfer' template under the 'Admin Messages' category and press 'Edit' .

Next, customize the two fields next to the 'From' option by putting your company name and email address.

Afterwards, change the desired email 'Subject' and its content to your needs. In the content window you can also use merge fields marked on the following screen with green color.
You can also use custom merge fields listed below:

  • {$client_name}
  • {$client_id}
  • {$domain_id}
  • {$domain_name}
Now, go back to 'Setup' 'Product/Services' 'Domain Registrars' and press 'Configure' next to registrar.

Mark the 'Admin Email' checkbox and select the previously edited template from the 'Email Template' dropdown menu.
Using 'Email Type' you can specify the admins who will receive a transfer request message.
Afterwards, press 'Save Changes'.


Client Area

Your customers can perform various actions on their domains directly from the client area.

To view the basic information related to their domain and domain renewal, clients can simply press the 'Renew' button from the 'Actions' sidebar.

At the 'Auto Renew' tab clients can enable/disable auto renewal of their domains by pressing the 'Enable Auto Renew' / 'Disable Auto Renew' button.
The 'Nameservers' tab allows your clients to change nameservers used by their domains.
Registrar lock that protects domains from being transferred without client's authorization can be enabled/disabled by client at the 'Registrar Lock' tab.

Note: Due to the ICANN regulations, domains cannot be transferred to another registrar within 60 days from the date they were registered on or transferred to a new registrar.
The aim of such procedure is to prevent fraud. Since this is the ICANN rule, and not a rule, there is no way you can remove the 60-day hold.

To manage or disable addons assigned to a TLD, your client will need to visit the 'Addons' tab.

Here clients can enable ID protection which will make the contact details associated with their domain appear as private in the WHOIS lookup base.
Important: ID protection can be enabled one time only and cannot be disabled later on. Please use it with caution as it will be auto-renewed every year as long as the domain remains active.

Under 'Management Tools' 'Contact Information' your clients can view and modify contact information.
By moving to 'Management Tools' 'Register Nameservers' your clients can create and manage custom nameservers for the domain.
If 'DNS Management' has been enabled in the 'Addons' tab, your clients will be allowed to manage DNS settings in this tab.
By using 'Get EPP Code' your clients can can obtain a password for the domain name that will be used when transferring the domain to another registrar.


1. This registrar supports 'IP Protection' and 'DNS Management' addons.

Please note that when the 'ID Protection' addon is enabled for the chosen domain, it will not be possible to disable it afterward.


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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If one of the TLDs you have configured is unavailable, please make sure you have set up pricing in a default currency.
3. Sometimes you might get the 'Error occured: Unexpected Error 1' , or domain not available notifications, or even notice missing settings when using API with 'Test Mode' enabled.
If so, try to reload the page or repeat the given action a few times. This issue should not occur in the Live mode.
The reason of this problem may lie in the slow and overloaded API responses that goes beyond the module's functionality.
4. The module supports many TLDs and gTLDs offered by
However, due to the fact that it is not based on the latest API version, sometimes the "Error occured: Command Failed" message may appear when trying to register certain domains (especially if the chosen TLD is subject to some registration restrictions).
For this reason, we recommend to ensure beforehand that there is a possibility to register a certain TLD before it is included in your WHMCS offer.
5. Once the 'ID Protection' feature is enabled for the domain, it cannot be disabled.
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
Community Registrar For WHMCS