PurchaseServices


Definition

Purchase one of our services in real time.

The PurchaseServices command allows you to purchase one service each time you run the query.

Usage

Use this command to purchase one value-added service in real time, as opposed to going through a shopping cart and our order queue. Most commonly, real-time commands are used by resellers who maintain their own databases.

Our credit card services are available for ID Protect and DNS hosting.

When you pass credit card information with this command, you must use the secure HTTPS protocol.

Availability

All resellers have access to this command.

Implementation on eNom.com

Log on to resellertest.enom.com with Login ID resellid, password resellpw.

https://resellertest.enom.com

The PurchaseServices command is not implemented on www.enom.com. Its functionality is most similar to the combined functionality of AddToCart and InsertNewOrder. The difference is that AddToCart and InsertNewOrder can put multiple items into a shopping cart and then put items selected from that cart into a queue for checkout, whereas the PurchaseServices command purchases a single item in real time.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • Some products are available to only some TLDs. For example, ID Protect is not available for .us.
  • To use our credit card processing (available only for ID Protect, Business Listing, and DNS hosting in the PurchaseServices suite of products), this must be an ETP reseller account that has signed a credit card agreement with us.

Input parameters

Click a link in the table below to go directly to a specific product:

Input parameters for ID Protect

Input parameters for SSL Certificates

Input parameters for VeriSign Trust Seal

Input parameters for GeoTrust Anti-Malware

Input parameters for SiteLock

Input parameters for RichContent

Input parameters for Business Listing

Input parameters for POP Email

Input parameters for Web Site Creator

Input parameters for Web hosting

Input parameters for DNS hosting

Input parameters for goMobi

 

Input parameters for ID Protect

The table below lists input parameters for ID Protect.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Permitted value for ID Protect is WPPS 15
SLD Required for WPPS Second-level domain name (forexample, enom in enom.com). 63
TLD Required for WPPS Top-level domain name (extension). 15
NumYears Optional for WPPS; default is 1 Number of years to subscribe to ID Protect 2
RenewName Optional for WPPS; default is 0 Use RenewName=1 to automatically renew ID Protect 30 days before it expires 1
EmailNotify Optional; default is 0 Permitted values are 0 and 1. 1 sends you an email confirmation when a customer makes a purchase using this command. 3
UseCreditCard Optional overall, but Required for resellers who have a credit card processing agreement with us AND want to use our CC processing to charge this transaction to the credit card included in this query string. Default is no. Available for WPPS. Permitted values are yes and no. The credit card supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted, or if the value supplied is anything other than yes, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the required credit card information. When you pass credit card information with this command, you must use the secure HTTPS protocol. 3
EndUserIP Required for our credit card processing End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. 15
ChargeAmount Required for our cc processing Amount to charge for each year; ChargeAmount will be multiplied by NumYears. Required format is DD.cc 6
CardType Required for our cc processing Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover 20
CreditCardNumber Required for our cc processing Credit card number 128
CreditCardExpMonth Required for our cc processing Expiration month of the credit card, in format MM 2
CreditCardExpYear Required for our cc processing Expiration year of the credit card, in format YYYY 4
CVV2 Required for our cc processing, if printed on the card Credit card verification value 4
CCName Required for our cc processing Cardholder’s name 60
CCAddress Required for our cc processing Credit card billing street address 60
CCCity Optional for our CC processing Credit card billing city 60
CCStateProvince Optional for our CC processing Credit card billing state or province 40
CCCountry Required for our cc processing Credit card billing country. Two-character country code is a permitted format 40
CCZip Required for our cc processing Credit card billing postal code 60
CCPhone Optional for our CC processing Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URL-encoded as a plus sign (%2B). 20
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for SSL Certificates

The table below lists input parameters for SSL certificates.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

       
UID Required Account login ID 20
PW Required Account password 20
Service Required Service to purchase. Permitted values for certs are:
Certificate-Comodo-Essential
Certificate-Comodo-Instant
Certificate-Comodo-Essential-Wildcard
Certificate-Comodo-Premium-Wildcard
Certificate-Comodo-EV
Certificate-Comodo-EV-SGC
Certificate-GeoTrust-QuickSSL
Certificate-GeoTrust-QuickSSL-Premium
Certificate-GeoTrust-TrueBizID
Certificate-GeoTrust-TrueBizID-Wildcard
Certificate-GeoTrust-TrueBizID-EV
Certificate-RapidSSL
Certificate-RapidSSL-RapidSSL-Wildcard
Certificate-VeriSign-Secure-Site
Certificate-VeriSign-Secure-Site-Pro
Certificate-VeriSign-Secure-Site-EV
Certificate-VeriSign-Secure-Site-Pro-EV
Certificate-Comodo-UCC-DV
Certificate-Comodo-UCC-OV
15
NumYears Optional for certs; default is 1

