API Guide –
(Application Programme Interface)
The guide allows Service Users to integrate the SmartDebit (iDD) direct debit sign up functionality into third party applications. Its designed to support the creation of a custom direct debit sign up wizard, management and maintenance.
It’s an HTTPS REST interface, REST (REpresentational State Transfer) uses HTTP Get, Post, Put and Delete actions along with the url of the resource to be acted upon. It allows passing of parameters for Post and Put methods as query parameters, form parameters, or as an xml body. All responses are xml documents.
Payer and Charge files
If partial integration is required, or if your systems already output BACS files then either forward files for testing, or review the format.
Request a copy of our guides via email providing your contact details and brief description of your project.
To set up an API test account please provide contact details, description of your project, fixed IP address and nature of the debiting (frequency type (monthly, quarterly etc), payment type (fixed amount fixed frequency, variable amount fixed frequency etc).
The use of a REST interface and XML documents means the API is client language agnostic. Examples are provided to interface with our systems.
The interface allows the creation of Fixed, Variable and Adhoc Direct Debit Instructions. To allow Service Users (clients) to verify correctness of entered data validate methods are also provided for each type of DDI (Direct debit Instruction).