List Outstanding Domains
Synopsis
| Description: | A command to retrieve a list of all outstanding domain name payments |
| URL: | https://toolkit.centralnic.com/srv/list_outstanding_domains |
| HTTP Method: | POST |
| Requires Authentication?: | Yes |
| Requires SSL?: | Yes |
| Query Parameters: | |
| test | The test flag (eg 1 or 0, optional) |
| user | Your Registrar Handle ID |
| password | Your encrypted Registrar password |
Using this command, you can get a list of all the unpaid domain names on your account.
Response Format
The response will be of the form
Transaction-ID: e2ca01ad7135e787a5e97ad5b421ed74 Status: 0 Message: 4 outstanding items follow. example.uk.com: expiry=2007-06-21::type=Renewal::years=1::proforma=123456::date=2007-06-22::currency=GBP::amount=22.50 example.us.com: expiry=2007-06-28::type=Registration::years=2::proforma=123456::date=2007-06-29::currency=GBP::amount=45.00 example.eu.com: expiry=2007-06-14::type=Registration::years=2::proforma=123456::date=2007-06-15::currency=GBP::amount=45.00::batch=54321 example.cn.com: expiry=2007-04-30::type=Renewal::years=1::proforma=123456::date=2007-05-01::currency=GBP::amount=22.50::batch=54321
Each domain name is listed on its own line. The fields on the right hand side are:
- expiry: the current expiry date of the domain name
- type: the item type (one of Registration or Renewal)
- years: the number of years the item is for
- proforma: the pro forma number if applicable
- invoice: the invoice number if applicable
- date: the date of the pro forma or invoice - this date is the point from which the lifecycle is measured
- currency: the currency of the item (one of GBP or USD)
- amount: the amount of the item in the above currency
- batch: if the domain is already in a payment batch (either via the submit_payment_batch function or the console), then the ID of this payment batch will be shown.
If there are no outstanding domains for your account, the response will not be an error, but will look like this:
Transaction-ID: e2ca01ad7135e787a5e97ad5b421ed74 Status:0 Message: no outstanding items.