Cancel Transfer

Cancels a pending transfer request. This can be used if the transfer was initiated in error or if the authorization code provided was incorrect. The price of the transfer will refund the amount to account credit.

Cancelable statuses:

• pending
• submitting_transfer
• pending_new_auth_code
• pending_unlock
• pending_registry_unlock
• rejected

Non-cancelable statuses:

• pending_transfer
• pending_insert
• completed
• failed
• canceled
• canceled_pending_refund

POST /core/v1/transfers/{domainName}:cancel

Cancel Transfer

cURL

curl --request POST \
  --url https://api.dev.name.com/core/v1/transfers/{domainName}:cancel \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "domainName": "example.com",
  "status": "pending_transfer",
  "email": "[e-mail]"
}

Authorizations

Authorization · string · header · required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Path Parameters

domainName · string · required

DomainName is the domain to cancel the transfer for.

Response

200

application/json

A successful response.

Transfer contains all relevant data for a domain transfer to name.com.

domainName · string · required

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

Example:

"example.com"

status · enum<string> · required

Terminal (finished; will not change):

• completed: Completed.
• failed: Failed.
• canceled: Canceled by the user.
• canceled_pending_refund: Canceled; refund processing.

Non-terminal (in progress; may change):

• pending: Requested.
• submitting_transfer: Being submitted to the registry.
• pending_new_auth_code: New auth code required.
• pending_unlock: Waiting for losing registrar unlock.
• pending_registry_unlock: Waiting for registry unlock.
• pending_transfer: Pending at the registry.
• pending_insert: Transfer complete; domain will be added to the account.
• rejected: Rejected at the losing registrar.

Available options: canceled, canceled_pending_refund, completed, failed, pending, pending_insert, pending_new_auth_code, pending_registry_unlock, pending_transfer, pending_unlock, rejected, submitting_transfer

Example:

"pending_transfer"

email · string<email>

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

Example:

"[e-mail]"