Contents
Discover and retrieve service messages from the EPP Gateway.
1. Poll Message queue
The EPP <poll> command is used to discover and retrieve service messages queued by the EPP Gateway. Each response returned from the server will include a server-unique message identifier, which will be required for acknowledging the receipt of a message. A counter exists to indicate the number of messages in the queue. After a client has received a message, the client MUST respond to the message with an explicit acknowledgement to confirm that the message has been received to make the next message in the queue (if any) available for retrieval.
The <poll> command MUST be represented as an empty element with no child elements. An “op” attribute with value “req” is REQUIRED to retrieve the first message from the server message queue.
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <poll op="req"></poll> <clTRID>53cfdf1fa0d00</clTRID> </command> </epp> |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="112"> <qDate>2014-01-01T14:33:22+00:00</qDate> <msg>Transfer canceled</msg> </msgQ> <resData> <domain:trnData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.st</domain:name> <domain:trStatus>clientCancelled</domain:trStatus> <domain:reID>ClientX</domain:reID> <domain:reDate>2014-01-01T14:31:37+00:00</domain:reDate> <domain:acID>ClientY</domain:acID> <domain:acDate>2014-01-01T14:31:37+00:00</domain:acDate> <domain:exDate>2016-05-22T17:51:05+00:00</domain:exDate> </domain:trnData> <domain:panData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name paResult="1">example.st</domain:name> <domain:paTRID> <clTRID>TR_TR_DOMAIN</clTRID> <svTRID>f3f949be-1dba-45c7-9916-7e45c04de0a5</svTRID> </domain:paTRID> <domain:paDate>1406126002</domain:paDate> </domain:panData> </resData> <trID> <clTRID>53cfdf1fa0d00</clTRID> <svTRID>fdf8fc18-cf09-4b50-8ff3-6a57355e51b3</svTRID> </trID> </response> </epp> |
2. Acknowledge Message
After a client has received a message, the client MUST respond to the message with an explicit acknowledgement to confirm that the message has been received to make the next message in the queue (if any) available for retrieval.
The <poll> command MUST be represented as an empty element with no child elements. An “op” attribute (with value “ack”) and a “msgID” attribute (whose value corresponds to the value of the “id” attribute copied from the <msg> element in the message being acknowledged) are REQUIRED to acknowledge receipt of a message.
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <poll op="ack" msgID="112"></poll> <clTRID>53cff0bf35f86</clTRID> </command> </epp> |
1 2 3 4 5 6 7 8 9 10 11 12 13 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1000"> <msg>Command completed successfully</msg> </result> <msgQ count="5" id="112"></msgQ> <trID> <clTRID>53cff0bf35f86</clTRID> <svTRID>6103a146-ff8d-4d74-9b16-a9d4e0b4dc9c</svTRID> </trID> </response> </epp> |
3. Notification message types
There is totally 10 events which will generate message in a queue:
- Domain expired
- Domain entered redemption period
- Domain deleted
- Insufficient funds to complete operation
- Balance low
- Automatic invoice
- Unpaid invoice reminder
- Transfer request
- Transfer successful
- Transfer rejected
- Transfer canceled
- Transfer forbidden
3.1. Domain expired
This message is generated when domain gain status serverHold when it reach expire date.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-09-08T22:00:00.0Z</qDate> <msg>Domain expired</msg> </msgQ> <resData> <domain:panData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>domain.st</domain:name> <domain:crDate>2012-09-08T22:00:00.0Z</domain:crDate> <domain:exDate>2013-09-08T22:00:00.0Z</domain:exDate> </domain:panData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |
3.2. Domain entered redemption period
This message is generated when domain gain status redemptionPeriod which occurs 40 days after expire event occurred.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-10-08T22:00:00.0Z</qDate> <msg>Domain entered redemption period</msg> </msgQ> <resData> <domain:panData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>domain.st</domain:name> <domain:crDate>2012-09-08T22:00:00.0Z</domain:crDate> <domain:exDate>2013-09-08T22:00:00.0Z</domain:exDate> </domain:panData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |
3.3. Domain deleted
This message is generated when domain completely removed from ST Registry repository and became publicly available for registration.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-11-23T22:00:00.0Z</qDate> <msg>Domain deleted</msg> </msgQ> <resData> <domain:panData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>domain.st</domain:name> <domain:crDate>2012-09-08T22:00:00.0Z</domain:crDate> <domain:exDate>2013-09-08T22:00:00.0Z</domain:exDate> </domain:panData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |
3.4. Insufficient funds
Message “Insufficient funds to complete operation” is generated if any operation which generate billing transaction was not completed due to the billing exception (insufficient funds on registrar balance to complete operation).
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-11-23T22:00:00.0Z</qDate> <msg>Insufficient funds on registrar balance to complete operation</msg> </msgQ> <resData> <domain:panData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>domain.st</domain:name> <domain:paTRID> <clTRID>ABC-123450</clTRID> <svTRID>54321-XYZ</svTRID> </domain:paTRID> <domain:paDate>2013-09-08T22:00:00.0Z </domain:paDate> </domain:panData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |
3.5. Balance low
This warning message is generated by ST Registry if registrar balance is below defined limit. Balance limit is calculated on monthly basis and calculate total number of funds needed to renew domains within next 3 months + number of domains registered during past 3 months. Resulting balance limit should cover hypothetic possible operations during next 3 months. Balance is compared with limit on a daily basis and if its goes below defined limit – corresponding message is generated by ST Registry.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-09-08T22:00:00.0Z</qDate> <msg>Registrar balance low. <limit>200</limit><bal>158</bal></msg> </msgQ> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |
3.6. Automatic invoice
This message is generated when ST Registry create automatic invoice basing on current registrar balance and balance limit calculated in message “3.5 Balance low“.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="1" id="12345"> <qDate>2014-01-30T00:00:01+00:00</qDate> <msg>New invoice #ABC-20140130-000001-630</msg> </msgQ> <resData> <invoice:panData xmlns:invoice="urn:ietf:params:xml:ns:invoice-1.0"> <invoice:number>ABC-20140130-000001-630</invoice:number> <invoice:anount>500</invoice:anount> <invoice:currency>EUR</invoice:currency> <invoice:issueDate>2014-01-30T00:00:01+00:00</invoice:issueDate> <invoice:dueDate>2014-02-14T00:00:01+00:00</invoice:dueDate> </invoice:panData> </resData> <trID> <clTRID>ClientTransactionID</clTRID> <svTRID>c3ecf56f-c34a-4b4e-90a9-d05d9bc48479</svTRID> </trID> </response> </epp> |
3.7. Unpaid invoice reminder
This message is generated as a reminder for unpaid invoice(s).
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="1" id="23456"> <qDate>2014-02-15T12:00:01+00:00</qDate> <msg>Invoice past due!</msg> </msgQ> <resData> <invoice:panData xmlns:invoice="urn:ietf:params:xml:ns:invoice-1.0"> <invoice:number>#ABC-20140130-000001-630</invoice:number> <invoice:anount>500</invoice:anount> <invoice:currency>EUR</invoice:currency> <invoice:issueDate>2014-01-30T00:00:01+00:00</invoice:issueDate> <invoice:dueDate>2014-02-14T00:00:01+00:00</invoice:dueDate> </invoice:panData> </resData> <trID> <clTRID>ClientTransactionID</clTRID> <svTRID>958f2aba-b1b5-49db-a3e0-d9acee626e2c</svTRID> </trID> </response> </epp> |
3.8. Transfer request
This message is generated for the loosing ST Registrar when a transfer request is issued for any domain. Transfer status in this case gain “pending” value.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-09-08T22:00:00.0Z</qDate> <msg>Transfer requested.</msg> </msgQ> <resData> <domain:trnData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>domain.st</domain:name> <domain:trStatus>pending</domain:trStatus> <domain:reID>ClientX</domain:reID> <domain:reDate>2012-09-08T22:00:00.0Z</domain:reDate> <domain:acID>ClientY</domain:acID> <domain:acDate>2012-09-08T22:00:00.0Z</domain:acDate> <domain:crDate>2012-09-08T22:00:00.0Z</domain:crDate> <domain:exDate>2013-09-08T22:00:00.0Z</domain:exDate> </domain:trnData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |
3.9. Transfer successful
This message is generated for the gaining ST Registrar when a transfer request for a domain was accepted by loosing ST Registrar or if transfer request was automatically approved by ST Registry (in case of inactivity by loosing ST Registrar for 7 days).
“paResult” attribute gain a positive Boolean value which indicate that request has been approved and completed. Transfer status in this case gain “clientApproved” value.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-09-08T22:00:00.0Z</qDate> <msg>Transfer successful.</msg> </msgQ> <resData> <domain:trnData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>domain.st</domain:name> <domain:trStatus>clientApproved</domain:trStatus> <domain:reID>ClientX</domain:reID> <domain:reDate>2012-09-08T22:00:00.0Z</domain:reDate> <domain:acID>ClientY</domain:acID> <domain:acDate>2012-09-08T22:00:00.0Z</domain:acDate> <domain:crDate>2012-09-08T22:00:00.0Z</domain:crDate> <domain:exDate>2013-09-08T22:00:00.0Z</domain:exDate> </domain:trnData> <domain:panData> <domain:name paResult="1">domain.st</domain:name> <domain:paTRID> <clTRID>CLTRID-13025163365-EBGK</clTRID> <svTRID>DNS-EPP-12F440607EA-1C274</svTRID> </domain:paTRID> <domain:paDate>2011-04-15T12:36:50Z</domain:paDate> </domain:panData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |
3.10. Transfer rejected
This message is generated for gaining/requesting ST Registrar when a transfer request for a domain was rejected by loosing ST Registrar.
“paResult” attribute gain a negative Boolean value which indicate that request has been rejected. Transfer status in this case gain “clientRejected” value.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-09-08T22:00:00.0Z</qDate> <msg>Transfer rejected.</msg> </msgQ> <resData> <domain:trnData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>domain.st</domain:name> <domain:trStatus>clientRejected</domain:trStatus> <domain:reID>ClientX</domain:reID> <domain:reDate>2012-09-08T22:00:00.0Z</domain:reDate> <domain:acID>ClientY</domain:acID> <domain:acDate>2012-09-08T22:00:00.0Z</domain:acDate> <domain:crDate>2012-09-08T22:00:00.0Z</domain:crDate> <domain:exDate>2013-09-08T22:00:00.0Z</domain:exDate> </domain:trnData> <domain:panData> <domain:name paResult="0">domain.st</domain:name> <domain:paTRID> <clTRID>CLTRID-13025163365-EBGK</clTRID> <svTRID>DNS-EPP-12F440607EA-1C274</svTRID> </domain:paTRID> <domain:paDate>2011-04-15T12:36:50Z</domain:paDate> </domain:panData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |
3.11. Transfer cancelled
This message is generated for the loosing ST Registrar when a transfer request was initiated but cancelled by gaining/requesting ST Registrar before transfer was completed.
“paResult” attribute gain a negative Boolean value which indicate that request has been cancelled. Transfer status in this case gain “clientCancelled” valued.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-09-08T22:00:00.0Z</qDate> <msg>Transfer cancelled.</msg> </msgQ> <resData> <domain:trnData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>domain.st</domain:name> <domain:trStatus>clientCancelled</domain:trStatus> <domain:reID>ClientX</domain:reID> <domain:reDate>2012-09-08T22:00:00.0Z</domain:reDate> <domain:acID>ClientY</domain:acID> <domain:acDate>2012-09-08T22:00:00.0Z</domain:acDate> <domain:crDate>2012-09-08T22:00:00.0Z</domain:crDate> <domain:exDate>2013-09-08T22:00:00.0Z</domain:exDate> </domain:trnData> <domain:panData> <domain:name paResult="0">domain.st</domain:name> <domain:paTRID> <clTRID>CLTRID-13025163365-EBGK</clTRID> <svTRID>DNS-EPP-12F440607EA-1C274</svTRID> </domain:paTRID> <domain:paDate>2011-04-15T12:36:50Z</domain:paDate> </domain:panData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |
3.12. Transfer forbidden
This message is generated for the gaining/requesting ST Registrar when the registry reject a transfer request for a domain. This might occur when domain status forbid transfer operation.
“paResult” attribute gain a negative Boolean value which indicate that request has been rejected. Transfer status in this case gain “serverRejected” value.
Example of EPP Response for this message type:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-09-08T22:00:00.0Z</qDate> <msg>Transfer forbidden.</msg> </msgQ> <resData> <domain:trnData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>domain.st</domain:name> <domain:trStatus>serverCancelled</domain:trStatus> <domain:reID>ClientX</domain:reID> <domain:reDate>2012-09-08T22:00:00.0Z</domain:reDate> <domain:acID>ClientY</domain:acID> <domain:acDate>2012-09-08T22:00:00.0Z</domain:acDate> <domain:crDate>2012-09-08T22:00:00.0Z</domain:crDate> <domain:exDate>2013-09-08T22:00:00.0Z</domain:exDate> </domain:trnData> <domain:panData> <domain:name paResult="0">domain.st</domain:name> <domain:paTRID> <clTRID>CLTRID-13025163365-EBGK</clTRID> <svTRID>DNS-EPP-12F440607EA-1C274</svTRID> </domain:paTRID> <domain:paDate>2011-04-15T12:36:50Z</domain:paDate> </domain:panData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp> |