Domain Transfer In

Server

Download schema

Initiate an inbound domain transfer

POST

https://api.sandbox.resellerclub.com/v2

/domains/{domainName}/transfer-in

Authorization (header)

+X-User-Id (header)

Transfers a domain name. Note You need to ensure that the domain name is not Locked.

Initiate an inbound domain transfer › path Parameters

domainName

string · required

Initiate an inbound domain transfer › Request Body

Transfers a domain name. Use the domain name as the path variable domainName; ensure the domain is not locked.

InitiateDomainTransferRequest

customerId

integer · int32 · required

The Customer for whom the Order should be added.

regContactId

integer · int32 · required

The Registrant Contact of the domain name. For .UK, the Registrant identity must not change during transfer.

adminContactId

integer · int32 · required

The Administrative Contact. Pass -1 for .EU, .RU, .UK (no admin contact).

techContactId

integer · int32 · required

The Technical Contact. Pass -1 for .EU, .RU, .UK.

billingContactId

integer · int32 · required

The Billing Contact. Pass -1 for .AT, .BERLIN, .CA, .EU, .NL, .NZ, .RU, .UK. field billing-contact-id.

invoiceOption

enum · minLength: 1 · required

Controls how the Customer Invoice will be handled.

Enum values:

NoInvoice

PayInvoice

KeepInvoice

OnlyAdd

autoRenew

boolean · required

Enables or disables the Auto Renewal setting for the domain name.

authCode

string

Authorization Code (Domain Secret) of the domain name to transfer. Optional for most TLDs; required at order placement for .AU, .CA, .DE, .EU, .NZ. May be submitted later via submit-auth-code when omitted.

purchasePrivacy

boolean

Adds the Privacy Protection service. Not supported for .ASIA, .AT, .AU, .CA, .CN, .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO, .DE, .ES, .EU, .HN, .IN, .NL, .NZ, .PRO, .RU, .SX, .TEL, .UK, .US.

protectPrivacy

boolean

Enables or disables the Privacy Protection setting for the domain name.

ns

string[]

Name Servers to associate with the domain name (maximum 13). Submitted as repeatable form field ns.

purchasePremiumDns

boolean

Purchase Premium DNS Service.

discountAmount

number · double

Optional discount amount applied to this transfer.

RegistrationAttribute[]

Optional TLD-specific extra details as name/value pairs for transfer-specific extensions.

Supported attribute keys

cedcontactid — .ASIA Charter Eligibility Declaration Contact ID (Admin, Technical, Billing, or Registrant contact ID).
type — Premium domain type — premium (registry premium) or premiumft (aftermarket premium).
premiumprice — Aftermarket premium price when type is premiumft (used as attr-value2 with type).
tnc — Terms and conditions acceptance — Y or y for .FR, .SCOT, .NZ (EEA contact), etc.
registrant-org-consent — Registrant organization consent for gTLDs with registrant organization value.
premium — Registry premium domain transfer — set to true for premium domains.

Initiate an inbound domain transfer › Responses

Returns the result of the domain operation, including action tracking metadata.

InitiateDomainTransferResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

DomainPrivacyDetailsDto

Privacy protection purchase details returned with domain mutation action envelopes.

POST/domains/{domainName}/transfer-in

curl https://api.sandbox.resellerclub.com/v2/domains/:domainName/transfer-in \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "authCode": "authCode",
  "customerId": 0,
  "regContactId": 0,
  "adminContactId": 0,
  "techContactId": 0,
  "billingContactId": 0,
  "invoiceOption": null,
  "purchasePrivacy": true,
  "protectPrivacy": true,
  "autoRenew": true,
  "ns": [
    "string"
  ],
  "purchasePremiumDns": true,
  "discountAmount": 0,
  "attributes": [
    {
      "name": "name",
      "value": "value"
    }
  ]
}'

Example Request Body

{
  "authCode": "authCode",
  "customerId": 0,
  "regContactId": 0,
  "adminContactId": 0,
  "techContactId": 0,
  "billingContactId": 0,
  "invoiceOption": null,
  "purchasePrivacy": true,
  "protectPrivacy": true,
  "autoRenew": true,
  "ns": [
    "string"
  ],
  "purchasePremiumDns": true,
  "discountAmount": 0,
  "attributes": [
    {
      "name": "name",
      "value": "value"
    }
  ]
}

json

Example Responses

