TP_CreateOrder


Definition

Transfer domains into an account. Accepts Fax and AutoVerification order types.

Usage

Use this command to create an order to transfer domains from another registrar to eNom or one of its resellers.

You can also use this command to create but not submit a transfer order, using the PreConfig parameter.

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

When you transfer a .eu or .be domain name from another registrar, we recommend that you always provide Registrant contact information that is separate from Billing contact information; don’t use the “same as Billing” default. Tip: If the Billing and Registrant contact information are the same, we recommend changing the use or spelling of abbreviations in the street address to help our system recognize that it needs to create multiple contacts. Separating the Registrant and Billing information makes it easier to update Registrant contact information in the future.

Premium Domain

A unique, memorable or noteworthy name might be considered as a premium domain. This type of domain will be more expensive depending on the name and TLD. If the TP_CreateOrder command returns the error "CustomerSuppliedPrice is required",then this domain is considered as a premium domain. The exact price for this domain must be declared in the parameter CustomerSuppliedPrice. Use the PE_GetPremiumPricing command to retrieve this price.

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/domains/TransferNew.asp

On the transfer a name page, the next button calls the TP_CreateOrder command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • To use our credit card processing, this must be an ETP reseller account.
  • All domain names in the order must be in top-level domains supported by this registrar.
  • To transfer EPP names, the query must include the authorization key from the Registrar.
  • When using the Fax order type, the registrant contact information must match the current Whois registrant.

Input parameters

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
PreConfig Optional; default is 0 Set PreConfig=1 to create, but not send, the order at this time. Using PreConfig=1 allows you to use TP_UpdateOrderDetail to modify DomainPassword, Lock, Renew, contacts, and extended attributes before submitting the order. When you are ready to submit the order, call TP_SubmitOrder. 1
OrderType Required Permitted values are Fax or Autoverification 20
CustomerSuppliedPrice Optional For premium domain(s), the exact price for this domain must be declared in this parameter. Use the PE_GetPremiumPricing command to retrieve the price. 8
IncludeIDP Optional Includes ID Protect on domain transfers for TLDs that support ID Protect. Permitted values are 1 = include ID Protect, and 0 = Do not include ID Protect. 1
IDPPrice Optional; required if IncludeIDP = 1 Price of ID Protect (the price can be retrieved from the appropriate price command)  
DomainCount Required The number of domain names to be submitted on the order. This number must match the actual number of names submitted. 4
SLDX X=1 to DomainCount Required Second-level domain name (for example, enom in enom.com) 63
TLDX Required Top-level domain name (extension) 15
AuthInfoX Required EPP TLDs Current (“losing”) registrar’s authorization key 20
DomainPassword Optional Set a domain access password on the domain name 16
Lock Optional Set Lock=1 to turn on RegistrarLock option 1
Renew Optional Set Renew=1 to turn on Auto-Renew option 1
AuthString Optional Authorization string for automated transfer order entries (approved accounts only) 100
UseContacts Optional for TLDs that do not require extended attributes; Required TLDs that require extended attributes Set UseContacts=1 to transfer existing Whois contacts with a domain that does not require extended attributes. Set UseContacts=0 if you want to supply new contacts, or when the Registry is one that requires extended attributes. 1
ExtendedAttributes Required for TLDs that use extended attributes, when UseContacts =0 Extended attributes, required for some country code TLDs. You can retrieve a list of required extended attributes for any TLD using the GetExtAttributes command. n/a
RegistrantAddress1 Optional; Required for Fax orders Registrant address 60
RegistrantAddress2 Optional Required Fax orders Registrant additional address info 60
RegistrantCity Optional Required for Fax orders Registrant city 60
RegistrantCountry Optional; Required for Fax orders Registrant country 60
RegistrantEmailAddress Optional; Required for Fax orders Registrant email address 128
RegistrantFax Optional Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URLencoded as a plus sign (%2B). . 20
RegistrantFirstName Optional; Required for Fax orders Registrant first name 60
RegistrantLastName Optional; Required for Fax orders Registrant last name 60
RegistrantJobTitle Optional Registrant job title 60
RegistrantOrganizationName Optional; Required for Fax orders Registrant organization 60
RegistrantPhone Optional; Required for Fax orders Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URLencoded as a plus sign (%2B). . 20
RegistrantPostalCode Required .org names when you supply new Registrant information Registrant postal code 16
RegistrantStateProvince Optional Registrant state or province 60
RegistrantStateProvinceChoice Optional Registrant state or province choice:
S state
P province
1
UseCreditCard Optional for resellers who use our credit card processing AND want to charge this transaction to the credit card included in this query string 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 UseCreditCard=no, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the Registrant contact and credit card information. When you pass credit card information with this command, you must use the secure HTTPS protocol. 3
EndUserIP Required 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
CardType Required our CC processing Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover 20
CreditCardNumber Required our CC processing Credit card number 128
CreditCardExpMonth Required our CC processing Expiration month of the credit card, in format MM 2
CreditCardExpYear Required our CC processing Expiration year of the credit card, in format YYYY 4
CVV2 Required our CC processing Credit card verification code 4
CCName Required our CC processing Cardholder’s name 60
CCAddress Required 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 our CC processing Credit card billing country. Two-character country code is a permitted format 40
CCZip Required 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
ChargeAmount Required our CC processing Amount to charge this credit card. Required format is DD.cc 6
ResponseType Optional in all cases Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
TransferOrderID Transfer order number.
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

  • 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 of SLD and TLD params:
    SLD1=first SLD
    TLD1=first TLD
    SLD2=second SLD
    TLD2=secondTLD
  • Additional params for contact information can be passed by replacing Registrant in the param names above with Tech, Admin or AuxBilling.
  • If UseContacts is set =1 and contact information is passed in the URL, current Whois contacts are transferred and preconfigured contacts (passed in the URL) are ignored.
  • Automatic transfer of Whois information is available only for the largest registrars.
  • An OrderType of Fax requires a signed fax to process the order, an OrderType of Autoverification uses an electronic verification process to authorize and initiate the transfer.

Example