domorder

Domain Products

Purchasing / Renewing Privacy Protection

You may purchase Privacy Protection or renew Privacy Protection (if the Privacy Protection expiry date is earlier than the domain name expiry date), for an existing domain name.

Purchasing Privacy Protection

Exceptions 

Note

This feature is not available for the following TLDs (extensions):

  • Due to restrictions imposed by the Registry Operator:

    • .ARCHI


    • .ASIA



    • .AU



    • .BERLIN


    • .BHARAT


    • .BIO


    • .BLOG


    • .BR


    • .CA


    • .CN


    • .CO.DE



    • .CYMRU


    • .DE


    • .EC


    • .ECO


    • .ES


    • .EU


    • .FR


    • .GDN




    • .IN




    • .LAT


    • .LTDA


    • .MX


    • .NGO


    • .NYC


    • .NZ


    • .PH


    • .RU


    • .SKI


    • .SRL


    • .SX


    • .TEL



    • .UK

      Additional Information

      .UK Registrants who are non-trading individuals (those who do not use or plan to use their domain name for business, trade [including registration of domain names for monetization purposes] or professional transactions) can choose to opt out of having their Contact Details displayed in the Whois lookup.

      This option can be enabled by the Registrant from within his Nominet control panel.


    • .US


    • .VOTE


    • .VOTO


    • .WALES

  • Due to other restrictions:

    • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  1. Login to your Control Panel. See details

  2. Search for the domain name and proceed to the Order Information view. See details

  3. Click the Privacy Protection link.

  4. Click the Buy Privacy button.

  5. Proceed to Pay for the Purchase.

Renewing Privacy Protection

  1. Login to your Control Panel. See details

  2. Search for the domain name and proceed to the Order Information view. See details

  3. Click the Renew link, next to Privacy Protection.

  4. Click the Buy Privacy button.

  5. Proceed to Pay for the Purchase.

Purchasing / Renewing Privacy Protection

Description

Adds / Renews the Privacy Protection service for the specified Domain Registration Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required

Order Id of the Domain Registration Order for which the Privacy Protection service needs to be purchased / renewed.

Privacy Protection is not supported for the following TLDs (extensions):

  • .ASIA

  • .AU

  • .CA

  • .CN

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .DE

  • .ES

  • .EU

  • .IN

  • .NL

  • .NZ

  • .PRO

  • .RU

  • .SX

  • .TEL

  • .UK

  • .US

invoice-option String Required This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:
  • NoInvoice: This will not raise any Invoice. The Order will be renewed.

  • PayInvoice: This will raise an Invoice and:

    • if there are sufficient funds in the Customer's Debit Account, then the Invoice will be paid and the Order will be renewed.

    • if there are insufficient funds in the Customer's Debit Account, then the Order will remain pending in the system.

  • KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be renewed.

  • OnlyAdd: This will raise an Invoice for the Customer to pay later. The purchase/renew action request will remain pending.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/purchase-privacy.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

domainname.com

  • Domain Name (description)

  • Order ID of the Domain Name Order (entityid)

  • Action Type (actiontype)

  • Description of the Privacy Protection Purchase / Renewal Action (actiontypedesc)

  • Action ID of the Privacy Protection Purchase / Renewal Action (eaqid)

  • Privacy Protection Purchase / Renewal Action Status (actionstatus)

  • Description of the Privacy Protection Purchase / Renewal Action Status (actionstatusdesc)

  • Invoice ID of the Privacy Protection Purchase / Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Domain Name Order (customerid)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.