Number of years to purchase this SSL certificate. Permitted values are 1 to the following maximum values:
3 Comodo Essential
3 Comodo Instant
3 Comodo Essential Wildcard
3 Comodo Premium Wildcard
2 Comodo EV
2 Comodo EV SGC
3 GeoTrust QuickSSL
3 GeoTrust QuickSSL Premium
3 GeoTrust True BusinessID
3 GeoTrust True BusinessID Wildcard
2 GeoTrust True BusinessID with EV
3 RapidSSL
3 RapidSSL Wildcard
3 VeriSign Secure Site
3 VeriSign Secure Site Pro
2 VeriSign Secure Site with EV
2 VeriSign Secure Site Pro with EV
3 Comodo UCC DV
3 Comodo UCC OV

2
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for VeriSign Trust Seal

The table below lists input parameters for VeriSign Trust Seal.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Service to purchase. Permitted values for VeriSign Trust Seal: Seal-VeriSign-Trust-Seal 15
NumYears Required Number of years to subscribe to VeriSign Trust Seal. Permitted values are 1, 2, or 3 1
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for GeoTrust Anti-Malware

The table below lists input parameters for GeoTrust Anti-Malware.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Service to purchase. Permitted values for GeoTrust Anti-Malware: GeoTrust-Anti-Malware-Scan GeoTrust-Anti-Malware-Scan-With-Seal 15
NumYears Optional; default=1 Number of years to subscribe to GeoTrust Anti-Malware. Permitted value is 1 1
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for SiteLock

The table below lists input parameters for SiteLock.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Service to purchase. Permitted values for SiteLock: SiteLock-Basic SiteLock-Premium SiteLock-Enterprise 15
NumYears Optional; default=1 Number of years to subscribe to SiteLock. Permitted value is 1 1
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for RichContent

The table below lists input parameters for RichContent.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Permitted values for RichContent are: RichContent RichContentFreeTrial 15
EmailAddress Either EmailAddress or PublisherID is Required Email address of the RichContent customer. An email address can be used for multiple RichContent subscriptions in the same domain name account, but can only be used for a free trial once. 150
PublisherID Either EmailAddress or PublisherID is Required Identification number for this email address in our records of RichContent subscriptions. To retrieve this number use the RC_GetSubscriptions command. Permitted values are integers 10
SourceDomain Optional for RichContent RichContentFreeTrial Domain name, with host records, to associate with this RichContent subscription. Permitted format is host.sld.tld 272
Quantity Optional; default is 1 Billing period, in months. For RichContent, permitted values are 1, 3, 6, or 12. For RichContentFreeTrial, the permitted value is 1, and the subscription automatically converts to monthly billing after the one-month free trial 2
EmailNotify Optional; default is 0 Permitted values are 0 and 1. 1 sends you an email confirmation when a customer makes a purchase using this command. 3
EndUserIP Required End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. 15
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for Business Listing

The table below lists input parameters for Business Listing.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Permitted value for Business Listing is BusListing 15
SLD Required for BusListing Second-level domain name (for example, enom in enom.com). 63
TLD Required for BusListing Top-level domain name (extension). 15
NumYears Optional for BusListing; default is 1 Number of years to subscribe to ID Protect. Permitted values are 1 to 10. 2
RenewName Optional for BusListing; default is 1 Use RenewName=1 to automatically renew Business Listing 30 days before it expires 1
EmailNotify Optional; default is 0 Permitted values are 0 and 1. 1 sends you an email confirmation when a customer makes a purchase using this command. 3
UseCreditCard Optional overall, but Required for resellers who have a credit card processing agreement with us AND want to use our CC processing to charge this transaction to the credit card included in this query string. Default is no. Available for BusListing. Permitted values are yes and no. The credit card supplied in this query string is charged only if UseCreditCard=yes . If this param is omitted, or if the value supplied is anything other than yes, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the required credit card information. When you pass credit card information with this command, you must use the secure HTTPS protocol. 3
EndUserIP Required for our CC processing End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. 15
ChargeAmount Required for our CC processing Amount to charge for each year; ChargeAmount will be multiplied by NumYears. Required format is DD.cc 6
CardType Required for our CC pprocessing Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover 20
CreditCardNumber Required for our CC processing Credit card number 128
CreditCardExpMonth Required for our CC processing Expiration month of the credit card, in format MM 2
CreditCardExpYear Required for our CC processing Expiration year of the credit card, in on year of the credit card, in format YYYY 4
CVV2 Required for our CC processing, if printed on the card Credit card verification value 4
CCName Required for our CC processing Cardholder’s name 60
CCAddress Required for our CC processing Credit card billing street address 60
CCCity Optional for our CC processing Credit card billing city 60
CCStateProvince Optional for our CC processing Credit card billing state or province 40
CCCountry Required for our CC processing Credit card billing country. Two-character country code is a permitted format 40
CCZip Required for our CC processing Credit card billing postal code 60
CCPhone Optional for our CC processing Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URL-encoded as a plus sign (%2B). 20
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for POP Email