{
  "actionStatus": "actionStatus",
  "actionStatusDesc": "actionStatusDesc",
  "actionTypeDesc": "actionTypeDesc",
  "entityId": "entityId",
  "eaqId": "eaqId",
  "actionType": "actionType",
  "currentAction": "currentAction",
  "description": "description",
  "status": "status",
  "message": "message",
  "privacyDetails": {
    "orderId": "orderId",
    "actionTypeDesc": "actionTypeDesc",
    "entityId": "entityId",
    "actionStatus": "actionStatus",
    "status": "status",
    "netCustomerCost": "netCustomerCost",
    "eaqId": "eaqId",
    "customerId": "customerId",
    "noOfDays": "noOfDays",
    "description": "description",
    "domainName": "domainName",
    "actionType": "actionType",
    "invoiceId": "invoiceId",
    "customerCost": "customerCost",
    "actionStatusDesc": "actionStatusDesc",
    "priority": "priority",
    "actionStarted": "actionStarted",
    "sellingCurrencySymbol": "sellingCurrencySymbol",
    "unutilisedSellingAmount": "unutilisedSellingAmount",
    "sellingAmount": "sellingAmount",
    "statusUpdateTime": "statusUpdateTime",
    "actionAdded": "actionAdded",
    "entityTypeId": "entityTypeId"
  }
}

json

application/json

List pending domain transfers

GET

https://api.sandbox.resellerclub.com/v2

/domain-transfers/pending

Authorization (header)

+X-User-Id (header)

Returns pending inbound domain transfers.

List pending domain transfers › query Parameters

size

integer · int32 · required

page

integer · int32 · required

customerId

integer · int32

Customer Id.

domainName

string

Domain Name.

orderId

integer · int32

Order Id.

resellerId

integer · int32

Reseller Id.

actionAddedRangeStart

string

Action Added Range Start.

actionAddedRangeEnd

string

Action Added Range End.

actionStatus

string

Action Status.

showChildOrders

boolean

Show Child Orders.

sort

string

Sort.

List pending domain transfers › Responses

Returns pending inbound domain transfers.

ListPendingTransfersResponse

PendingTransferDto[]

Pending inbound domain transfers matching the query.

totalItems

integer · int32

Total number of matching records in the database.

itemsOnPage

integer · int32

Number of records returned on this page.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

Submit authorization code for a transfer

POST

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/transfer-in/auth-code

Authorization (header)

+X-User-Id (header)

Submit the Domain Secret (also known as Authorization Code) for a domain name that is currently being transferred in to Demo Registrar.

Submit authorization code for a transfer › path Parameters

orderId

integer · int32 · required

Submit authorization code for a transfer › Request Body

Submit the Domain Secret (Authorization Code) for a domain transfer in progress. POST /domains/transfer/submit-auth-code. Order Id is supplied as the path variable orderId.

SubmitTransferAuthCodeRequest

authCode

string · minLength: 1 · required

Domain Secret or Authorization Code for the domain name being transferred.

Submit authorization code for a transfer › Responses

Returns the result of the domain operation, including action tracking metadata.

SubmitTransferAuthCodeResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

error

string

Error message when the operation failed.

success

boolean

Whether the boolean-style operation succeeded.

POST/domains/{orderId}/transfer-in/auth-code

curl https://api.sandbox.resellerclub.com/v2/domains/:orderId/transfer-in/auth-code \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "authCode": "authCode"
}'

Example Request Body

{
  "authCode": "authCode"
}

json

Example Responses

{
  "actionStatus": "actionStatus",
  "actionStatusDesc": "actionStatusDesc",
  "actionTypeDesc": "actionTypeDesc",
  "entityId": "entityId",
  "eaqId": "eaqId",
  "actionType": "actionType",
  "currentAction": "currentAction",
  "description": "description",
  "status": "status",
  "message": "message",
  "error": "error",
  "success": true
}

json

application/json

Validate whether a domain transfer request is valid

GET

https://api.sandbox.resellerclub.com/v2

/domains/{domainName}/validate-transfer-in

Authorization (header)

+X-User-Id (header)

Checks if a transfer request is valid for the specified domain name.

Validate whether a domain transfer request is valid › path Parameters

domainName

string · required

Validate whether a domain transfer request is valid › Responses

Returns domain availability for the requested names.

ValidateTransferRequestResponse

success

boolean

Whether the boolean-style operation succeeded.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

Domain Lifecycle Domain Transfer Out

Domains APIs

Domain Transfer In

Server

Download schema

Initiate an inbound domain transfer

POST

https://api.sandbox.resellerclub.com/v2

/domains/{domainName}/transfer-in

Authorization (header)

+X-User-Id (header)

Transfers a domain name. Note You need to ensure that the domain name is not Locked.

Initiate an inbound domain transfer › path Parameters

domainName

string · required

Initiate an inbound domain transfer › Request Body

Transfers a domain name. Use the domain name as the path variable domainName; ensure the domain is not locked.

InitiateDomainTransferRequest

customerId

integer · int32 · required

The Customer for whom the Order should be added.

regContactId

integer · int32 · required

The Registrant Contact of the domain name. For .UK, the Registrant identity must not change during transfer.

adminContactId

integer · int32 · required

The Administrative Contact. Pass -1 for .EU, .RU, .UK (no admin contact).

techContactId

integer · int32 · required

The Technical Contact. Pass -1 for .EU, .RU, .UK.

billingContactId

integer · int32 · required

The Billing Contact. Pass -1 for .AT, .BERLIN, .CA, .EU, .NL, .NZ, .RU, .UK. field billing-contact-id.

invoiceOption

enum · minLength: 1 · required

Controls how the Customer Invoice will be handled.

Enum values:

NoInvoice

PayInvoice

KeepInvoice

OnlyAdd

autoRenew

boolean · required

Enables or disables the Auto Renewal setting for the domain name.

authCode

string

purchasePrivacy

boolean

Adds the Privacy Protection service. Not supported for .ASIA, .AT, .AU, .CA, .CN, .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO, .DE, .ES, .EU, .HN, .IN, .NL, .NZ, .PRO, .RU, .SX, .TEL, .UK, .US.

protectPrivacy

boolean

Enables or disables the Privacy Protection setting for the domain name.

ns

string[]

Name Servers to associate with the domain name (maximum 13). Submitted as repeatable form field ns.

purchasePremiumDns

boolean

Purchase Premium DNS Service.

discountAmount

number · double

Optional discount amount applied to this transfer.

RegistrationAttribute[]

Optional TLD-specific extra details as name/value pairs for transfer-specific extensions.

Supported attribute keys

cedcontactid — .ASIA Charter Eligibility Declaration Contact ID (Admin, Technical, Billing, or Registrant contact ID).
type — Premium domain type — premium (registry premium) or premiumft (aftermarket premium).
premiumprice — Aftermarket premium price when type is premiumft (used as attr-value2 with type).
tnc — Terms and conditions acceptance — Y or y for .FR, .SCOT, .NZ (EEA contact), etc.
registrant-org-consent — Registrant organization consent for gTLDs with registrant organization value.
premium — Registry premium domain transfer — set to true for premium domains.

Initiate an inbound domain transfer › Responses

Returns the result of the domain operation, including action tracking metadata.

InitiateDomainTransferResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

DomainPrivacyDetailsDto

Privacy protection purchase details returned with domain mutation action envelopes.

POST/domains/{domainName}/transfer-in

curl https://api.sandbox.resellerclub.com/v2/domains/:domainName/transfer-in \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "authCode": "authCode",
  "customerId": 0,
  "regContactId": 0,
  "adminContactId": 0,
  "techContactId": 0,
  "billingContactId": 0,
  "invoiceOption": null,
  "purchasePrivacy": true,
  "protectPrivacy": true,
  "autoRenew": true,
  "ns": [
    "string"
  ],
  "purchasePremiumDns": true,
  "discountAmount": 0,
  "attributes": [
    {
      "name": "name",
      "value": "value"
    }
  ]
}'

Example Request Body

{
  "authCode": "authCode",
  "customerId": 0,
  "regContactId": 0,
  "adminContactId": 0,
  "techContactId": 0,
  "billingContactId": 0,
  "invoiceOption": null,
  "purchasePrivacy": true,
  "protectPrivacy": true,
  "autoRenew": true,
  "ns": [
    "string"
  ],
  "purchasePremiumDns": true,
  "discountAmount": 0,
  "attributes": [
    {
      "name": "name",
      "value": "value"
    }
  ]
}

json

Example Responses

