From WHMCS Documentation

Supported Features

Register Transfer Renew Registrar Lock
Yes Yes Yes Yes
Update Nameservers Update WHOIS Get EPP Code Register Nameservers
Yes Yes Yes Yes
DNS Record Management Email Forwarding Domain Release Domain Sync Script
No No No Yes
Premium Domains Transfer Out Automation
No No


To activate and begin using the OpenSRS registrar module, follow the steps below:

  1. Login to your WHMCS Admin Area
  2. Navigate to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
  3. Locate OpenSRS in the list
  4. Click the Activate button
  5. Enter your OpenSRS API credentials
  6. Click Save Changes to complete the process
Before you can begin using the OpenSRS API with your account you must authorize your server IP for access to your account. See below for steps to do this.

IP Registration

  • OpenSRS's API is IP restricted.
  • Therefore to use the OpenSRS API, you must first access the OpenSRS Reseller Web Interface using your OpenSRS username and password, and then access the “Add IPs for Script/API Access” link.
  • The IP address that needs to be set up is the one that your WHMCS instance will be seen as from the world wide web.

Additional Registrar Module Files Requirement

OpenSRS requires some third party classes such as PEAR in order to work and it’s likely that the module will fail to operate entirely without these files. The files can be obtained using the following link and need to be unzipped and the contents uploaded into the /modules/registrars/opensrs/ folder.

Finally, domain pricing needs to be configured within WHMCS. Please see the Domains Management page for additional help on doing that.

Private Key Generation

To generate your private key, login to the OpenSRS Reseller Web Interface using your OpenSRS username and password and access the “Generate New Private Key” link.

Configuring your OpenSRS Reseller Account

Before using OpenSRS for domain registrations your OpenSRS reseller account should be configured and funded for use.

Please refer to “Setting your account defaults” and “Payments” (funding your account) sections in the “Reseller's Guide to Domain Name Registration and Management” available in the documentation section of our website (

The “Reseller's Guide to Domain Name Registration and Management” is a very important resource for managing and troubleshooting domain registrations, as is the Reseller Web Interface we provide you with your OpenSRS reseller account.

Automatic Registration

WHMCS allows you to setup automatic domain registration on a per extension basis enabling you to use different registrars for different TLDs to give you the flexibility to offer more extensions and always get the best value. To enable automatic registration, please refer to Configuring Automatic Registration

Automatic Domain Synchronization

The OpenSRS module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers. To enable this functionality, you need to ensure you have the Domain Sync Enabled in Configuration () > System Settings > General Settings > Domains or, prior to WHMCS 8.0, Setup > General Settings > Domains. Ensure you have the Domain Sync Cron configured on your system.


Blank Response or Connection Error Message
This is commonly caused by the port numbers that the OpenSRS API operates on being blocked by your server's firewall. The ports used in communication to the API are 55443 and 55000 so need to be opened for both inbound and outbound connections.

Partially Loaded Page (Blank or Lost Formatting)
The OpenSRS module requires some additional files in order to work. Please refer to the Requirements section above for more info.

Domain Already Renewed
Seeing this error when attempting to renew a domain is caused by an invalid or incorrect Expiry Date value under the client's Domains tab. Correcting this value will enable the domain to be renewed.

Order xxxxxxx is not a pending, declined or cancelled order and cannot be processed
The domain name will still be registered, but changing the "Process Immediately" setting in your OpenSRS account to "Off" will stop this error occurring.

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin - VePortal
Lxadmin - Virtualmin Pro - XPanel - HyperVM - FluidVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Echeck - - CIM - Bank Transfer
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay
Direct Debit - EMatters - E-Path - eProcessingNetwork
eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop - LinkPoint
Inpay - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment
Merchant Partners - Merchant Warrior - IDEALMollie - Moneris - Moneris Vault
Skrill 1-Tap - SlimPay - NaviGate - NETbilling - Netregistry Pay - NoChex
Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Express Checkout - PayPal Payments Pro (SecPay) - Payson - Planet Authorize - SagePay - ProtX VSP Form - PSIGate
Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens - SecPay - SecurePay - SecurePay AU
Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible