Overview
As a Brixly Reseller Pro customer, you are able to sell domain names through our automated API / module for WHMCS. This guide will step you through the process.
Pre-Requisites
Once you have downloaded the module, you will need to upload the .zip file to your WHMCS root directory, then extract it.
Enable the Domain Registrar Module in WHMCS
Once you have installed the module, you will be able to…
Navigate to Setup -> Products / Services -> Domain Registrars
Click ‘Activate’ next to the Brixly - Domain Reseller v2 module
You will be prompted to enter your ‘User Email’ (the email address you use to login to our client area) and an API Key (explained below)
Obtaining your API Key
To get the API key for use in the setup screen above, you can go to...
Domains -> Reseller Area -> Settings
From here, you can generate your API key by clicking the option below...
Configuring your WHMCS for selling domains
That is the integration complete. You would now need to configure WHMCS to define your ‘Domain Pricing’. A video and the full documentation of this process can be found below:
A summarised guide can be found below:
Reviewing your Domain Reseller Logs
Preview a list of logs on API requests and responses, including errors stored in the module. This is ideal, for diagnosing issues with any domain registrations or renewals.
Domain Reseller Pricing
Our domain reseller module allows you to sell domains at our main retail pricing.
You can view the domain pricing here...
For an easier view of our domain prices, see the following...
Client Area for your End Users
Adding Funds to your Account
All payments for domains are taken from your account credit. Please note, that you can add funds to your account balance by going to:
Billing -> Add Funds
Example Workflow
In this section, we will present you with a sample workflow of the module.
In a basic workflow 3 users take part:
Provider – us, as the top-level provider for your domain registrations
Reseller - you, as the provider's client who aims at reselling TLDs offered to him/her by the provider.
End Client – a person with a client account in the Reseller's system (WHMCS)
Resellers Role:
The Reseller has access to the Reseller Area once logged into the provider's client area as outlined above in the documentation.
The Reseller is able to download and install the provider's provisioning module to allow the resale of domain names via WHMCS.
The reseller must add funds to his credit balance in the provider system to be able to pay off the charges and settle the amounts owed to the provider for his resold TLDs.
End Clients Role:
End Client orders a domain from his client area in the Reseller's system.
Payment Flow:
Now, that the End-Client has ordered and has paid the reseller for the domain, at the provider's system a new invoice for that domain is created automatically (on behalf of the reseller).
If funds are available, the invoice will be paid with credits and the domain registration/transfer will be attempted - if successful, the invoice will be marked as paid with credits.
In case the reseller does not have sufficient credits on his account to pay for the domain registration the process is stopped until the invoice is manually paid by the reseller.
Assigning Existing Domains
If you are looking to assign a domain that already exists in our client area, to the reseller module, you can do this via the 'Domains -> Assign Domains' option.
Upgrading from Brixly Domain Reseller v1 Module
Unfortunately, the Brixly Domain Reseller v1.x module is no longer compatible with WHMCS v8.0 and would require significant development effort to work correctly in the new WHMCS structure.
As such, we are no longer able to offer support for the previous module.
If you had previously used our deprecated module, I would recommend going through the installation process above for the new module, then selecting all of your domain TLDs to use the new module in its place to ensure transfers and registrations take place as expected.
Errors and Problems:
Invalid Payment Method. Valid options include
This message indicates that the default payment method wasn't defined in the pre-requisites above...
Provided domain has not been found in reseller account
Since upgrading to the v2 of our Domain Reseller module, you will need to 'import' your domains to the Reseller Area. This is a security enhancement, which ensures that domain control is restricted to the correct reseller.
To do this, you can go to Domains -> Reseller Area -> Domains
Then click 'Assign Domains', and select the domain from the dropdown.
Once you have confirmed by clicking 'Assign', the error should no longer take place.
