Submit Payment Batch

Synopsis

Description:A command to automatically notify us of a payment
URL:https://toolkit.centralnic.com/srv/submit_payment_batch
HTTP Method:POST
Requires Authentication?:Yes
Requires SSL?:Yes
 
Query Parameters:
testThe test flag (eg 1 or 0, optional)
userYour Registrar Handle ID
passwordYour encrypted Registrar password
methodThe payment method - either BA (for a bank transfer) or CH (for a cheque)
domains[]A list of domain names to put into the batch (multiple)

This command allows registrars to automatically advise us of payment for domain names. It is intended to allow registrars to minimise the amount of human work required to manage the payment of invoices for domains registered or renewed.

When combined with the list_outstanding_domains function, registrars can automatically manage unpaid invoices:

  1. use list_outstanding_domains to retrieve a list of outstanding domains
  2. filter the list for domains already in a payment batch, or based on the invoice date (eg to only pay off domains that have been outstanding for more than N days)
  3. reconcile this list with local information (ie whether you have received payment or a deletion request from your customer)
  4. delete any unwanted domains
  5. submit a payment batch for the domains you want to pay for
  6. notify your finance department to issue a cheque or submit a wire transfer

This function will refuse to create a batch that contains a domain name that is already in another batch (which you can check in the information provided by list_outstanding_domains), or which is under a Registry Lock.

Note: since it is possible for a domain to have multiple outstanding invoice items (for example because of multiple renewals), this function will add all these items to the batch.

Response Format

The response will be of the form

Status: 0
Message: Payment batch accepted, please remit payment immediately!
Batch: 12345
Items: 25
Currency: GBP
Amount: 1125.00
VAT: 196.88

The VAT field specifies the amount of VAT you need to add to the amount, therefore the Amount field does not include VAT. The VAT field will be zero for all registrars who are billed in US dollars, who are not in VAT-paying countries, or who have supplied us with a VAT number.

Please ensure that you quote the Batch field when you remit payment.

In the event of an error, the server will return something like this:

Transaction-ID: e2ca01ad7135e787a5e97ad5b421ed74
Status: 1
Message: No outstanding items found for 'example.uk.com'