Sign in

v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB
Transfers

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

Path parameters

domainNamestring required

DomainName is the domain to cancel the transfer for.

Response

A successful response.

domainNamestring required

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

emailstring 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.

status'canceled' | 'canceled_pending_refund' | 'completed' | 'failed' | 'pending' | 'pending_insert' | 'pending_new_auth_code' | 'pending_registry_unlock' | 'pending_transfer' | 'pending_unlock' | 'rejected' | 'submitting_transfer' 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.

Example response

{
  "domainName": "example.com",
  "email": "admin@example.com",
  "status": "pending_transfer"
}