Direct Debit
API Technical Details
The API is REST based and communication is conducted over a regular HTTPS connection.
API key
The API key should also be specified in the request using the
apiKey header.
API input
It accepts input either in the x-www-form-urlencoded format or as a JSON object in the request body.
Output selection
The output is selected using the Accept header, including either application/json or
application/xml.
HTTP methods
Our API uses four different HTTP methods to indicate the different operations being undertaken on the data being manipulated. These are:
| Method | Operation |
|---|---|
GET | Request for information from the server. The server will respond with the data requested. |
POST | Request to create a record on the server. The POST request must be accompanied by the relevant data in the body or query string as dictated by the specification for that endpoint. |
PATCH | Request to amend (or partially amend) the record on the server. |
DELETE | A request to remove a record from the server (this is only available on selected calls). |
Example headers for JSON mode
GET https://ddcms.accesspaysuite.com/api/v3/client/LUISCT/BACS/customer/callback
Accept: application/json
apiKey: xAQdXTPtZPG3QqsUJw73wx1o
Content-Type: application/json