The table below lists input parameters for POP Email. Using the PurchaseServices command, you can purchase POP Email for 1 year. You can renew in real time using the RenewPOPBundle command, or set auto-renew preferences with the SetPakRenew or SetRenew commands.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
EndUserIP Required End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. 15
ProductType Required

Type of product to add. Permitted values are:

  • POP (10-mailbox pak with 1GB storage per mailbox)
  • Renew-POP EmailStorage (512MB extra storage per mailbox)
  • Mailbox (This is the new email type which allows for both creating new mailboxes and renewals.)
39
SLD Required for POP3 Second-level domain name (for example, enom in enom.com). 63
TLD Required for POP3 Top-level domain name (extension). 15
Quantity Optional for POP
Renew-POP EmailStorage Mailbox

For ProductType=POP, the number of 10-mailbox paks to purchase for this domain.

For ProductType=Renew-POP, the number of years to add to this POP pak subscription.

For ProductType=EmailStorage, the number of 512MB units of storage to add to this pak.

For ProductType=Mailbox, the number of mailboxs to add.

2
ProductID Required for Renew-POP EmailStorage Also required for ProductType=Mailbox with ActionType=Renew POP pak ID number. To retrieve this value, use the GetPOP3 command. 3
ActionType Optional for Mailbox Possible values: Create (default) Renew (ProductID is required for renewal) 3
TimeUnit Optional for Mailbox Possible values: Year (default) Month  
TimeQuantity Optional for Mailbox Possible values: 1-12 number of months or years (default is 1) 3
Capacity Optional for Mailbox

Possible values:

1 - 1 Gigabyte of storage (default)

3 - 3 Gigabytes of storage

5 - 5 Gigabytes of storage

10 - 10 Gigabytes of storage

3
ClearItems Optional; you must also add another item to the cart in the same query Make all items currently in the cart inactive (but keep them in the cart), and add a new item. Permitted value is yes. To reactivate items in the cart that are inactive, use the UpdateCart command. 3
ResponseType Optional; default is Text Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for Web Site Creator

The table below lists input parameters for Web Site Creator (WSC). Using the PurchaseServices command, you can subscribe to WSC with a monthly billing cycle.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Type of service to purchase. For WSC, use Service=LWSCBasic, LWSCFull, or LWSCECom. 15
SLD Required for LWSCBasic, LWSCFull, and LWSCECom Second-level domain name (for example, enom in enom.com). For LWSC*, this is the domain WSC will be associated with. 63
TLD Required for LWSCBasic, LWSCFull, and LWSCECom Top-level domain name (extension). For LWSC*, this is the domain WSC will be associated with. 15
EmailNotify Optional; default is 0 Permitted values are 0 and 1. 1 sends you an email confirmation when a customer makes a purchase using this command. 3
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for Web hosting

The table below lists input parameters for Web hosting.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Type of service to purchase. For Web hosting, use Service=WebHosting 15
SLD Optional for WebHosting Second-level domain name (for example, enom in enom.com). For WebHosting, this is the domain the Web hosting package will be associated with. 63
TLD Optional for WebHosting Top-level domain name (extension). For WebHosting , this is the domain the Web hosting package will be associated with. 15
HostAccount Required for WebHosting Name for this Web hosting account. Permitted values are 6 to 14 characters in length, begin with a letter, and the remaining characters are alphanumeric. 14
HostPassword Required for WebHosting Password for this Web hosting account; must be alphanumeric and 6 to 14 characters in length. 14
FullName Required for WebHosting First and last name of the contact person for this Web hosting account, for example, John Doe 44
HostAccountEmail Optional for WebHosting Email address for communications from us regarding this Web hosting account, for example, john.doe@resellerdocs.com 78
Package Required for WebHosting Package name. To retrieve currently defined packages, use the WebHostGetPackages command from the Web hosting API catalog. 11
OverageOption Required for WebHosting Your instructions for how we should handle bandwidth overages, measured on a per-month basis. Permitted values are: 1 Upgrade to the next bandwidth package 2 Charge on a per-GB basis on my next monthly bill 3 Disable the account until the beginning of the next monthly billing cycle 1
EmailNotify Optional; default is 0 Permitted values are 0 and 1. 1 sends you an email confirmation when a customer makes a purchase using this command. 3
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for DNS hosting

