Direct Debit API

Control over website Direct Debit collections

iDirectDebit's Application Programme Interface (API) allows service users to integrate our sign up functionality into third party applications. Our API supports the creation of a customised Direct Debit sign up wizard and allows Direct Debit Instructions (DDIs) to be easily managed and maintained.

It provides you with control over branding, payer sign up, Direct Debit collections, edits, confirmation and reports. Your payers remain at your website while signing up. Discover more about the advantages of setting up online Direct Debits via your website

Better usability

The API is a HTTPS REST interface. REST (REpresentational State Transfer) uses HTTP GET, POST, PUT and DELETE actions along with the URL of the resource to act on. The API includes only GET and POST-based methods. It allows parameters for POST and PUT methods to be passed as query parameters, form parameters or as an xml body. All responses are xml documents.

Using a REST interface and XML documents means the API is client language agnostic. Examples are provided to interface with iDD from Ruby and PHP in the 'client examples' section.

The API also enables fixed, variable and adhoc DDIs to be created. Validate methods are provided for each type of DDI so that you can verify entered data.

Total security

All calls must be made from a valid IP address and include a username and password using HTTP basic authentication.

Responses to query methods will return an xml document with a root tag of <successful> or, if errors have occurred, a root tag of <errors>. Some general errors can be returned for any method such as unsuccessful authentication or authorisation errors.

Call 01276 856 464 or email for details.