ListTransfers

ListTransfers lists all pending transfer in requests. To get the information related to a non-pending transfer, you can use the GetTransfer function for that.

Endpoint:   

GET /v4/transfers

Parameters:


perPage

int32

Per Page is the number of records to return per request. Per Page defaults to 1,000.


page

int32

Page is which page to return


Response:


transfers

Transfers is a list of pending transfers


nextPage

int32

NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.


lastPage

int32

LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.


Example:

curl -u 'username:token' 'https://api.name.com/v4/transfers'
{
    "transfers": [
        {
            "domainName": "example.org",
            "status": "Retrieving Email"
        }
    ]
}					

GetTransfer

GetTransfer gets details for a transfer request.

Endpoint:   

GET /v4/transfers/{domainName}

Parameters:


domainName
(path parameters)

string

DomainName is the domain you want to get the transfer information for.


Response:


domainName
(read only)

string

DomainName is the domain to be transfered to Name.com.


email
(read only)

string

Email is the email address that the approval email was sent to. Not every TLD requries an approval email. This is usaully pulled from Whois.


status
(read only)

string

Status is the current status of the transfer. Details about statuses can be found in the following Knowledge Base article: https://www.name.com/support/articles/115012519688-Transfer-status-FAQ.


Example:

curl -u 'username:token' 'https://api.name.com/v4/transfers/example.org'
{
    "domainName": "example.org",
    "email": "admin@example.org",
    "status": "Pending Approval"
}					

CreateTransfer

CreateTransfer purchases a new domain transfer request.

Endpoint:   

POST /v4/transfers

Parameters:


domainName

string

DomainName is the domain you want to transfer to Name.com.


authCode

string

AuthCode is the authorization code for the transfer. Not all TLDs require authorization codes, but most do.


privacyEnabled

bool

PrivacyEnabled is a flag on whether to purchase Whois Privacy with the transfer.


purchasePrice

float64

PurchasePrice is the amount to pay for the transfer of the domain. If privacy_enabled is set, the regular price for Whois Privacy will be added automatically. If VAT tax applies, it will also be added automatically. PurchasePrice is required if the domain to transfer is a premium domain.


promoCode

string

PromoCode is not implemented yet


Response:


transfer

Transfer is the transfer resource created.


order

int32

Order is an identifier for this purchase.


totalPaid

float64

TotalPaid is the total amount paid, including VAT and Whois Privacy.


Example:

curl -u 'username:token' 'https://api.name.com/v4/transfers' -X POST --data '{"domainName":"example.org","authCode":"Authc0de","purchasePrice":12.99}'
{
    "transfer": {
        "domainName": "example.org",
        "status": "Retrieving Email"
    },
    "order": 123456,
    "totalPaid": 12.99
}					

CancelTransfer

CancelTransfer cancels a pending transfer request and refunds the amount to account credit.

Endpoint:   

POST /v4/transfers/{domainName}:cancel

Parameters:


domainName
(path parameters)

string

DomainName is the domain to cancel the transfer for.


Response:


domainName
(read only)

string

DomainName is the domain to be transfered to Name.com.


email
(read only)

string

Email is the email address that the approval email was sent to. Not every TLD requries an approval email. This is usaully pulled from Whois.


status
(read only)

string

Status is the current status of the transfer. Details about statuses can be found in the following Knowledge Base article: https://www.name.com/support/articles/115012519688-Transfer-status-FAQ.


Example:

curl -u 'username:token' 'https://api.name.com/v4/transfers/example.org:cancel' -X POST 
{
    "domainName": "example.org",
    "email": "admin@example.org",
    "status": "Pending Approval"
}