The table below lists input parameters for DNS hosting.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Type of service to purchase. For DNS hosting, use Service=DNSHosting. 15
NumYears Required for DNSHosting Number of years to subscribe to this service. Permitted values are 1 to 10. 2
SLD Required for DNSHosting Second-level domain name (for example, enom in enom.com). 63
TLD Required for DNSHosting Top-level domain name (extension). 15
DomainPassword Optional for DNSHosting Set a password on the domain name 60
RenewName Optional for DNSHosting Set to 1 to auto-renew the name 1
EmailNotify Optional; default is 0 Permitted values are 0 and 1. 1 sends you an email confirmation when a customer makes a purchase using this command. 3
UseCreditCard Optional overall, but Required for resellers who have a credit card processing agreement with us AND want to use our CC processing to charge this transaction to the credit card included in this query string. Default is no. Credit card processing is available for DNSHosting. Permitted values are yes and no. The credit card supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted, or if the value supplied is anything other than yes, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the required credit card information. When you pass credit card information with this command, you must use the secure HTTPS protocol. 3
EndUserIP Required for credit card processing End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. 15
ChargeAmount Required for our CC processing Amount to charge for each year of DNS hosting; ChargeAmount is multiplied by NumYears to yield the total charge for this order. Required format is DD.cc 6
CardType Required for our CC processing Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover 20
CreditCardNumber Required for our CC processing Credit card number 128
CreditCardExpMonth Required for our CC processing Expiration month of the credit card, in format MM 2
CreditCardExpYear Required for our CC processing Expiration year of the credit card, in format YYYY 4
CVV2 Required for our CC processing, if printed on the card Credit card verification value 4
CCName Required for our CC processing Cardholder’s name 60
CCAddress Required for our CC processing Credit card billing street address 60
CCCity Optional for our CC processing Credit card billing city 60
CCStateProvince Optional for our CC processing Credit card billing state or province 40
CCCountry Required processing Credit card billing country. Two-character country code is a permitted format 40
CCZip Required for our cc processing Credit card billing postal code 60
CCPhone Optional for our CC processing Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URL-encoded as a plus sign (%2B). 20
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Input parameters for goMobi

The table below lists input parameters for goMobi, our product that instantly converts any Web site to a compact format suitable for display on mobile devices.

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Service Required Type of service to purchase. For goMobi, permitted values are: goMobi goMobiFreeTrial 15
Quantity Required Billing cycle for goMobi. Permitted values are: 1 Monthly billing 12 Yearly billing 2
EmailNotify Optional; default is 0 Permitted values are 0 and 1. 1 sends you an email confirmation when a customer makes a purchase using this command. 3
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
CCTransResult Credit card preauthorization result; included when using our credit card processing for Service=WPPS, BusListing, or DNSHosting
PublisherID Our identification number for the email address associated with this RichContent purchase; included for Service=RichContent and RichContentFreeTrial
SubscriptionID Our identification number for the Domain Name associated with this GoMobi purchase; included for Service=GoMobi and GoMobiFreeTrial
BundleID Our identification number for this POP pak; included for Service=POP3
BundleCount Total number of POP paks purchased with this query; included for Service=POP3
LWSCHostAccount WSC account name; included for Service=LWSC*
LWSCUpgrade Success status for adding WSC to this domain; included for Service=LWSC*
SetBilling Success status for setting up monthly billing for this WSC account; included for Service=LWSC*
PackageID Web hosting package ID number assigned by us; included for Service=WebHosting
ServerIP IP of the Web hosting server for this Web hosting account; included for Service=WebHosting
Successful Success status of this query; included for Service=WebHosting
OrderID Order ID number
CertID Cert ID for the cert purchased in this order; included for any cert purchase
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
ErrX Error messages explaining the failure. These can be presented as is back to the client.
Done True indicates this entire response has reached you successfully.

 

Notes

  • A fully qualified domain name is expressed in the format “hostname.SLD.TLD.”. Note that the period at the end is an essential component of a fully qualified domain name.
  • The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example