curl --request POST \
--url https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'token: <token>' \
--header 'username: <username>' \
--data domain=example.com \
--data regperiod=1 \
--data 'nameservers={
"ns1": "ns1.example.com",
"ns2": "ns2.example.com",
"ns3": "<string>",
"ns4": "<string>",
"ns5": "<string>"
}' \
--data 'contacts={
"Registrant": {},
"Admin": {},
"Tech": {},
"Billing": {}
}' \
--data 'eppcode=<string>' \
--data 'addons={
"dnsmanagement": false,
"emailforwarding": false,
"idprotection": false
}' \
--data 'domainfields=<string>' \
--data 'idnLanguage=<string>' \
--data 'originalvars={}'import requests
url = "https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer"
payload = {
"domain": "example.com",
"regperiod": "1",
"nameservers": "{
\"ns1\": \"ns1.example.com\",
\"ns2\": \"ns2.example.com\",
\"ns3\": \"<string>\",
\"ns4\": \"<string>\",
\"ns5\": \"<string>\"
}",
"contacts": "{
\"Registrant\": {},
\"Admin\": {},
\"Tech\": {},
\"Billing\": {}
}",
"eppcode": "<string>",
"addons": "{
\"dnsmanagement\": false,
\"emailforwarding\": false,
\"idprotection\": false
}",
"domainfields": "<string>",
"idnLanguage": "<string>",
"originalvars": "{}"
}
headers = {
"username": "<username>",
"token": "<token>",
"Content-Type": "application/x-www-form-urlencoded"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
username: '<username>',
token: '<token>',
'Content-Type': 'application/x-www-form-urlencoded'
},
body: new URLSearchParams({
domain: 'example.com',
regperiod: '1',
nameservers: '{\n "ns1": "ns1.example.com",\n "ns2": "ns2.example.com",\n "ns3": "<string>",\n "ns4": "<string>",\n "ns5": "<string>"\n}',
contacts: '{\n "Registrant": {},\n "Admin": {},\n "Tech": {},\n "Billing": {}\n}',
eppcode: '<string>',
addons: '{\n "dnsmanagement": false,\n "emailforwarding": false,\n "idprotection": false\n}',
domainfields: '<string>',
idnLanguage: '<string>',
originalvars: '{}'
})
};
fetch('https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "domain=example.com®period=1&nameservers=%7B%0A%20%20%22ns1%22%3A%20%22ns1.example.com%22%2C%0A%20%20%22ns2%22%3A%20%22ns2.example.com%22%2C%0A%20%20%22ns3%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns4%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns5%22%3A%20%22%3Cstring%3E%22%0A%7D&contacts=%7B%0A%20%20%22Registrant%22%3A%20%7B%7D%2C%0A%20%20%22Admin%22%3A%20%7B%7D%2C%0A%20%20%22Tech%22%3A%20%7B%7D%2C%0A%20%20%22Billing%22%3A%20%7B%7D%0A%7D&eppcode=%3Cstring%3E&addons=%7B%0A%20%20%22dnsmanagement%22%3A%20false%2C%0A%20%20%22emailforwarding%22%3A%20false%2C%0A%20%20%22idprotection%22%3A%20false%0A%7D&domainfields=%3Cstring%3E&idnLanguage=%3Cstring%3E&originalvars=%7B%7D",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded",
"token: <token>",
"username: <username>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer"
payload := strings.NewReader("domain=example.com®period=1&nameservers=%7B%0A%20%20%22ns1%22%3A%20%22ns1.example.com%22%2C%0A%20%20%22ns2%22%3A%20%22ns2.example.com%22%2C%0A%20%20%22ns3%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns4%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns5%22%3A%20%22%3Cstring%3E%22%0A%7D&contacts=%7B%0A%20%20%22Registrant%22%3A%20%7B%7D%2C%0A%20%20%22Admin%22%3A%20%7B%7D%2C%0A%20%20%22Tech%22%3A%20%7B%7D%2C%0A%20%20%22Billing%22%3A%20%7B%7D%0A%7D&eppcode=%3Cstring%3E&addons=%7B%0A%20%20%22dnsmanagement%22%3A%20false%2C%0A%20%20%22emailforwarding%22%3A%20false%2C%0A%20%20%22idprotection%22%3A%20false%0A%7D&domainfields=%3Cstring%3E&idnLanguage=%3Cstring%3E&originalvars=%7B%7D")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("username", "<username>")
req.Header.Add("token", "<token>")
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer")
.header("username", "<username>")
.header("token", "<token>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("domain=example.com®period=1&nameservers=%7B%0A%20%20%22ns1%22%3A%20%22ns1.example.com%22%2C%0A%20%20%22ns2%22%3A%20%22ns2.example.com%22%2C%0A%20%20%22ns3%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns4%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns5%22%3A%20%22%3Cstring%3E%22%0A%7D&contacts=%7B%0A%20%20%22Registrant%22%3A%20%7B%7D%2C%0A%20%20%22Admin%22%3A%20%7B%7D%2C%0A%20%20%22Tech%22%3A%20%7B%7D%2C%0A%20%20%22Billing%22%3A%20%7B%7D%0A%7D&eppcode=%3Cstring%3E&addons=%7B%0A%20%20%22dnsmanagement%22%3A%20false%2C%0A%20%20%22emailforwarding%22%3A%20false%2C%0A%20%20%22idprotection%22%3A%20false%0A%7D&domainfields=%3Cstring%3E&idnLanguage=%3Cstring%3E&originalvars=%7B%7D")
.asString();require 'uri'
require 'net/http'
url = URI("https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["username"] = '<username>'
request["token"] = '<token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "domain=example.com®period=1&nameservers=%7B%0A%20%20%22ns1%22%3A%20%22ns1.example.com%22%2C%0A%20%20%22ns2%22%3A%20%22ns2.example.com%22%2C%0A%20%20%22ns3%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns4%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns5%22%3A%20%22%3Cstring%3E%22%0A%7D&contacts=%7B%0A%20%20%22Registrant%22%3A%20%7B%7D%2C%0A%20%20%22Admin%22%3A%20%7B%7D%2C%0A%20%20%22Tech%22%3A%20%7B%7D%2C%0A%20%20%22Billing%22%3A%20%7B%7D%0A%7D&eppcode=%3Cstring%3E&addons=%7B%0A%20%20%22dnsmanagement%22%3A%20false%2C%0A%20%20%22emailforwarding%22%3A%20false%2C%0A%20%20%22idprotection%22%3A%20false%0A%7D&domainfields=%3Cstring%3E&idnLanguage=%3Cstring%3E&originalvars=%7B%7D"
response = http.request(request)
puts response.read_body"success"{
"error": "Invalid API Token provided"
}{
"error": "Invalid API Token provided"
}{
"error": "Invalid API Token provided"
}{
"error": "Invalid API Token provided"
}Transfer Domain
Transfers an existing domain to the registrar. Creates the order, bills the reseller, and initiates the transfer.
curl --request POST \
--url https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'token: <token>' \
--header 'username: <username>' \
--data domain=example.com \
--data regperiod=1 \
--data 'nameservers={
"ns1": "ns1.example.com",
"ns2": "ns2.example.com",
"ns3": "<string>",
"ns4": "<string>",
"ns5": "<string>"
}' \
--data 'contacts={
"Registrant": {},
"Admin": {},
"Tech": {},
"Billing": {}
}' \
--data 'eppcode=<string>' \
--data 'addons={
"dnsmanagement": false,
"emailforwarding": false,
"idprotection": false
}' \
--data 'domainfields=<string>' \
--data 'idnLanguage=<string>' \
--data 'originalvars={}'import requests
url = "https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer"
payload = {
"domain": "example.com",
"regperiod": "1",
"nameservers": "{
\"ns1\": \"ns1.example.com\",
\"ns2\": \"ns2.example.com\",
\"ns3\": \"<string>\",
\"ns4\": \"<string>\",
\"ns5\": \"<string>\"
}",
"contacts": "{
\"Registrant\": {},
\"Admin\": {},
\"Tech\": {},
\"Billing\": {}
}",
"eppcode": "<string>",
"addons": "{
\"dnsmanagement\": false,
\"emailforwarding\": false,
\"idprotection\": false
}",
"domainfields": "<string>",
"idnLanguage": "<string>",
"originalvars": "{}"
}
headers = {
"username": "<username>",
"token": "<token>",
"Content-Type": "application/x-www-form-urlencoded"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
username: '<username>',
token: '<token>',
'Content-Type': 'application/x-www-form-urlencoded'
},
body: new URLSearchParams({
domain: 'example.com',
regperiod: '1',
nameservers: '{\n "ns1": "ns1.example.com",\n "ns2": "ns2.example.com",\n "ns3": "<string>",\n "ns4": "<string>",\n "ns5": "<string>"\n}',
contacts: '{\n "Registrant": {},\n "Admin": {},\n "Tech": {},\n "Billing": {}\n}',
eppcode: '<string>',
addons: '{\n "dnsmanagement": false,\n "emailforwarding": false,\n "idprotection": false\n}',
domainfields: '<string>',
idnLanguage: '<string>',
originalvars: '{}'
})
};
fetch('https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "domain=example.com®period=1&nameservers=%7B%0A%20%20%22ns1%22%3A%20%22ns1.example.com%22%2C%0A%20%20%22ns2%22%3A%20%22ns2.example.com%22%2C%0A%20%20%22ns3%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns4%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns5%22%3A%20%22%3Cstring%3E%22%0A%7D&contacts=%7B%0A%20%20%22Registrant%22%3A%20%7B%7D%2C%0A%20%20%22Admin%22%3A%20%7B%7D%2C%0A%20%20%22Tech%22%3A%20%7B%7D%2C%0A%20%20%22Billing%22%3A%20%7B%7D%0A%7D&eppcode=%3Cstring%3E&addons=%7B%0A%20%20%22dnsmanagement%22%3A%20false%2C%0A%20%20%22emailforwarding%22%3A%20false%2C%0A%20%20%22idprotection%22%3A%20false%0A%7D&domainfields=%3Cstring%3E&idnLanguage=%3Cstring%3E&originalvars=%7B%7D",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded",
"token: <token>",
"username: <username>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer"
payload := strings.NewReader("domain=example.com®period=1&nameservers=%7B%0A%20%20%22ns1%22%3A%20%22ns1.example.com%22%2C%0A%20%20%22ns2%22%3A%20%22ns2.example.com%22%2C%0A%20%20%22ns3%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns4%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns5%22%3A%20%22%3Cstring%3E%22%0A%7D&contacts=%7B%0A%20%20%22Registrant%22%3A%20%7B%7D%2C%0A%20%20%22Admin%22%3A%20%7B%7D%2C%0A%20%20%22Tech%22%3A%20%7B%7D%2C%0A%20%20%22Billing%22%3A%20%7B%7D%0A%7D&eppcode=%3Cstring%3E&addons=%7B%0A%20%20%22dnsmanagement%22%3A%20false%2C%0A%20%20%22emailforwarding%22%3A%20false%2C%0A%20%20%22idprotection%22%3A%20false%0A%7D&domainfields=%3Cstring%3E&idnLanguage=%3Cstring%3E&originalvars=%7B%7D")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("username", "<username>")
req.Header.Add("token", "<token>")
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer")
.header("username", "<username>")
.header("token", "<token>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("domain=example.com®period=1&nameservers=%7B%0A%20%20%22ns1%22%3A%20%22ns1.example.com%22%2C%0A%20%20%22ns2%22%3A%20%22ns2.example.com%22%2C%0A%20%20%22ns3%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns4%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns5%22%3A%20%22%3Cstring%3E%22%0A%7D&contacts=%7B%0A%20%20%22Registrant%22%3A%20%7B%7D%2C%0A%20%20%22Admin%22%3A%20%7B%7D%2C%0A%20%20%22Tech%22%3A%20%7B%7D%2C%0A%20%20%22Billing%22%3A%20%7B%7D%0A%7D&eppcode=%3Cstring%3E&addons=%7B%0A%20%20%22dnsmanagement%22%3A%20false%2C%0A%20%20%22emailforwarding%22%3A%20false%2C%0A%20%20%22idprotection%22%3A%20false%0A%7D&domainfields=%3Cstring%3E&idnLanguage=%3Cstring%3E&originalvars=%7B%7D")
.asString();require 'uri'
require 'net/http'
url = URI("https://vicem.com/modules/addons/DomainsReseller/api/index.php/order/domains/transfer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["username"] = '<username>'
request["token"] = '<token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "domain=example.com®period=1&nameservers=%7B%0A%20%20%22ns1%22%3A%20%22ns1.example.com%22%2C%0A%20%20%22ns2%22%3A%20%22ns2.example.com%22%2C%0A%20%20%22ns3%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns4%22%3A%20%22%3Cstring%3E%22%2C%0A%20%20%22ns5%22%3A%20%22%3Cstring%3E%22%0A%7D&contacts=%7B%0A%20%20%22Registrant%22%3A%20%7B%7D%2C%0A%20%20%22Admin%22%3A%20%7B%7D%2C%0A%20%20%22Tech%22%3A%20%7B%7D%2C%0A%20%20%22Billing%22%3A%20%7B%7D%0A%7D&eppcode=%3Cstring%3E&addons=%7B%0A%20%20%22dnsmanagement%22%3A%20false%2C%0A%20%20%22emailforwarding%22%3A%20false%2C%0A%20%20%22idprotection%22%3A%20false%0A%7D&domainfields=%3Cstring%3E&idnLanguage=%3Cstring%3E&originalvars=%7B%7D"
response = http.request(request)
puts response.read_body"success"{
"error": "Invalid API Token provided"
}{
"error": "Invalid API Token provided"
}{
"error": "Invalid API Token provided"
}{
"error": "Invalid API Token provided"
}Headers
Reseller email address registered in WHMCS
HMAC-SHA256 authentication token.
PHP formula: base64_encode(hash_hmac('sha256', $apiKey, $email . ':' . gmdate('y-m-d H')))
Important: hash_hmac without the 3rd parameter true (returns hex, not binary), then base64_encode of the hex result. The token is 88 characters long.
An optional timestamp header (Unix timestamp, 60-second tolerance) can be sent to synchronize time.
"YTk4YjRmNjI..."
Body
Full domain name to transfer
"example.com"
Registration period in years
1
Show child attributes
Show child attributes
WHOIS contacts. Keys: Registrant (required), Admin, Tech, Billing. Each value is a key-value object of contact fields.
Show child attributes
Show child attributes
EPP/Auth code for the domain (optional depending on TLD)
Domain addons. Each key is an addon name, value is a boolean indicating whether it is enabled.
Show child attributes
Show child attributes
TLD-specific additional fields, encoded as base64(serialize(array))
Language code for IDN domains
Original parameters from the reseller WHMCS
Response
Success - Returns "success"
The response is of type string.
"success"