{
  "actionStatus": "actionStatus",
  "actionStatusDesc": "actionStatusDesc",
  "actionTypeDesc": "actionTypeDesc",
  "entityId": "entityId",
  "eaqId": "eaqId",
  "actionType": "actionType",
  "currentAction": "currentAction",
  "description": "description",
  "status": "status",
  "message": "message",
  "privacyDetails": {
    "orderId": "orderId",
    "actionTypeDesc": "actionTypeDesc",
    "entityId": "entityId",
    "actionStatus": "actionStatus",
    "status": "status",
    "netCustomerCost": "netCustomerCost",
    "eaqId": "eaqId",
    "customerId": "customerId",
    "noOfDays": "noOfDays",
    "description": "description",
    "domainName": "domainName",
    "actionType": "actionType",
    "invoiceId": "invoiceId",
    "customerCost": "customerCost",
    "actionStatusDesc": "actionStatusDesc",
    "priority": "priority",
    "actionStarted": "actionStarted",
    "sellingCurrencySymbol": "sellingCurrencySymbol",
    "unutilisedSellingAmount": "unutilisedSellingAmount",
    "sellingAmount": "sellingAmount",
    "statusUpdateTime": "statusUpdateTime",
    "actionAdded": "actionAdded",
    "entityTypeId": "entityTypeId"
  }
}

json

application/json

List pending domain transfers

GET

https://api.sandbox.resellerclub.com/v2

/domain-transfers/pending

Authorization (header)

+X-User-Id (header)

Returns pending inbound domain transfers.

List pending domain transfers › query Parameters

size

integer · int32 · required

page

integer · int32 · required

customerId

integer · int32

Customer Id.

domainName

string

Domain Name.

orderId

integer · int32

Order Id.

resellerId

integer · int32

Reseller Id.

actionAddedRangeStart

string

Action Added Range Start.

actionAddedRangeEnd

string

Action Added Range End.

actionStatus

string

Action Status.

showChildOrders

boolean

Show Child Orders.

sort

string

Sort.

List pending domain transfers › Responses

Returns pending inbound domain transfers.

ListPendingTransfersResponse

PendingTransferDto[]

Pending inbound domain transfers matching the query.

totalItems

integer · int32

Total number of matching records in the database.

itemsOnPage

integer · int32

Number of records returned on this page.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

Submit authorization code for a transfer

POST

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/transfer-in/auth-code

Authorization (header)

+X-User-Id (header)

Submit the Domain Secret (also known as Authorization Code) for a domain name that is currently being transferred in to Demo Registrar.

Submit authorization code for a transfer › path Parameters

orderId

integer · int32 · required

Submit authorization code for a transfer › Request Body

Submit the Domain Secret (Authorization Code) for a domain transfer in progress. POST /domains/transfer/submit-auth-code. Order Id is supplied as the path variable orderId.

SubmitTransferAuthCodeRequest

authCode

string · minLength: 1 · required

Domain Secret or Authorization Code for the domain name being transferred.

Submit authorization code for a transfer › Responses

Returns the result of the domain operation, including action tracking metadata.

SubmitTransferAuthCodeResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

error

string

Error message when the operation failed.

success

boolean

Whether the boolean-style operation succeeded.

POST/domains/{orderId}/transfer-in/auth-code

curl https://api.sandbox.resellerclub.com/v2/domains/:orderId/transfer-in/auth-code \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "authCode": "authCode"
}'

Example Request Body

{
  "authCode": "authCode"
}

json

Example Responses

{
  "actionStatus": "actionStatus",
  "actionStatusDesc": "actionStatusDesc",
  "actionTypeDesc": "actionTypeDesc",
  "entityId": "entityId",
  "eaqId": "eaqId",
  "actionType": "actionType",
  "currentAction": "currentAction",
  "description": "description",
  "status": "status",
  "message": "message",
  "error": "error",
  "success": true
}

json

application/json

Validate whether a domain transfer request is valid

GET

https://api.sandbox.resellerclub.com/v2

/domains/{domainName}/validate-transfer-in

Authorization (header)

+X-User-Id (header)

Checks if a transfer request is valid for the specified domain name.

Validate whether a domain transfer request is valid › path Parameters

domainName

string · required

Validate whether a domain transfer request is valid › Responses

Returns domain availability for the requested names.

ValidateTransferRequestResponse

success

boolean

Whether the boolean-style operation succeeded.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

Domain Lifecycle Domain Transfer Out