Contact and balance check
Checking Registrar Balance
Requesting Registrar Balance
- The Balance Check is a custom extension to the standard Contact Info EPP command.
- The response will contain a figure that represents the current real-time balance of a registrar.
- If a balance amount is a negative number, it means that the registrar is currently in overdraft and should consider topping up their account.
- The currency of the number in the response is in ZAR (South African Rands).
- To successfully obtain the balance, the <cozacontact:balance> element must be used in the extension declaration, with an element value of “true”.
Possible Responses:
1000: Command Completed Successfully
A response code of 1000 means that the command has been successfully processed. The available balance may be viewed in the value of the <cozacontact:balance> element. Additional information related to the registrar acount will also be displayed as part of the Contact Info command.
2201: Requester Is Not Owner
A response code of 2201 means that the registrar ID provided does not match the ID of the requesting registrar. Please review the registrar ID element to ensure that the correct ID is specified.
Contact Info Including Linked Domains
Requesting Linked Domains
- Domain Listing is a custom extension to the standard Contact Info EPP command.
- The listing will provide up to a maximum of 100 domain names that are linked to the specified contact ID.
- The 100 domains are the most recent 100 domains associated with the contact.
- A domain listing cannot be obtained for contact objects taht do not belong to the requesting registrar.
- To successfully obtain the listing, the <cozacontact:domainListing> element must be used in the extension declaration, with an element value of “true”.
Possible Responses:
1000: Info Command Completed Successfully
A response code of 1000 means taht the server has processed the command. A listing of the most recent 100 domains linked to the contact will be displayed at the end of the request, in the extension section. The rest of the information for the contact will also be provided.
Cancel Pending Actions
Canceling a Pending Action
- A Cancel Pending Action command will cancel a pending event that is currently in progress.
- Succesfully cancelling a pending action will result in a poll message being queued for the registrar indicating that the pending action was cancelled.
- Once a pending action is cancelled the contact object will revert back to its initial state prior to the initiation of the update.
- To successfully execute the cancellation of a pending action, the <cozacontact:update cancelPendingAction=”pending action“> element must be used in the extension, and the pending action to be cancelled must be specified as the value for the “cancelPendingAction” attribute. A complete list of available pending actions is available further down.
Possible Responses:
1000: Contact Action Cancelled
A response code of 1000 means that the command was successfully processed and the pending update will be cancelled shortly. Please reference the Poll Message queue for the eventual successful result message.
2306: Event Not Found
A response code of 2306 means that the specified action to be cancelled is not currently pending on the contact. Please review the specified action in accordance to the available actions further below.
Available Pending Actions
Canceling a pending action requires the action name to be specified. The following contact pending actions can be canceled after being performed:
– PendingUpdate
