Accounts-accountNumber-domains-transfer-domainName:GET

From Hostway API Documentation
Jump to: navigation, search

GET /accounts/{accountNumber}/domains/transfers/{domainName}

This call will return detailed information on a domain transfer that is in progress for the given domain name and customer number.

Contents

Request

GET /accounts/{accountNumber}/domains/transfers/{domainName}

URI Parameters

accountNumber
client account number

Template:DomainTransfer

Parameters

None.

Request Headers

Accept: application/json

Request Body

None.

Response

Status Code

200 OK
Returns status for transfer.
403 Forbidden

This customer is not authorized to view the transfer. Possibly the transfer belongs to another account.

404 Not Found

No transfer order found for this domain and account number.

500 Internal Server Error

Registry error.

Response Body

Status info for the transfer order.

Parameters

history
List of status objects (see below for the status fields)
status
Current status object with the following fields:

Status object fields

canBeReset
Boolean value that indicates if a transfer is in a state that can be reset. This means the transfer ran into a problem that prevents it from proceeding until corrective actions are taken and the transfer is reset. If a transfer is still in progress it cannot be reset. Nor may a transfer be reset if it has been voided.
status
Status value of the transfer order. Valid statuses are:
StatusCan be ResetDescription
0 NTransfer request created - awaiting fax
1 NWhoIs information matches
2 YCanceled due to WhoIs error
3 NPending due to domain status
4 YCanceled due to domain status
5 NTransferred and paid successfully
6 YTransfer incomplete charge problem
7 NFrozen due to charge problem
8 YNSI rejected transfer
9 NAwaiting auto verification of transfer request
10 YUnable to retrieve current domain contacts from UWhois
11 NAuto verification of transfer request initiated
12 NAwaiting for auto transfer string validation
13 NDomain awaiting transfer initiation
14 NDomain transfer initiated and awaiting approval
15 YCanceled - cannot obtain domain contacts from UWhois
16 YCanceled - domain contacts did not response to verification e-mails
17 YCanceled - domain contacts did not approve transfer of domain
18 NCanceled - domain validation string is invalid
19 NCanceled - Whois information provided does not match current registrant
20 NCanceled - Domain is currently not registered and cannot be transferred
21 NCanceled - Domain already registered in account & cannot be transferred
22 YCanceled - Domain is locked at current registrar
23 YCanceled - Transfer already initiated for this domain
24 YCanceled - Unable to transfer due to unknown error
25 YCanceled - Transfer rejected by losing registrar
26 YCanceled - Transfer authorization fax not received
27 YCanceled by customer
28 NFax received - awaiting registrant verification
29 NAwaiting manual fax verification
30 NCanceled - Domain name is invalid or is Invalid for Transfers
31 YCanceled - Domain is currently undergoing transfer by another Registrar
32 YCanceled - Invalid EPP/authorization key - Please contact current registrar to obtain correct key
33 NCanceled - Cannot transfer domain from name-only account
34 NUnable to complete transfer. Transfers must include a change in registrar.
35 NTransfer request not yet submitted
36 NCanceled - Account is not authorized to perform domain transfers
37 YCanceled - Domain was not retagged or not retagged in time by losing registrar
45 YOrder cancelled
description
Description of the status.
emailAddress (optional)
E-mail address to which FOA notification was sent
statusChangeDate (optional)
The date when status has changed
authInfo
The current authInfo value being used to start the transfer at the registry. The authInfo can be updated using the reset transfer call. For example if the transfer is blocking with a status of 32, the authInfo needs to be updated, or the losing registrar must set the authInfo to the present value.

Example of getting transfer status.

Request

GET /accounts/acct12345/domains/transfers/test.com
 

Response

200 OK
Content-Type: application/json; charset=UTF-8

{
   "status": {
      "status": 7,
      "emailAddress": "joshbond@usa.net",
      "description": "Auto verification of transfer request initiated",
      "statusChangeDate": "2014-03-25T11:15:11-05:00",
      "authInfo": "auth123$000",
      "canBeReset": false
   },
   "history": [{
      "status": 7,
      "emailAddress": "joshbond@usa.net",
      "description": "Auto verification of transfer request initiated",
      "statusChangeDate": "2014-03-25T11:15:11-05:00",
      "authInfo": "auth123$000",
      "canBeReset": false
   }]
}
 

See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox