{"info":{"_postman_id":"2b5bd0bc-0697-48b1-b166-9ba85793a555","name":"SmartDebit API Programmer's Guide","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"6207449","collectionId":"2b5bd0bc-0697-48b1-b166-9ba85793a555","publishedId":"S1TPcgzt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-03-11T08:24:32.000Z"},"item":[{"name":"1 Introduction","item":[{"name":" 1.1 About this document","item":[],"id":"3a5f145d-55ac-4f06-b015-d8f8ec60bac7","description":"

This online document provides a full and detailed description of the SmartDebit API®, its capabilities and how it can be used. The SmartDebit API® provides direct access to the core of the SmartDebit Direct Debit processing systems, giving seamless integration with greater control.

SmartDebit is part of Access Paysuite, the UK’s leading Direct Debit service provider. SmartDebit combines superior customer service, enterprise security and compliance, with a suite of powerful tools to automate payment collections while reducing customer churn and improving financial reporting.

The API is just one element of our advanced systems for the collection of recurring payments. SmartDebit customers can also utilise:

SmartDebit Pulse® - A powerful and comprehensive Direct Debit collection portal offering full Direct Debit management and reporting
\n
SmartDebit Online® - A hosted or custom-branded webpage to sign up customers on your own website
\n
SmartDebit SFTP® - Quick and simple data exchange, either manual or automated to suit your requirements
\n
SmartDebit Direct® - Simple-to-use, secure and powerful Direct Debit and Direct Credit Bacs file submission solution.
\n

This document helps you to get started, gives tips and advice on how to use the calls and what the responses mean. The reference section includes call syntax, code snippets and sample responses. You can change the client language to suit your requirements.

\n","event":[{"listen":"prerequest","script":{"id":"18efce3e-8aa3-441f-b8b1-b356eb1bc73c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1f99ba4f-291c-4a7a-8574-3f4ed64cce14","type":"text/javascript","exec":[""]}}],"_postman_id":"3a5f145d-55ac-4f06-b015-d8f8ec60bac7"},{"name":"1.2 About Direct Debits","item":[],"id":"f1ed3971-75ea-4278-9595-c1c5e824b4a1","description":"

Direct Debit is the simplest way for organisations to collect regular or occasional payments from their customers, donors (if the organisation is a charity), or members (if the organisation is a club or association).

A Direct Debit is an instruction from a customer to their bank or building society authorising an organisation, or service user, to collect varying amounts from their account, as long as the customer has been given advance notice of the collection amounts and dates.

This instruction is known as a Direct Debit Instruction or DDI. The customer is referred to simply as a payer. The terms DDI and payer are largely synonymous in the context of the API.

The instruction must be sent to the payer's bank before any funds can be collected. This process is referred to as lodgement. Because the payer must be given advance notice and because time must be allowed for lodgement, payments cannot be collected immediately when a new payer gives their authority (or signs up).

SmartDebit can issue advance notice (and other notifications) by email on behalf of the service user.

SmartDebit submits payment instructions, as well as new payers and cancellations, to the paying banks electronically via a secure connection to Bacs, the organisation that administers the Direct Debit scheme.

A customer may cancel their instruction at any time. They may transfer it to a different bank account. They have the right to claim back payments that were taken in error.

SmartDebit receives notifications from the paying banks in the form of Bacs reports, such as:

instructions that fail to lodge (AUDDIS)
amendments and cancellations (ADDACS)
payments that could not be collected (ARUDD)
indemnity claims (DDICA)

SmartDebit makes these notifications available through the API and also applies any changes to its records.

\n","event":[{"listen":"prerequest","script":{"id":"13aae07b-bbdd-4970-8d8e-679af97790fb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"69972930-3cf1-4b59-9c3d-ad899997b3f6","type":"text/javascript","exec":[""]}}],"_postman_id":"f1ed3971-75ea-4278-9595-c1c5e824b4a1"},{"name":"1.3 About the API","item":[],"id":"8b4401cd-a04b-4ea5-940a-ddfbebeba6a4","description":"

The SmartDebit API® is a web-based API that allows authorised partners to integrate the SmartDebit Direct Debit sign-up and management functionality into their own applications. The main purpose is to extend CRM systems to support Direct Debit payments, but any system can benefit from use of this API. \nUsing the API isn’t always necessary though. We have created simpler options. If you just need to sign up payers, you can use SmartDebit Online® instead, as this will display branded web-pages that we host to remove the sign-up from your own systems completely.

What does it do?

The API can be used to manage all aspects of the Direct Debit process, or you can use it to deal with some aspects and control others manually with SmartDebit Pulse®. You can upload payers you’ve signed up, manage their payments, check statuses and download responses from Bacs. In fact, you can do nearly everything you can do with SmartDebit Pulse®, other than manage system user settings and passwords.

How does it work?

The API is an HTTPS interface, authenticated with basic HTTP authentication. Connections attempted that don't use HTTPS (i.e. that use basic HTTP) are rejected. The freedom and flexibility inherent in the API design allow you to build an application that meets all your needs. We encourage partners to provide specific IP addresses we can whitelist for added security. The SmartDebit API includes GET, PUT and POST methods. The API allows passing of parameters for POST and PUT methods as query parameters, form parameters, or as an XML body. All responses are XML documents.

SmartDebit API allows:

collections of any value to be collected as and when required (the \"adhoc\" model), or
recurring collections to be generated and collected on a schedule (the \"variable\" model), and
payment schedules to be altered, overridden and also extended with one-off collections.\n

\n\n

The best model for your business will be discussed with your SmartDebit sales representative. Each model has its own advantages and the choice of model will depend mainly on the type of business the service user operates.

\n","event":[{"listen":"prerequest","script":{"id":"37042608-4cec-4fc1-b025-629071f6168d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4547702a-e2ba-4435-8898-ad321f014168","type":"text/javascript","exec":[""]}}],"_postman_id":"8b4401cd-a04b-4ea5-940a-ddfbebeba6a4"},{"name":"1.4 Versioning","item":[],"id":"ee198f43-267f-4e45-abe0-608df541b318","description":"

API versioning allows for the roll-out of functional enhancements and interface changes without breaking existing client implementations. The latest API version is given by the system_status call. Clients can upgrade independently by changing the base URL in their API calls.

API versioning is introduced in document version 2.0, API version 1.1. Changes prior to document version 2.0 are unversioned.

For example, these two versions of get_successful_collection_report present indemnity-claimed collections differently:

https://secure.ddprocessing.co.uk/api/v1.1/get_successful_collection_report

https://secure.ddprocessing.co.uk/api/get_successful_collection_report

Note:

All calls accept a version number in the URL.
You cannot use a URL which includes .../api/v1.0/...
Some system changes may be impossible to restrict to a new API version.
Backward-compatible changes may be introduced, unversioned, at any point (e.g. new optional parameters or new calls). They will be accompanied by a new document version.

This document includes change histories for both the API and the document itself.

\n","event":[{"listen":"prerequest","script":{"id":"33e19bb5-bff2-4e83-9982-a00a4f87fd2a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"42233a18-65db-4b88-b9b0-8255df961fab","type":"text/javascript","exec":[""]}}],"_postman_id":"ee198f43-267f-4e45-abe0-608df541b318"},{"name":"1.5 Authentication and authorisation","item":[],"id":"250ca8fe-d1bb-464d-9e12-c7bc8aad169b","description":"

SmartDebit issues API users with a username, password and also a PSLID value. The PSLID value is the service user designation. Different credentials are normally used for the sandbox and live environments. Where connectivity to multiple service users is required, multiple sets of credentials are usually issued.

Only API users can use the API – other types of SmartDebit user are not authorised. API users have restricted use of the Pulse portal, whereas other users have full use of the portal.

API users can change their password via the Pulse portal (live or sandbox as appropriate).

IP whitelisting can be applied and, particularly for the live environment, is encouraged. \nAll calls must include a username and password using HTTP basic authentication.

Authentication failures present as a \"401 Unauthorized\" HTTP status. For further details, see system_status.

\n","event":[{"listen":"prerequest","script":{"id":"c3772f99-d9d5-4838-8d66-9d81866ea4f5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f53269d0-7146-4e65-87be-b3fb6cd2bd70","type":"text/javascript","exec":[""]}}],"_postman_id":"250ca8fe-d1bb-464d-9e12-c7bc8aad169b"}],"id":"3eccade2-50c2-4090-ab83-5f40de12f02a","event":[{"listen":"prerequest","script":{"id":"10956eaa-dde5-4c85-917e-81a7dc0350db","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4cdc5785-3b11-40b6-a5d6-574684e224fa","type":"text/javascript","exec":[""]}}],"_postman_id":"3eccade2-50c2-4090-ab83-5f40de12f02a","description":""},{"name":"2 Concepts and features","item":[],"id":"e61b1ac9-6b42-4188-a2db-3c74bba7018c","description":"

Parameterised URLs

API calls for specific resources have the identifier of the resource embedded in the URL. For example the PUT call ddi/variable/{{reference_number}} is used to update a payer, where {{reference_number}} must be replaced with the reference number of the DDI to be updated, e.g. PUT ddi/variable/ABC123456.

Extended parameters

A number of methods in the SmartDebit API allow repeating parameters. These parameters can be set using query or form parameters, indeed HTML forms support repeating parameters, however it is recommended that an XML body is used for extended parameters.

The following code sample demonstrates how to create a set of debits for an Adhoc DDI using form parameters.

form_data = []\nform_data << \"adhoc_ddi[service_user][pslid]=su_pslid\" \nform_data << \"adhoc_ddi[first_name]=John\"\nform_data << \"adhoc_ddi[start_date]=2019-05-23\" \n...\nform_data << \"adhoc_ddi[debits][debit][][amount]=500\" \nform_data << \"adhoc_ddi[debits][debit][][date]=2019-05-23\" \n\nform_data << \"adhoc_ddi[debits][debit][][amount]=1500\" \nform_data << \"adhoc_ddi[debits][debit][][date]=2019-06-01\" \n\nform_data << \"adhoc_ddi[debits][debit][][amount]=1500\" \nform_data << \"adhoc_ddi[debits][debit][][date]=2019-07-01\" \n\nreq.body = form_data.join(\"&\")\n

The pairs of adhoc_ddi[debits][debit][][amount] and adhoc_ddi[debits][debit][][date] parameters specify the debits to be created. As the names of these parameters are identical, the ordering matters.

Note:

Amounts are given in pence.
The syntax: adhoc_ddi[debits][debit][][amount] (including empty square brackets) is mandatory.

\n\n

Using an XML body clarifies the nesting being emulated by the form parameter names. The nesting of the <debits> and <debit> tags removes any ambiguity of which amounts and dates belong together. For example:

XML_body = \"\"\nXML_body << \"<?XML version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n\"\nXML_body << \"<adhoc_ddi>\\n\"\nXML_body << \"<service_user><pslid> su_pslid </pslid></service_user>\\n\"  \nXML_body << \"<first_name> John </first_name>\\n\"\nXML_body << \"<start_date> 2019-05-23 </start_date>\\n\" \n...\nXML_body << \"<debits>\\n\"   \n\nXML_body << \"  <debit>\\n\"  \nXML_body << \"    <amount> 500 </amount><date> 2019-05-23 </date>\"  \nXML_body << \"  </debit>\\n\"\n\nXML_body << \"  <debit>\\n\"   \nXML_body << \"    <amount> 1500 </amount><date> 2019-06-01 </date>\\n\"  \nXML_body << \"  </debit>\\n\"\n\nXML_body << \"  <debit>\\n\"\nXML_body << \"    <amount> 1500 </amount><date> 2019-07-01 </date>\\n\"\nXML_body << \"  </debit>\\n\"\n\nXML_body << \"</debits>\\n\"  \nXML_body << \"</adhoc_ddi>\" \nreq.body = XML_body \n

Conditional parameters

As the requirements of service users differ, there are numerous configuration options, some of which affect the use of the SmartDebit API. The most significant is the processing model; others affect the parameters required to call API methods. Any such parameters are explicitly stated, with the circumstances of their use listed.

Valid characters

The SmartDebit API supports a restricted character set. All fields relating to payer details are subject to these character restrictions and also length restrictions as detailed. Further restrictions apply to reference numbers.

Processing models

SmartDebit offers two processing models and it is important that the correct one is chosen because it cannot subsequently be changed and because the calls used to manage payers are different. The variable model supports automated payment schedules, whereas the adhoc model requires every collection to be created or imported by the client application. Significantly, if SmartDebit is sending advance notice emails to payers, then it sends an email in advance of every collection under the adhoc model but only sends one if the collection amount is different from the previous collection amount under the variable model.

Where regular payments are made, each of the same amount, the variable model is likely to be appropriate.
Where regular payments are made, of varying amounts, the variable model is likely to be appropriate, though without automated scheduling.
Where irregular payments are made, either model can be used.
Where collection schedules are controlled entirely by the client application, either model can be used.

\n\n\n

Collection schedules

The variable model supports collection schedules. There are two aspects to this feature.

Where payer notifications are issued by the SmartDebit system, the initial confirmation includes the payer's collection schedule. Unless the schedule is altered, no further emails are issued.
\n
The schedule can be defined at the point of payer creation. No further action is required.
\n

Refer to section 3.3 for further details.

Lead times

You cannot collect from a new payer immediately. You must allow time for the DDI to be sent to and set up (“lodged”) by the payer’s bank. This time is referred to as the payer lead time. The collection lead time is the greater of the time allowed for collections to be sent to the payer’s bank and the service user's advance notice period (as stipulated by their sponsoring bank). Collection details must be provided to SmartDebit by the end of the day prior to submission and cannot be altered after that time.

Lead times may be calculated on a calendar or working day basis.

Example: A service user has a payer lead time of five working days. If there are no date restrictions placed on the service user and the service user does not specify a start date, the DDI is sent to Bacs on the working day after creation of the payer and the service user may collect five working days after that. If the service user wishes to specify a start date for the payer, they cannot set a date earlier than five working days after submission.

Example: In a normal week with no bank holidays a service user with a collection lead time of three working days can import collections up to the end of Sunday for collection on the following Thursday. Collections due on a Saturday, Sunday or Monday must be imported by the end of the previous Tuesday.

Further examples are given here.

Email notifications

The SmartDebit system can be configured to send Bacs-compliant notifications to payers. The following email types can be activated:

initial confirmation
amendment
advance notice
re-present advance notice
cancellation
reinstatement

The API does not expose endpoints to send emails. Instead, actions performed on a payer (either through the API or in the Pulse web portal) trigger an email.

\n","event":[{"listen":"prerequest","script":{"id":"6511290f-a15c-4bdc-8782-273857f16bb6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0da422c4-05c7-4609-8e9d-e3f3426ab362","type":"text/javascript","exec":[""]}}],"_postman_id":"e61b1ac9-6b42-4188-a2db-3c74bba7018c"},{"name":"3 How to use the API","item":[{"name":"3.1 Getting started","item":[],"id":"293d002b-9384-4530-90db-36aecbc4ca9b","description":"

Start with the system_status call. Either

https://sandbox.ddprocessing.co.uk/api/system_status for a test account, or
https://secure.ddprocessing.co.uk/api/system_status for a live account on the production environment.

You can make this call from your code, from a REST client or simply directly from your browser. This verifies your credentials and your associated service user(s). These values are likely to be constants within your application.

Contact support@smartdebit.com if you encounter any error responses at this stage.

Develop against the latest API version. The base URL is likely to be a constant within your application.

Decide which processing model suits your business. Service user configuration affects how the API behaves, so it is important that your sandbox environment is an accurate representation from the outset. Consult with your SmartDebit representative. It is useful to be clear about:

your advance notice period (as stipulated by your sponsoring bank)
whether you require regular collections to be generated by the SmartDebit system
whether you are restricting collections to specific days of the month
how email notifications are to be issued

If you intend to construct public-facing sign-up pages, read the sign-up screens section. Either the variable or adhoc versions of the validate and create calls will be used behind these pages. Allow for the pages to be reviewed by your sponsoring bank.

\n","event":[{"listen":"prerequest","script":{"id":"b8be0f68-1913-41bd-9a19-379c46c63bd9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e621c74f-bc0c-487e-85ca-86394a290e02","type":"text/javascript","exec":[""]}}],"_postman_id":"293d002b-9384-4530-90db-36aecbc4ca9b"},{"name":"3.2 Building your application","item":[],"id":"d7d56cec-89dc-4fb8-96ec-c1f7cd17281c","description":"

During development

If you experience any difficulty in making a call through your application code, consider using an external REST API testing tool to build your call before integrating it into your application.

Use SmartDebit Pulse® to confirm the outcomes of your API calls. If there are issues with parameter values, viewing a screen in SmartDebit Pulse® may reveal them quicker than eyeballing a parameter list.

If you cannot determine why a call has failed and you require further assistance, contact SmartDebit with details of the call and the response.

Explore how the API - and your application - handles data that is obviously wrong, such as strings that exceed their maximum length, collection dates in the past or missing parameters.

Designing your application

Consider how your application should behave if it does not receive a response.

Be aware that some calls such as a file upload or a data dump call can take several minutes. Code your application to handle long response times, especially if you plan to handle large volumes of data. Avoid making repeated calls with the same parameters.

Some calls can fail, or at least generate errors, yet still return an HTTP status of 200. The XML response should always be parsed.

This document does not provide sufficient detail for comprehensive automated error handling. Nevertheless, a robust, lightweight application can be developed with little effort by concentrating on the success cases and ensuring that errors are reported to a user. Over time the application can be refined as necessary to increase automation.

In production

There can be teething problems when switching from the sandbox to the live environment. Be prepared for them and monitor your application closely to begin with. SmartDebit support teams are on hand and most issues can be ironed out quickly without any business impact.

Collection reports are issued by email on the day of submission. Contact SmartDebit immediately if this report is not as expected.

Example: Failure to import a collection file

Provided the problem is identified at the time of the failure, SmartDebit can quickly diagnose and provide advice on manual intervention. The file can be imported manually with no business impact.
If the problem is not discovered until the due date, the business disruption could be considerable.

Example: Sign-up screens

A problem here means a loss of business. Don't rely on users reporting problems.

Risks

Service user configurations can differ between environments.
Unexpected scenarios or data can arise which were not considered during testing.
Sample Bacs reports provided for the sandbox environment cannot be expected to cover all scenarios.
The relatively long time period inherent in the Bacs cycle - several days between performing an action and achieving a result - makes real-time testing cumbersome.

\n","event":[{"listen":"prerequest","script":{"id":"1155b411-0579-4d1f-b478-c9f0342de1d6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7508ca27-e8ce-4c34-808c-cc85ef3ea360","type":"text/javascript","exec":[""]}}],"_postman_id":"d7d56cec-89dc-4fb8-96ec-c1f7cd17281c"},{"name":"3.3 Creating, updating and listing payers","item":[{"name":"3.3.1 Collection schedules","item":[],"id":"00289dbb-14a9-44e3-bd86-0e7ea4bdd4cd","description":"

The variable model supports collection schedules, whereby the collections are generated by SmartDebit. A payer's collection schedule can be specified when the payer is created and can be changed by updating the payer.

Collection schedules are based on a frequency of collection defined as W (weekly), M (monthly), Q (quarterly) or Y (yearly). Service users with their own SUN are able to specify a frequency_factor between 1 and 4 inclusive. E.g. To collect once every two months, specify a frequency_factor of 2 and a frequency of M (monthly).

The following parameters can be used to control the collection schedule:

start date\n
frequency type (typically M, monthly)\n
frequency factor (optional, with certain restrictions)\n
regular amount\n
first amount (optional)\n
end date (optional)\n

\n\n

A change may cause an amendment notification to be issued to the payer, giving them notice of the new schedule.

Scheduled payments can be stopped or paused by setting the regular amount to zero or by setting an end date. Note that if a collection is due on the end date then it will take place. This does not cancel the payer.

The end date can be used effectively to control seasonal memberships or payments spread over, say, 10 months. Just before the beginning of each season you can move the end date by one year and the collection schedule will start again. You may or may not need to move the start date as well.

Example: For 10 monthly payments, set the end date to (start date + 9 months). The first amount, if specified, will be collected on the start date.

Tip: If you change the start date, you may collect the first amount again.

Tip: Avoid setting a first amount of zero. Do not specify a first amount unless it is specifically required.

A collection schedule can be interrupted by creating overriding collections. Refer to \"Creating and updating collections\".

SmartDebit supports collections on any day. Collections with a due date that falls on a non-working day take place on the next working day. Where a regular collection is due on a date that does not exist, the collection will take place on the 1st of the following month.

Example: A payer with frequency type Y (yearly) and a start date of 29 February 2016 will pay on 1 March in non-leap years.

Tip: For simplicity, avoid regular collections on 29th - 31st of the month if possible.

\n","event":[{"listen":"prerequest","script":{"id":"3280aff0-fc81-40b4-87b1-e0f079411c0f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ee910c24-9887-4af8-bcac-d385fbd4bfe5","type":"text/javascript","exec":[""]}}],"_postman_id":"00289dbb-14a9-44e3-bd86-0e7ea4bdd4cd"},{"name":"3.3.2 Creating payers","item":[],"id":"bd107dc8-c659-408f-96f1-1695a61cac38","description":"

There are two ways to create payers:

ddi/variable/validate followed by ddi/variable/create (or ddi/adhoc/validate followed by ddi/adhoc/create as appropriate)
importing a payer file

If you are developing online sign-up screens then the first method is better suited.

If creating payers individually, always make the validate call before making the create call. Only proceed with the create if the response from the validate indicates that Direct Debits can be collected from the account.

If so configured, an email notification is issued to the payer upon creation.

Reference number

Bacs-compliant references can be generated by the client system or by SmartDebit. Where the API is being used to build online sign-up pages, the reference number must be generated by the client system so that it can be displayed on screen before the payer has been created.

Refer to the reference number rules. A simple reference numbering scheme of the format ABC12345 is effective. Excessive padding such as 000000011 is best avoided. Spaces within the reference number are best avoided.

Customer ID

A second reference may be specified, often referred to as \"Customer ID\". Typical use would be to link to another system such as a CRM.

Customer ID can be specified in the validate/create/update calls as \"payer_reference\". In a payer file it can be specified at creation as \"reference number\" but only if the Bacs reference is generated by SmartDebit.

Customer ID, which is not part of the DDI, is not subject to the same rules as the reference number. In most cases the field name is payer-reference or payer_reference (and payerReference in the data/dump response) but the collection reports present it as customer_id.

Start date

Consider how you wish to use this parameter. It serves a number of purposes. It can be specified by the client or calculated by SmartDebit.

It approximates to the date of lodgement for a new payer. Hence it represents the earliest possible collection date for a new payer.
It plays a part in the generation of regular collections for a variable payer. See Collection schedules.
If a first amount is specified for a variable payer, then this amount, rather than the regular amount, is collected on the payer’s start date.
Because of the above, you can change a payer’s start date. Note that changing the start date of an adhoc payer serves no purpose.
It can be used to control submission costs. Restrictions can be applied to a service user to allow only certain collection dates, which controls when new payers are submitted.
Example: A service user wishes to reduce submission costs and simplify Direct Debit processing (at the expense of convenience for its payers and also the time to first collection) by allowing collections on only one day every month.
Solution: The service user is configured to collect only on the first day of the month. The service user need not specify a start date; SmartDebit will calculate the earliest possible date, which will always be the 1st. New payers will all be submitted on the same day of the month (typically around the 21st), regardless of when they were created, and all collections will be submitted on the same day (typically around the 27th). Note that other submissions resulting from cancellations and account changes may take place at any time.

Bank details

The test service user accounts only accept a sort code of 000000. For a success response, choose any non-zero account number.

\n\n\n

Note: The API does not support the migration of existing payers. Contact SmartDebit support for assistance.

\n","event":[{"listen":"prerequest","script":{"id":"24661ec1-3683-4ea3-bde9-a82fb42b6153","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"adb1bc75-5204-4347-952e-790e9a21d2cc","type":"text/javascript","exec":[""]}}],"_postman_id":"bd107dc8-c659-408f-96f1-1695a61cac38"},{"name":"3.3.3 Updating payers","item":[],"id":"b9b47f99-fe39-435d-8a3f-531c2f413d06","description":"

Updates to payers can be performed in two ways:

the relevant update call (ddi/variable/{{reference_number}} or ddi/adhoc/{{reference_number}})
importing a payer file

Reference numbers cannot be changed. The update calls allow any other attribute to be changed, though restrictions may apply. Payer files cannot update bank details or frequency types. Sort code and account number are optional when using payer files to update payers; best practice is to omit them because if they do not match then the update will be rejected.

The update may result in an email notification being issued to the payer.

\n","event":[{"listen":"prerequest","script":{"id":"cb7309a3-84ac-4f23-8d91-c606e0dc51f3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cc2e0d61-15cf-4fbb-8897-4abbf76d383c","type":"text/javascript","exec":[""]}}],"_postman_id":"b9b47f99-fe39-435d-8a3f-531c2f413d06"},{"name":"3.3.4 Cancelling payers","item":[],"id":"dd916b51-a4b1-4b78-a977-5b29fa4135cf","description":"

Payers can be cancelled in two ways:

the relevant cancel call (ddi/variable/{{reference_number}}/cancel or ddi/adhoc/{{reference_number}}/cancel)
importing a payer file with the value \"3\" in the final column

Cancellation may result in an email notification being issued to the payer. The cancellation will be submitted to Bacs, usually the following day.

\n","event":[{"listen":"prerequest","script":{"id":"6aa93780-e5dc-42c3-b2c7-81e2044806af","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a5e12680-e922-4328-890d-5bcae336c148","type":"text/javascript","exec":[""]}}],"_postman_id":"dd916b51-a4b1-4b78-a977-5b29fa4135cf"},{"name":"3.3.5 Reinstating payers","item":[],"id":"482ab614-6d84-48cf-8515-c5daf24a3537","description":"

Payers can be reinstated in two ways:

the relevant reinstate call (ddi/variable/{{reference_number}}/reinstate or ddi/adhoc/{{reference_number}}/reinstate)
importing a payer file with the value \"0\" in the final column

The first method is usually preferable as the scope of the call is restricted to reinstatement and no additional fields are required.

A service user may wish to reinstate a DDI in order to resume collections under the existing reference. If it is not necessary to use the same reference, it may be simpler to create a new DDI for the payer rather than reinstating.

If the payer has cancelled the DDI, the service user must obtain new authorisation from the payer before reinstating.

A DDI cancelled by reason codes 0 or K cannot be reinstated.

If the DDI has been cancelled by SmartDebit in response to an AUDDIS advice, the DDI can be reactivated once valid bank details have been obtained from the payer. Ensure that the update follows immediately after the reinstate.

Reinstatement may result in an email notification being issued to the payer. The reinstatement will be submitted to Bacs, usually the following day. The DDI cannot be collected on until 4 working days after the reinstatement is submitted.

\n","event":[{"listen":"prerequest","script":{"id":"5512dd9f-a3dd-44c4-973a-951b5bd7475d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"89e906f7-8d6d-4115-8fcf-cdf34de4f0c9","type":"text/javascript","exec":[""]}}],"_postman_id":"482ab614-6d84-48cf-8515-c5daf24a3537"},{"name":"3.3.6 Listing payer information","item":[],"id":"e2b8a0c8-eb18-4ab4-977a-12b11e8ce3a6","description":"

There are two ways to retrieve payer details:

data/dump, either for a specified payer or for all payers
the appropriate update call, but without updating anything (e.g. variable/{{reference_number}}?variable[dummy]=null)

data/dump can be used to retrieve a listing of all payers but it can be slow to respond if you have a large number of payers, so use it with care. It can be used with a reference number parameter to return the details of a single payer.

There are some differences between the format and type of information brought back by data/dump and update, which can be seen in the table below. Note that the data is only present in the returned XML if it is populated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	data/dump	update
Title	✅	✅
First name	✅	✅
Last name	✅	✅
Address 1	✅	✅
Address 2	✅	✅
Address 3	✅	✅
Town	✅	✅
County	✅	✅
Post code	✅	✅
Country	❌	✅
Frequency type	✅	✅
Frequency factor	✅	✅
Regular/default amount	✅	✅
First amount	✅	✅
Reference number	✅	✅
Payer reference	✅	✅
Start date	✅	✅
End date	❌	✅
Email address	✅	✅
Support gift aid	✅	✅
Promotion	❌	✅
Company name	❌	✅
Current state	✅	❌
Date/time of cancellation	❌	✅
List of collections	❌	✅
In addition the following details may be provided when a single payer dump is requested, subject to service user configuration.
Account name	✅	❌
Account number	✅	❌
Sort code	✅	❌

\n\n

A payer's audit history can be retrieved with the data/auditlog call.

\n","event":[{"listen":"prerequest","script":{"id":"4b13037a-46a8-4909-b99a-73fe1c2ecb08","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"68ca1791-f742-40a3-8fad-092a68386a48","type":"text/javascript","exec":[""]}}],"_postman_id":"e2b8a0c8-eb18-4ab4-977a-12b11e8ce3a6"}],"id":"1b2343bd-e19a-4d5a-8fce-1ba5866dd358","description":"","event":[{"listen":"prerequest","script":{"id":"8cc7dd27-6898-42f9-93cd-0acf75b16b2e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"383dfda8-c4e1-4242-8083-ca8f99743f99","type":"text/javascript","exec":[""]}}],"_postman_id":"1b2343bd-e19a-4d5a-8fce-1ba5866dd358"},{"name":"3.4 Creating and updating collections","item":[],"id":"5b338616-059a-46ec-a4bd-59cc7edae35a","description":"

Methods

Scheduling payments for variable payers is described above.
The create and update calls (both variable and adhoc) can be used with extended parameters to create collections or to change the amounts of existing collections.
Collection files can be imported.
Some failed collections can be re-presented, as described below.
The Pulse web portal offers similar functionality.

Time constraints

Collections can be created or updated from the moment the payer is created up until the day prior to submission. Submission takes place a few days before the due date (the exact interval is configurable for the service user - the \"collection lead time\" - and is usually determined by the service user's advance notice period, as stipulated by their sponsoring bank). Allow for this lead time and for the submission day when creating collections.

Example: For a service user with a 3 working-day lead time, a collection due on a Monday must be in the SmartDebit system by the end of the previous Tuesday on a normal working week.

Restrictions

Collections cannot be due before the payer's start date or after their end date (if one has been specified). These restrictions may be lifted in a future release. Otherwise there is no limit to how far in the future a collection may be due.

Restrictions on due dates can be applied and are configurable, specifically:

they can be restricted to certain days of the month
they can be restricted to the payer's scheduled dates only

Collections cannot be for an amount greater than a maximum configured for the service user.

SmartDebit supports only one collection per payer per day (except for re-presents). Importing multiple collections due on the same day for the same payer will cause subsequent collection imports to overwrite previous ones.

The API does not have a method to add to an existing collection.

Collections cannot be deleted. They can, though, be changed so the amount is zero.

Payment schedules

If a collection is added that coincides with the payer's schedule then it overrides the schedule: it is collected instead of, not as well as, the regular payment. An overriding collection with an amount of zero suppresses the regular payment.

Collection references

If you use collection files to import collections then you can specify a unique identifier for each collection. Note that the full reference (core reference plus hyphen plus collection reference) must be a maximum of 18 characters. If the collection fails then the ARUDD advice contains this full reference, making it easier to match the failed payment in the client system.

Example: Mr Smith has an account with a local business and pays by Direct Debit. His account number, SMIT05, is also the reference number of his DDI. Invoice number INV6789, for £123.45 is due on 1 September. This could be denoted by the following collection file entry:

,SMIT05,123.45,2019/09/01,,SMIT05-INV6789,\n

This would then would be reported by the following reconciliation report entry:

    <Success account_name=\"Mr Smith\" customer_id=\"\" amount=\"123.45\" transaction_ref=\"SMIT05-INV6789\" reference_number=\"SMIT05\" debit_date=\"01/09/2019 00:00\"/>\n

Failures

Common reasons why collection(s) fail to be created:

Not allowing enough time for submission (i.e. too late)
The payer is in a cancelled state
The date of the debit does not conform to the configured allowable dates for the service user
You cannot create a debit that is due before the payer's start date (or after the payer's end date).

\n","event":[{"listen":"prerequest","script":{"id":"c3782909-5d96-4d09-b6d7-f94466c9e82a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"432d8ca2-4710-44fa-a231-e5e69d2da589","type":"text/javascript","exec":[""]}}],"_postman_id":"5b338616-059a-46ec-a4bd-59cc7edae35a"},{"name":"3.5 Reconciling payments","item":[],"id":"db95498a-da4c-4a3f-b426-611299eac96f","description":"\n\n

On the day of submission, SmartDebit notifies the service user by email, supplying a list of collections being submitted. get_collection_report provides a similar list, however it may also include some collections that are not submitted. This report:

is available prior to the collection date
lists what will be or has been submitted for collection
does not include collections generated by the system (i.e. variable payers with regular amounts) until the day of submission
may include rejections, though these may not be apparent until after the day of submission (e.g. where a transaction was rejected by Bacs, before reaching the payer’s bank)
may also list some collections that have not been submitted

In general, where a payer cancels before submission, the collection is not reported. This behaviour may change.

Submission does not guarantee payment. Failed collections are reported as ARUDD advices in the days following the due date. ARUDD advices originate from the paying banks and are made available by the API and in the Pulse web portal. For further guidance on handling ARUDDs, see below.

Alternatively, get_successful_collection_report lists collections for a given date together with their status. This report:

is effectively the collection report which has had ARUDD notifications applied to it
is available from the third working day after the collection date
includes (as failed) some collections that were not submitted or failed to reach the paying bank
does not (currently) provide the reason for a failed payment but that information is provided by the ARUDD

The three-day delay allows for ARUDD advices. In rare, exceptional cases (occasionally around Christmas or Easter or with an obscure paying bank) an ARUDD may be received late, even after three working days. get_successful_collection_report gives an up-to-date result so you may wish to consider calling it again, say a week later.

Rather than work out when the reconciliation report will be available, you could simply ask for it every day after the collection date until it is available. You’ll get an error response if you are too early.

Whilst this report gives a fairly definitive list of successful collections, it does not give a complete list of failures because collections are not reported if the payer cancelled prior to submission (or if the import into SmartDebit failed).

\n","event":[{"listen":"prerequest","script":{"id":"3d7bc6d1-acd8-454a-9915-1b9b484e7131","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fa7511ec-8aba-4b0e-bcbf-c6a52b5a2572","type":"text/javascript","exec":[""]}}],"_postman_id":"db95498a-da4c-4a3f-b426-611299eac96f"},{"name":"3.6 Handling Bacs reports","item":[{"name":"3.6.1 AUDDIS advices","item":[],"id":"494b728c-29e8-415e-bf0d-8a79f645923e","description":"

There are two principal AUDDIS transactions:

a \"0N\" transaction, which is an instruction to the payer's bank to set up or \"lodge\" a DDI
a \"0C\" transaction, which is an instruction to the payer's bank to cancel a DDI

When a payer changes their bank account the DDI is simply cancelled at one bank and lodged at the other.

An AUDDIS advice is a notification from Bacs or from a bank that an AUDDIS transaction has failed or has been amended. Appropriate handling depends firstly on the service user's business processes, secondly on the type of transaction that caused the advice to be issued and thirdly on the reason code. Some general principles apply:

advices arising from cancellations can be ignored
advices from the old bank can be ignored
advices where new account details are provided are handled by SmartDebit and can be ignored (unless you need to update your record of the account details)
otherwise, AUDDIS advices generally indicate that a DDI is uncollectible

The auddis/{{id}} response does not currently include the transaction type so it can be difficult to follow these principles but looking to see whether the DDI is still live may help. The DDI may have been cancelled by SmartDebit to prevent any submissions against a DDI that is known to be invalid. If this is the case, valid bank details will be required from the payer. The DDI can be reinstated and then updated, or a new DDI can be set up with a different reference number (depending on what has been agreed with the payer).

\n","event":[{"listen":"prerequest","script":{"id":"7b7ff90c-f9eb-4a2c-bb23-3f68fcd7866b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"87f877ee-43a0-44f3-8e0a-1d1e60265ecd","type":"text/javascript","exec":[""]}}],"_postman_id":"494b728c-29e8-415e-bf0d-8a79f645923e"},{"name":"3.6.2 ADDACS advices","item":[],"id":"3bf549dc-98cb-4b94-b56c-0c837e68afe7","description":"

An ADDACS advice is a notification from a bank of an amendment to or cancellation of a DDI. Such advices may be received at any time.

Appropriate handling depends firstly on the service user's business processes and secondly on the reason code. Some general principles apply:

advices from another bank can be ignored
advices where new account details are provided are handled by SmartDebit and can be ignored (unless you need to update your record of the account details)

SmartDebit updates its record of the DDI, marking it as cancelled where appropriate.

\n","event":[{"listen":"prerequest","script":{"id":"693fed01-f1ec-48b7-9058-de87c8897f11","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"53110870-4998-4c6c-bb21-bf2ad538f7a0","type":"text/javascript","exec":[""]}}],"_postman_id":"3bf549dc-98cb-4b94-b56c-0c837e68afe7"},{"name":"3.6.3 ARUDD advices","item":[],"id":"52a32c1d-df44-4c1e-ae60-45d9e8094058","description":"

An ARUDD advice is a notification from a bank of a failed collection. The advice gives the reason for the failure.

The majority of ARUDD advices are received the working day after the collection takes place (which may itself be the working day after the due date if the due date falls on a non-working day). Some may be received a day later. In rare, exceptional cases (occasionally around Christmas or Easter or with an obscure paying bank) an ARUDD may be received late, even after three working days.

Advices can be matched to collections by the \"ref\", \"valueOf\" and \"originalProcessingDate\" values. If unique collection references are used then these are returned as the \"ref\", otherwise the reference number of the DDI is given. The \"valueOf\" matches the collection amount exactly and the \"originalProcessingDate\" should be the working day before the collection's due date. Occasionally the \"originalProcessingDate\" might be later than expected.

Occasionally SmartDebit receives ARUDD advices where, due to bank error, the \"ref\" value does not match a DDI. SmartDebit performs routine data integrity checks to catch such anomalies.

The two most common reasons for a failed collection are:

the payer has insufficient funds, or
the payer has cancelled the DDI

A complete list of failure reasons is given below and more information can be found here.

\n","event":[{"listen":"prerequest","script":{"id":"a103dc5e-7dfa-4a93-b816-35e375586699","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6d91e829-c2a7-473b-bc87-a936c23ec51e","type":"text/javascript","exec":[""]}}],"_postman_id":"52a32c1d-df44-4c1e-ae60-45d9e8094058"},{"name":"3.6.4 DDICA advices","item":[],"id":"0afc58a1-08d9-4ea5-88e9-53250cb90c03","description":"

A DDICA advice is a notification from a bank that a payer is claiming back one or more collections that have previously been paid.

The claimed funds are returned automatically three weeks after the advice is issued.

A DDICA may be cancelled before the funds are returned. DDICA cancellations are made available in the Pulse web portal but not by the API.

\n","event":[{"listen":"prerequest","script":{"id":"818938a5-1b7d-4883-8ed2-86adeda2703a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6116cceb-9bf7-4a30-9043-05de3032b2c8","type":"text/javascript","exec":[""]}}],"_postman_id":"0afc58a1-08d9-4ea5-88e9-53250cb90c03"}],"id":"d43dbd15-0e03-4120-b93e-d62ab74d78ec","description":"

Bacs reports are issued by Bacs to notify service users of changes or errors with their payers. They advise of failed and claimed collections, cancellations and amendments. They work on the exception principle: successful transactions and unchanged DDIs are not reported.

Bacs reports contain one or more advices.

The API supports only the Direct Debit report types. Should you also require Direct Credit reports, SmartDebit can supply all report types by SFTP.

The SmartDebit system retrieves reports, making them available to API clients. The following changes are applied to payers:

bank details may be updated
payers may be cancelled in response to cancellation notifications
payers may be cancelled where a DDI failed to lodge and is therefore uncollectible
payers may be reinstated

Sandbox environment: Test service users do not receive reports as they are isolated from Bacs but Bacs reports can be simulated. Contact support@smartdebit.com with your requirements once you have a suitable set of payers and collections.

Broadly, one of three approaches may be taken to Bacs reports:

Leave the SmartDebit system to handle them

in most cases this is not the most suitable approach

Manage them manually, via the Pulse web portal

if you have a small number of payers and/or collect infrequently
if you intend to integrate quickly and develop your application as the business develops

Automate the download and processing

the approach most suited to API users, your exact requirements will depend on your business

Automated processing:\nThe recommended method is to check daily (though SmartDebit processes new reports only on business days) and to query by ID rather than by date. The report ID values are different for each report type and are not contiguous but always increase. Note that when more than one report is returned, they are listed in reverse order. Therefore, for each report type:

keep a record of the last report ID
add one to the last report ID and use this as the \"query[id_from]\" value
retrieve and process all the reports returned by the list call
retain the maximum ID value of the retrieved reports for use next time

This method ensures that all new reports are processed once only. Querying by date can be unreliable.

Further detail of the different types is given below.

\n","event":[{"listen":"prerequest","script":{"id":"34d57e32-e82a-49b3-881a-472d13ad11fe","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d602e594-82ee-4f99-b36a-de01421da5ab","type":"text/javascript","exec":[""]}}],"_postman_id":"d43dbd15-0e03-4120-b93e-d62ab74d78ec"},{"name":"3.7 Re-presenting failed collections","item":[],"id":"48a6cabb-7bea-4d97-8989-c2e21906ddbd","description":"

Failed collections can, under some circumstances, be re-presented.

You can only re-present collections that failed with reason code 0 (\"refer to payer\").
The re-present must be within one calendar month of the original failed collection.
The API only allows a single re-presentation.

You can identify failed collections either by the rejects node of the reconciliation report or directly from the ARUDDs. The reconciliation report gives you the reference number, debit date and amount of the failed debit that you need for the re-present call but does not provide the failure reason. The ARUDD gives reference number, amount and the failure reason but does not give the debit date, which can be awkward to find because a debit scheduled for Saturday, Sunday and Monday all have the same ARUDD original processing date. Assuming you process your ARUDDs on the day they are issued, you could try with yesterday's date and if that fails, try again with the previous day, up to a maximum of six attempts to accommodate Easter and Christmas and late ARUDDs.

SmartDebit allows a re-presentation to take place on the same day as a normal collection. This helps to keep submission costs down.

A specific advance notice email may be issued to the payer.

\n","event":[{"listen":"prerequest","script":{"id":"cacca151-f457-4185-9e40-e1a347ea5dc1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4d6a7420-897a-4c2c-a4fa-2b0ccfcbd602","type":"text/javascript","exec":[""]}}],"_postman_id":"48a6cabb-7bea-4d97-8989-c2e21906ddbd"}],"id":"e373ec84-e3d1-4f95-8618-2b2711eeccef","event":[{"listen":"prerequest","script":{"id":"e6be6c24-3454-4447-8fbf-eb06e5ff3fa2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bc88bf1c-eab6-485e-8fcb-310e392bc8ca","type":"text/javascript","exec":[""]}}],"_postman_id":"e373ec84-e3d1-4f95-8618-2b2711eeccef","description":""},{"name":"4 API call reference","item":[{"name":"4.1 System status","item":[{"name":"system_status","event":[{"listen":"test","script":{"id":"e4b284a4-afcb-4b93-b93e-09972521b132","exec":["let api_user = pm.environment.get(\"api_user\");","let api_login_line = \"\" + api_user +\"\";","","pm.test(\"Body contains User Name\", function () {"," pm.expect(pm.response.text()).to.include(\"1.1\");"," pm.expect(pm.response.text()).to.include(api_login_line);"," var jsonObject = xml2Json(responseBody);"," if(jsonObject.assigned_service_users !== undefined && jsonObject.assigned_service_users.length === 1)"," {return true;}"," else{"," return 'no service user has been assigned to this api user';"," }","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","","pm.environment.set(\"new_api_system_status\", pm.response.text());","","","pm.globals.set('object_comparer',\"function CompareObject(a,b,iteration){ if(iteration === undefined || iteration === null) {iteration = 0;} console.log(iteration+'. iteration'); var aKeys = Object.keys(a); for(var key in aKeys) { var theKey = aKeys[key]; console.log(aKeys[key]); console.log(theKey); console.log(a[theKey]); console.log(typeof(a[theKey])); if(typeof(a[theKey]) === 'object') { var innerResult = CompareObject(a[theKey],b[theKey], iteration + 1); if (!innerResult) {return false;} } else{ if(a[theKey] !== b[theKey]) { console.log('Value in CompareObject does not match! Property name: '+theKey+ ' values: a: '+a[theKey] + ' b: ' +b[theKey]); return false; } } } return true;}\");"],"type":"text/javascript"}}],"id":"00d989b0-dc35-4a14-89a2-8db6d0c5bdf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/system_status","description":"","urlObject":{"path":["system_status"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"eeabc44a-3695-49be-b5e0-37b9ce31343a","name":"GET system_status","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/system_status"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 12 Feb 2019 09:44:05 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Runtime","value":"0.03424"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Sun, 10 Feb 2019 12:32:10 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"visid_incap_1416256=4h7evyKJTXSSsaQGR66ZrXVk9VsAAAAAQUIPAAAAAACBaPf/JRsV9YGl7yOZH4ea; expires=Tue, 11 Feb 2020 12:34:45 GMT; path=/; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_368_1416256=T8syeFh8EGdHAdXkmmYbBX2VYlwAAAAArzUpwTPxQZ8WWDABQUwucw==; path=/; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"___utmvboNuBZVNB=a; Max-Age=0; path=/; expires=Sun, 10 Feb 2019 12:32:10 GMT"},{"key":"Set-Cookie","value":"___utmvmoNuBZVNB=a; Max-Age=0; path=/; expires=Sun, 10 Feb 2019 12:32:10 GMT"},{"key":"Content-Length","value":"285"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"7-4609959-4609970 SNNN RT(1549964669619 3341) q(0 0 0 -1) r(1 1) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 1.1\n \n documentationapi\n \n \n apidocument\n \n \n \n"}],"_postman_id":"00d989b0-dc35-4a14-89a2-8db6d0c5bdf6"}],"id":"7e74d88c-7f36-43d8-9229-deb16e50bf2a","description":"

The system_status call allows an API user to query the latest version of the API and to obtain a listing of which service users are assigned to them. The call is a simple way to verify credentials.

The call requires no parameters. All versions of the call return the same response.

Response

A successful call to system_status returns an XML document containing:

the latest available API version
the user's login name
a list of pslid values corresponding to the service users accessible to the user

Errors

Invalid credentials:

\n\n

401 Unauthorized\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Could not authenticate you</error>\n</errors>\n

User is not an API user:

\n\n

401 Unauthorized\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Permission denied. You cannot access the requested resource.</error>\n</errors>\n

Access denied due to IP restriction:

\n\n

401 Unauthorized\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Attempted access from unknown IP address 'xxx.xxx.xxx.xxx'</error>\n</errors>\n

\n\n

If the user is not assigned to any service users the <assigned_service_users> node is empty. If this is the case then no other functionality is available.

Contact support@smartdebit.com if you encounter any of these responses.

The above authorisation errors are common to all endpoints.

\n","event":[{"listen":"prerequest","script":{"id":"a262742b-eb8a-43aa-8a60-7069d5806099","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"052c55bb-eed4-4d7a-81ee-dd6c36236af8","type":"text/javascript","exec":[""]}}],"_postman_id":"7e74d88c-7f36-43d8-9229-deb16e50bf2a"},{"name":"4.2 Payer actions","item":[{"name":"4.2.1 Variable validate","item":[{"name":"ddi/variable/validate","event":[{"listen":"test","script":{"id":"7479e859-00c9-415f-a498-91eacef639b1","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 800ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(800);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","var jsonObject = xml2Json(responseBody);","console.log(JSON.stringify(jsonObject));","","","var schema = sd.api.schema.validateResponse;","","console.log(schema);","pm.test('Schema is valid', function() {"," pm.expect(tv4.validate(jsonObject, schema)).to.be.true;","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"07c7f8ac-60eb-4064-889c-b57e0966a1c4","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","","var dataGen = sd.testing;","","var startDate = new Date();","startDate.setHours(0,0,0,0);","startDate = startDate.addMonths(2);","","var endDate = new Date();","endDate.setHours(0,0,0,0);","endDate = endDate.addMonths(6);","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false, false, true);","","console.log(payer);","","pm.environment.set('validate_reference_number','API-Test-0123'); //should not exist","pm.environment.set('validate_adhoc_title', payer.title);","pm.environment.set('validate_first_name', payer.first_name);","pm.environment.set('validate_last_name', payer.last_name);","pm.environment.set('validate_adhoc_company_name', 'Acme Co.');","pm.environment.set('validate_address1', payer.address_1);","pm.environment.set('validate_adhoc_address2', payer.address_2);","pm.environment.set('validate_adhoc_address3', payer.address_3);","pm.environment.set('validate_town', payer.town);","pm.environment.set('validate_adhoc_county', payer.county);","pm.environment.set('validate_postcode', payer.postcode);","pm.environment.set('validate_country', payer.country);","pm.environment.set('validate_frequency_type', 'M');","pm.environment.set('validate_default_amount', '1000');","pm.environment.set('validate_first_amount', '2000');","","pm.environment.set('validate_adhoc_email_address', payer.email);","","pm.environment.set('validate_adhoc_start_date', dataGen.getISODate(startDate));","pm.environment.set('validate_adhoc_end_date', dataGen.getISODate(endDate));","pm.environment.set('validate_sort_code', '000000');","pm.environment.set('validate_account_number', '12345678');","pm.environment.set('validate_adhoc_promotion', 'PROMO');","","pm.environment.set('validate_adhoc_payer_reference', payer.account_number);","pm.environment.set('validate_account_name', payer.account_name);","","","console.log(dataGen.getISODate(startDate));","console.log(dataGen.getISODate(endDate));","","","","","","","",""],"type":"text/javascript"}}],"id":"232815a9-a9f8-4889-856a-12cdc5c83cb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

Required
\nService user identifier

\n","key":"variable_ddi[service_user][pslid]","type":"text","value":"{{pslid}}"},{"description":"

Conditional (usually required)
\nUnique identifier for the DDI
\nFormat: 6 to 18 characters. See reference number rules.

\n","key":"variable_ddi[reference_number]","type":"text","value":"{{validate_reference_number}}"},{"description":"

Required
\nFormat: single character only (W, M, Q, Y)

\n","key":"variable_ddi[frequency_type]","type":"text","value":"{{validate_frequency_type}}"},{"description":"

Required
\nFormat: either 111111 or 11-11-11

\n","key":"variable_ddi[sort_code]","type":"text","value":"{{validate_sort_code}}"},{"description":"

Required
\nFormat: 8 digit number

\n","key":"variable_ddi[account_number]","type":"text","value":"{{validate_account_number}}"},{"description":"

Required
\nFormat: 3 to 18 characters

\n","key":"variable_ddi[account_name]","type":"text","value":"{{validate_account_name}}"},{"description":"

Required
\nFormat: 1 to 32 characters

\n","key":"variable_ddi[first_name]","type":"text","value":"{{validate_first_name}}"},{"description":"

Required
\nFormat: 1 to 32 characters

\n","key":"variable_ddi[last_name]","type":"text","value":"{{validate_last_name}}"},{"key":"variable_ddi[start_date]","value":"{{validate_start_date}}","description":"

Format: YYYY-MM-DD
Default: next valid start date

\n","type":"text"},{"description":"

If used, specifies the date after which no further collections will be made
Format: YYYY-MM-DD
Default: none

\n","key":"variable_ddi[end_date]","type":"text","value":"{{validate_end_date}}"},{"description":"

Format: integer, the value of the regular collection amount in pence

\n","key":"variable_ddi[default_amount]","type":"text","value":"{{validate_default_amount}}"},{"description":"

If provided, this value is used on the start date only, in place of the default amount
Format: integer, the value of the first collection amount in pence

\n","key":"variable_ddi[first_amount]","type":"text","value":"{{validate_first_amount}}"},{"key":"variable_ddi[frequency_factor]","value":"{{validate_frequency_factor}}","description":"

Frequency factors 2, 3 and 4 cannot be used with frequency type Y
Format: integer, 1 to 4
Default: 1

\n","type":"text"},{"description":"

Format: 1 to 32 characters

\n","key":"variable_ddi[title]","type":"text","value":"{{validate_title}}"},{"description":"

Format: 5 to 64 characters

\n","key":"variable_ddi[email_address]","type":"text","value":"{{validate_email_address}}"},{"description":"

Format: 1 to 32 characters

\n","key":"variable_ddi[company_name]","type":"text","value":"{{validate_company_name}}"},{"description":"

Format: 1 to 255 characters

\n","key":"variable_ddi[payer_reference]","type":"text","value":"{{validate_payer_reference}}"},{"description":"

Format: 1 to 255 characters

\n","key":"variable_ddi[address_1]","type":"text","value":"{{validate_address1}}"},{"description":"

Format: 1 to 32 characters

\n","key":"variable_ddi[address_2]","type":"text","value":"{{validate_address2}}"},{"description":"

Format: 1 to 32 characters

\n","key":"variable_ddi[address_3]","type":"text","value":"{{validate_address3}}"},{"description":"

Format: 1 to 255 characters

\n","key":"variable_ddi[town]","type":"text","value":"{{validate_town}}"},{"description":"

Format: 1 to 255 characters

\n","key":"variable_ddi[county]","type":"text","value":"{{validate_county}}"},{"description":"

Format: 1 to 255 characters

\n","key":"variable_ddi[postcode]","type":"text","value":"{{validate_postcode}}"},{"description":"

Format: 1 to 255 characters

\n","key":"variable_ddi[country]","type":"text","value":"{{validate_country}}"},{"key":"variable_ddi[support_gift_aid]","value":"{{validate_support_gift_aid}}","description":"

Format: boolean, accepts 'true', 'false', 1 or 0
Default: false

\n","type":"text"},{"description":"

Format: 1 to 8 characters

\n","key":" variable_ddi[promotion]","type":"text","value":"{{validate_promotion}}"}]},"url":"{{base_url}}/ddi/variable/validate","urlObject":{"path":["ddi","variable","validate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9146cf5a-6d91-4b6f-a620-d3215d5b6965","name":"validate","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Format: Sort Code – either 111111 or 11-11-11 format accepted.","key":"variable_ddi[sort_code]","type":"text","value":"{{validate_sort_code}}"},{"description":"Format: 8 digit number ","key":"variable_ddi[account_number]","type":"text","value":"{{validate_account_number}}"},{"description":"A unique reference number must be passed.
Format: plain text Restrictions: Unique, 6 to 18 characters May not contain solidus (/) and further restrictions apply.","key":"variable_ddi[reference_number]","type":"text","value":"{{validate_reference_number}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[first_name]","type":"text","value":"{{validate_first_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[last_name]","type":"text","value":"{{validate_last_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[address_1]","type":"text","value":"{{validate_address1}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[town]","type":"text","value":"{{validate_town}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[postcode]","type":"text","value":"{{validate_postcode}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[country]","type":"text","value":"{{validate_country}}"},{"description":"Format: 8 digit number.
Typical sort code and account numbers to use from a test account are 000000 for the sort code and 12345678 for the account number. ","key":"variable_ddi[account_name]","type":"text","value":"{{validate_account_name}}"},{"description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid ","key":"variable_ddi[service_user][pslid]","type":"text","value":"{{pslid}}"},{"description":"Format: Single Character – (W, M, Q, Y) Restrictions: Must be a frequency type configured on the SU ","key":"variable_ddi[frequency_type]","type":"text","value":"{{validate_frequency_type}}"},{"description":"Format: Integer, the value of the default amount in pence.
Restrictions: value between 0 and the SU's maximum_debit_amount ","key":"variable_ddi[default_amount]","type":"text","value":"{{validate_default_amount}}"},{"description":"Format: Integer, the value of the first amount in pence.
Restrictions: value between 0 and the SU‟s maximum_debit_amount ","key":"Variable_ddi[first_amount]","type":"text","value":"{{validate_first_amount}}"},{"description":"Format: plain text
Restrictions: 0 to 18 characters
Default: none ","key":"variable_ddi[payer_reference]","type":"text","value":"{{validate_adhoc_payer_reference}}"},{"description":"Format: YYYY-MM-DD
Restrictions: Must be far enough in the future to allow the SU's lead time.","key":"variable_ddi[start_date]","type":"text","value":"{{validate_adhoc_start_date}}"},{"description":"Format: YYYY-MM-DD
Restrictions: Must be after the start time, not required to fall on a debit day.
Default: none","key":"variable_ddi[end_date]","type":"text","value":"{{validate_adhoc_end_date}}"},{"description":"Format: plain text
Restrictions: 0 to 255 characters
Default: none ","key":"variable_ddi[title]","type":"text","value":"{{validate_adhoc_title}}"},{"description":"Format: plain text
Restrictions: 0 to 255 characters
Default: none ","key":"variable_ddi[address_2]","type":"text","value":"{{validate_adhoc_address2}}"},{"description":"Format: plain text
Restrictions: 0 to 255 characters
Default: none ","key":"variable_ddi[address_3]","type":"text","value":"{{validate_adhoc_address3}}"},{"description":"Format: plain text
Restrictions: 0 to 255 characters
Default: none ","key":"variable_ddi[county]","type":"text","value":"{{validate_adhoc_county}}"},{"description":"Format: must be a valid email format
Restrictions: 0 to 64 characters
Default: none ","key":"variable_ddi[email_address]","type":"text","value":"{{validate_adhoc_email_address}}"},{"description":"Format: plain text
Restrictions: 0 to 8 characters
Default: none ","key":"variable_ddi[promotion]","type":"text","value":"{{validate_adhoc_promotion}}"},{"description":"Format: plain text
Restrictions: 0 to 32 characters ","key":"variable_ddi[company_name]","type":"text","value":"{{validate_adhoc_company_name}}"}]},"url":"{{base_url}}/api/ddi/variable/validate"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 14 Feb 2019 08:31:38 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.56609"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Mon, 11 Feb 2019 12:10:11 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_368_1416256=mhs9ZRWtdipkaJE5nWYbBY0nZVwAAAAAJiW66dhODcc6cpT7APalwQ==; path=/; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"___utmvmoNuBZVNB=SQdICqAkKWV; path=/; Max-Age=900"},{"key":"Set-Cookie","value":"___utmvaoNuBZVNB=OIR\u0001kfxS; path=/; Max-Age=900"},{"key":"Set-Cookie","value":"___utmvboNuBZVNB=iZd XkmOTalR: mtN; path=/; Max-Age=900"},{"key":"Content-Length","value":"344"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"13-19628225-19628228 NNNN CT(4 14 0) RT(1550133131994 24) q(0 0 0 0) r(19 19) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n DDI details valid\n Bank Account supports Direct Debit Instructions\n \n"}],"_postman_id":"232815a9-a9f8-4889-856a-12cdc5c83cb4"},{"name":"ddi/variable/validate (with extended parameters)","id":"861c70f3-cc5a-4cf7-b6ca-e22c456bcb7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"variable_ddi[debits][debit][][amount]","value":"{{collection_1_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"variable_ddi[debits][debit][][date]","value":"{{collection_1_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"},{"key":"variable_ddi[debits][debit][][amount]","value":"{{collection_2_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"variable_ddi[debits][debit][][date]","value":"{{collection_2_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"}]},"url":"{{base_url}}/ddi/variable/validate","description":"

When creating adhoc collections, or overriding an existing collection, pairs of amount and date values must be passed together.

\n","urlObject":{"path":["ddi","variable","validate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"861c70f3-cc5a-4cf7-b6ca-e22c456bcb7a"}],"id":"fa3a7bfa-8f69-4244-ab51-0e2e121595ff","description":"

Description

ddi/variable/validate allows an API user to check the details for a DDI without committing to creating it. It is intended to be used as part of the sign-up user journey so that when the payer confirms, the create call completes successfully.

The call validates that all supplied values are accepted by the SmartDebit system. The call also verifies that the payer's bank account accepts Direct Debits. If used with extended parameters the call can also validate an initial set of collections.

Note:

When validating in a sandbox environment, a sort code of six zeros should be used to return a successful response. Typically an account number of 12345678 would be used.
Using eight zeros for the account number returns an error response (invalid account details).

Parameters

Mandatory parameters are:

pslid
sort code, account number, account name
first name & last name
frequency type

Character restrictions apply to parameters. Accented characters and apostrophes should be removed from name and address values, as should most non-alphanumerics.

Optional parameters are listed below.

Conditional parameters (those that depend on the service user configuration) include:

reference number
email address, which is required if SmartDebit is to issue email notifications on behalf of the service user
frequency type, as restrictions can be placed on what frequencies are available
start date (optional), which must allow sufficient time for the DDI to lodge and this interval is derived from the service user's advance notice period
start date can also be restricted to configured days of the month
debit amounts must not exceed a configured maximum
debit dates can be restricted to the payer's schedule (as defined by his start_date, frequency_type and frequency_factor values)

The reference number must be unique and must comply with the reference number rules. Although SmartDebit is able to generate compliant reference numbers, the validate call is usually used for the sign-up user journey in which the details of the DDI, including the reference number, are presented to the payer before they confirm. For this reason, the service user would normally generate the reference number.

There is a practical upper limit of 19 months in the future for the start date. This exists because the DDI is submitted a maximum of 6 months after creation and expires after 13 months of inactivity.

Extended parameters may be used with this call to validate the values for an optional initial set of collections. Collections are specified by pairs of parameters:

variable_ddi[debits][debit][][amount] - the collection amount in pence
variable_ddi[debits][debit][][date] - the collection date in YYYY-MM-DD format, which must be on or after the start date

It is recommended that the XML body method of parameter passing is used if multiple debits are to be validated.

Care should be taken when using extended parameters together with a regular_amount.

Response

A successful call to ddi/variable/validate returns an XML document with a root tag of <successful>, with three <success> entries, the third of which includes information about the bank branch.

Note the single quotes in this response.

Errors

Errors are returned with an HTTP status other than \"200 OK\".

Missing parameters result in appropriate errors. A missing or incorrect service user returns one of the errors <error>No service user id supplied.</error>, <error>Invalid Service User ID: 'su_pslid'</error> or in the case of calling ddi/variable/validate without any frequency types configured for the service user, <error>Service User 'Example SU' does not support Variable DDIs</error>. The error is contained in an <errors> root tag.

Omitting any required parameters or supplying invalid values for any parameter may return a listing of all validation errors in one document. For example:

422 Unprocessable Entity\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Frequency type must be supplied</error>\n  <error>Sort code is invalid</error>\n  <error>Account name can't be blank</error>\n  <error>Account name is too short (minimum is 3 characters)</error>\n  <error>Account name only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are   permitted in account name</error>\n  <error>Last name can't be blank</error>\n  <error>Last name only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are   permitted in last names</error>\n  <error>Account number must not be empty</error>\n  <error>First name can't be blank</error>\n  <error>First name only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are   permitted in first names</error>\n</errors>\n

If all parameters pass validation, it is still possible that the bank account details are invalid. For example:

422 Unprocessable Entity\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid bank account details (Sort code not found)</error>\n</errors>\n

If extended parameters are used then the debits are validated and can generate errors.

\n","event":[{"listen":"prerequest","script":{"id":"0cd7d518-1807-417b-8999-cb54bb555936","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c3d0834b-978e-43b7-b567-262b9df844af","type":"text/javascript","exec":[""]}}],"_postman_id":"fa3a7bfa-8f69-4244-ab51-0e2e121595ff"},{"name":"4.2.2 Variable create","item":[{"name":"ddi/variable/create","event":[{"listen":"prerequest","script":{"id":"9af24909-c4d1-4b5e-b3e8-2fc08fa72efa","exec":["","pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","pm.environment.set(\"reference\", (sd.testing.getReferenceNumber('SD1')));","","","pm.environment.set('account_number','00000007');","pm.environment.set('sort_code', '111111');","","var d = new Date();","d.setHours(0,0,0,0);","d.setMonth(d.getMonth()+1);","","pm.environment.set('create_startdate', sd.testing.getISODate(d));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"e5e9fc6b-a3c8-4d63-84e6-606e00a18666","exec":["pm.test(\"Response time is less than 1000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1000);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include(\"\");"," pm.expect(pm.response.text()).to.include(\"\");","});","","//Schema Validation","var jsonObject = xml2Json(responseBody);","console.log(JSON.stringify(jsonObject));","","var schema ={"," \"definitions\": {},"," \"$schema\": \"http://json-schema.org/draft-07/schema#\","," \"$id\": \"http://example.com/root.json\","," \"type\": \"object\","," \"properties\": {"," \"variable_ddi\": {"," \"$id\": \"#/properties/variable_ddi\","," \"type\": \"object\","," \"properties\": {"," \"address_1\": {"," \"$id\": \"#/properties/variable_ddi/properties/address_1\","," \"type\": \"string\""," },"," \"country\": {"," \"$id\": \"#/properties/variable_ddi/properties/country\","," \"type\": \"string\""," },"," \"first_name\": {"," \"$id\": \"#/properties/variable_ddi/properties/first_name\","," \"type\": \"string\""," },"," \"frequency_type\": {"," \"$id\": \"#/properties/variable_ddi/properties/frequency_type\","," \"type\": \"string\""," },"," \"last_name\": {"," \"$id\": \"#/properties/variable_ddi/properties/last_name\","," \"type\": \"string\""," },"," \"postcode\": {"," \"$id\": \"#/properties/variable_ddi/properties/postcode\","," \"type\": \"string\""," },"," \"reference_number\": {"," \"$id\": \"#/properties/variable_ddi/properties/reference_number\","," \"type\": \"string\""," },"," \"start_date\": {"," \"$id\": \"#/properties/variable_ddi/properties/start_date\","," \"type\": \"object\","," \"properties\": {"," \"_\": {"," \"$id\": \"#/properties/variable_ddi/properties/start_date/properties/_\","," \"type\": \"string\""," },"," \"$\": {"," \"$id\": \"#/properties/variable_ddi/properties/start_date/properties/$\","," \"type\": \"object\","," \"properties\": {"," \"type\": {"," \"$id\": \"#/properties/variable_ddi/properties/start_date/properties/$/properties/type\","," \"type\": \"string\""," }"," }"," }"," }"," },"," \"town\": {"," \"$id\": \"#/properties/variable_ddi/properties/town\","," \"type\": \"string\""," },"," \"service_user\": {"," \"$id\": \"#/properties/variable_ddi/properties/service_user\","," \"type\": \"object\","," \"properties\": {"," \"pslid\": {"," \"$id\": \"#/properties/variable_ddi/properties/service_user/properties/pslid\","," \"type\": \"string\""," }"," }"," }"," }"," }"," }","};","","pm.test('Schema is valid', function() {"," pm.expect(tv4.validate(jsonObject, schema)).to.be.true;","});"],"type":"text/javascript"}}],"id":"45d15571-df93-4553-98c3-5dbea1993513","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

Required
Service user identifier

\n","key":"variable_ddi[service_user][pslid]","type":"text","value":"{{pslid}}"},{"key":"variable_ddi[reference_number]","value":"{{create_reference_number}}","description":"

Conditional (usually required)
\nUnique identifier for the DDI
\nFormat: 6 to 18 characters. See reference number rules.

\n","type":"text"},{"description":"

Required
\nFormat: single character only (W, M, Q, Y)

\n","key":"variable_ddi[frequency_type]","type":"text","value":"{{create_frequency_type}}"},{"description":"

Required
\nFormat: either 111111 or 11-11-11

\n","key":"variable_ddi[sort_code]","type":"text","value":"{{create_sort_code}}"},{"description":"

Required
\nFormat: 8 digit number

\n","key":"variable_ddi[account_number]","type":"text","value":"{{create_account_number}}"},{"description":"

Required
\nFormat: 3 to 18 characters

\n","key":"variable_ddi[account_name]","type":"text","value":"{{create_account_name}}"},{"key":"variable_ddi[first_name]","value":"{{create_first_name}}","description":"

Required
\nFormat: 1 to 32 characters

\n","type":"text"},{"description":"

Required
\nFormat: 1 to 32 characters

\n","key":"variable_ddi[last_name]","type":"text","value":"{{create_last_name}}"},{"key":"variable_ddi[start_date]","type":"text","value":"{{create_start_date}}","description":"

Format: YYYY-MM-DD
Default: next valid start date

\n"},{"key":"variable_ddi[end_date]","value":"{{create_end_date}}","description":"

If used, specifies the date after which no further collections will be made
Format: YYYY-MM-DD
Default: none

\n","type":"text"},{"key":"variable_ddi[default_amount]","type":"text","value":"{{create_default_amount}}","description":"

Format: integer, the value of the regular collection amount in pence

\n"},{"key":"variable_ddi[first_amount]","type":"text","value":"{{create_first_amount}}","description":"

If provided, this value is used on the start date only, in place of the default amount
Format: integer, the value of the first collection amount in pence

\n"},{"key":"variable_ddi[frequency_factor]","type":"text","value":"{{create_frequency_factor}}","description":"

Frequency factors 2, 3 and 4 cannot be used with frequency type Y
Format: integer, 1 to 4
Default: 1

\n"},{"key":"variable_ddi[title]","type":"text","value":"{{create_title}}","description":"

Format: 1 to 32 characters

\n"},{"key":"variable_ddi[email_address]","type":"text","value":"{{create_email_address}}","description":"

Format: 5 to 64 characters

\n"},{"key":"variable_ddi[company_name]","type":"text","value":"{{create_company_name}}","description":"

Format: 1 to 32 characters

\n"},{"key":"variable_ddi[payer_reference]","type":"text","value":"{{create_payer_reference}}","description":"

Format: 1 to 255 characters

\n"},{"key":"variable_ddi[address_1]","value":"{{create_address1}}","description":"

Format: 1 to 255 characters

\n","type":"text"},{"key":"variable_ddi[address_2]","type":"text","value":"{{create_address2}}","description":"

Format: 1 to 32 characters

\n"},{"key":"variable_ddi[address_3]","type":"text","value":"{{create_address3}}","description":"

Format: 1 to 32 characters

\n"},{"key":"variable_ddi[town]","value":"{{create_town}}","description":"

Format: 1 to 255 characters

\n","type":"text"},{"key":"variable_ddi[county]","type":"text","value":"{{create_county}}","description":"

Format: 1 to 255 characters

\n"},{"key":"variable_ddi[postcode]","value":"{{create_postcode}}","description":"

Format: 1 to 255 characters

\n","type":"text"},{"key":"variable_ddi[country]","value":"{{create_country}}","description":"

Format: 1 to 255 characters

\n","type":"text"},{"key":"variable_ddi[support_gift_aid]","type":"text","value":"{{create_support_gift_aid}}","description":"

Format: boolean, accepts 'true', 'false', 1 or 0
Default: false

\n"},{"key":"variable_ddi[promotion]","type":"text","value":"{{create_promotion}}","description":"

Format: 1 to 8 characters

\n"}]},"url":"{{base_url}}/ddi/variable/create","description":"","urlObject":{"path":["ddi","variable","create"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"02bf5706-8328-4ccf-84fe-eaaf61844cfb","name":"create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"description":"A unique reference number must be passed.
Format: plain text Restrictions: Unique, 6 to 18 characters May not contain solidus (/) and further restrictions apply.","key":"variable_ddi[reference_number]","type":"text","value":"{{reference}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[first_name]","type":"text","value":"{{create_first_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[last_name]","type":"text","value":"{{create_last_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[address_1]","type":"text","value":"{{create_address1}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[town]","type":"text","value":"{{create_town}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[postcode]","type":"text","value":"{{create_postcode}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"variable_ddi[country]","type":"text","value":"{{create_country}}"},{"description":"Format: plain text
Restrictions: 3 to 18 characters ","key":"variable_ddi[account_name]","type":"text","value":"{{create_account_name}}"},{"description":"Format: Sort Code – either 111111 or 11-11-11 format accepted.","key":"variable_ddi[sort_code]","type":"text","value":"{{sort_code}}"},{"description":"Format: 8 digit number ","key":"variable_ddi[account_number]","type":"text","value":"{{account_number}}"},{"description":"Format: Single Character – (W, M, Q, Y) Restrictions: Must be a frequency type configured on the SU ","key":"variable_ddi[frequency_type]","type":"text","value":"{{crearte_frequency_type}}"},{"description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid ","key":"variable_ddi[service_user][pslid]","type":"text","value":"{{pslid}}"},{"key":"variable_ddi[default_amount]","type":"text","value":"1001","disabled":true},{"key":"variable_ddi[first_amount]","type":"text","value":"99","disabled":true},{"key":"variable_ddi[payer_reference]","type":"text","value":"custom_api_test","disabled":true},{"key":"variable_ddi[start_date]","type":"text","value":"2018-09-15","disabled":true},{"key":"variable_ddi[title]","type":"text","value":"Mr","disabled":true},{"key":"variable_ddi[address_2]","type":"text","value":"--","disabled":true},{"key":"variable_ddi[address_3]","type":"text","value":"--","disabled":true},{"key":"variable_ddi[county]","type":"text","value":"Surrey","disabled":true},{"key":"variable_ddi[email_address]","type":"text","value":"test-ruby@smartdebit.com","disabled":true},{"key":"variable_ddi[promotion]","type":"text","value":"freeRUBY","disabled":true},{"key":"variable_ddi[support_gift_aid]","type":"text","value":"false","disabled":true},{"key":"variable_ddi[company_name]","type":"text","value":"Ruby API","disabled":true},{"key":"variable_ddi[frequency_factor]","type":"text","value":"1","disabled":true}]},"url":"{{base_url}}/api/ddi/variable/create"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 12 Feb 2019 15:39:54 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Runtime","value":"0.67634"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Mon, 11 Feb 2019 12:10:11 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_368_1416256=kpn2NqKMpUnJRmI4nWYbBefoYlwAAAAAGnN3GtRmLkeIuO3xWvBfiQ==; path=/; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"___utmvmoNuBZVNB=ajnfsQmcNsa; path=/; Max-Age=900"},{"key":"Set-Cookie","value":"___utmvaoNuBZVNB=zFD\u0001qNJi; path=/; Max-Age=900"},{"key":"Set-Cookie","value":"___utmvboNuBZVNB=CZD XbqOraln: LtN; path=/; Max-Age=900"},{"key":"Content-Length","value":"489"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"14-2709257-2709261 NNNN CT(16 28 0) RT(1549986022955 27) q(0 0 1 1) r(10 10) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 1 ApiTest Road\n United Kingdom\n Test\n M\n Smith\n RR23 3AP\n SD1190112153954270\n 2019-03-01T00:00:00Z\n Bagshot\n \n apidocument\n \n"}],"_postman_id":"45d15571-df93-4553-98c3-5dbea1993513"},{"name":"ddi/variable/create (with extended parameters)","id":"a9f24465-29e2-496d-bb3f-d0efcc342510","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"variable_ddi[debits][debit][][amount]","value":"{{collection_1_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"variable_ddi[debits][debit][][date]","value":"{{collection_1_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"},{"key":"variable_ddi[debits][debit][][amount]","value":"{{collection_2_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"variable_ddi[debits][debit][][date]","value":"{{collection_2_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"}]},"url":"{{base_url}}/ddi/variable/create","description":"

When creating adhoc collections, or overriding an existing collection, pairs of amount and date values must be passed together.

\n","urlObject":{"path":["ddi","variable","create"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9f24465-29e2-496d-bb3f-d0efcc342510"}],"id":"d2e3ace6-4817-472e-a61c-991761e4b76d","description":"

Description

ddi/variable/create is used to create a new payer. The call should be made only if the validate call has already returned a success result. ddi/variable/create takes the same parameters as ddi/variable/validate. An arbitrary number of debits can also be created.

The new payer is created and is immediately accessible in the SmartDebit Pulse web portal. If email notifications are configured for the service user and the payer's email address was supplied, a confirmation email is sent to the payer. The details of the DDI are scheduled for submission to Bacs in time for the first collection to be taken.

Parameters

Refer to the validate section for details of the accepted parameters.

Response

A successful response from ddi/variable/create is an XML rendition of the payer with a root tag of variable_ddi. Any unpopulated optional fields on the DDI are omitted from the XML document. If extended parameters are passed, the response includes the debits. The <frequency_factor> node is included only if the factor is greater than 1.

Errors

Refer to the validate section for example error responses.

\n","event":[{"listen":"prerequest","script":{"id":"40336317-4900-42e9-bec1-573db0214597","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a8da4a95-2fd4-4d3d-ab4a-5a107ca99660","type":"text/javascript","exec":[""]}}],"_postman_id":"d2e3ace6-4817-472e-a61c-991761e4b76d"},{"name":"4.2.3 Variable update","item":[{"name":"ddi/variable/{{reference_number}}","event":[{"listen":"test","script":{"id":"7143515e-d68d-493f-9177-ab5fcb4d4d39","exec":["","eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 400ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(400);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('' + pm.environment.get('reference_number') + '');"," pm.expect(pm.response.text()).to.include('');","});","","","// SCHEMA Validation //","var result = xml2Json(responseBody); // ","var schema = sd.api.schema.updateVariableResponse; //"," //","//var schema = sd.api.schema.dumpResponse; //"," //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //","",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"90ff0aab-4b57-4db7-93e7-330df5d43945","exec":["","pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var dataGen = sd.testing;","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false);","","//This needs only for variable payers","payer.frequency_type = 'M';","payer.email_address = 'test-ruby@smartdebt.com';","","","//var payerFormData = dataGen.json2formData(payer, 'adhoc_ddi');","var payerFormData = dataGen.json2formData(payer, 'variable_ddi');","","const createPayerRequest = {"," //url: pm.environment.get('base_url') + '/api/ddi/adhoc/create',"," url: pm.environment.get('base_url') + '/ddi/variable/create',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: payerFormData"," }","};","","pm.sendRequest(createPayerRequest, function (err, res) {"," console.log(err ? err : res.text());"," "," pm.environment.set('reference_number', payer.reference_number);"," console.log('reference number for the payer we try to update is: ' + payer.reference_number);","});","","var debitDate = new Date();","debitDate.setHours(0,0,0,0);","debitDate = debitDate.addMonths(2);","","pm.environment.set('update_dd_amount', dataGen.randomInt(100, 10000));","pm.environment.set('update_dd_date', dataGen.getISODate(debitDate));","","pm.environment.set('update_dd_amount', dataGen.randomInt(100, 10000));","pm.environment.set('update_dd_date', dataGen.getISODate(debitDate));","","pm.environment.set('update_first_name', 'Updated-Bob');","pm.environment.set('update_last_name', 'Updated-Smith');","pm.environment.set('validate_adhoc_company_name', 'Acme Co.');","pm.environment.set('update_address1', '123 SandBox Street');","pm.environment.set('update_town', 'Alfold');","pm.environment.set('update_postcode', 'GU99 9ZZ');","pm.environment.set('update_country', 'United Kingdom');","",""],"type":"text/javascript"}}],"id":"b884aef1-0abc-4a93-863a-c5982db87043","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"variable_ddi[frequency_type]","value":"{{frequency_type}}","description":"

Format: single character only (W, M, Q, Y)

\n","type":"text"},{"key":"variable_ddi[sort_code]","value":"{{sort_code}}","description":"

Format: either 111111 or 11-11-11

\n","type":"text"},{"key":"variable_ddi[account_number]","value":"{{account_number}}","description":"

Format: 8 digit number

\n","type":"text"},{"key":"variable_ddi[account_name]","value":"{{account_name}}","description":"

Format: 3 to 18 characters

\n","type":"text"},{"key":"variable_ddi[first_name]","value":"{{first_name}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"variable_ddi[last_name]","value":"{{last_name}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"variable_ddi[start_date]","value":"{{start_date}}","description":"

Format: YYYY-MM-DD

\n","type":"text"},{"key":"variable_ddi[end_date]","value":"{{end_date}}","description":"

If used, specifies the date after which no further collections will be made
Format: YYYY-MM-DD

\n","type":"text"},{"key":"variable_ddi[default_amount]","value":"{{default_amount}}","description":"

Format: integer, the value of the regular collection amount in pence

\n","type":"text"},{"key":"variable_ddi[first_amount]","value":"{{first_amount}}","description":"

If provided, this value is used on the start date only, in place of the default amount
Format: integer, the value of the first collection amount in pence

\n","type":"text"},{"key":"variable_ddi[frequency_factor]","value":"{{frequency_factor}}","description":"

Frequency factors 2, 3 and 4 cannot be used with frequency type Y
Format: integer, 1 to 4

\n","type":"text"},{"key":"variable_ddi[title]","value":"{{title}}","description":"

Format: 1 to 32 characters

\n","type":"text"},{"key":"variable_ddi[email_address]","value":"{{email_address}}","type":"text","description":"

Format: 1 to 64 characters

\n"},{"key":"variable_ddi[company_name]","value":"{{company_name}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"variable_ddi[payer_reference]","value":"{{payer_reference}}","description":"

Format: 1 to 255 characters

\n","type":"text"},{"key":"variable_ddi[address_1]","value":"{{address_1}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"variable_ddi[address_2]","value":"{{address_2}}","description":"

Format: 1 to 32 characters

\n","type":"text"},{"key":"variable_ddi[address_3]","value":"{{address_3}}","description":"

Format: 1 to 32 characters

\n","type":"text"},{"key":"variable_ddi[town]","value":"{{town}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"variable_ddi[county]","value":"{{county}}","description":"

Format: 1 to 255 characters

\n","type":"text"},{"key":"variable_ddi[postcode]","value":"{{postcode}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"variable_ddi[country]","value":"{{country}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"variable_ddi[support_gift_aid]","value":"{{support_gift_aid}}","description":"

Format: boolean, accepts 'true', 'false', 1 or 0

\n","type":"text"},{"key":"variable_ddi[promotion]","value":"{{promotion}}","description":"

Format: 1 to 8 characters

\n","type":"text"}]},"url":"{{base_url}}/ddi/variable/{{reference_number}}","description":"

All parameters are optional.

\n","urlObject":{"path":["ddi","variable","{{reference_number}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0a93e95d-58dd-47f1-bb71-177ba6799f89","name":"update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"variable_ddi[first_name]","value":"{{update_first_name}}","type":"text","description":" Format: Integer, the value of the debit amount in pence. Restrictions: value between 0 and the SU's maximum_debit_amount "},{"key":"variable_ddi[last_name]","value":"{{update_last_name}}","type":"text","description":" Format: YYYY-MM-DD Restrictions: must be on or after the start date, and must fall on a whole number of periods after the start date"},{"key":"variable_ddi[address_1]","value":"{{update_address1}}","type":"text","description":"Format: Integer, the value of the debit amount in pence. Restrictions: value between 0 and the SU's maximum_debit_amount "},{"key":"variable_ddi[town]","value":"{{update_town}}","type":"text","description":"Format: YYYY-MM-DD Restrictions: must be on or after the start date, and must fall on a whole number of periods after the start date "},{"key":"variable_ddi[postcode]","value":"{{update_postcode}}","type":"text"},{"key":"variable_ddi[country]","value":"{{update_country}}","type":"text"},{"key":"variable_ddi[debits][debit][][amount]","value":"{{update_dd_amount}}","type":"text"},{"key":"variable_ddi[debits][debit][][date]","value":"{{update_dd_date}}","type":"text"},{"key":"variable_ddi[debits][debit][][amount]","value":"1000","type":"text"},{"key":"variable_ddi[debits][debit][][date]","value":"2019-04-28","type":"text"}]},"url":"{{base_url}}/api/ddi/variable/{{reference_number}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 14 Feb 2019 13:43:42 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.19808"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"904"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"12-16060495-16072749 SNNN RT(1550151770862 85369) q(0 0 0 -1) r(2 2) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 123 SandBox Street\n United Kingdom\n test-ruby@smartdebt.com\n Updated-Bob\n M\n Updated-Smith\n GU99 9ZZ\n SD1190114134344789\n 2019-03-01T00:00:00Z\n Alfold\n \n \n 6570\n 2019-04-14T00:00:00Z\n \n \n 1000\n 2019-04-28T00:00:00Z\n \n \n \n apidocument\n \n"}],"_postman_id":"b884aef1-0abc-4a93-863a-c5982db87043"},{"name":"ddi/variable/{{reference_number}} (with extended parameters)","event":[{"listen":"test","script":{"id":"7143515e-d68d-493f-9177-ab5fcb4d4d39","exec":["","eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 400ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(400);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('' + pm.environment.get('reference_number') + '');"," pm.expect(pm.response.text()).to.include('');","});","","","// SCHEMA Validation //","var result = xml2Json(responseBody); // ","var schema = sd.api.schema.updateVariableResponse; //"," //","//var schema = sd.api.schema.dumpResponse; //"," //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //","",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"90ff0aab-4b57-4db7-93e7-330df5d43945","exec":["","pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var dataGen = sd.testing;","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false);","","//This needs only for variable payers","payer.frequency_type = 'M';","payer.email_address = 'test-ruby@smartdebt.com';","","","//var payerFormData = dataGen.json2formData(payer, 'adhoc_ddi');","var payerFormData = dataGen.json2formData(payer, 'variable_ddi');","","const createPayerRequest = {"," //url: pm.environment.get('base_url') + '/api/ddi/adhoc/create',"," url: pm.environment.get('base_url') + '/ddi/variable/create',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: payerFormData"," }","};","","pm.sendRequest(createPayerRequest, function (err, res) {"," console.log(err ? err : res.text());"," "," pm.environment.set('reference_number', payer.reference_number);"," console.log('reference number for the payer we try to update is: ' + payer.reference_number);","});","","var debitDate = new Date();","debitDate.setHours(0,0,0,0);","debitDate = debitDate.addMonths(2);","","pm.environment.set('update_dd_amount', dataGen.randomInt(100, 10000));","pm.environment.set('update_dd_date', dataGen.getISODate(debitDate));","",""],"type":"text/javascript"}}],"id":"b3a0184a-a568-4105-9a01-b0971c2411e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"description":"

Format: integer, the value of the debit amount in pence

\n","key":"variable_ddi[debits][debit][][amount]","type":"text","value":"{{collection_1_amount}}"},{"description":"

Format: YYYY-MM-DD

\n","key":"variable_ddi[debits][debit][][date]","type":"text","value":"{{collection_1_date}}"},{"description":"

Format: integer, the value of the debit amount in pence

\n","key":"variable_ddi[debits][debit][][amount]","type":"text","value":"{{collection_2_amount}}"},{"description":"

Format: YYYY-MM-DD

\n","key":"variable_ddi[debits][debit][][date]","type":"text","value":"{{collection_2_date}}"}]},"url":"{{base_url}}/ddi/variable/{{reference_number}}","description":"

When creating adhoc collections, or overriding an existing collection, pairs of amount and date values must be passed together.

\n","urlObject":{"path":["ddi","variable","{{reference_number}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"801e6059-65d4-4aa1-92bf-e3d90a1054ca","name":"update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"description":" Format: Integer, the value of the debit amount in pence. Restrictions: value between 0 and the SU's maximum_debit_amount ","key":"variable_ddi[debits][debit][][amount]","type":"text","value":"{{update_dd_amount}}"},{"description":" Format: YYYY-MM-DD Restrictions: must be on or after the start date, and must fall on a whole number of periods after the start date","key":"variable_ddi[debits][debit][][date]","type":"text","value":"{{update_dd_date}}"},{"description":"Format: Integer, the value of the debit amount in pence. Restrictions: value between 0 and the SU's maximum_debit_amount ","key":"variable_ddi[debits][debit][][amount]","type":"text","value":"1000"},{"description":"Format: YYYY-MM-DD Restrictions: must be on or after the start date, and must fall on a whole number of periods after the start date ","key":"variable_ddi[debits][debit][][date]","type":"text","value":"2019-04-28"}]},"url":"{{base_url}}/api/ddi/variable/{{reference_number}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 13 Feb 2019 11:10:04 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.27362"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"885"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"13-10522462-10597743 SNNN RT(1550055876383 358922) q(0 0 0 -1) r(3 3) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 82 Manor Road\n United Kingdom\n test-ruby@smartdebt.com\n Isla\n M\n Grad\n W1A 0AX\n SD119011311105464\n 2019-03-01T00:00:00Z\n Harrowgate\n \n \n 8233\n 2019-04-13T00:00:00Z\n \n \n 1000\n 2019-04-28T00:00:00Z\n \n \n \n apidocument\n \n"}],"_postman_id":"b3a0184a-a568-4105-9a01-b0971c2411e8"},{"name":"ddi/variable/{{reference_number}}/update","event":[{"listen":"test","script":{"id":"7143515e-d68d-493f-9177-ab5fcb4d4d39","exec":["","eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 400ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(400);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('' + pm.environment.get('reference_number') + '');"," pm.expect(pm.response.text()).to.include('');","});","","","// SCHEMA Validation //","var result = xml2Json(responseBody); // ","var schema = sd.api.schema.updateVariableResponse; //"," //","//var schema = sd.api.schema.dumpResponse; //"," //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //","",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"90ff0aab-4b57-4db7-93e7-330df5d43945","exec":["","pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var dataGen = sd.testing;","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false);","","//This needs only for variable payers","payer.frequency_type = 'M';","payer.email_address = 'test-ruby@smartdebt.com';","","","//var payerFormData = dataGen.json2formData(payer, 'adhoc_ddi');","var payerFormData = dataGen.json2formData(payer, 'variable_ddi');","","const createPayerRequest = {"," //url: pm.environment.get('base_url') + '/api/ddi/adhoc/create',"," url: pm.environment.get('base_url') + '/ddi/variable/create',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: payerFormData"," }","};","","pm.sendRequest(createPayerRequest, function (err, res) {"," console.log(err ? err : res.text());"," "," pm.environment.set('reference_number', payer.reference_number);"," console.log('reference number for the payer we try to update is: ' + payer.reference_number);","});","","var debitDate = new Date();","debitDate.setHours(0,0,0,0);","debitDate = debitDate.addMonths(2);","","pm.environment.set('update_dd_amount', dataGen.randomInt(100, 10000));","pm.environment.set('update_dd_date', dataGen.getISODate(debitDate));","","","pm.environment.set('update_first_name', 'Updated-Bob');","pm.environment.set('update_last_name', 'Updated-Smith');","pm.environment.set('validate_adhoc_company_name', 'Acme Co.');","pm.environment.set('update_address1', '123 SandBox Street');","pm.environment.set('update_town', 'Alfold');","pm.environment.set('update_postcode', 'GU99 9ZZ');","pm.environment.set('update_country', 'United Kingdom');"],"type":"text/javascript"}}],"id":"78322665-5f76-45c8-896c-be3896079b5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{base_url}}/ddi/variable/{{reference_number}}/update","description":"

This is an alias for the PUT update call. The same parameters as above can be used with this version.

\n","urlObject":{"path":["ddi","variable","{{reference_number}}","update"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ca698202-78cb-4dcf-84d3-4cb5772bd7e8","name":"update","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"variable_ddi[first_name]","value":"{{update_first_name}}","type":"text","description":" Format: Integer, the value of the debit amount in pence. Restrictions: value between 0 and the SU's maximum_debit_amount "},{"key":"variable_ddi[last_name]","value":"{{update_last_name}}","type":"text","description":" Format: YYYY-MM-DD Restrictions: must be on or after the start date, and must fall on a whole number of periods after the start date"},{"key":"variable_ddi[address_1]","value":"{{update_address1}}","type":"text","description":"Format: Integer, the value of the debit amount in pence. Restrictions: value between 0 and the SU's maximum_debit_amount "},{"key":"variable_ddi[town]","value":"{{update_town}}","type":"text","description":"Format: YYYY-MM-DD Restrictions: must be on or after the start date, and must fall on a whole number of periods after the start date "},{"key":"variable_ddi[postcode]","value":"{{update_postcode}}","type":"text"},{"key":"variable_ddi[country]","value":"{{update_country}}","type":"text"},{"key":"variable_ddi[debits][debit][][amount]","value":"{{update_dd_amount}}","type":"text"},{"key":"variable_ddi[debits][debit][][date]","value":"{{update_dd_date}}","type":"text"},{"key":"variable_ddi[debits][debit][][amount]","value":"1000","type":"text"},{"key":"variable_ddi[debits][debit][][date]","value":"2019-04-28","type":"text"}]},"url":"{{base_url}}/api/ddi/variable/{{reference_number}}/update"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 14 Feb 2019 13:45:18 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.26889"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"904"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"12-16060495-16087082 SNNN RT(1550151770862 181115) q(0 0 0 -1) r(3 3) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 123 SandBox Street\n United Kingdom\n test-ruby@smartdebt.com\n Updated-Bob\n M\n Updated-Smith\n GU99 9ZZ\n SD1190114134520545\n 2019-03-01T00:00:00Z\n Alfold\n \n \n 5438\n 2019-04-14T00:00:00Z\n \n \n 1000\n 2019-04-28T00:00:00Z\n \n \n \n apidocument\n \n"}],"_postman_id":"78322665-5f76-45c8-896c-be3896079b5d"}],"id":"42d76121-1dd6-4e0a-ab9b-6454d618b1b5","description":"

Syntax

PUT {{base_url}}/ddi/variable/{{reference_number}}\n

aliased as

POST {{base_url}}/ddi/variable/{{reference_number}}/update\n

Description

The update method allows the attributes of a payer to be amended, their payment schedule to be changed, and collections to be created and updated. The update may result in an amendment email being sent to the payer.

The DDI reference number cannot be changed. Cancelled DDIs cannot be updated.

If the reference number contains solidus, it must be urlencoded.

Updating bank details: Simple validation of account number and sort code takes place but full validation does not. This behaviour may change in a future release. Thus, a five-digit sort code would not be accepted but an invalid six-digit sort code would.

Updating cancelled payers: Attempting to update a cancelled payer results in a \"200 OK\" status and an XML response as if the update was accepted but the update does not take place. The XML response includes the \"cancelled_on\" node. This behaviour may change in a future release.

Updating collection dates: A payer's collection date is determined by their start date, which can be changed by this call. When doing so, consider the following:

If the start date is moved into the future and the payer has a first amount, that amount will be collected again.
Changing the start date at or near a submission date may have unintended consequences. Consider a payer who collects on the 10th of the month: if, around the 10th of the month, the start date is changed to the 15th then two payments will be collected that month; if, around the 5th of the month, the start date is changed to the 5th, then no payments will be collected that month.

Deleting an end date: It may be useful to remove a payer's end date. Whilst some optional values can be deleted with empty form data, such as:

    variable_ddi[payer_reference] = \n

trying to remove an end date with form data results in an error:

422 Unprocessable Entity\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Unable to parse end date '' expected format is YYYY-MM-DD</error>\n</errors>\n

However an end date can be removed with an XML body containing an empty end_date tag:

<variable_ddi>\n  <end_date></end_date>\n</variable_ddi>\n

The content-type must be application/xml.

Updating collections: Extended parameters can be used to add a collection or to change the amount of a collection. They cannot be used to change the date of a collection or to delete a collection. If a collection is added that coincides with the payer's schedule then it overrides the schedule: it is collected instead of, not as well as, the regular payment. An overriding collection with an amount of zero suppresses the regular payment. Collections cannot be edited on or after the date of submission.

Parameters

Optional parameters define the attribute or attributes to be updated. Extended parameters can be specified in order to create or update collections. It is recommended that the XML body method of parameter passing is used if multiple collections are to be created or edited.

A dummy parameter, e.g. variable_ddi[dummy], may be used to simply return the payer details without performing an update.

Response

A successful response from ddi/variable/{{reference_number}} is an XML rendition of the payer with a root tag of variable_ddi. Any unpopulated optional fields on the payer are omitted from the XML document. The entire payer and any collections are always returned regardless of the number of attributes updated. For instance,

PUT /api/ddi/variable/ABC106093 \n<?XML version=\"1.0\" encoding=\"UTF-8\"?> \n<variable_ddi>\n  <first_name>John</first_name>\n</variable_ddi>\n

could return:

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<variable_ddi>\n  <reference_number>ABC106093</reference_number>\n  <first_name>John</first_name>\n  <last_name>Smith</last_name>\n  <frequency_type>M</frequency_type>\n  <default_amount type=\"integer\">2000</default_amount>\n  <start_date type=\"datetime\">2018-07-01T00:00:00Z</start_date>\n  <address_1>123 Fake St</address_1>\n  <town>London</town>\n  <postcode>sw2 3ed</postcode>\n  <country>United Kingdom</country>\n  <service_user>\n    <pslid>su_pslid</pslid>\n  </service_user>\n</variable_ddi> \n

The same is true of updating the debits on a DDI. For instance,

PUT /api/ddi/variable/ABC106093 \n<?XML version=\"1.0\" encoding=\"UTF-8\"?>\n<variable_ddi>\n  <debits> \n    <debit>\n      <amount>500</amount><date>2019-08-01</date>\n    </debit>\n  </debits>\n</variable_ddi>\n

could return

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<variable_ddi>\n  <reference_number>ABC106093</reference_number>\n  <first_name>John</first_name>\n  <last_name>Smith</last_name>\n  <frequency_type>M</frequency_type>\n  <default_amount type=\"integer\">2000</default_amount>\n  <start_date type=\"datetime\">2018-07-01T00:00:00Z</start_date>\n  <address_1>123 Fake St</address_1>\n  <town>London</town>\n  <postcode>sw2 3ed</postcode> \n  <country>United Kingdom</country>\n  <debits type=\"array\"> \n    <debit type=\"DdaDebit\">\n      <amount type=\"integer\">1500</amount>\n      <debit_date type=\"datetime\">2019-07-01T00:00:00Z</debit_date>\n    </debit> \n    <debit>\n      <amount type=\"integer\">500</amount>\n      <debit_date type=\"datetime\">2019-08-01T00:00:00Z</debit_date>\n    </debit>\n  </debits>\n  <service_user>\n    <pslid>su_pslid</pslid>\n  </service_user>\n</variable_ddi>\n

A cancelled DDI is identified by the presence of cancelled_on in the response, indicating the date and time of cancellation. Where the cancellation is by Bacs advice, the value of cancelled_on may be taken from the advice.

Amounts are given in pence.

Collection statuses are not provided. The presence of a collection does not mean that it was paid, nor even that it was submitted.

Errors

Error responses are similar to the error responses for ddi/variable/validate and ddi/variable/create. Missing parameters result in appropriate errors. Passing no parameters at all returns:

400 Bad Request \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Direct Debit parameters not supplied.</error>\n</errors> \n

Attempting to update with an incorrect reference number returns:

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Variable Direct Debit 'AAAAAA' not found.</error>\n</errors>\n

Attempting to update an 'adhoc' DDI returns the same response.

Supplying invalid values for any parameter may return a listing of all validation errors in one document. For example:

422 Unprocessable Entity \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Account name is too short (minimum is 3 characters)</error>\n  <error>First name is too long (maximum is 32 characters)</error>\n</errors>\n

Supplying invalid debit values returns a listing of all validation errors in one document. This example shows an invalid date and an amount that exceeds the maximum allowed for the service user. Note the HTML encoding in this response.

422 Unprocessable Entity\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Amount must be less than &#163;250.00</error>\n  <error>Debit date must not be before the start of the DDI: 2018/07/01 00:00</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"e8efa11b-7873-4a9c-a88f-faff81dc7032","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"10d17560-3171-43f7-8a92-b9da403f2e15","type":"text/javascript","exec":[""]}}],"_postman_id":"42d76121-1dd6-4e0a-ab9b-6454d618b1b5"},{"name":"4.2.4 Variable cancel","item":[{"name":"ddi/variable/{{reference_number}}/cancel","event":[{"listen":"test","script":{"id":"c0292e00-f624-4837-845e-fd52dadadd98","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('' + pm.environment.get('reference_number_to_cancel') + '');"," pm.expect(pm.response.text()).to.include('');","});","","// SCHEMA Validation //","var result = xml2Json(responseBody); // ","var schema = sd.api.schema.updateVariableResponse; //","// //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //","","","//pm.environment.set(\"api_cancel_adhoc_response_2\", pm.response.text());"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f68927c4-6304-4373-8a8f-90956c01555a","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var dataGen = sd.testing;","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false);","","//This needs only for variable payers","payer.frequency_type = 'M';","payer.email_address = 'test-ruby@smartdebt.com';","","","//var payerFormData = dataGen.json2formData(payer, 'adhoc_ddi');","var payerFormData = dataGen.json2formData(payer, 'variable_ddi');","","const createPayerRequest = {"," //url: pm.environment.get('base_url') + '/api/ddi/adhoc/create',"," url: pm.environment.get('base_url') + '/ddi/variable/create',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: payerFormData"," }","};","","pm.sendRequest(createPayerRequest, function (err, res) {"," console.log(err ? err : res.text());"," "," pm.environment.set('reference_number_to_cancel',payer.reference_number);"," console.log('reference number for the payer we will cancel is: ' + payer.reference_number);","});","","","",""],"type":"text/javascript"}}],"id":"aabd97e8-ca8c-470d-a411-525400abe441","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{base_url}}/ddi/variable/{{reference_number_to_cancel}}/cancel","urlObject":{"path":["ddi","variable","{{reference_number_to_cancel}}","cancel"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bf15eb75-bf1d-428f-951b-235338b5b437","name":"cancel","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/api/ddi/variable/{{reference_number_to_cancel}}/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 14 Feb 2019 11:11:10 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.09400"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"619"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"13-21068860-21087126 SNNN RT(1550142591588 112642) q(0 0 0 -1) r(1 1) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 16 Victoria Road\n 2019-02-14T11:11:10Z\n United Kingdom\n test-ruby@smartdebt.com\n Lenin\n M\n Bella\n CR2 6XH\n SD1190114111113172\n 2019-03-01T00:00:00Z\n Harrowgate\n \n apidocument\n \n"}],"_postman_id":"aabd97e8-ca8c-470d-a411-525400abe441"}],"id":"7795898c-fbb6-4fee-9a2b-2c9ad65c0818","description":"

The cancel method allows a DDI to be cancelled. Cancelling a DDI may result in a cancellation email being sent to the payer.

If the reference number contains solidus, it must be urlencoded.

Response

A successful response is an XML rendition of the DDI with a root tag of variable_ddi. The cancellation time is included as cancelled_on. Any unpopulated optional fields on the DDI are omitted from the XML document.

Cancelling an already-cancelled DDI returns a success response but performs no action.

Errors

Attempting to cancel with an incorrect reference number returns:

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Variable Direct Debit 'AAAAAA' not found.</error>\n</errors>\n

Attempting to cancel an adhoc DDI returns the same response.

\n","event":[{"listen":"prerequest","script":{"id":"84dca9c0-ae28-4c16-8ba6-d9eaa6309cc0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6941e157-a8bf-4d73-a22d-4b7c89757350","type":"text/javascript","exec":[""]}}],"_postman_id":"7795898c-fbb6-4fee-9a2b-2c9ad65c0818"},{"name":"4.2.5 Variable reinstate","item":[{"name":"ddi/variable/{{reference_number}}/reinstate","id":"9ba4f071-605a-47fc-b6a0-a38252efea1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{base_url}}/ddi/variable/{{reference_number}}/reinstate","urlObject":{"path":["ddi","variable","{{reference_number}}","reinstate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ba4f071-605a-47fc-b6a0-a38252efea1f"}],"id":"e0acea5c-f440-40ab-9867-84b65c05f3bb","description":"

The reinstate method allows a cancelled DDI to be made live again. Reinstating a DDI may result in a reinstatement email being sent to the payer.

If the reference number contains solidus, it must be urlencoded.

Response

A successful response is an XML rendition of the DDI with a root tag of variable_ddi. Any unpopulated optional fields on the DDI are omitted from the XML document. The fact that the response does not include a cancelled_on field indicates that the DDI is live.

Reinstating a DDI that is already live returns a success response but performs no action.

Errors

Attempting to reinstate with an incorrect reference number returns:

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<errors>\n    <error>Variable Direct Debit 'AAAAAA' not found.</error>\n</errors>\n

Attempting to reinstate an adhoc DDI returns the same response.

\n","event":[{"listen":"prerequest","script":{"id":"119356b7-231c-4a90-8be7-2bf512a3870e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"395147e4-419b-4ae5-a237-1bd0d4c6639f","type":"text/javascript","exec":[""]}}],"_postman_id":"e0acea5c-f440-40ab-9867-84b65c05f3bb"},{"name":"4.2.6 Adhoc validate","item":[{"name":"ddi/adhoc/validate","event":[{"listen":"test","script":{"id":"a0f7c137-6100-446b-8405-61412f663605","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","var jsonObject = xml2Json(responseBody);","console.log(JSON.stringify(jsonObject));","","","var schema = sd.api.schema.validateResponse;","","console.log(schema);","pm.test('Schema is valid', function() {"," pm.expect(tv4.validate(jsonObject, schema)).to.be.true;","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"1f3c829c-3be1-4237-a572-83e54e1c01c8","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var dataGen = sd.testing;","","var startDate = new Date();","startDate.setHours(0,0,0,0);","startDate = startDate.addMonths(2);","","var endDate = new Date();","endDate.setHours(0,0,0,0);","endDate = endDate.addMonths(6);","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false, false, true);","","console.log(payer);","console.log(dataGen.getISODate(startDate));","console.log(dataGen.getISODate(endDate));","","console.log(payer.last_name);","","pm.environment.set('validate_reference_number','API-Test-0123'); //should not exist","pm.environment.set('validate_adhoc_title', payer.title);","pm.environment.set('validate_first_name', payer.first_name);","pm.environment.set('validate_last_name', payer.last_name);","pm.environment.set('validate_adhoc_company_name', 'Acme Co.');","pm.environment.set('validate_address1', payer.address_1);","pm.environment.set('validate_adhoc_address2', payer.address_2);","pm.environment.set('validate_adhoc_address3', payer.address_3);","pm.environment.set('validate_town', payer.town);","pm.environment.set('validate_adhoc_county', payer.county);","pm.environment.set('validate_postcode', payer.postcode);","pm.environment.set('validate_country', payer.country);","","pm.environment.set('validate_adhoc_email_address', payer.email);","","pm.environment.set('validate_adhoc_start_date', dataGen.getISODate(startDate));","pm.environment.set('validate_adhoc_end_date', dataGen.getISODate(endDate));","pm.environment.set('validate_sort_code', '000000');","pm.environment.set('validate_account_number', '12345678');","pm.environment.set('validate_adhoc_promotion', 'PROMO');","","","pm.environment.set('validate_adhoc_payer_reference', payer.account_number);","pm.environment.set('validate_account_name', payer.account_name);","","","var debitDate = new Date();","debitDate.setHours(0,0,0,0);","debitDate = debitDate.addMonths(2);","","pm.environment.set('validate_adhoc_dd_amount', dataGen.randomInt(100, 10000));","pm.environment.set('validate_adhoc_dd_date', dataGen.getISODate(debitDate));"],"type":"text/javascript"}}],"id":"23d97a1a-b71d-4bfc-8632-550235f92a8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"adhoc_ddi[service_user][pslid]","value":"{{pslid}}","type":"text","description":"

Required
\nService user identifier

\n"},{"key":"adhoc_ddi[reference_number]","value":"{{validate_reference_number}}","type":"text","description":"

Conditional (usually required)
\nUnique identifier for the DDI
\nFormat: 6 to 18 characters. See reference number rules.

\n"},{"key":"adhoc_ddi[sort_code]","value":"{{validate_sort_code}}","type":"text","description":"

Required
\nFormat: either 111111 or 11-11-11

\n"},{"key":"adhoc_ddi[account_number]","value":"{{validate_account_number}}","type":"text","description":"

Required
\nFormat: 8 digit number

\n"},{"key":"adhoc_ddi[account_name]","value":"{{validate_account_name}}","type":"text","description":"

Required
\nFormat: 3 to 18 characters

\n"},{"key":"adhoc_ddi[first_name]","value":"{{validate_first_name}}","type":"text","description":"

Required
\nFormat: 1 to 32 characters

\n"},{"key":"adhoc_ddi[last_name]","value":"{{validate_last_name}}","type":"text","description":"

Required
\nFormat: 1 to 32 characters

\n"},{"key":"adhoc_ddi[start_date]","value":"{{validate_adhoc_start_date}}","type":"text","description":"

Format: YYYY-MM-DD
Default: next valid start date

\n"},{"key":"adhoc_ddi[end_date]","value":"{{validate_adhoc_end_date}}","type":"text","description":"

Deprecated
Format: YYYY-MM-DD
Default: none

\n"},{"key":"adhoc_ddi[title]","value":"{{validate_adhoc_title}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[email_address]","value":"{{validate_adhoc_email_address}}","type":"text","description":"

Format: 5 to 64 characters

\n"},{"key":"adhoc_ddi[company_name]","value":"{{validate_adhoc_company_name}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[payer_reference]","value":"{{validate_adhoc_payer_reference}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[address_1]","value":"{{validate_address1}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[address_2]","value":"{{validate_adhoc_address2}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[address_3]","value":"{{validate_adhoc_address3}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[town]","value":"{{validate_town}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[county]","value":"{{validate_adhoc_county}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[postcode]","value":"{{validate_postcode}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[country]","value":"{{validate_country}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[support_gift_aid]","value":"{{validate_support_gift_aid}}","description":"

Format: boolean, accepts 'true', 'false', 1 or 0
Default: false

\n","type":"text"},{"key":"adhoc_ddi[promotion]","value":"{{validate_adhoc_promotion}}","type":"text","description":"

Format: 1 to 8 characters

\n"}]},"url":"{{base_url}}/ddi/adhoc/validate","urlObject":{"path":["ddi","adhoc","validate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ba6b25af-3b6f-4119-b3c9-11b31fcf43a7","name":"validate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"adhoc_ddi[sort_code]","value":"{{validate_sort_code}}","type":"text","description":"Format: Sort Code – either 111111 or 11-11-11 format accepted."},{"key":"adhoc_ddi[account_number]","value":"{{validate_account_number}}","type":"text","description":"Format: 8 digit number "},{"key":"adhoc_ddi[reference_number]","value":"{{validate_reference_number}}","type":"text","description":"A unique reference number must be passed. \nFormat: plain text \nRestrictions: Unique, 6 to 18 characters May not contain solidus (/) and further restrictions apply."},{"key":"adhoc_ddi[first_name]","value":"{{validate_first_name}}","type":"text","description":"Format: plain text \nRestrictions: 1 to 32 characters"},{"key":"adhoc_ddi[last_name]","value":"{{validate_last_name}}","type":"text","description":"Format: plain text \nRestrictions: 1 to 32 characters"},{"key":"adhoc_ddi[address_1]","value":"{{validate_address1}}","type":"text","description":"Format: plain text \nRestrictions: 1 to 32 characters"},{"key":"adhoc_ddi[town]","value":"{{validate_town}}","type":"text","description":"Format: plain text \nRestrictions: 1 to 32 characters"},{"key":"adhoc_ddi[postcode]","value":"{{validate_postcode}}","type":"text","description":"Format: plain text \nRestrictions: 1 to 32 characters"},{"key":"adhoc_ddi[country]","value":"{{validate_country}}","type":"text","description":"Format: plain text \nRestrictions: 1 to 32 characters"},{"key":"adhoc_ddi[account_name]","value":"{{validate_account_name}}","type":"text","description":"Format: 8 digit number.
\nTypical sort code and account numbers to use from a test account are 000000 for the sort code and 12345678 for the account number. "},{"key":"adhoc_ddi[service_user][pslid]","value":"{{pslid}}","type":"text","description":"Format: plain text \nRestrictions: 5 to 255 characters, must match existing SU's pslid "},{"key":"adhoc_ddi[payer_reference]","value":"{{validate_adhoc_payer_reference}}","type":"text","description":"Format: plain text \nRestrictions: 0 to 18 characters
Default: none ","disabled":true},{"key":"adhoc_ddi[start_date]","value":"{{validate_adhoc_start_date}}","type":"text","description":"Format: YYYY-MM-DD \nRestrictions: Must be far enough in the future to allow the SU's lead time.","disabled":true},{"key":"adhoc_ddi[end_date]","value":"{{validate_adhoc_end_date}}","type":"text","description":"Format: YYYY-MM-DD \nRestrictions: Must be after the start time, not required to fall on a debit day. \nDefault: none","disabled":true},{"key":"adhoc_ddi[title]","value":"{{validate_adhoc_title}}","type":"text","description":"Format: plain text \nRestrictions: 0 to 255 characters \nDefault: none ","disabled":true},{"key":"adhoc_ddi[address_2]","value":"{{validate_adhoc_address2}}","type":"text","description":"Format: plain text\nRestrictions: 0 to 32 characters \nDefault: none ","disabled":true},{"key":"adhoc_ddi[address_3]","value":"{{validate_adhoc_address3}}","type":"text","description":"Format: plain text \nRestrictions: 0 to 32 characters \nDefault: none ","disabled":true},{"key":"adhoc_ddi[county]","value":"{{validate_adhoc_county}}","type":"text","description":"Format: plain text \nRestrictions: 0 to 32 characters \nDefault: none ","disabled":true},{"key":"adhoc_ddi[email_address]","value":"{{validate_adhoc_email_address}}","type":"text","description":"Format: must be a valid email format \nRestrictions: 0 to 64 characters \nDefault: none ","disabled":true},{"key":"adhoc_ddi[promotion]","value":"{{validate_adhoc_promotion}}","type":"text","description":"Format: plain text \nRestrictions: 0 to 8 characters \nDefault: none ","disabled":true},{"key":"adhoc_ddi[company_name]","value":"{{validate_adhoc_company_name}}","type":"text","description":"Format: plain text \nRestrictions: 0 to 32 characters ","disabled":true},{"key":"adhoc_ddi[debits][debit][][amount]","value":"{{validate_adhoc_dd_amount}}","type":"text","description":"Format: Integer, the value of the debit amount in pence. \nRestrictions: value between 0 and the SU's maximum_debit_amount ","disabled":true},{"key":"adhoc_ddi[debits][debit][][date]","value":"{{validate_adhoc_dd_date}}","type":"text","description":"Format: YYYY-MM-DD \nRestrictions: must be on or after the start date, and must fall on a whole number of periods after the start date ","disabled":true},{"key":"adhoc_ddi[debits][debit][][amount]","value":"1300","type":"text","description":"Format: Integer, the value of the debit amount in pence. \nRestrictions: value between 0 and the SU's maximum_debit_amount ","disabled":true},{"key":"adhoc_ddi[debits][debit][][date]","value":"2019-01-27","type":"text","description":"Format: YYYY-MM-DD \nRestrictions: must be on or after the start date, and must fall on a whole number of periods after the start date ","disabled":true},{"key":"adhoc_ddi[debits][debit][][amount]","value":"1400","type":"text","description":"Format: Integer, the value of the debit amount in pence. \nRestrictions: value between 0 and the SU's maximum_debit_amount ","disabled":true},{"key":"adhoc_ddi[debits][debit][][date]","value":"2019-02-27","type":"text","description":"Format: YYYY-MM-DD \nRestrictions: must be on or after the start date, and must fall on a whole number of periods after the start date ","disabled":true}]},"url":"{{base_url}}/api/ddi/adhoc/validate"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 22 Feb 2019 16:10:45 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.71796"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Tue, 19 Feb 2019 10:15:09 GMT; Domain=.ddprocessing.co.uk"},{"key":"Content-Length","value":"344"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"10-5559133-5566320 NNNN CT(3 21 0) RT(1550851715073 183680) q(0 0 0 -1) r(9 9) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n DDI details valid\n Bank Account supports Direct Debit Instructions\n \n"}],"_postman_id":"23d97a1a-b71d-4bfc-8632-550235f92a8e"},{"name":"ddi/adhoc/validate (with extended parameters)","id":"25e5d8cc-7657-440a-9899-74e6feec067b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"adhoc_ddi[debits][debit][][amount]","value":"{{collection_1_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"adhoc_ddi[debits][debit][][date]","value":"{{collection_1_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"},{"key":"adhoc_ddi[debits][debit][][amount]","value":"{{collection_2_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"adhoc_ddi[debits][debit][][date]","value":"{{collection_2_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"}]},"url":"{{base_url}}/ddi/adhoc/validate","description":"

When creating adhoc collections, or overriding an existing collection, pairs of amount and date values must be passed together.

\n","urlObject":{"path":["ddi","adhoc","validate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"25e5d8cc-7657-440a-9899-74e6feec067b"}],"id":"9050bf7f-c5c8-4c49-a192-8ae878151db2","description":"

Description

ddi/adhoc/validate allows an API user to check the details for a DDI without committing to creating it. It is intended to be used as part of the sign-up user journey so that when the payer confirms, the create call completes successfully.

Note:

When validating in a sandbox environment, a sort code of six zeros should be used to return a successful response. Typically an account number of 12345678 would be used.
Using eight zeros for the account number returns an error response (invalid account details).

Parameters

Mandatory parameters are:

pslid
sort code, account number, account name
first name & last name

Character restrictions apply to parameters. Accented characters and apostrophes should be removed from name and address values, as should most non-alphanumerics.

Optional parameters are listed below.

Conditional parameters (those that depend on the service user configuration) include:

reference number
email address, which is required if SmartDebit is to issue email notifications on behalf of the service user
start date (optional), which must allow sufficient time for the DDI to lodge and this interval is derived from the service user's advance notice period
start date can also be restricted to configured days of the month
debit amounts must not exceed a configured maximum

The start_date parameter serves little purpose for adhoc payers, though it can be used to batch new payer submissions and therefore reduce submission costs.

Extended parameters may be used with this call to validate the values for an optional initial set of collections. Collections are specified by pairs of parameters:

adhoc_ddi[debits][debit][][amount] - the collection amount in pence
adhoc_ddi[debits][debit][][date] - the collection date in YYYY-MM-DD format, which must be on or after the start date

It is recommended that the XML body method of parameter passing is used if multiple debits are to be validated.

Response

A successful call to ddi/adhoc/validate returns an XML document with a root tag of <successful>, with three <success> entries, the third of which includes information about the bank branch.

Note the single quotes in this response.

Errors

Errors are returned with an HTTP status other than \"200 OK\".

Missing parameters result in appropriate errors. A missing or incorrect service user returns one of the errors <error>No service user id supplied.</error>, <error>Invalid Service User ID: 'su_pslid'</error> or in the case of calling ddi/adhoc/validate for a service user configured for variable DDIs, <error>Service User 'Example SU' does not support Adhoc DDIs</error>. The error is contained in an <errors> root tag.

Omitting any required parameters or supplying invalid values for any parameter may return a listing of all validation errors in one document. For example:

422 Unprocessable Entity\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Sort code is invalid</error>\n  <error>Account name can't be blank</error>\n  <error>Account name is too short (minimum is 3 characters)</error>\n  <error>Account name only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are   permitted in account name</error>\n  <error>Last name can't be blank</error>\n  <error>Last name only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are   permitted in last names</error>\n  <error>Account number must not be empty</error>\n  <error>First name can't be blank</error>\n  <error>First name only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are   permitted in first names</error>\n</errors>\n

If all parameters pass validation, it is still possible that the bank account details are invalid. For example:

422 Unprocessable Entity\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid bank account details (Sort code not found)</error>\n</errors>\n

If extended parameters are used then the debits are validated and can generate errors.

Version history

\n\n\n\n\n\n

The adhoc_ddi[end_date] parameter is deprecated because it is used to control payment schedules and the adhoc model does not support payment schedules.

\n","event":[{"listen":"prerequest","script":{"id":"579ce3b7-7539-47e2-8669-a80ca65e0309","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"89a56697-d879-4cd6-a2ae-b06d9e3de418","type":"text/javascript","exec":[""]}}],"_postman_id":"9050bf7f-c5c8-4c49-a192-8ae878151db2"},{"name":"4.2.7 Adhoc create","item":[{"name":"ddi/adhoc/create","event":[{"listen":"test","script":{"id":"823d555b-1ac4-45cf-905a-9ed624fb03e1","exec":["pm.test(\"Response time is less than 1000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1000);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include(\"\");"," pm.expect(pm.response.text()).to.include(\"\");","});","","","//Schema Validation","var jsonObject = xml2Json(responseBody);","console.log(JSON.stringify(jsonObject));","","var schema = {"," \"definitions\": {},"," \"$schema\": \"http://json-schema.org/draft-07/schema#\","," \"$id\": \"http://example.com/root.json\","," \"type\": \"object\","," \"properties\": {"," \"adhoc_ddi\": {"," \"$id\": \"#/properties/adhoc_ddi\","," \"type\": \"object\","," \"properties\": {"," \"address_1\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/address_1\","," \"type\": \"string\""," },"," \"address_2\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/address_2\","," \"type\": \"string\""," },"," \"address_3\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/address_3\","," \"type\": \"string\""," },"," \"country\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/country\","," \"type\": \"string\""," },"," \"county\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/county\","," \"type\": \"string\""," },"," \"email_address\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/email_address\","," \"type\": \"string\""," },"," \"end_date\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/end_date\","," \"type\": \"object\","," \"properties\": {"," \"_\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/end_date/properties/_\","," \"type\": \"string\""," },"," \"$\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/end_date/properties/$\","," \"type\": \"object\","," \"properties\": {"," \"type\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/end_date/properties/$/properties/type\","," \"type\": \"string\""," }"," }"," }"," }"," },"," \"first_name\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/first_name\","," \"type\": \"string\""," },"," \"last_name\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/last_name\","," \"type\": \"string\""," },"," \"payer_reference\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/payer_reference\","," \"type\": \"string\""," },"," \"postcode\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/postcode\","," \"type\": \"string\""," },"," \"promotion\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/promotion\","," \"type\": \"string\""," },"," \"reference_number\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/reference_number\","," \"type\": \"string\""," },"," \"start_date\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/start_date\","," \"type\": \"object\","," \"properties\": {"," \"_\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/start_date/properties/_\","," \"type\": \"string\""," },"," \"$\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/start_date/properties/$\","," \"type\": \"object\","," \"properties\": {"," \"type\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/start_date/properties/$/properties/type\","," \"type\": \"string\""," }"," }"," }"," }"," },"," \"title\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/title\","," \"type\": \"string\""," },"," \"town\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/town\","," \"type\": \"string\""," },"," \"service_user\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/service_user\","," \"type\": \"object\","," \"properties\": {"," \"pslid\": {"," \"$id\": \"#/properties/adhoc_ddi/properties/service_user/properties/pslid\","," \"type\": \"string\""," }"," }"," }"," }"," }"," }","};","","","pm.test('Schema is valid', function() {"," pm.expect(tv4.validate(jsonObject, schema)).to.be.true;"," ","});","",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"fff635c3-7caf-4dda-aaa6-46b5cf988c7b","exec":["","pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","pm.environment.set(\"reference\", (sd.testing.getReferenceNumber('SD1')));","","","pm.environment.set('account_number','00000007');","pm.environment.set('sort_code', '111111');","","var d = new Date();","d.setHours(0,0,0,0);","d.setMonth(d.getMonth()+1);","","pm.environment.set('create_startdate', sd.testing.getISODate(d));","//pm.globals.set('account_number','12345678');","//pm.globals.set('sort_code', '000000');","","",""],"type":"text/javascript"}}],"id":"a4835f2a-1911-4e32-b5aa-4386c916fa20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

Required
\nService user identifier

\n","key":"adhoc_ddi[service_user][pslid]","type":"text","value":"{{pslid}}"},{"description":"

Conditional (usually required)
\nUnique identifier for the DDI
\nFormat: 6 to 18 characters. See reference number rules.

\n","key":"adhoc_ddi[reference_number]","type":"text","value":"{{reference}}"},{"description":"

Required
\nFormat: either 111111 or 11-11-11

\n","key":"adhoc_ddi[sort_code]","type":"text","value":"{{sort_code}}"},{"description":"

Required
\nFormat: 8 digit number

\n","key":"adhoc_ddi[account_number]","type":"text","value":"{{account_number}}"},{"description":"

Required
\nFormat: 3 to 18 characters

\n","key":"adhoc_ddi[account_name]","type":"text","value":"{{account_name}}"},{"description":"

Required
\nFormat: 1 to 32 characters

\n","key":"adhoc_ddi[first_name]","type":"text","value":"{{first_name}}"},{"description":"

Required
\nFormat: 1 to 32 characters

\n","key":"adhoc_ddi[last_name]","type":"text","value":"{{last_name}}"},{"key":"adhoc_ddi[start_date]","type":"text","value":"{{start_date}}","description":"

Format: YYYY-MM-DD
Default: next valid start date

\n"},{"key":"adhoc_ddi[end_date]","type":"text","value":"{{end_date}}","description":"

Deprecated
Format: YYYY-MM-DD
Default: none

\n"},{"key":"adhoc_ddi[title]","type":"text","value":"{{title}}","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[email_address]","type":"text","value":"{{email_address}}","description":"

Format: 5 to 64 characters

\n"},{"key":"adhoc_ddi[company_name]","type":"text","value":"{{company_name}}","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[payer_reference]","type":"text","value":"{{payer_reference}}","description":"

Format: 1 to 255 characters

\n"},{"description":"

Format: 1 to 255 characters

\n","key":"adhoc_ddi[address_1]","type":"text","value":"{{address1}}"},{"key":"adhoc_ddi[address_2]","type":"text","value":"{{address2}}","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[address_3]","type":"text","value":"{{address3}}","description":"

Format: 1 to 32 characters

\n"},{"description":"

Format: 1 to 255 characters

\n","key":"adhoc_ddi[town]","type":"text","value":"{{town}}"},{"key":"adhoc_ddi[county]","type":"text","value":"{{county}}","description":"

Format: 1 to 255 characters

\n"},{"description":"

Format: 1 to 255 characters

\n","key":"adhoc_ddi[postcode]","type":"text","value":"{{postcode}}"},{"description":"

Format: 1 to 255 characters

\n","key":"adhoc_ddi[country]","type":"text","value":"{{country}}"},{"key":"adhoc_ddi[support_gift_aid]","value":"{{support_gift_aid}}","description":"

Format: boolean, accepts 'true', 'false', 1 or 0
Default: false

\n","type":"text"},{"key":"adhoc_ddi[promotion]","type":"text","value":"{{promotion}}","description":"

Format: 1 to 8 characters

\n"}]},"url":"{{base_url}}/ddi/adhoc/create","urlObject":{"path":["ddi","adhoc","create"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0d6b44e6-fe2f-4107-bc03-a72fb8f1ea08","name":"create","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"A unique reference number must be passed.
Format: plain text Restrictions: Unique, 6 to 18 characters May not contain solidus (/) and further restrictions apply.","key":"adhoc_ddi[reference_number]","type":"text","value":"{{reference}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[first_name]","type":"text","value":"{{create_first_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[last_name]","type":"text","value":"{{create_last_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[address_1]","type":"text","value":"{{create_address1}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[town]","type":"text","value":"{{create_town}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[postcode]","type":"text","value":"{{create_postcode}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[country]","type":"text","value":"{{create_country}}"},{"description":"Format: plain text
Restrictions: 3 to 18 characters ","key":"adhoc_ddi[account_name]","type":"text","value":"{{create_account_name}}"},{"description":"Format: Sort Code – either 111111 or 11-11-11 format accepted.","key":"adhoc_ddi[sort_code]","type":"text","value":"{{sort_code}}"},{"description":"Format: 8 digit number ","key":"adhoc_ddi[account_number]","type":"text","value":"{{account_number}}"},{"description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid ","key":"adhoc_ddi[service_user][pslid]","type":"text","value":"{{pslid}}"},{"key":"adhoc_ddi[payer_reference]","type":"text","value":"--","disabled":true},{"key":"adhoc_ddi[start_date]","type":"text","value":"2018-10-20","disabled":true},{"key":"adhoc_ddi[end_date]","type":"text","value":"2020-01-01","disabled":true},{"key":"adhoc_ddi[title]","type":"text","value":"Mr","disabled":true},{"key":"adhoc_ddi[address_2]","type":"text","value":"--","disabled":true},{"key":"adhoc_ddi[address_3]","type":"text","value":"--","disabled":true},{"key":"adhoc_ddi[county]","type":"text","value":"Rails","disabled":true},{"key":"adhoc_ddi[email_address]","type":"text","value":"ruby_api@smartdebit.com","disabled":true},{"key":"adhoc_ddi[promotion]","type":"text","value":"12345678","disabled":true},{"key":"adhoc_ddi[company_name]","type":"text","value":"RUBY API","disabled":true}]},"url":"{{base_url}}/api/ddi/adhoc/create"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 14 Feb 2019 12:04:54 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.21920"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Mon, 11 Feb 2019 12:10:11 GMT; Domain=.ddprocessing.co.uk"},{"key":"Content-Length","value":"445"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"7-9605307-9605308 NNNN CT(3 7 0) RT(1550145927933 58) q(0 0 1 -1) r(3 3) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 1 ApiTest Road\n United Kingdom\n Test\n Smith\n RR23 3AP\n SD119011412456372\n 2019-03-01T00:00:00Z\n Bagshot\n \n apidocument\n \n"}],"_postman_id":"a4835f2a-1911-4e32-b5aa-4386c916fa20"},{"name":"ddi/adhoc/create (with extended parameters)","id":"63f34aa5-6818-4da4-a1a5-7100ebf5d657","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"adhoc_ddi[debits][debit][][amount]","value":"{{collection_1_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"adhoc_ddi[debits][debit][][date]","value":"{{collection_1_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"},{"key":"adhoc_ddi[debits][debit][][amount]","value":"{{collection_2_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"adhoc_ddi[debits][debit][][date]","value":"{{collection_2_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"}]},"url":"{{base_url}}/ddi/adhoc/create","description":"

When creating adhoc collections, or overriding an existing collection, pairs of amount and date values must be passed together.

\n","urlObject":{"path":["ddi","adhoc","create"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"63f34aa5-6818-4da4-a1a5-7100ebf5d657"}],"id":"864f7242-2c0c-4021-86da-254e7b530930","description":"

Description

ddi/adhoc/create is used to create a new payer. The call should be made only if the validate call has already returned a success result. ddi/adhoc/create takes the same parameters as ddi/adhoc/validate. An arbitrary number of debits can also be created.

Parameters

Refer to the validate section for details of the accepted parameters.

Response

A successful response from ddi/adhoc/create is an XML rendition of the payer with a root tag of adhoc_ddi. Any unpopulated optional fields on the DDI are omitted from the XML document. If extended parameters are passed, the response includes the debits.

Errors

Refer to the validate section for example error responses.

\n","event":[{"listen":"prerequest","script":{"id":"4f445f7e-c1ac-4b3f-8283-79eaba4211ab","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"863f3b6f-48a5-4c42-a781-18b669b8138a","type":"text/javascript","exec":[""]}}],"_postman_id":"864f7242-2c0c-4021-86da-254e7b530930"},{"name":"4.2.8 Adhoc update","item":[{"name":"ddi/adhoc/{{reference_number}}","event":[{"listen":"test","script":{"id":"a636b107-dcf0-4ca9-9d34-e3270a511efd","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 400ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(400);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('' + pm.environment.get('reference_number') + '');"," pm.expect(pm.response.text()).to.include('');","});","","","// SCHEMA Validation //","var result = xml2Json(responseBody); // ","var schema = sd.api.schema.updateAdhocResponse; //"," //","//var schema = sd.api.schema.dumpResponse; //"," //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //","",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"1c89a4a9-73f1-45e0-9047-d36e7f73ef58","exec":["","pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var dataGen = sd.testing;","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false);","","","var payerFormData = dataGen.json2formData(payer, 'adhoc_ddi');","//var payerFormData = dataGen.json2formData(payer, 'variable_ddi');","","const createPayerRequest = {"," url: pm.environment.get('base_url') + '/ddi/adhoc/create',"," //url: pm.environment.get('base_url') + '/api/ddi/variable/create',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: payerFormData"," }","};","","pm.sendRequest(createPayerRequest, function (err, res) {"," console.log(err ? err : res.text());"," "," pm.environment.set('reference_number', payer.reference_number);"," console.log('reference number for the payer we try to update is: ' + payer.reference_number);","});","","var debitDate = new Date();","debitDate.setHours(0,0,0,0);","debitDate = debitDate.addMonths(3);","","var newStartDate = new Date();","newStartDate.setHours(0,0,0,0);","newStartDate = newStartDate.addMonths(2);","","pm.environment.set('update_dd_amount', dataGen.randomInt(100, 10000));","pm.environment.set('update_dd_date', dataGen.getISODate(debitDate));","","pm.environment.set('update_first_name', 'Updated-Bob');","pm.environment.set('update_last_name', 'Updated-Smith');","pm.environment.set('validate_adhoc_company_name', 'Acme Co.');","pm.environment.set('update_address1', '123 SandBox Street');","pm.environment.set('update_town', 'Alfold');","pm.environment.set('update_postcode', 'GU99 9ZZ');","pm.environment.set('update_country', 'United Kingdom');","pm.environment.set('update_startdate', newStartDate);"],"type":"text/javascript"}}],"id":"943211f6-8f5f-4ac4-9d64-afbfe6959896","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"adhoc_ddi[sort_code]","value":"{{sort_code}}:","type":"text","description":"

Format: either 111111 or 11-11-11

\n"},{"key":"adhoc_ddi[account_number]","value":"{{account_number}}","type":"text","description":"

Format: 8 digit number

\n"},{"key":"adhoc_ddi[account_name]","value":"{{account_name}}","type":"text","description":"

Format: 3 to 18 characters

\n"},{"key":"adhoc_ddi[first_name]","value":"{{first_name}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[last_name]","value":"{{last_name}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[start_date]","value":"{{start_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"},{"key":"adhoc_ddi[end_date]","value":"{{end_date}}","type":"text","description":"

Deprecated
Format: YYYY-MM-DD

\n"},{"key":"adhoc_ddi[title]","value":"{{title}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[email_address]","value":"{{email_address}}","type":"text","description":"

Format: 1 to 64 characters

\n"},{"key":"adhoc_ddi[company_name]","value":"{{company_name}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[payer_reference]","value":"{{payer_reference}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[address_1]","value":"{{address_1}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[address_2]","value":"{{address_2}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[address_3]","value":"{{address_3}}","type":"text","description":"

Format: 1 to 32 characters

\n"},{"key":"adhoc_ddi[town]","value":"{{town}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[county]","value":"{{county}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[postcode]","value":"{{postcode}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[country]","value":"{{country}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"adhoc_ddi[support_gift_aid]","value":"{{support_gift_aid}}","type":"text","description":"

Format: boolean, accepts 'true', 'false', 1 or 0

\n"},{"key":"adhoc_ddi[promotion]","value":"{{promotion}}","type":"text","description":"

Format: 1 to 8 characters

\n"}]},"url":"{{base_url}}/ddi/adhoc/{{reference_number}}","description":"

All parameters are optional.

\n","urlObject":{"path":["ddi","adhoc","{{reference_number}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3c463d1d-9dd7-4b77-a908-2530c515a12e","name":"update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[first_name]","type":"text","value":"{{update_first_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[last_name]","type":"text","value":"{{update_last_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[address_1]","type":"text","value":"{{update_address1}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[town]","type":"text","value":"{{update_town}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[postcode]","type":"text","value":"{{update_postcode}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[country]","type":"text","value":"{{update_country}}"},{"description":"Format: YYYY-MM-DD
Restrictions: Must be far enough in the future to allow the SU's lead time.","key":"adhoc_ddi[start_date]","type":"text","value":"{{update_startdate}}"}]},"url":"{{base_url}}/api/ddi/adhoc/{{reference_number}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 14 Feb 2019 13:51:07 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.13529"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"463"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"14-28858955-28870981 SNNN RT(1550152240799 60054) q(0 0 0 -1) r(2 2) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 123 SandBox Street\n United Kingdom\n Updated-Bob\n Updated-Smith\n GU99 9ZZ\n SD119011413519424\n 2019-04-13T00:00:00Z\n Alfold\n \n apidocument\n \n"}],"_postman_id":"943211f6-8f5f-4ac4-9d64-afbfe6959896"},{"name":"ddi/adhoc/{{reference_number}} (with extended parameters)","event":[{"listen":"test","script":{"id":"a636b107-dcf0-4ca9-9d34-e3270a511efd","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 400ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(400);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('' + pm.environment.get('reference_number') + '');"," pm.expect(pm.response.text()).to.include('');","});","","","// SCHEMA Validation //","var result = xml2Json(responseBody); // ","var schema = sd.api.schema.updateAdhocResponse; //"," //","//var schema = sd.api.schema.dumpResponse; //"," //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //","",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"1c89a4a9-73f1-45e0-9047-d36e7f73ef58","exec":["","pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var dataGen = sd.testing;","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false);","","","var payerFormData = dataGen.json2formData(payer, 'adhoc_ddi');","//var payerFormData = dataGen.json2formData(payer, 'variable_ddi');","","const createPayerRequest = {"," url: pm.environment.get('base_url') + '/ddi/adhoc/create',"," //url: pm.environment.get('base_url') + '/api/ddi/variable/create',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: payerFormData"," }","};","","pm.sendRequest(createPayerRequest, function (err, res) {"," console.log(err ? err : res.text());"," "," pm.environment.set('reference_number', payer.reference_number);"," console.log('reference number for the payer we try to update is: ' + payer.reference_number);","});","","var debitDate = new Date();","debitDate.setHours(0,0,0,0);","debitDate = debitDate.addMonths(3);","","var newStartDate = new Date();","newStartDate.setHours(0,0,0,0);","newStartDate = newStartDate.addMonths(2);","","pm.environment.set('update_dd_amount', dataGen.randomInt(100, 10000));","pm.environment.set('update_dd_date', dataGen.getISODate(debitDate));","","pm.environment.set('update_first_name', 'Updated-Bob');","pm.environment.set('update_last_name', 'Updated-Smith');","pm.environment.set('validate_adhoc_company_name', 'Acme Co.');","pm.environment.set('update_address1', '123 SandBox Street');","pm.environment.set('update_town', 'Alfold');","pm.environment.set('update_postcode', 'GU99 9ZZ');","pm.environment.set('update_country', 'United Kingdom');","pm.environment.set('update_startdate', newStartDate);","","","//var debitDate = new Date();","//debitDate.setHours(0,0,0,0);","//debitDate = debitDate.addMonths(4);","","pm.environment.set('update_dd_amount', dataGen.randomInt(100, 10000));","pm.environment.set('update_dd_date', dataGen.getISODate(debitDate));"],"type":"text/javascript"}}],"id":"ca334952-76f2-426f-bf8b-9063fe6735f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"adhoc_ddi[debits][debit][][amount]","value":"{{collection_1_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"adhoc_ddi[debits][debit][][date]","value":"{{collection_1_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"},{"key":"adhoc_ddi[debits][debit][][amount]","value":"{{collection_2_amount}}","type":"text","description":"

Format: integer, the value of the debit amount in pence

\n"},{"key":"adhoc_ddi[debits][debit][][date]","value":"{{collection_2_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"}]},"url":"{{base_url}}/ddi/adhoc/{{reference_number}}","description":"

When creating adhoc collections, or overriding an existing collection, pairs of amount and date values must be passed together.

\n","urlObject":{"path":["ddi","adhoc","{{reference_number}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2be6d8fe-5b4e-4874-a1a1-3cdabcabf612","name":"update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[first_name]","type":"text","value":"{{update_first_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[last_name]","type":"text","value":"{{update_last_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[address_1]","type":"text","value":"{{update_address1}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[town]","type":"text","value":"{{update_town}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[postcode]","type":"text","value":"{{update_postcode}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[country]","type":"text","value":"{{update_country}}"},{"description":"Format: YYYY-MM-DD
Restrictions: Must be far enough in the future to allow the SU's lead time.","key":"adhoc_ddi[start_date]","type":"text","value":"{{update_startdate}}"}]},"url":"{{base_url}}/api/ddi/adhoc/{{reference_number}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 14 Feb 2019 13:51:07 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.13529"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"463"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"14-28858955-28870981 SNNN RT(1550152240799 60054) q(0 0 0 -1) r(2 2) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 123 SandBox Street\n United Kingdom\n Updated-Bob\n Updated-Smith\n GU99 9ZZ\n SD119011413519424\n 2019-04-13T00:00:00Z\n Alfold\n \n apidocument\n \n"}],"_postman_id":"ca334952-76f2-426f-bf8b-9063fe6735f3"},{"name":"ddi/adhoc/{{reference_number}}/update","event":[{"listen":"test","script":{"id":"a636b107-dcf0-4ca9-9d34-e3270a511efd","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 400ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(400);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('' + pm.environment.get('reference_number') + '');"," pm.expect(pm.response.text()).to.include('');","});","","","// SCHEMA Validation //","var result = xml2Json(responseBody); // ","var schema = sd.api.schema.updateAdhocResponse; //"," //","//var schema = sd.api.schema.dumpResponse; //"," //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //","",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"1c89a4a9-73f1-45e0-9047-d36e7f73ef58","exec":["","pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var dataGen = sd.testing;","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false);","","","var payerFormData = dataGen.json2formData(payer, 'adhoc_ddi');","//var payerFormData = dataGen.json2formData(payer, 'variable_ddi');","","const createPayerRequest = {"," url: pm.environment.get('base_url') + '/ddi/adhoc/create',"," //url: pm.environment.get('base_url') + '/api/ddi/variable/create',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: payerFormData"," }","};","","pm.sendRequest(createPayerRequest, function (err, res) {"," console.log(err ? err : res.text());"," "," pm.environment.set('reference_number', payer.reference_number);"," console.log('reference number for the payer we try to update is: ' + payer.reference_number);","});","","var debitDate = new Date();","debitDate.setHours(0,0,0,0);","debitDate = debitDate.addMonths(3);","","var newStartDate = new Date();","newStartDate.setHours(0,0,0,0);","newStartDate = newStartDate.addMonths(2);","","pm.environment.set('update_dd_amount', dataGen.randomInt(100, 10000));","pm.environment.set('update_dd_date', dataGen.getISODate(debitDate));","","pm.environment.set('update_first_name', 'Updated-Bob');","pm.environment.set('update_last_name', 'Updated-Smith');","pm.environment.set('validate_adhoc_company_name', 'Acme Co.');","pm.environment.set('update_address1', '123 SandBox Street');","pm.environment.set('update_town', 'Alfold');","pm.environment.set('update_postcode', 'GU99 9ZZ');","pm.environment.set('update_country', 'United Kingdom');","pm.environment.set('update_startdate', newStartDate);"],"type":"text/javascript"}}],"id":"cf1200ab-3490-4fd6-9686-b0f66a24b3e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{base_url}}/ddi/adhoc/{{reference_number}}/update","description":"

This is an alias for the PUT update call. The same parameters as above can be used with this version.

\n","urlObject":{"path":["ddi","adhoc","{{reference_number}}","update"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d80e3f19-834a-476a-95b6-e72ff4d32557","name":"update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[first_name]","type":"text","value":"{{update_first_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[last_name]","type":"text","value":"{{update_last_name}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[address_1]","type":"text","value":"{{update_address1}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[town]","type":"text","value":"{{update_town}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[postcode]","type":"text","value":"{{update_postcode}}"},{"description":"Format: plain text
Restrictions: 1 to 32 characters","key":"adhoc_ddi[country]","type":"text","value":"{{update_country}}"},{"description":"Format: YYYY-MM-DD
Restrictions: Must be far enough in the future to allow the SU's lead time.","key":"adhoc_ddi[start_date]","type":"text","value":"{{update_startdate}}"}]},"url":"{{base_url}}/api/ddi/adhoc/{{reference_number}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 14 Feb 2019 13:51:07 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.13529"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"463"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"14-28858955-28870981 SNNN RT(1550152240799 60054) q(0 0 0 -1) r(2 2) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 123 SandBox Street\n United Kingdom\n Updated-Bob\n Updated-Smith\n GU99 9ZZ\n SD119011413519424\n 2019-04-13T00:00:00Z\n Alfold\n \n apidocument\n \n"}],"_postman_id":"cf1200ab-3490-4fd6-9686-b0f66a24b3e2"}],"id":"5bae7530-c86e-4e23-8616-1f05708cf16e","description":"

Syntax

PUT {{base_url}}/ddi/adhoc/{{reference_number}}\n

aliased as

POST {{base_url}}/ddi/adhoc/{{reference_number}}/update\n

Description

The update method allows the attributes of a payer to be amended and collections to be created and updated. The update may result in an amendment email being sent to the payer.

The DDI reference number cannot be changed. Cancelled DDIs cannot be updated.

If the reference number contains solidus, it must be urlencoded.

This method should be used for 'adhoc' payers and does not support payment schedules.

Parameters

The start_date parameter serves little purpose for adhoc payers. There is unlikely to be any reason to update it.

A dummy parameter, e.g. adhoc_ddi[dummy], may be used to simply return the payer details without performing an update.

Response

A successful response from ddi/adhoc/{{reference_number}} is an XML rendition of the payer with a root tag of adhoc_ddi. Any unpopulated optional fields on the payer are omitted from the XML document. The entire payer and any debits are always returned regardless of the number of attributes updated. For instance,

PUT /api/ddi/adhoc/ABC106093 \n<?XML version=\"1.0\" encoding=\"UTF-8\"?> \n<adhoc_ddi>\n  <first_name>John</first_name>\n</adhoc_ddi>\n

could return:

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<adhoc_ddi>\n  <reference_number>ABC106093</reference_number>\n  <first_name>John</first_name>\n  <last_name>Smith</last_name>\n  <start_date type=\"datetime\">2018-07-01T00:00:00Z</start_date>\n  <address_1>123 Fake St</address_1>\n  <town>London</town>\n  <postcode>sw2 3ed</postcode>\n  <country>United Kingdom</country>\n  <service_user>\n    <pslid>su_pslid</pslid>\n  </service_user>\n</adhoc_ddi> \n

The same is true of updating the debits on a DDI. For instance,

PUT /api/ddi/adhoc/ABC106093 \n<?XML version=\"1.0\" encoding=\"UTF-8\"?>\n<adhoc_ddi>\n  <debits> \n    <debit>\n      <amount>500</amount><date>2019-08-01</date>\n    </debit>\n  </debits>\n</adhoc_ddi>\n

could return

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<adhoc_ddi>\n  <reference_number>ABC106093</reference_number>\n  <first_name>John</first_name>\n  <last_name>Smith</last_name>\n  <start_date type=\"datetime\">2018-07-01T00:00:00Z</start_date>\n  <address_1>123 Fake St</address_1>\n  <town>London</town>\n  <postcode>sw2 3ed</postcode> \n  <country>United Kingdom</country>\n  <debits type=\"array\"> \n    <debit type=\"DdaDebit\">\n      <amount type=\"integer\">1500</amount>\n      <debit_date type=\"datetime\">2019-07-01T00:00:00Z</debit_date>\n    </debit> \n    <debit>\n      <amount type=\"integer\">500</amount>\n      <debit_date type=\"datetime\">2019-08-01T00:00:00Z</debit_date>\n    </debit>\n  </debits>\n  <service_user>\n    <pslid>su_pslid</pslid>\n  </service_user>\n</adhoc_ddi>\n

Amounts are given in pence.

Collection statuses are not provided. The presence of a collection does not mean that it was paid, nor even that it was submitted.

Errors

Error responses are similar to the error responses for ddi/adhoc/validate and ddi/adhoc/create. Missing parameters result in appropriate errors. Passing no parameters at all returns:

400 Bad Request \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Direct Debit parameters not supplied.</error>\n</errors> \n

Attempting to update with an incorrect reference number returns:

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Adhoc Direct Debit 'AAAAAA' not found.</error>\n</errors>\n

Attempting to update a 'variable' DDI returns the same response.

Supplying invalid values for any parameter may return a listing of all validation errors in one document. For example:

422 Unprocessable Entity \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Last name only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are permitted in last names</error>\n  <error>Start date must be in the future</error>\n  <error>Start date must be on or after 01/03/2019</error>\n  <error>First name only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are permitted in first names</error>\n</errors>\n

422 Unprocessable Entity\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Amount must be less than &#163;250.00</error>\n  <error>Debit date must not be before the start of the DDI: 2018/07/01 00:00</error>\n</errors>\n

Version history

\n\n\n\n\n\n

The adhoc_ddi[end_date] parameter is deprecated because it is used to control payment schedules and the adhoc model does not support payment schedules.

","event":[{"listen":"prerequest","script":{"id":"70a5c701-5281-4ed8-8dff-1f2d942da905","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d271d5de-4456-450d-b597-b690f2330de5","type":"text/javascript","exec":[""]}}],"_postman_id":"5bae7530-c86e-4e23-8616-1f05708cf16e"},{"name":"4.2.9 Adhoc cancel","item":[{"name":"ddi/adhoc/{{reference_number}}/cancel","event":[{"listen":"test","script":{"id":"de3c41c3-7d83-4beb-a28f-2f7322fb16d4","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('' + pm.environment.get('reference_number_to_cancel') + '');"," pm.expect(pm.response.text()).to.include('');","});","","","// SCHEMA Validation //","var result = xml2Json(responseBody); // ","var schema = sd.api.schema.updateAdhocResponse; //","// //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //","","","//pm.environment.set(\"api_cancel_adhoc_response_2\", pm.response.text());"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f68927c4-6304-4373-8a8f-90956c01555a","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var dataGen = sd.testing;","","var payer = dataGen.getJsonPayer(pm.environment.get('pslid'), dataGen.getReferenceNumber('SD1'), 3, false);","","//This needs only for variable payers","//payer.frequency_type = 'M';","//payer.email_address = 'test-ruby@smartdebt.com';","","","var payerFormData = dataGen.json2formData(payer, 'adhoc_ddi');","//var payerFormData = dataGen.json2formData(payer, 'variable_ddi');","","const createPayerRequest = {"," url: pm.environment.get('base_url') + '/ddi/adhoc/create',"," //url: pm.environment.get('base_url') + '/api/ddi/variable/create',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: payerFormData"," }","};","","pm.sendRequest(createPayerRequest, function (err, res) {"," console.log(err ? err : res.text());"," "," pm.environment.set('reference_number_to_cancel',payer.reference_number);"," console.log('reference number for the payer we will cancel is: ' + payer.reference_number);","});"],"type":"text/javascript"}}],"id":"55d6aca6-64f1-4b38-a158-d7ca5897f2c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{base_url}}/ddi/adhoc/{{reference_number_to_cancel}}/cancel","urlObject":{"path":["ddi","adhoc","{{reference_number_to_cancel}}","cancel"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7820925a-427c-45dc-aae4-43e29226c42f","name":"cancel_adhoc","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/api/ddi/adhoc/{{reference_number_to_cancel}}/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 22 Feb 2019 16:07:55 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.54349"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"516"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=93"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"10-5559133-5559134 SNNN RT(1550851715073 14432) q(0 0 0 -1) r(6 6) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n 2 Church Street\n 2019-02-22T16:07:56Z\n United Kingdom\n Donna\n Hoffmann\n W1A 0AX\n SD11901221687952\n 2019-04-01T00:00:00Z\n Bagshot\n \n apidocument\n \n"}],"_postman_id":"55d6aca6-64f1-4b38-a158-d7ca5897f2c0"}],"id":"2920cee3-c966-4690-921d-4fcd2d5d2253","description":"

The cancel method allows a DDI to be cancelled. Cancelling a DDI may result in a cancellation email being sent to the payer.

If the reference number contains solidus, it must be urlencoded.

Response

A successful response is an XML rendition of the DDI with a root tag of adhoc_ddi. The cancellation time is included as cancelled_on. Any unpopulated optional fields on the DDI are omitted from the XML document.

Cancelling an already-cancelled DDI returns a success response but performs no action.

Errors

Attempting to cancel with an incorrect reference number returns:

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Adhoc Direct Debit 'AAAAAA' not found.</error>\n</errors>\n

Attempting to cancel a variable DDI returns the same response.

\n","event":[{"listen":"prerequest","script":{"id":"18d0d118-a472-4963-9968-3b2c3171825f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"68b458c0-2846-4bc5-a71a-14b1c4a51a82","type":"text/javascript","exec":[""]}}],"_postman_id":"2920cee3-c966-4690-921d-4fcd2d5d2253"},{"name":"4.2.10 Adhoc reinstate","item":[{"name":"ddi/adhoc/{{reference_number}}/reinstate","id":"7c75f31a-9b5d-4dc0-b709-084cfb336146","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{base_url}}/ddi/adhoc/{{reference_number}}/reinstate","urlObject":{"path":["ddi","adhoc","{{reference_number}}","reinstate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c75f31a-9b5d-4dc0-b709-084cfb336146"}],"id":"2a323a26-9acc-4f9e-8900-65e846eefd63","description":"

The reinstate method allows a cancelled DDI to be made live again. Reinstating a DDI may result in a reinstatement email being sent to the payer.

If the reference number contains solidus, it must be urlencoded.

Response

A successful response is an XML rendition of the DDI with a root tag of adhoc_ddi. Any unpopulated optional fields on the DDI are omitted from the XML document. The fact that the response does not include a cancelled_on field indicates that the DDI is live.

Reinstating a DDI that is already live returns a success response but performs no action.

Errors

Attempting to reinstate with an incorrect reference number returns:

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<errors>\n    <error>Adhoc Direct Debit 'AAAAAA' not found.</error>\n</errors>\n

Attempting to reinstate a variable DDI returns the same response.

\n","event":[{"listen":"prerequest","script":{"id":"73195b47-db07-484a-831b-11810ff12221","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6dd077fb-dd91-464c-a99a-ad7f241ffd46","type":"text/javascript","exec":[""]}}],"_postman_id":"2a323a26-9acc-4f9e-8900-65e846eefd63"}],"id":"93ecfda9-5948-4a05-a753-683e5711afb2","description":"

Twin sets of endpoints are available. The endpoint that you use depends on the chosen processing model (variable or adhoc).

\n","event":[{"listen":"prerequest","script":{"id":"0f8bb343-da60-4d14-87e7-d9a1922bd8ff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ebd45d1d-13d2-420f-8ee5-f735a32bbefa","type":"text/javascript","exec":[""]}}],"_postman_id":"93ecfda9-5948-4a05-a753-683e5711afb2"},{"name":"4.3 Retrieve payer","item":[{"name":"data/dump","event":[{"listen":"prerequest","script":{"id":"f8e9ea1b-34f4-44f5-bbdb-a19c10aac01a","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var searchFilter = {};","searchFilter.service_user = {};","searchFilter.service_user.pslid = pm.environment.get('pslid');","searchFilter.report_format = 'XML';","searchFilter.include_header = 'true';","console.log(searchFilter);","","var postData = sd.testing.json2formData(searchFilter, 'query');","","console.log(postData);","","const dataDumpRequest = {"," url: pm.environment.get('base_url') + '/data/dump',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: postData"," }","};","","","pm.sendRequest(dataDumpRequest, function (err, res) {"," //console.log(err ? err : res.text());"," var dataDump = xml2Json(res.text());"," "," //console.log(dataDump.DataDump.Data.PayerDetails[0].$.reference_number);"," pm.environment.set('datadump_reference_number', dataDump.DataDump.Data.PayerDetails[0].$.reference_number);"," //console.log('reference number for the payer we try to update is: ' + payer.reference_number);","});",""],"type":"text/javascript"}},{"listen":"test","script":{"id":"baef55a6-878a-48e1-9441-7d829a5ed515","exec":["// Documentation refers to a POST request in this case","","eval(pm.globals.get('object_comparer'));","eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 800ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(800);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," ","});","","","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","// SCHEMA Validation //","/*var result = xml2Json(responseBody); // "," //","var schema = sd.api.schema.dumpResponse; //"," //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //","","// pull the first record returned nd store for later","pm.environment.set(\"reference_number\", result.DataDump.Data.PayerDetails[0].$.reference_number);","","var apiDataDampOriginal = xml2Json(responseBody);","var newApiDataDamp = xml2Json(pm.environment.get(\"api_data_dump_response\"));","","///////////////////////////////////WARNING/////////////////////////////////////////////////////","//This will print a massive object into the console which tend to breack the Postman Console.//","//console.log(CompareObject(apiDataDampOriginal,newApiDataDamp,0)); //","///////////////////////////////////WARNING/////////////////////////////////////////////////////","","pm.test(\"Json objects are matching\", function () {"," pm.expect(CompareObject(apiDataDampOriginal,newApiDataDamp,0)).to.be.true;","});","*/"],"type":"text/javascript"}}],"id":"55dcb194-1e80-4f6c-a3d5-bcbd2c228f46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

Required
\nService user identifier

\n","key":"query[service_user][pslid]","type":"text","value":"{{pslid}}"},{"description":"

Format: 'CSV' or 'XML'
Default: XML

\n","key":"query[report_format] ","type":"text","value":"{{report_format}}"},{"description":"

Bacs reference as payer identifier

\n","key":"query[reference_number]","type":"text","value":"{{reference_number}}"},{"description":"

Deprecated
Format: 'true' or 'false'
Default: false

\n","key":"query[include_header] ","type":"text","value":"{{include_header}}"}]},"url":"{{base_url}}/data/dump","urlObject":{"path":["data","dump"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"55dcb194-1e80-4f6c-a3d5-bcbd2c228f46"}],"id":"2b78be39-712e-407c-ab49-0dc19e43e322","description":"

The data/dump call is used to retrieve details of a payer or of all payers for a service user.

Caution: When used without a reference_number parameter the call takes a long time to respond. Avoid excessive use of this call to list all payers and do not re-try.

Note: A single payer's details can also be obtained from an update call. The two methods are slightly different and are compared in section 3.3.4.

Parameters

query[service_user][pslid] is mandatory and specifies the service user
query[reference_number] specifies a single payer
query[report_format]=CSV can be used to specify a response in CSV format (the default is XML)
query[include_header]=true can be used to specify a header row (deprecated)

Response

A successful call to data/dump returns a document in the specified format.

The following values are returned. If CSV format, they are returned in this order.

payerReference (XML) / payer_reference (CSV)
reference_number
frequency_type
frequency_factor
start_date
title
first_name
last_name
email_address
address_1
address_2
address_3
town
county
postcode
regular_amount
first_amount
current_state
support_gift_aid

Notes:

payer_reference is an alias for customer_id
reference_number is the unique reference for the payer
start_date is returned in YYYY-MM-DD format (XML) or YYYY/MM/DD format (CSV)
account details are, by default, not returned
amounts are given in pounds and pence - with a currency symbol (£) or without a currency symbol (CSV)
support_gift_aid may take the value \"true\" or \"false\"
blank fields in CSV format may or may not be quoted
end date is not returned

The values for current_state and their meanings are as follows:

0 or 1 = draft
\n10 = live
\n11 = cancelled

Service users with their own SUN are able to retrieve the payer's account details – account name, account number and sort code - subject to a setting held against the service user in SmartDebit. This applies only to the retrieval of individual payer details (passing a reference number in the call). To enable the setting, please make a request to support@smartdebit.com.

Adhoc payers do not have values for frequency_type, first_amount or regular_amount.

If query[report_format]=CSV and query[include_header]=true are specified then the first line of output is:

\"payer_reference,reference_number,frequency_type,frequency_factor, start_date,title,first_name,last_name,email_address,address_1,address_2,address_3,town,county,postcode,regular_amount,first_amount,current_state,support_gift_aid\"\n

Errors

Invalid service user

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid Service User ID: 'su_pslid'</error>\n</errors>\n

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Permission denied. You cannot access the requested resource.</error>\n</errors>\n

Reference number does not exist

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Database is empty.</error>\n</errors>\n

\n\n\n

Version history

\n\n\n\n\n\n

The query[include_header] parameter is deprecated because the header is incorrectly formatted.

\n","event":[{"listen":"prerequest","script":{"id":"846e8487-5f7f-4332-ae4c-ed4108b2c507","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cec5899b-e847-41d7-ad4f-1c5842fbe7eb","type":"text/javascript","exec":[""]}}],"_postman_id":"2b78be39-712e-407c-ab49-0dc19e43e322"},{"name":"4.4 Data file import","item":[{"name":"4.4.1 Payer file - asynchronous import","item":[{"name":"payer_file/async_import","event":[{"listen":"test","script":{"id":"3228d4d5-ffa8-49fa-accf-837f53e2ba77","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 600ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(600);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," //pm.expect(pm.response.text()).to.include(`'+pm.environment.get('updatedPayerFile_Name') +'')"," pm.expect(pm.response.text()).to.include(''+pm.environment.get('pslid')+'')","});","","","// SHEMA Validation //","var result = xml2Json(responseBody); //"," //"," var schema = sd.api.schema.payerFileResponse; //"," //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true;//"," }); //","// SHEMA Validation //","","var res = result.payer_file_import.$.uri.split('/');","pm.environment.set('payer_file_import_id',res[res.length-1]);"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"8c2df2e4-952d-4010-bf6b-0f3e176f0213","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","pm.environment.set('payer_file_name',sd.testing.getPayerFile.fileName() );","","var payerFile = sd.testing.getPayerFile.file(6, true,true, 6, 'SD1', true);","","pm.environment.set('file', payerFile);","pm.environment.set('fileNotBase64',atob(payerFile));","","pm.environment.set('emptyFile', '');","","var updatedPayerFile = \"\";","console.log(payerFile);","console.log(atob(payerFile));","","var lines = atob(payerFile).split('\\r\\n');","","console.log(lines);","//console.log(lines);","for (var line in lines)","{"," if(lines[line] ===\"\") {continue;}"," //console.log(lines[line]);"," var elements = lines[line].split(',');"," //console.log (elements[15]);"," var newName = elements[15] + ' Wilde';"," elements[15] =newName;"," console.log (elements[15]);"," elements[30] = sd.testing.randomInt(1,99) + '.' + sd.testing.randomInt(1,99);"," elements[36] = sd.testing.randomInt(1,28).pad(2);"," var newLine = elements.join(',');"," console.log(newLine);"," updatedPayerFile += newLine;","}","","console.log(updatedPayerFile);","pm.environment.set('updatedPayerFile_Name',sd.testing.getPayerFile.fileName() );","pm.environment.set('updatedPayerFile',btoa(updatedPayerFile) );"],"type":"text/javascript"}}],"id":"f87ce3d9-f04a-4877-9a36-6bd7b42b7357","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

Service user identifier

\n","key":"payer_file_import[service_user][pslid]","type":"text","value":"{{pslid}}"},{"description":"

Format: 1 to 255 characters

\n","key":"payer_file_import[file_name]","type":"text","value":"{{file_name}}"},{"description":"

Format: Base64 encoded multiline comma separated values. See payer file format.

\n","key":"payer_file_import[file]","type":"text","value":"{{file}}"},{"description":"

Format: 'CREATE' or 'UPDATE'

\n","key":"payer_file_import[action]","type":"text","value":"{{action}}"}]},"url":"{{base_url}}/payer_file/async_import","description":"

All parameters are required.

\n","urlObject":{"path":["payer_file","async_import"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"90e568d8-a57f-44fb-bb1e-692edaae56fc","name":"import payer file (UPDATE)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"payer_file_import[action]","value":"UPDATE","type":"text","description":"Format: plain text
Restrictions: 'CREATE' or 'UPDATE'"},{"key":"payer_file_import[file_name]","value":"{{updatedPayerFile_Name}}","type":"text","description":"Format: plain text"},{"key":"payer_file_import[file]","value":"{{updatedPayerFile}}","type":"text","description":"Format: Base64 encoded multi line comma separated value (46 fields per entry) TODO: link for 46 field explanation"},{"key":"payer_file_import[service_user][pslid]","value":"{{pslid}}","type":"text","description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid"}]},"url":"{{base_url}}/api/payer_file/async_import"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 26 Feb 2019 14:31:21 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Runtime","value":"0.19998"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Content-Length","value":"425"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"5-14159042-14159065 NNNN CT(4 8 0) RT(1551191544745 76) q(0 0 0 -1) r(2 2) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n UPDATE\n test_file_name_2019-02-26T14_31_35.727Z\n \n apidocument\n \n \n \n \n \n"}],"_postman_id":"f87ce3d9-f04a-4877-9a36-6bd7b42b7357"}],"id":"ada59f4f-9f29-4c87-ba37-5db8e2d8adda","description":"

Description

Payer file import is an asynchronous service. A payer file can be enqueued for import via the payer_file/async_import call and the status of the import, and results on completion, can be queried via the payer_file/{{import_id}} call.

A payer file can be used to create new DDIs or update existing DDIs. The file must be Base64 encoded. Files are broken into 100-line chunks for parallel processing.

The service user is specified using the payer_file_import[service_user][pslid] parameter.
The file name is specified using the payer_file_import[file_name] parameter.
The file content is supplied, base64-encoded, as the payer_file_import[file] parameter. Refer to the file format specification.
The payer_file_import[action] parameter indicates whether the file represents CREATE or UPDATE actions.

Response

A successful call to payer_file/async_import returns an XML version of the enqueued import. The root tag of <payer_file_import> includes a URI attribute that identifies this import, and can be used to poll for the progress of the import. Each of the queued payer file chunks is listed in the <file_chunks> grouping tag. Each <file_chunk> tag includes the lines included in the chunk, and the current status of the chunk – the response from payer_file/async_import always has the status \"In process - please wait\".

Errors

No parameters supplied

\n\n

400 Bad Request \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Payer File parameters not supplied.</error>\n</errors>\n

Missing or invalid service user

\n\n

400 Bad Request \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

\n\n

400 Bad Request \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid Service User ID: 'su_pslid'</error>\n</errors>\n

File name not supplied

\n\n

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>File name not supplied.</error>\n</errors>\n

Missing or invalid action

\n\n

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>An import action of 'CREATE' or 'UPDATE' must be supplied</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"314498d1-3b7e-4b3b-bc07-323b66ee4e54","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7d28afd6-c546-4d38-b343-898e899d432b","type":"text/javascript","exec":[""]}}],"_postman_id":"ada59f4f-9f29-4c87-ba37-5db8e2d8adda"},{"name":"4.4.2 Payer file import status","item":[{"name":"payer_file/{{import_id}}","event":[{"listen":"test","script":{"id":"f6c13798-d6cf-406c-be08-2b55320dbcb5","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include(`\n\n CREATE\n 2019-02-26T14:41:51Z\n test_file_name_2019-02-26T14_42_01.144Z\n \n apidocument\n \n \n \n \n \n \n Line 1: Not imported: frequency_type: must be in list, start_date: must be on or after 30/03/2019\n Line 2: Not imported: start_date: must be on or after 30/03/2019\n Line 3: Not imported: frequency_type: must be in list, start_date: must be on or after 30/03/2019\n Line 4: Not imported: start_date: must be on or after 30/03/2019\n Line 5: Not imported: start_date: must be on or after 30/03/2019\n Line 6: Not imported: start_date: must be on or after 30/03/2019\n \n \n \n"}],"_postman_id":"7922b1e8-bc71-4def-b8c6-68ae846ec606"}],"id":"e0803f58-543a-49c9-afae-f35f0252b00b","description":"

Description

payer_file/{{import_id}} can be used to query the status of a payer file import and to get the results on completion.

Response

A successful call to payer_file/{{import_id}} returns an XML document containing the status of the enqueued import. Each of the queued payer file chunks is listed in the <file_chunks> grouping tag. Each <file_chunk> tag includes the lines included in the chunk and the current status of the chunk. As each chunk is processed, its status moves through the following values:

In process - please wait
allocated
started
Import complete, click here for result

Once a chunk has completed, a listing of the changes made is included in the <file_chunk> in a <successes> group tag. Similarly, any failed lines or errors are listed in an <errors> group tag:

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<payer_file_import uri=\"https://sandbox.ddprocessing.co.uk/api/payer_file/123\">\n  <action>CREATE</action>\n  <completed_on>2019-05-12T12:04:21Z</completed_on>\n  <file_name>payer_file.csv</file_name>\n  <service_user>\n    <pslid>su_pslid</pslid>\n  </service_user>\n  <file_chunks>\n    <file_chunk to_line=\"10\" status=\"Import complete, click here for result\" from_line=\"1\">\n      <successes total=\"8\">\n        <success>Line 1: VariableDdi ABC153242 created.</success>\n        <success>Line 3: VariableDdi ABC153243 created.</success>\n        <success>Line 5: VariableDdi ABC153244 created.</success>\n        <success>Line 6: VariableDdi ABC153245 created.</success>\n        <success>Line 7: VariableDdi ABC153246 created.</success>\n        <success>Line 8: VariableDdi ABC153247 created.</success>\n        <success>Line 9: VariableDdi ABC153248 created.</success>\n        <success>Line 10: VariableDdi ABC153249 created.</success>\n      </successes>\n      <errors total=\"2\">\n        <error>Line 2: Too few fields, expected 46 but found 45.</error>\n        <error>Line 4: Too few fields, expected 46 but found 45.</error>\n      </errors>\n    </file_chunk>\n  </file_chunks>\n</payer_file_import>\n

Note:

The line number reported in each <success> or <error> tag is relative to the chunk and not necessarily the whole file.
<error> tags indicate that a payer was not imported. They are significant.
The HTTP status relates to the call and not to the import. A line, a chunk or the whole file may fail to import, despite an HTTP status of \"200 OK\".

Errors

Querying the status of an invalid file results in one of these two errors:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find ParallelTask with ID=1524</error>\n</errors>\n

\n\n

401 Unauthorized\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Permission denied. You cannot access the requested resource.</error>\n</errors>\n

An example data format error

\nThis example response is from a two-line file in which the first line is a header and the second has a comma in address line 1. The data are not enclosed in double quotes.\n\n

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<payer_file_import uri=\"https://sandbox.ddprocessing.co.uk/api/payer_file/737\">\n  <action>CREATE</action>\n  <completed_on>2019-05-07T10:20:48Z</completed_on>\n  <file_name>payer.csv</file_name>\n  <service_user>\n    <pslid>apidocument</pslid>\n  </service_user>\n  <file_chunks>\n    <file_chunk status=\"Import complete, click here for result\" from_line=\"1\" to_line=\"2\">\n      <successes total=\"0\">\n      </successes>\n      <errors total=\"2\">\n        <error>Line 1: Not imported: start_date: unable to parse date: 'StartYear,StartMonth,StartDate'</error>\n        <error>Line 2: Too many fields, expected 46 but found 47.</error>\n      </errors>\n    </file_chunk>\n  </file_chunks>\n</payer_file_import>\n

Had the data been quoted, the line 2 error would have been different:

        <error>Line 2: Not imported: address_1: only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are permitted in address 1, address_1: only letters, numbers, spaces, hyphens, forward slash, ampersand and full stops are permitted in address 2</error>\n

A formatting error may cause the whole file or chunk to fail:
\nIn this case there is no <success> node and only one <error>.\n\n
```
<file_chunk status=\"failed\" from_line=\"1\" to_line=\"3\">\n
```
For example, an email address of the form joe.bloggs\"at\"gmail.com.
\n

Contact SmartDebit support if a file or chunk remains stuck at
\n\n
```
In process - please wait\n
```

","event":[{"listen":"prerequest","script":{"id":"3b2524a2-dcf9-446a-ba58-ef1e06f083d0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d441df5d-ba86-4f47-9721-7a57efef42c7","type":"text/javascript","exec":[""]}}],"_postman_id":"e0803f58-543a-49c9-afae-f35f0252b00b"},{"name":"4.4.3 Collection file - synchronous import","item":[{"name":"charge_file/import","event":[{"listen":"test","script":{"id":"ea3f55fa-b8cc-4960-ad57-6f9d10ee7c97","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 400ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(400);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","var response = xml2Json(responseBody);","","//console.log(response);","//console.log(JSON.stringify(response));","","var schema = sd.api.schema.collectionFile;","","pm.test('Schema is valid', function() {"," pm.expect(tv4.validate(response, schema)).to.be.true;","});","","var newResponse = pm.environment.get('new_collectionFile_response');","","console.log('new API collectionFile response: ');","console.log(newResponse);"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"a8018d84-592c-4584-b209-fa761cf99df5","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","var dataGen = sd.testing;","","pm.environment.set('collection_file_name_date', sd.testing.getPayerFile.fileName());","","console.log(pm.environment.get('collection_file_name_date'));","","console.log(sd.testing.getCollectionFile(2, [{ start_date: new Date().addDays(5), reference_number: 'ABSDER155415' }]));","","var searchFilters = {};","searchFilters.service_user = {};","searchFilters.service_user.pslid = pm.environment.get('pslid');","searchFilters.report_format = 'XML';","searchFilters.include_header = 'true';","","","var dataDumpPostData = dataGen.json2formData(searchFilters, 'query');","","console.log(dataDumpPostData);","","const createDataDumpRequest = {"," url: pm.environment.get('base_url') + '/data/dump',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: dataDumpPostData"," }","};","","pm.sendRequest(createDataDumpRequest, function (err, res) {"," //console.log(err ? err : res.text());"," var payersXml = res.text();"," //console.log(payersXml);"," "," var payers = xml2Json(payersXml);","","//console.log(payers);"," //pm.environment.set('reference_number', payer.reference_number);"," //console.log('reference number for the payer we try to update is: ' + payer.reference_number);"," "," var lastPayer=payers.DataDump.Data.PayerDetails[payers.DataDump.Data.PayerDetails.length-1].$;","var lastPayer2=payers.DataDump.Data.PayerDetails[payers.DataDump.Data.PayerDetails.length-2].$;","","console.log(lastPayer);","console.log(lastPayer2);","","var collectionFile = sd.testing.getCollectionFile(6, [{ start_date: lastPayer.start_date, reference_number: lastPayer.reference_number, last_collection: new Date().addDays(-2) },{ start_date: lastPayer2.start_date, reference_number: lastPayer2.reference_number, last_collection: new Date().addDays(-2) }],true);","console.log('Collection File Start.........');","console.log(collectionFile);","console.log('Collection File Finish.........');","","pm.environment.set(\"collectionFile\", collectionFile);","});","","//var payersXml = pm.environment.get(\"api_data_dump_response\", pm.response.text());","","","","//console.log(payers.DataDump.Data.PayerDetails[payers.DataDump.Data.PayerDetails.length-1].$.reference_number);","","var lastPayer=payers.DataDump.Data.PayerDetails[payers.DataDump.Data.PayerDetails.length-1].$;","var lastPayer2=payers.DataDump.Data.PayerDetails[payers.DataDump.Data.PayerDetails.length-2].$;","","//console.log(lastPayer);","//console.log(new Date().addDays(-2));","","","","//pm.environment.set('collection_file_name_date', sd.testing.getCollectionFile.fileName())"],"type":"text/javascript"}}],"id":"090d73a7-97d4-4655-8b78-dbdf27e0beff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"charge_file[service_user][pslid]","value":"{{pslid}}","type":"text","description":"

Service user identifier

\n"},{"key":"charge_file[file_name]","value":"{{file_name}}","type":"text","description":"

Format: 1 to 255 characters

\n"},{"key":"charge_file[file]","value":"{{collectionFile}}","type":"text","description":"

Format: multiline comma separated values. See collection file format.

\n"}]},"url":"{{base_url}}/charge_file/import","description":"

All parameters are required.

\n","urlObject":{"path":["charge_file","import"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c1a30c36-2f44-4592-9715-c21814ab728b","name":"import_collections","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"charge_file[file_name]","value":"{{collection_file_name_date}}","type":"text","description":"Format: plain text "},{"key":"charge_file[file]","value":"{{collectionFile}}","type":"text","description":"Format: multi line comma separated value (7 fields per entry)\n"},{"key":"charge_file[service_user][pslid]","value":"{{pslid}}","type":"text","description":"Service user identifier"}]},"url":"{{base_url}}/charge_file/import"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 27 Feb 2019 15:49:04 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Runtime","value":"0.17645"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"1501"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"11-18583466-18717321 SNNN RT(1551281736218 874452) q(0 0 0 -1) r(3 3) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n test_file_name_2019-02-27T15_49_20.292Z\n ,SD11901221682,19.23,2019/03/25,,SD11901221682-1039,\n,SD11901221682,21.74,2019/04/25,,SD11901221682-1039,\n,SD11901221687952,4.63,2019/03/25,,SD11901221687952,\n,SD11901221687952,3.86,2019/04/25,,SD11901221687952,\n,SD11901221687952,23.54,2019/05/25,,SD11901221687952,\n,SD11901221687952,22.17,2019/06/25,,SD11901221687952,\n\n \n apidocument\n \n false\n \n Line 1: Not Imported: The DDI was cancelled on 22 February 2019 and cannot be debited.\n Line 2: Not Imported: The DDI was cancelled on 22 February 2019 and cannot be debited.\n Line 3: User format debit reference 'SD11901221687952' invalid - it should be begin with SD11901221687952- followed by the user format debit reference.\n Line 4: User format debit reference 'SD11901221687952' invalid - it should be begin with SD11901221687952- followed by the user format debit reference.\n Line 5: User format debit reference 'SD11901221687952' invalid - it should be begin with SD11901221687952- followed by the user format debit reference.\n Line 6: User format debit reference 'SD11901221687952' invalid - it should be begin with SD11901221687952- followed by the user format debit reference.\n \n"}],"_postman_id":"090d73a7-97d4-4655-8b78-dbdf27e0beff"}],"id":"abc76044-4f83-4bfa-b640-86018235fc5e","description":"

Description

charge_file/import can be used to create or update collections, or both at the same time.

This call can be used to import small collection files up to a maximum of 5000 lines. Use charge_file/async_import instead for larger files.

The service user is specified using the charge_file[service_user][pslid] parameter.
The file name is specified using the charge_file[file_name] parameter.
The file content is supplied as the charge_file[file] parameter. Refer to the file format specification.

IMPORTANT NOTE:\nA collection file entry with a reference number and date that matches an existing collection updates the existing collection. You cannot specify two separate collections on the same date. Instead, either specify the sum or use a different collection date.

Response

A successful call to charge_file/import returns an XML document with a root tag of <charge_file>. An <import_successful> tag contains 'true' if any entries in the collection file were imported successfully. A listing of the change caused by each entry is listed in the group tag <successful>.

200 OK\n

<?XML version=\"1.0\" encoding=\"UTF-8\"?>\n<charge_file>\n <file_name>collection_file.csv</file_name>\n <file>\n  ,ABC123456,49.95,2019/06/15,,,\n  ,”ABC123456”,”15”,”19/07/03”,,,\n </file>\n <service_user>\n  <pslid>su_pslid</pslid>\n </service_user>\n <import_successful>true</import_successful>\n <successful> \n  <success>Line 1: Debit for 15 June 2019 updated.</success>\n  <success>Line 2: Debit for 3 July 2019 created.</success>\n </successful>\n</charge_file>\n

In the case that one or more entries cannot be imported, each failure is listed in the group tag <errors>. If no entries in the file can be imported then the <import_successful> tag contains 'false'. It is worth noting that this is one of the few instances where an API call can fail, and return an HTTP status of 200 OK.

200 OK \n

<?XML version=\"1.0\" encoding=\"UTF-8\"?>\n<charge_file>\n <file_name>collection_file.csv</file_name> \n  ... \n <import_successful>false</import_successful>\n <errors>\n  <error>Line 1: Not imported: Could not find DDI 'ABC123456'</error>\n  <error>Line 2: Not imported: Could not find DDI 'ABC123456'</error>\n </errors>\n</charge_file>\n

Errors

Passing no parameters returns:

\n\n

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Collection File parameters not supplied.</error>\n</errors>\n

A missing or incorrect service user ID returns one of:

\n\n

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

\n\n

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid Service User ID: 'su_pslid'</error>\n</errors>\n

Omitting the file or filename returns one of:

\n\n

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>File data not supplied.</error>\n</errors>\n

\n\n

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>File name not supplied.</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"3c83187d-5634-4481-a148-11c5192abf6d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"006098dd-475f-4771-8b9f-ac6755284a8c","type":"text/javascript","exec":[""]}}],"_postman_id":"abc76044-4f83-4bfa-b640-86018235fc5e"},{"name":"4.4.4 Collection file - asynchronous import","item":[{"name":"charge_file/async_import","id":"c3d2067b-a49a-4933-88d7-91faa2b10350","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"charge_file_import[service_user][pslid]","value":"{{pslid}}","description":"

Service user identifier

\n","type":"text"},{"key":"charge_file_import[file_name]","value":"{{file_name}}","description":"

Format: 1 to 255 characters

\n","type":"text"},{"key":"charge_file_import[file]","value":"{{file}}","description":"

Format: multiline comma separated values. See collection file format.

\n","type":"text"}]},"url":"{{base_url}}/charge_file/async_import","description":"

All parameters are required.

\n","urlObject":{"path":["charge_file","async_import"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3d2067b-a49a-4933-88d7-91faa2b10350"}],"id":"9c5741cd-3976-4537-becf-30909a3d36ce","description":"

Description

charge_file/async_import can be used to create or update collections, or both at the same time.

This call can be used to import collection files that are too large for charge_file/import. Files are broken into 1000-line chunks for parallel processing. Files are imported asynchronously and you must use charge_file/{{charge_file_import_id}} to obtain the result.

The service user is specified using the charge_file_import[service_user][pslid] parameter.
The file name is specified using the charge_file_import[file_name] parameter.
The file content is supplied as the charge_file_import[file] parameter. Refer to the file format specification.

Response

A successful call to charge_file/async_import returns an XML version of the enqueued import. The root tag of <charge_file_import> includes a URI attribute that identifies this import, and can be used to poll for the progress of the import. Each of the queued charge file chunks is listed in the grouping tag. Each tag includes the lines included in the chunk and the current status of the chunk – the response from charge_file/async_import always has the status \"In process - please wait\".

Errors

No parameters supplied

\n\n

400 Bad Request \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Charge File parameters not supplied.</error>\n</errors>\n

Missing or invalid service user

\n\n

400 Bad Request \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

\n\n

400 Bad Request \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid Service User ID: 'su_pslid'</error>\n</errors>\n

File name not supplied

\n\n

400 Bad Request\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>File name not supplied.</error>\n</errors>\n

File not supplied

\n\n

400 Bad Request \n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>File data not supplied.</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"a29616fa-0ca9-4ca9-b2d6-2936f62972b9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0e772984-b6a0-4df8-a44d-02146eba48bb","type":"text/javascript","exec":[""]}}],"_postman_id":"9c5741cd-3976-4537-becf-30909a3d36ce"},{"name":"4.4.5 Collection file import status","item":[{"name":"charge_file/{{import_id}}","id":"a4ca0d94-fd06-4e5c-b6ae-e9fddcbf7151","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/charge_file/{{collection_file_import_id}}","urlObject":{"path":["charge_file","{{collection_file_import_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a4ca0d94-fd06-4e5c-b6ae-e9fddcbf7151"}],"id":"84af45d3-15bc-44cc-84d7-f0f16152dcc2","description":"

Description

charge_file/{{import_id}} can be used to query the status of a collection file import and to get the results on completion.

Response

A successful call to charge_file/{{import_id}} returns an XML document containing the status of the enqueued import. Each of the queued collection file chunks is listed in the <file_chunks> grouping tag. Each <file_chunk> tag includes the lines included in the chunk and the current status of the chunk. As each chunk is processed, its status moves through the following values:

In process - please wait
allocated
started
Import complete, click here for result

Once a chunk has completed, a listing of the changes made is included in the <file_chunk> in a <successes> group tag. Similarly, any failed lines or errors are listed in an <errors> group tag:

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<charge_file_import uri=\"https://sandbox.ddprocessing.co.uk/api/charge_file/123\">\n  <action>CREATE</action>\n  <file_name>collection_file.csv</file_name>\n  <completed_on>2019-05-12T12:04:21Z</completed_on>\n  <service_user>\n    <pslid>su_pslid</pslid>\n  </service_user>\n  <file_chunks>\n    <file_chunk to_line=\"2\" status=\"Import complete, click here for result\" from_line=\"1\">\n      <successes total=\"1\">\n        <success>Line 2: Debit for 15 June 2019 created</success>\n        </successes>\n      <errors total=\"1\">\n        <error>Line 1: Not Imported: the date 2019/05/15 00:00 is before today plus the charge file lead time of 3 days.</error>\n      </errors>\n    </file_chunk>\n  </file_chunks>\n</charge_file_import>\n

Note:

The line number reported in each <success> or <error> tag is relative to the chunk and not necessarily the whole file.
<error> tags indicate that a collection was not imported. They are significant.
The HTTP status relates to the call and not to the import. A line, a chunk or the whole file may fail to import, despite an HTTP status of \"200 OK\".
The <action> node is not significant.

Errors

Querying the status of an invalid file results in one of these two errors:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find ParallelTask with ID=1524</error>\n</errors>\n

\n\n

401 Unauthorized\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Permission denied. You cannot access the requested resource.</error>\n</errors>\n

Contact SmartDebit support if a file or chunk remains stuck at
\n\n
```
In process - please wait\n
```

","event":[{"listen":"prerequest","script":{"id":"32364913-3d4d-4db6-8d3e-9d55ce16cb4e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e2e87969-0f83-47e3-8f2f-80fc76a25c4d","type":"text/javascript","exec":[""]}}],"_postman_id":"84af45d3-15bc-44cc-84d7-f0f16152dcc2"}],"id":"e2e50faf-3e40-43ea-9792-3ff7a28f0aea","description":"

Direct Debit Instructions (DDIs, payers) and individual debits (collections) can be created and updated via imported data files.

Note:

both file types are CSV formats
date formats are as given in the specification, and
amounts are in pounds and pence

Payer files can be used to:

create either variable or adhoc DDIs
update DDIs
cancel DDIs
re-instate cancelled DDIs

Collection files can be used to:

create or update collections for one or more payers
suppress or modify payment schedules if the imported collections coincide with those schedules

Collection files cannot be used to delete collections, though a value of zero can be used.

\n","event":[{"listen":"prerequest","script":{"id":"f6ef5a42-d80a-4819-952b-5f03ac6b1896","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"60e6e02e-184d-471e-999d-fdbd13eddfc1","type":"text/javascript","exec":[""]}}],"_postman_id":"e2e50faf-3e40-43ea-9792-3ff7a28f0aea"},{"name":"4.5 Audit log","item":[{"name":"data/auditlog (XML example)","event":[{"listen":"test","script":{"id":"e90c48b1-e3f9-4807-8f95-6e563fabbcb3","exec":["// Documentation refers to a POST request in this case","","eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 300ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," ","});","","// SCHEMA Validation //","var result = xml2Json(responseBody); // "," //","var schema = sd.api.schema.auditLog; //"," //"," pm.test('Schema is valid', function() { //"," pm.expect(tv4.validate(result, schema)).to.be.true; //"," }); //","// SCHEMA Validation //"],"type":"text/javascript"}}],"id":"59fdc403-98bf-4985-b23b-6d35dbe79470","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","description":"

Required
\nService user identifier

\n","type":"text"},{"key":"query[report_format]","value":"{{report_format}}","description":"

Required
Format: 'CSV' or 'XML'
Default: XML

\n","type":"text"},{"key":"query[reference_number]","value":"{{reference_number}}","description":"

Required
Bacs reference as payer identifier

\n","type":"text"},{"key":"query[include_header] ","value":"{{include_header}}","description":"

Format: 'true' or 'false'
Default: false

\n","type":"text"},{"key":"query[from_date]","value":"{{from_date}}","description":"

Format: YYYY-MM-DD

\n","type":"text"},{"key":"query[to_date]","value":"{{to_date}}","description":"

Format: YYYY-MM-DD

\n","type":"text"}]},"url":"{{base_url}}/data/auditlog","urlObject":{"path":["data","auditlog"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"078dc37f-b581-4dd7-93f5-79f7d5d577da","name":"audit_log (XML)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid","type":"text"},{"key":"query[report_format]","value":"XML","description":"Restrictions: 'CSV' or 'XML'
Default: is 'XML'","type":"text"},{"key":"query[reference_number]","value":"{{reference_number}}","description":"A unique reference number must be passed.
\nFormat: plain text
\nRestrictions: Unique, 6 to 18 characters May not contain solidus (/) and further restrictions apply.","type":"text"},{"key":"query[include_header] ","value":"","description":"Format: plain text
Restrictions: 'true' or 'false'
Default: is false ","type":"text","disabled":true},{"key":"query[from_date]","value":"","description":"Optional
Format: YYYY-MM-DD
\nRestrictions: Must be far enough in the past before the to_date parameter]","type":"text","disabled":true},{"key":"query[to_date]","value":"","description":"Optional
Format: YYYY-MM-DD
\nRestrictions: Must be after the from_date parameter","type":"text","disabled":true}]},"url":"{{base_url}}/data/auditlog"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 28 Feb 2019 09:05:21 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Runtime","value":"0.09595"},{"key":"Content-Disposition","value":"attachment; filename=audit_log.xml"},{"key":"Content-Transfer-Encoding","value":"binary"},{"key":"Cache-Control","value":"private"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/xml; charset=iso-8859-1"},{"key":"X-Iinfo","value":"14-63845015-63883178 NNNN CT(76 9 0) RT(1551344670888 117709) q(0 0 1 -1) r(3 3) U5"},{"key":"X-CDN","value":"Incapsula"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n"}],"_postman_id":"59fdc403-98bf-4985-b23b-6d35dbe79470"}],"id":"5bdf8c47-d604-4a15-95b5-8c2da05899aa","description":"

Description

data/auditlog may be called as a GET or a POST. It may be used to retrieve a list of audit records for a specified payer.

The service user is specified using the query[service_user][pslid] parameter.
The payer is specified using the query[reference_number] parameter. If the payer is not found, the call returns successfully with no records.
A date range can be specified with the query[from_date] and query[to_date] parameters. Note that query[to_date] is exclusive - any records from that day are not returned.

Response

The audit records can be returned in XML or CSV format. The default format is XML.

XML response:\nThe returned document contains an AuditDetails element for each audit record. This element has the following attributes:
\n
- timestamp (in \"YYYY/MM/DD hh:mm\" format)
- reference_number
- description
- User
\n
CSV response:\nThe following columns are returned, left to right:
\n
- timestamp (in \"YYYY/MM/DD hh:mm\" format)
- reference number
- description
- user
\n

Errors

If no service user is specified:

\n\n

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AuditLog xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"nonamesp.xsd\">\n  <Errors>\n    <ErrorDetail>No service user id supplied.</ErrorDetail>\n  </Errors>\n</AuditLog>\n

If an invalid service user is specified (example):

\n\n

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AuditLog xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"nonamesp.xsd\">\n  <Errors>\n    <ErrorDetail>Invalid Service User ID: 'invalid'</ErrorDetail>\n  </Errors>\n</AuditLog>\n

If no reference number is specified:

\n\n

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AuditLog xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"nonamesp.xsd\">\n  <Errors>\n    <ErrorDetail>No reference number supplied.</ErrorDetail>\n  </Errors>\n</AuditLog>\n

If an invalid reference number is specified (example):

\n\n

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AuditLog xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"nonamesp.xsd\">\n  <Errors>\n    <ErrorDetail>Invalid reference number supplied. 12345</ErrorDetail>\n  </Errors>\n</AuditLog>\n

If a non-existent reference number is supplied:

\n\n

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AuditLog xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"nonamesp.xsd\">\n  <Data>\n  </Data>\n</AuditLog>\n

... or, if CSV format is specified, an empty document is returned.

If a date parameter is given with a month or day of zero, or a month greater than 12, or a day greater than 31:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>argument out of range</error>\n</errors>\n

\n\n

Version history

\n\n\n\n\n\n

The query[include_header] parameter is deprecated because the header is incorrectly formatted: \"Timestamp,Reference No,Description,User\".

","event":[{"listen":"prerequest","script":{"id":"a4ac0981-9f33-427a-8940-f2729018a76f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7fdf2be8-d98c-4cd3-b562-9daf4e5c300b","type":"text/javascript","exec":[""]}}],"_postman_id":"5bdf8c47-d604-4a15-95b5-8c2da05899aa"},{"name":"4.6 Collection report","item":[{"name":"get_collection_report","event":[{"listen":"test","script":{"id":"0c00135f-ed85-40a4-a668-0fea72fb666d","exec":["eval(pm.globals.get('jasmine'));","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"\");"," pm.expect(pm.response.text()).to.include(\"\");"," pm.expect(pm.response.text()).to.include(\"\");"," pm.expect(pm.response.text()).to.include(\"\");"," pm.expect(pm.response.text()).to.include(\"\");"," pm.expect(pm.response.text()).to.include(\"

\");"," pm.expect(pm.response.text()).to.include(\"\");"," pm.expect(pm.response.text()).to.include(\"

\");"," pm.expect(pm.response.text()).to.include(\"\");"," var jsonObject = xml2Json(responseBody);"," if(jsonObject.assigned_service_users !== undefined && jsonObject.assigned_service_users.length === 1)"," {return true;}"," else{"," return 'no service user has been assigned to this api user';"," }","});","","","","","var jsonObject = xml2Json(responseBody);","console.log(JSON.stringify(jsonObject));","","","var schema = sd.api.schema.collectionReport;","","console.log(schema);","pm.test('Schema is valid', function() {"," pm.expect(tv4.validate(jsonObject, schema)).to.be.true;","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"67a033e8-b011-40a9-80bc-5263db9b2148","exec":["","pm.environment.set('collection_date','2019-03-06');"],"type":"text/javascript"}}],"id":"9c7048af-9192-420d-b2d7-adfe30ea3385","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/get_collection_report?query[service_user][pslid]={{pslid}}&query[debit_date]={{collection_date}}","urlObject":{"path":["get_collection_report"],"host":["{{base_url}}"],"query":[{"description":{"content":"

Required
\nService user identifier

\n","type":"text/plain"},"key":"query[service_user][pslid]","value":"{{pslid}}"},{"description":{"content":"

Recommended
Format: YYYY-MM-DD

\n","type":"text/plain"},"key":"query[debit_date]","value":"{{collection_date}}"}],"variable":[]}},"response":[{"id":"11ec859b-777f-4684-bc24-df18b728dce5","name":"get_collection_report","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/get_collection_report?query[service_user][pslid]={{pslid}}&query[debit_date]={{collection_date}}","host":["{{base_url}}"],"path":["get_collection_report"],"query":[{"key":"query[service_user][pslid]","value":"{{pslid}}","description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid"},{"key":"query[debit_date]","value":"{{collection_date}}","description":"Format: YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 04 Mar 2019 09:33:12 GMT"},{"key":"Server","value":"Apache"},{"key":"Content-Transfer-Encoding","value":"binary"},{"key":"Cache-Control","value":"private"},{"key":"X-Runtime","value":"0.03869"},{"key":"Content-Disposition","value":"attachment; filename=\"collection_report.xml\""},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_373_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/xml"},{"key":"X-Iinfo","value":"5-90065521-90067091 NNNN CT(0 0 0) RT(1551692061300 8868) q(0 0 0 -1) r(1 1) U5"},{"key":"X-CDN","value":"Incapsula"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n \n \n \n \n \n \n

\n 06/03/2019\n \n \n

\n"}],"_postman_id":"9c7048af-9192-420d-b2d7-adfe30ea3385"}],"id":"2f6356dc-6e65-41fd-ad5f-7ef61521b2f3","description":"

Description

get_collection_report provides a summary and a list of collections due on the specified date.

Response

A successful call to get_collection_report returns an XML document containing a list of collections due on a specified date.

An XML collection report file consists of a Successes tag, a Rejects tag and a Summary tag within a CollectionReport wrapper.

Within the Successes tag there may be a list of Success tags, each of which has the following attributes:

debit_date: the due date (which may be a non-working day) in the format \"DD/MM/YYYY 00:00\"
account_name: the payer's account name
amount: in pounds and pence without the £ symbol
reference_number: the unique identifier for the DDI
customer_id: if used, a further label given to the DDI (equivalent to \"payer_reference\" in other calls)
transaction_ref: if used, an identifier for the collection (comprising the reference_number followed by a hyphen followed by another label)

Within the Rejects tag there may be a list of Reject tags, each of which has the same attributes as the Success tag with an additional error_message tag which gives the rejection reason or may be empty.

The Summary tag contains a CollectionDate tag (where the date is in the format DD/MM/YYYY), a Succesful (sic) tag with attributes number_submitted and amount_submitted, and a Rejected tag with attributes number_rejected and amount_rejected. Amounts are in pounds and pence without the £ sign.

Understanding the response:

Collections that have been imported into the system are reported as soon as they have been imported (whether they have been submitted to Bacs or not).
Collections that are generated by the system (for variable DDIs with regular amounts) are reported as soon as they have been generated, which is early on the day of submission. Collections are submitted ahead of the due date, depending on the service user's advance notice period.
When a DDI is cancelled, pending collections are usually deleted. Such collections are not currently reported. The deletion of collections is subject to design review, therefore this behaviour may change.
Under some circumstances the collections may remain for a cancelled DDI. These are reported as successes.
Under some circumstances a collection may be rejected by Bacs. Such collections are reported as successes until the working day following submission, when they become rejects.

Thus, get_collection_report does not indicate the success of a collection (for that, see get_successful_collection_report) and does not give a reliable indication that a collection was submitted.

Note the spelling of \"Succesful\" in the <Summary> section.

If there are no collections for the specified date the returned XML is as this example:

200 OK\n

<?xml version='1.0' encoding='UTF-8'?>\n<CollectionReport xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>\n  <Summary>No collection report for 2019-04-01</Summary>\n</CollectionReport>\n

Note the single quotes in this response.

Version history

\n\n\n\n\n\n

Use of this call without a date parameter is deprecated. This usage was designed to return a list of collections being submitted today. However the call calculates the due date as {today} + {collection file lead time} and can only return collections due on a single date. Most service users' lead times are calculated in working days. For such service users the call may return an unexpected date and may not report some collections.

\n\n\n

Errors

Service user not specified

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"95a3e85e-f9ba-40b8-bf24-4da752b7f5eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4bfaa4c4-44b0-4abc-bdaf-ff9024028e9e","type":"text/javascript","exec":[""]}}],"_postman_id":"2f6356dc-6e65-41fd-ad5f-7ef61521b2f3"},{"name":"4.7 Reconciliation report","item":[{"name":"get_successful_collection_report","event":[{"listen":"test","script":{"id":"ed913c8b-7b0f-4564-bb92-4567452e9426","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 300ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","////////////////////////////////////","//Prepare for next call parameters//","////////////////////////////////////","var d = new Date().toISOString().replace(/:/g,'').replace(/-/g,'').slice(9, 15);","console.log(d);","","//let no = (d.getHours()+d.getMinutes()+d.getSeconds()).toString().replace(/_/g,'_').slice(0, 6);","//console.log(((d.getHours()+d.getMinutes()+d.getSeconds()).toString()).toString());","//console.log((d.getHours()+d.getMinutes()+d.getSeconds()).toString().replace(/_/g,'_'));","//console.log(no);","var ref_no = new Date().toISOString().replace(/:/g,'_').replace(/-/g,'').slice(0, 8);","var reference_number = 'API-'+ref_no+d;","","console.log(reference_number);","","pm.environment.set(\"ref_number\", reference_number);","","","var jsonObject = xml2Json(responseBody);","console.log(JSON.stringify(jsonObject));","","","var schema = sd.api.schema.collectionReport;","","console.log(schema);","pm.test('Schema is valid', function() {"," pm.expect(tv4.validate(jsonObject, schema)).to.be.true;","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"e56d986e-41c5-45ef-8ae8-ec84e5f92e35","exec":["pm.environment.set('successful_collection_date','2019-03-06');"],"type":"text/javascript"}}],"id":"f1e498d3-1a90-42b0-85f1-8cbbda55898e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/get_successful_collection_report?query[service_user][pslid]={{pslid}}&query[collection_date]={{collection_date}}","description":"

All parameters are required.

\n","urlObject":{"path":["get_successful_collection_report"],"host":["{{base_url}}"],"query":[{"description":{"content":"

Service user identifier

\n","type":"text/plain"},"key":"query[service_user][pslid]","value":"{{pslid}}"},{"description":{"content":"

Format: YYYY-MM-DD

\n","type":"text/plain"},"key":"query[collection_date]","value":"{{collection_date}}"}],"variable":[]}},"response":[{"id":"afcace9d-44d4-4c1f-b8eb-e6c93e0553ae","name":"get_successful_collection_report","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/get_successful_collection_report?query[service_user][pslid]={{pslid}}&query[collection_date]={{collection_date}}","host":["{{base_url}}"],"path":["get_successful_collection_report"],"query":[{"key":"query[service_user][pslid]","value":"{{pslid}}","description":"Service user identifier"},{"key":"query[collection_date]","value":"{{collection_date}}","description":"Format: YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\n\n \n \n \n \n \n \n

\n 16/01/2019\n \n \n

\n"}],"_postman_id":"f1e498d3-1a90-42b0-85f1-8cbbda55898e"}],"id":"efceb3f7-3bb8-4af9-b126-f8f912bb5fc7","description":"

get_successful_collection_report provides a summary and a breakdown of collections that were taken on a specified date.

This report reflects any unpaid collections and is made available on the third working day after the collection date to allow for any unpaid collections (ARUDDs) to be reported.

This report differs from get_collection_report as follows:

the report is available only after the collection date
the date parameter is query[collection_date] rather than query[debit_date]
the Rejects section has a different meaning

Response

A successful call to get_successful_collection_report returns an XML document containing a list of collections due on a specified date.

An XML collection report file consists of a Successes tag, a Rejects tag and a Summary tag within a CollectionReport wrapper.

Within the Successes tag there may be a list of Success tags, each of which has the following attributes:

debit_date: the due date (which may be a non-working day) in the format \"DD/MM/YYYY 00:00\"
account_name: the payer's account name
amount: in pounds and pence without the £ symbol
reference_number: the unique identifier for the DDI
customer_id: if used, a further label given to the DDI (equivalent to \"payer_reference\" in other calls)
transaction_ref: if used, an identifier for the collection (comprising the reference_number followed by a hyphen followed by another label)

Within the Rejects tag there may be a list of Reject tags, each of which has the same attributes as the Success tag with an additional error_message tag which may give the reason or may be empty.

Understanding the response:

In all but the most exceptional cases the ARUDDs will have been received within the 3 working days.
The Successes node contains all collections that are believed to have been paid.
Collections that failed with an ARUDD are listed as Rejects.
Collections that were rejected by Bacs are listed as Rejects.
Collections that were not submitted (and have not been deleted) are listed as Rejects - typically those with an amount of 0.00.
Collections that have been indemnity claimed by the payer are listed as Successes in v1.1 onward, otherwise as Rejects.
Where the DDI was cancelled prior to submission of the collection, the collection is not currently reported. The deletion of collections is subject to design review, therefore this behaviour may change.

Note the spelling of \"Succesful\" in the <Summary> section.

If 3 working days have not elapsed since the collection date the following XML is returned:

200 OK\n

<?xml version='1.0' encoding='UTF-8'?>\n<SuccessfulCollectionReport xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>\n  <Summary>A successful collection report can only be issued 3 working days after the collection date to allow for ARUDD returns.\n </Summary>\n</SuccessfulCollectionReport>\n

If there are no collections for the specified date the following XML is returned:

200 OK\n

<?xml version='1.0' encoding='UTF-8'?>\n<CollectionReport xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>\n  <Summary>No collection report for 2019-04-01</Summary>\n</CollectionReport>\n

Note the single quotes in this response.

Version history

\n\n\n\n\n\n\n\n\n\n

v1.1	Collections that have been indemnity claimed are presented as \"Successes\".
	Collections that have been indemnity claimed are presented as \"Rejects\".

\n\n\n

Errors

Service user not specified

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"20e1cfcb-65dc-412f-837d-7d7f6da2ef4f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6eceb9f3-2201-4483-b5c5-3b92eff3efaf","type":"text/javascript","exec":[""]}}],"_postman_id":"efceb3f7-3bb8-4af9-b126-f8f912bb5fc7"},{"name":"4.8 Bacs reports","item":[{"name":"4.8.1 List AUDDIS","item":[{"name":"auddis/list","event":[{"listen":"test","script":{"id":"f304f9d0-01be-4c53-b0b4-476e956421d6","exec":["pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," "," var response = pm.response.text();"," var pattern = //g;"," "," //pm.expect(pattern.test(response)).to.eql(true);"," pm.expect(pm.response.text()).to.include('');","});","","//pm.test(\"Body is correct\", function () {","// pm.response.to.have.body(pm.environment.get(\"new_auddis_list_response\"));","//});","","pm.test('Schema is valid', function() {"," var jsonObject = xml2Json(pm.response.text()); "," console.log(jsonObject);"," "," var jsonSchema = sd.api.schema.auddisList; "," "," pm.expect(tv4.validate(jsonObject, jsonSchema)).to.be.true;"," ","});","","pm.globals.unset(\"new_auddis_list_response\");","","var regEx = new RegExp('([0-9]+)<\\/auddis_id>', 'gm');","var knownAuddisId = regEx.exec(responseBody)[1];","pm.globals.set(\"known_auddis_id\", knownAuddisId);","",""],"type":"text/javascript"}}],"id":"db62fb9b-fd63-4e21-bdd8-b7fa333189dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","type":"text","description":"

Required
\nService user identifier

\n"},{"key":"query[max_results]","value":"{{max_results}}","type":"text","description":"

Format: integer, 1 to 1000
Default: 100

\n"},{"key":"query[start_index]","value":"{{start_index}}","type":"text","description":"

Format: integer
Default: 0

\n"},{"key":"query[id_from]","value":"{{id_from}}","type":"text","description":"

Format: integer

\n"},{"key":"query[from_date]","value":"{{from_date}}","type":"text","description":"

Conditional (required if till_date is used)
Format: YYYY-MM-DD

\n"},{"key":"query[till_date]","value":"{{till_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"}]},"url":"{{base_url}}/auddis/list","urlObject":{"path":["auddis","list"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"476fb697-877c-4dce-ab45-bc41aed05506","name":"auddis/list","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","type":"text","description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid"},{"key":"query[max_results]","value":"","description":"Format: integer
Restrictions: 1 to 1000
Default: is 100","type":"text"},{"key":"query[start_index]","value":"","description":"Format: integer
Restrictions: 0 or greater
Default: 0","type":"text"},{"key":"query[id_from]","value":"","description":"Format: integer
Restrictions: 0 or greater","type":"text"},{"key":"query[from_date]","value":"","description":"Format: date YYYY-MM-DD","type":"text"},{"key":"query[till_date]","value":"","description":"Format: date YYYY-MM-DD","type":"text"}]},"url":"{{base_url}}/auddis/list"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 04 Mar 2019 15:09:27 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.04437"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_874_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_373_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Content-Length","value":"400"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"13-114222854-114392497 NNNN CT(3 7 0) RT(1551711491196 753886) q(0 0 0 -1) r(1 1) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n \n _DOWNLOADED_445566_AUDDIS_269836580.xml\n 2019-03-04T00:00:00Z\n 1\n 81\n \n"}],"_postman_id":"db62fb9b-fd63-4e21-bdd8-b7fa333189dd"}],"id":"4bb69dc2-f890-4ee7-a498-c808dc13d83d","description":"

Description

auddis/list provides a paginated summary of all AUDDIS reports for a specified service user. By default the first 100 reports are returned. Reports are listed in reverse order, most recent first. Each AUDDIS file summary includes the URI to retrieve the full file.

Usage

This call must be made as a POST. If made as a GET the uri attribute is incorrect.

Typically a client application would make this call once a day to list new reports.

<auddis_id> values are not contiguous but always increase. To list reports once only, keep a record of the maximum <auddis_id> value. When making the call, add one to the maximum and use this as the query[id_from] parameter.

Listing reports by date range can be unreliable.

Response

A successful response from auddis/list is an XML list of AUDDIS file summaries. The root <auddises> tag includes the number of results returned, the start index for the results returned, and the total number of results.

In the case that there are no AUDDIS files the root element is empty:

200 OK\n

<?xml version='1.0' encoding='UTF-8'?><auddises results='0' total_results='0' start_index='0'></auddises>\n

Note the single quotes in this response.

Errors

Missing or invalid service user

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid Service User ID: 'su_pslid'</error>\n</errors>\n

Invalid date value

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Unable to parse date 'tomorrow' expected format is YYYY-MM-DD</error>\n</errors>\n

Value out of range

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Mysql::Error: #42000You have an error in your SQL syntax  [...]  </error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"98ff7fc0-9715-4f32-b92b-1159329154d0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3af3a085-3c84-4be0-a3a2-1f2f6783cf6f","type":"text/javascript","exec":[""]}}],"_postman_id":"4bb69dc2-f890-4ee7-a498-c808dc13d83d"},{"name":"4.8.2 Retrieve AUDDIS file","item":[{"name":"auddis/{{id}}","event":[{"listen":"test","script":{"id":"f304f9d0-01be-4c53-b0b4-476e956421d6","exec":["pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," //pm.expect(pm.response.text()).to.include('');"," "," //var response = pm.response.text();"," // var pattern = //g;"," "," //pm.expect(pattern.test(response)).to.eql(true);"," pm.expect(pm.response.text()).to.include(''+pm.environment.get('auddis_file_name')+''); //Mia_new_account_449165_AUDDIS_269836580.xml"," pm.expect(pm.response.text()).to.include('');","});","","//pm.test(\"Body is correct\", function () {","// pm.response.to.have.body(pm.environment.get(\"new_auddis_list_response\"));","//});","","pm.test('Schema is valid', function() {"," var jsonObject = xml2Json(pm.response.text()); "," var jsonSchema = sd.api.schema.auddisList; "," "," pm.expect(tv4.validate(jsonObject, jsonSchema)).to.be.true;"," ","});","",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f07b83ad-4f3e-4dbe-9bf5-1bb15403ead1","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","console.log(authHash);","","var dataGen = sd.testing;","","//var postData = {};","var query = {};","query.service_user = {};","query.service_user.pslid = pm.environment.get('pslid');","","","var postFormData = dataGen.json2formData(query, 'query');","","console.log(postFormData);","","const postDataRequest = {"," url: pm.environment.get('base_url') + '/auddis/list',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: postFormData"," }","};","","pm.sendRequest(postDataRequest, function (err, res) {"," console.log('RESPONSE START');"," console.log(res.text());"," console.log('RESPONSE END');"," "," var jsonObject = xml2Json(res.text());"," "," pm.environment.set('auddis_file_id',jsonObject.auddises.auddis.auddis_id);"," pm.environment.set('auddis_file_name', jsonObject.auddises.auddis.file_name);","});"],"type":"text/javascript"}}],"id":"d45bab5f-a369-4abb-ab1d-31d838621655","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/auddis/{{auddis_file_id}}","urlObject":{"path":["auddis","{{auddis_file_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3344ece5-85e2-4c79-8857-124b22969abd","name":"auddis file","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid","key":"query[service_user][pslid]","type":"text","value":"{{pslid}}"},{"description":"Format: integer Restrictions: 1 to 1000
Default: 100","key":"query[max_results]","type":"text","value":""},{"description":"Format: integer
Restrictions: 0 or greater
Default: 0","key":"query[start_index]","type":"text","value":""},{"description":"Format: integer
Restrictions: 0 or greater","key":"query[id_from]","type":"text","value":""},{"description":"Format: date YYYY-MM-DD","key":"query[from_date]","type":"text","value":""},{"description":"Format: date YYYY-MM-DD","key":"query[till_date]","type":"text","value":""}]},"url":{"raw":"{{base_url}}/auddis/{{auddis_file_id}}","host":["{{base_url}}"],"path":["auddis","{{auddis_file_id}}"],"query":[{"key":"file_id","type":"text","value":"{{auddis_file_id}}","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 04 Mar 2019 15:11:19 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.05223"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"1303"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"13-114222854-114420341 SNNN RT(1551711491196 866658) q(0 0 0 -1) r(1 1) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n _DOWNLOADED_445566_AUDDIS_269836580.xml\n 2019-03-04T00:00:00Z\n 1\n PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEJBQ1NE\nb2N1bWVudD4KICA8RGF0YT4KICAgIDxNZXNzYWdpbmdBZHZpY2VzPgogICAg\nICA8SGVhZGVyIGRvY3VtZW50LW51bWJlcj0iMCIgc3ViamVjdC1maXJzdC1h\nb3NuPSIwMDEwMTQ3NCIgc3ViamVjdC1sYXN0LWFvc249IjAwMTAxNDc0IiB1\nc2VyLW51bWJlcj0iNTAwMDE3IiBhZHZpY2UtdHlwZT0iQVVERElTIiByZXBv\ncnQtZ2VuZXJhdGlvbi1kYXRlPSIyMDE5LTAzLTA0IiB1c2VyLW5hbWU9IkFQ\nSSBEb2N1bWVudGF0aW9uIiByZXBvcnQtdHlwZT0iNzAwMiIgc3RyZWFtLWlk\nZW50aWZpZXI9IjAiIGVudmVsb3BlLXNlcXVlbmNlLW51bWJlcj0iMDAwMDA1\nMTciPgogICAgICA8L0hlYWRlcj4KICAgICAgPEFkZHJlc3NlZUluZm9ybWF0\naW9uPgogICAgICA8L0FkZHJlc3NlZUluZm9ybWF0aW9uPgogICAgICA8TWVz\nc2FnaW5nQWR2aWNlIHBheWVyLW5ldy1zb3J0LWNvZGU9IioqKioqKiIgcmVm\nZXJlbmNlPSJTRDExOTAxMjIxMjE3MjI4MzIiIHBheWVyLW5hbWU9Ik1pYSIg\ncGF5ZXItYWNjb3VudC1udW1iZXI9IioqKiowMDciIGVmZmVjdGl2ZS1kYXRl\nPSIyMDE5LTAzLTA2IiBwYXllci1zb3J0LWNvZGU9IioqKioqKiIgcmVhc29u\nLWNvZGU9IjYiIHBheWVyLW5ldy1hY2NvdW50LW51bWJlcj0iKioqKjAwOCIg\nYW9zbj0iMTAxNDc0Ii8+CiAgICA8L01lc3NhZ2luZ0FkdmljZXM+CiAgPC9E\nYXRhPgo8L0JBQ1NEb2N1bWVudD4K\n\n"}],"_postman_id":"d45bab5f-a369-4abb-ab1d-31d838621655"}],"id":"81d043f2-55ef-42cd-a32a-e2f06bc843bc","description":"

Description

Individual AUDDIS files can be retrieved from the SmartDebit API in XML format. The files are returned as base64 encoded strings.

Response

The example response shows the base64 encoded file within the file node.

The XML version of the AUDDIS file is a filtered version of the original Bacs file. In the case that the referenced DDI has a Customer Id in SmartDebit the Customer Id is included in the MessagingAdvice as the payer-reference attribute.

An XML AUDDIS file consists of a Header, an AddresseeInformation and a number of MessagingAdvice tags within a BACSDocument > Data > MessagingAdvices wrapper. The data formats in the AUDDIS file are preserved – dates are presented in the format YYYY-MM-DD.

The Header tag can contain the following attributes:

document-number
advice-type (which may take the value \"AUDDIS\" or \"AUDACC\")
subject-first-aosn (the serial number of the first advice in the report)
subject-last-aosn (the serial number of the last advice in the report)
user-number (the service user's SUN)
stream-identifier
envelope-sequence-number
report-generation-date
user-name (the service user's bank account name)
report-type (which may take the value \"7002\" or \"7003\")

The AddresseeInformation tag is usually empty but can contain the following attributes:

name
address1
address2
address3
address4
address5

The MessagingAdvice tag can contain the following attributes:

reference (the reference number of the DDI)
payer-reference (the Customer Id of the payer)
user-number (the service user's SUN)
record-type
effective-date
payer-name
payer-sort-code
payer-account-number
payer-new-sort-code
payer-new-account-number
reason-code (refer to the list of reason codes)
aosn (the serial number of the advice)

Depending on the service user configuration, account details may be obscured.

An example XML AUDDIS file, including payer-reference, would look like:

<?XML version=\"1.0\" encoding=\"UTF-8\"?>\n  <BACSDocument>\n    <Data>\n      <MessagingAdvices>\n        <Header advice-type=\"AUDDIS\" document-number=\"0\" report-generation-date=\"2019-03-28\" subject-last-aosn=\"00000020\" user-name=\"SERVICE USER LTD\" user-number=\"250050\" report-type=\"7002\" subject-first-aosn=\"00000020\" stream-identifier=\"0\" envelope-sequence-number=\"00000008\">\n        </Header>\n        <AddresseeInformation>\n        </AddresseeInformation>\n        <MessagingAdvice reason-code=\"B\" reference=\"ABC1234567\" payer-reference=\"65880\" aosn=\"20\" effective-date=\"2019-03-27\" payer-account-number=\"12345678\" payer-name=\"R SMITH\" payer-sort-code=\"000000\"/>\n      </MessagingAdvices>\n    </Data>\n  </BACSDocument> \n

Errors

Errors can be avoided by retrieving only reports listed by auddis/list.

If the report cannot be found:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find AddacsImport with ID=1235545</error>\n</errors>\n

If no report has been specified - {{base_url}}/auddis/

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find AddacsImport without an ID</error>\n</errors>\n

If you do not have permission to view the report:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Permission Denied.</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"2ac20792-6019-4ae8-a8d2-b86f4f182b7a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d1628307-95b7-4e55-9e97-ef62ef76e04f","type":"text/javascript","exec":[""]}}],"_postman_id":"81d043f2-55ef-42cd-a32a-e2f06bc843bc"},{"name":"4.8.3 List ADDACS","item":[{"name":"addac/list","event":[{"listen":"test","script":{"id":"c3275e63-138a-48ee-91a0-284442eac16b","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 300ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," "," var response = pm.response.text();"," var pattern = //g;"," "," pm.expect(pattern.test(response)).to.eql(true);"," pm.expect(pm.response.text()).to.include('');","});","","","pm.test('Schema is valid', function() {"," var jsonObject = xml2Json(pm.response.text()); "," var jsonSchema = sd.api.schema.addacsList; "," "," pm.expect(tv4.validate(jsonObject, jsonSchema)).to.be.true;"," ","});","","pm.globals.unset(\"new_addac_list_response\");","","var regEx = new RegExp('([0-9]+)<\\/addac_id>', 'gm');","var knownAddacsId = regEx.exec(responseBody)[1];","pm.globals.set(\"known_addacs_id\", knownAddacsId);",""],"type":"text/javascript"}}],"id":"cfbd051c-2c14-4102-830e-539c096a6554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","type":"text","description":"

Required
\nService user identifier

\n"},{"key":"query[max_results]","value":"{{max_results}}","description":"

Format: integer, 1 to 1000
Default: 100

\n","type":"text"},{"key":"query[start_index]","value":"{{start_index}}","description":"

Format: integer
Default: 0

\n","type":"text"},{"key":"query[id_from]","value":"{{id_from}}","description":"

Format: integer

\n","type":"text"},{"key":"query[from_date]","value":"{{from_date}}","description":"

Conditional (required if till_date is used)
Format: YYYY-MM-DD

\n","type":"text"},{"key":"query[till_date]","value":"{{till_date}}","description":"

Format: YYYY-MM-DD

\n","type":"text"}]},"url":"{{base_url}}/addac/list","urlObject":{"path":["addac","list"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"94f17664-a07b-4190-9d41-80fe9f445a03","name":"addac/list ","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","type":"text","description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid"},{"key":"query[max_results]","value":"","description":"Format: integer Restrictions: 1 to 1000
Default: 100","type":"text"},{"key":"query[start_index]","value":"","description":"Format: integer
Restrictions: 0 or greater
Default: 0","type":"text"},{"key":"query[id_from]","value":"","description":"Format: integer
Restrictions: 0 or greater","type":"text"},{"key":"query[from_date]","value":"","description":"Format: date YYYY-MM-DD","type":"text"},{"key":"query[till_date]","value":"","description":"Format: date YYYY-MM-DD","type":"text"}]},"url":"{{base_url}}/addac/list"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 04 Mar 2019 15:38:30 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.05625"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_874_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_373_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Sun, 24 Feb 2019 13:13:15 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_368_1416256=zjPdSZUVIWco047loWYbBcRGfVwAAAAA8ctqWNQ+gM0AoFAfTlLW5w==; path=/; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"___utmvmoNuBZVNB=PshzlbKfAIo; path=/; Max-Age=900"},{"key":"Set-Cookie","value":"___utmvaoNuBZVNB=wuT\u0001kadd; path=/; Max-Age=900"},{"key":"Set-Cookie","value":"___utmvboNuBZVNB=mZJ XQeOqalE: GtJ; path=/; Max-Age=900"},{"key":"Content-Length","value":"395"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"2-31315336-31315338 NNNN CT(2 10 0) RT(1551713988376 24) q(0 1 1 1) r(2 2) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n \n _DOWNLOADED_445566_ADDACS_269843831.xml\n 2019-03-04T00:00:00Z\n 1\n 82\n \n"}],"_postman_id":"cfbd051c-2c14-4102-830e-539c096a6554"}],"id":"e55ab879-f272-48da-93b5-ef8922d9848a","description":"

Description

addac/list provides a paginated summary of all ADDACS reports for a specified service user. By default the first 100 reports are returned. Reports are listed in reverse order, most recent first. Each ADDACS file summary includes the URI to retrieve the full file.

Usage

This call must be made as a POST. If made as a GET the uri attribute is incorrect.

Typically a client application would make this call once a day to list new reports.

<addac_id> values are not contiguous but always increase. To list reports once only, keep a record of the maximum <addac_id> value. When making the call, add one to the maximum and use this as the query[id_from] parameter.

Listing reports by date range can be unreliable.

Response

A successful response from addac/list is an XML list of ADDACS file summaries. The root <addacs> tag includes the number of results returned, the start index for the results returned, and the total number of results.

In the case that there are no ADDACS files the root element is empty:

200 OK\n

<?xml version='1.0' encoding='UTF-8'?><addacs results='0' total_results='0' start_index='0'></addacs>\n

Note the single quotes in this response.

Errors

Missing or invalid service user

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid Service User ID: 'su_pslid'</error>\n</errors>\n

Invalid date value

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Unable to parse date 'tomorrow' expected format is YYYY-MM-DD</error>\n</errors>\n

Value out of range

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Mysql::Error: #42000You have an error in your SQL syntax  [...]  </error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"f726fae6-bed5-4726-9092-3df20090b18b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4147ea0c-1f80-47d9-90f5-d01b5fc20290","type":"text/javascript","exec":[""]}}],"_postman_id":"e55ab879-f272-48da-93b5-ef8922d9848a"},{"name":"4.8.4 Retrieve ADDACS file","item":[{"name":"addac/{{id}}","event":[{"listen":"test","script":{"id":"30e9deb0-1b3d-47eb-bb50-3cc513d4053d","exec":["pm.test(\"Response time is less than 300ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include(''+ pm.environment.get('addac_file_name') +'');"," "," var response = pm.response.text();"," //var pattern = //g;"," "," //pm.expect(pattern.test(response)).to.eql(true);"," pm.expect(pm.response.text()).to.include('');","});","","pm.test(\"Body is correct\", function () {"," pm.response.to.have.body(pm.environment.get(\"new_addac_list_response\"));","});","","pm.globals.unset(\"new_addac_list_response\");"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"5e2508d8-083b-4e45-acb1-83525fc7dfca","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","console.log(authHash);","","var dataGen = sd.testing;","","//var postData = {};","var query = {};","query.service_user = {};","query.service_user.pslid = pm.environment.get('pslid');","","","var postFormData = dataGen.json2formData(query, 'query');","","console.log(postFormData);","","const postDataRequest = {"," url: pm.environment.get('base_url') + '/addac/list',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: postFormData"," }","};","","pm.sendRequest(postDataRequest, function (err, res) {"," console.log('RESPONSE START');"," console.log(res.text());"," console.log('RESPONSE END');"," "," var jsonObject = xml2Json(res.text());"," "," pm.environment.set('addac_file_id',jsonObject.addacs.addac.addac_id);"," pm.environment.set('addac_file_name', jsonObject.addacs.addac.file_name);","});"],"type":"text/javascript"}}],"id":"335a37fe-7b74-41e2-be69-7b25f1050b75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/addac/{{addac_file_id}}","urlObject":{"path":["addac","{{addac_file_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"db086b29-9df8-4417-a3da-c238ab5bc617","name":"addac file","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/addac/{{addac_file_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 04 Mar 2019 16:17:19 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.05340"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"1219"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"8-7847393-7852469 SNNN RT(1551715975677 342231) q(0 0 0 -1) r(0 0) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n _DOWNLOADED_445566_ADDACS_269778437.xml\n 2019-03-04T00:00:00Z\n 1\n PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEJBQ1NE\nb2N1bWVudD4KICA8RGF0YT4KICAgIDxNZXNzYWdpbmdBZHZpY2VzPgogICAg\nICA8SGVhZGVyIGRvY3VtZW50LW51bWJlcj0iMCIgc3ViamVjdC1maXJzdC1h\nb3NuPSIwMDEwNDI2MSIgc3ViamVjdC1sYXN0LWFvc249IjAwMTA0MjYxIiB1\nc2VyLW51bWJlcj0iNTAwMDE3IiBhZHZpY2UtdHlwZT0iQUREQUNTIiByZXBv\ncnQtZ2VuZXJhdGlvbi1kYXRlPSIyMDE5LTAzLTA0IiB1c2VyLW5hbWU9IkFQ\nSSBEb2N1bWVudGF0aW9uIiByZXBvcnQtdHlwZT0iNzAwMSIgc3RyZWFtLWlk\nZW50aWZpZXI9IjAiIGVudmVsb3BlLXNlcXVlbmNlLW51bWJlcj0iMDAwMDEx\nMzIiPgogICAgICA8L0hlYWRlcj4KICAgICAgPEFkZHJlc3NlZUluZm9ybWF0\naW9uPgogICAgICA8L0FkZHJlc3NlZUluZm9ybWF0aW9uPgogICAgICA8TWVz\nc2FnaW5nQWR2aWNlIHJlZmVyZW5jZT0iU0QxMTkwMTIyMTIxNzIyODMyIiBw\nYXllci1uYW1lPSJNaWEiIHBheWVyLWFjY291bnQtbnVtYmVyPSIqKioqMDAw\nNyIgZWZmZWN0aXZlLWRhdGU9IjIwMTktMDMtMDQiIHBheWVyLXNvcnQtY29k\nZT0iKioqKioqIiByZWFzb24tY29kZT0iMCIgYW9zbj0iMTA0MjYxIi8+CiAg\nICA8L01lc3NhZ2luZ0FkdmljZXM+CiAgPC9EYXRhPgo8L0JBQ1NEb2N1bWVu\ndD4K\n\n"}],"_postman_id":"335a37fe-7b74-41e2-be69-7b25f1050b75"}],"id":"1b98a12a-365d-478b-9735-ce98f56fb437","description":"

Description

Individual ADDACS files can be retrieved from the SmartDebit API in XML format. The files are returned as base64 encoded strings.

Response

The example response shows the base64 encoded file within the file node.

The XML version of the ADDACS file is a filtered version of the original Bacs file. In the case that the referenced DDI has a Customer Id in SmartDebit the Customer Id is included in the MessagingAdvice as the payer-reference attribute.

An XML ADDACS file consists of a Header, an AddresseeInformation and a number of MessagingAdvice tags within a BACSDocument > Data > MessagingAdvices wrapper. The data formats in the ADDACS file are preserved – dates are presented in the format YYYY-MM-DD.

The Header tag can contain the following attributes:

document-number
advice-type (which takes the value \"ADDACS\")
subject-first-aosn (the serial number of the first advice in the report)
subject-last-aosn (the serial number of the last advice in the report)
user-number (the service user's SUN)
stream-identifier
envelope-sequence-number
report-generation-date
user-name (the service user's bank account name)
report-type (which takes the value \"7001\")

The AddresseeInformation tag is usually empty but can contain the following attributes:

name
address1
address2
address3
address4
address5

The MessagingAdvice tag can contain the following attributes:

reference (the reference number of the DDI or the last-used collection reference)
payer-reference (the Customer Id of the payer)
reason-code (refer to the list of reason codes)
user-number (the service user's SUN)
record-type
effective-date
payer-name
payer-sort-code
payer-account-number
payer-new-sort-code
payer-new-account-number
payer-new-name
aosn (the serial number of the advice)

Depending on the service user configuration, account details may be obscured.

An example XML ADDACS file, including payer-reference, would look like:

<?XML version=\"1.0\" encoding=\"UTF-8\"?>\n  <BACSDocument>\n    <Data>\n      <MessagingAdvices>\n        <Header advice-type=\"ADDACS\" document-number=\"0\" report-generation-date=\"2019-03-28\" subject-last-aosn=\"00000020\" user-name=\"SERVICE USER LTD\" user-number=\"250050\" report-type=\"7001\" subject-first-aosn=\"00000020\" stream-identifier=\"0\" envelope-sequence-number=\"00000008\">\n        </Header>\n        <AddresseeInformation>\n        </AddresseeInformation>\n        <MessagingAdvice reason-code=\"B\" reference=\"ABC1234567\" payer-reference=\"65880\" aosn=\"20\" effective-date=\"2019-03-28\" payer-account-number=\"12345678\" payer-name=\"R SMITH\" payer-sort-code=\"000000\"/>\n      </MessagingAdvices>\n    </Data>\n  </BACSDocument> \n

Errors

Errors can be avoided by retrieving only reports listed by addac/list.

If the report cannot be found:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find AddacsImport with ID=1235545</error>\n</errors>\n

If no report has been specified - {{base_url}}/addac/

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find AddacsImport without an ID</error>\n</errors>\n

If you do not have permission to view the report:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Permission Denied.</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"d65269fa-f1dd-4e00-805a-c384e3d707d0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6afe1571-1189-4e88-986a-6c938c19c277","type":"text/javascript","exec":[""]}}],"_postman_id":"1b98a12a-365d-478b-9735-ce98f56fb437"},{"name":"4.8.5 List ARUDD files","item":[{"name":"arudd/list","event":[{"listen":"test","script":{"id":"b96004a1-4227-4d35-a14f-d35afba43b44","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 300ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"\");"," "," var response = pm.response.text();",""," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');","});","","pm.test('Schema is valid', function() {"," var jsonObject = xml2Json(pm.response.text()); "," var jsonSchema = sd.api.schema.aruddList; "," "," pm.expect(tv4.validate(jsonObject, jsonSchema)).to.be.true;"," ","});"],"type":"text/javascript"}}],"id":"b0d4815e-100f-4779-ba39-57be75466244","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","type":"text","description":"

Required
\nService user identifier

\n"},{"key":"query[max_results]","value":"{{max_results}}","type":"text","description":"

Format: integer, 1 to 1000
Default: 100

\n"},{"key":"query[start_index]","value":"{{start_index}}","type":"text","description":"

Format: integer
Default: 0

\n"},{"key":"query[id_from]","value":"{{id_from}}","type":"text","description":"

Format: integer

\n"},{"key":"query[from_date]","value":"{{from_date}}","type":"text","description":"

Conditional (required if till_date is used)
Format: YYYY-MM-DD

\n"},{"key":"query[till_date]","value":"{{till_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"}]},"url":"{{base_url}}/arudd/list","urlObject":{"path":["arudd","list"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"748857b6-0609-4f08-923a-c0f5d98f1e0c","name":"arudd/list","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","type":"text","description":"Required
\nService user identifier"},{"key":"query[max_results]","value":"{{max_results}}","type":"text","description":"Format: integer, 1 to 1000
Default: 100"},{"key":"query[start_index]","value":"{{start_index}}","type":"text","description":"Format: integer
Default: 0"},{"key":"query[id_from]","value":"{{id_from}}","type":"text","description":"Format: integer"},{"key":"query[from_date]","value":"{{from_date}}","type":"text","description":"Conditional (required if till_date is used)
Format: YYYY-MM-DD"},{"key":"query[till_date]","value":"{{till_date}}","type":"text","description":"Format: YYYY-MM-DD"}]},"url":"{{base_url}}/arudd/list"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\n\n _DOWNLOADED_445566_ARUDD_280646574.xml\n 2019-03-20T00:00:00Z\n REFT1019\n 999\n 33\n 3\n 15184\n \n _DOWNLOADED_445566_ARUDD_280540919.xml\n 2019-03-19T00:00:00Z\n REFT1019\n 999\n 28\n 4\n 33960\n "}],"_postman_id":"b0d4815e-100f-4779-ba39-57be75466244"}],"id":"50da72c5-432c-4e3f-9640-22be989fee95","description":"

Description

arudd/list provides a paginated summary of all ARUDD reports for a specified service user. By default the first 100 reports are returned. Reports are listed in reverse order, most recent first. Each ARUDD file summary includes the URI to retrieve the full file.

Usage

This call must be made as a POST. If made as a GET the uri attribute is incorrect.

Typically a client application would make this call once a day to list new reports.

<arudd_id> values are not contiguous but always increase. To list reports once only, keep a record of the maximum <arudd_id> value. When making the call, add one to the maximum and use this as the query[id_from] parameter.

Listing reports by date range can be unreliable.

Response

A successful response from arudd/list is an XML list of ARUDD file summaries. The root <arudds> tag includes the number of results returned, the start index for the results returned, and the total number of results.

In the case that there are no ARUDD files the root element is empty:

200 OK\n

<?xml version='1.0' encoding='UTF-8'?><arudds results='0' total_results='0' start_index='0'>\n</arudds>\n

Note the single quotes in this response.

Errors

Missing or invalid service user

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid Service User ID: 'su_pslid'</error>\n</errors>\n

Invalid date value

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Unable to parse date 'tomorrow' expected format is YYYY-MM-DD</error>\n</errors>\n

Value out of range

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Mysql::Error: #42000You have an error in your SQL syntax  [...]  </error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"dffdd5bf-b393-411f-8514-6c61a0744de4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"25956be1-d4e6-4bc5-827e-2c73766ee08a","type":"text/javascript","exec":[""]}}],"_postman_id":"50da72c5-432c-4e3f-9640-22be989fee95"},{"name":"4.8.6 Retrieve ARUDD file","item":[{"name":"arudd/{{id}}","event":[{"listen":"test","script":{"id":"68e9b89b-34a9-4ac1-ae1b-f298c0b834fb","exec":["pm.test(\"Response time is less than 300ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(''); //Pay attention on different reports the XML uses single quotes and on others uses double quotes"," "," var response = pm.response.text();"," "," //var pattern = //g;"," "," //pm.expect(pattern.test(response)).to.eql(true);"," //pm.expect(pm.response.text()).to.include('');","});","","","//MISSING SCHEMA CHECK"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"9bf8b351-dc78-42cf-bf2a-2dcd3d484d71","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","console.log(authHash);","","var dataGen = sd.testing;","","//var postData = {};","var query = {};","query.service_user = {};","query.service_user.pslid = pm.environment.get('pslid');","","","var postFormData = dataGen.json2formData(query, 'query');","","console.log(postFormData);","","const postDataRequest = {"," url: pm.environment.get('base_url') + '/arudd/list',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: postFormData"," }","};","","pm.sendRequest(postDataRequest, function (err, res) {"," console.log('RESPONSE START');"," console.log(res.text());"," console.log('RESPONSE END');"," "," var jsonObject = xml2Json(res.text());"," "," pm.environment.set('arudd_file_id',jsonObject.arudds.arudd.arudd_id);"," pm.environment.set('arudd_file_name', jsonObject.arudds.arudd.file_name);","});"],"type":"text/javascript"}}],"id":"cc430d18-83b9-4d92-be33-334959c95356","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/arudd/{{arudd_file_id}}","urlObject":{"path":["arudd","{{arudd_file_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5ca1b925-6c2c-4cc4-951c-7691f442a1ed","name":"arudd file","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/arudd/{{arudd_file_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 05 Mar 2019 10:11:14 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.06216"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"2297"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"6-254871-259131 SNNN RT(1551780638679 115786) q(0 0 0 -1) r(1 1) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n test_account_TestArudd.xml\n 2019-03-05T00:00:00Z\n REFT1019\n 999\n 1\n 19995\n PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEJBQ1NE\nb2N1bWVudCB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1M\nU2NoZW1hLWluc3RhbmNlIiB4c2k6bm9OYW1lc3BhY2VTY2hlbWFMb2NhdGlv\nbj0ibmV3YmFjcy1hZHZpY2VzLnhzZCI+CiAgPERhdGE+CiAgICA8QVJVREQ+\nCiAgICAgIDxIZWFkZXIgcmVwb3J0VHlwZT0iUkVGVDEwMTkiIGFkdmljZU51\nbWJlcj0iOTk5IiBjdXJyZW50UHJvY2Vzc2luZ0RhdGU9IjIwMTktMDMtMDUi\nPgogICAgICA8L0hlYWRlcj4KICAgICAgPEFkZHJlc3NlZUluZm9ybWF0aW9u\nIG5hbWU9IkFQSSBEb2N1bWVudGF0aW9uIj4KICAgICAgPC9BZGRyZXNzZWVJ\nbmZvcm1hdGlvbj4KICAgICAgPFNlcnZpY2VMaWNlbnNlSW5mb3JtYXRpb24g\ndXNlck5hbWU9IkFQSSBEb2N1bWVudGF0aW9uIiB1c2VyTnVtYmVyPSI1MDAw\nMTciPgogICAgICA8L1NlcnZpY2VMaWNlbnNlSW5mb3JtYXRpb24+CiAgICAg\nIDxBZHZpY2U+CiAgICAgICAgPE9yaWdpbmF0aW5nQWNjb3VudFJlY29yZHM+\nCiAgICAgICAgICA8T3JpZ2luYXRpbmdBY2NvdW50UmVjb3JkPgogICAgICAg\nICAgICA8T3JpZ2luYXRpbmdBY2NvdW50IHR5cGU9IjAiIHNvcnRDb2RlPSIq\nKioqKioiIGJhbmtOYW1lPSJBUEkgRG9jdW1lbnRhdGlvbiIgYnJhbmNoTmFt\nZT0iQ0lUWSBPRkZJQ0UiIG5hbWU9IkFQSSBEb2N1bWVudGF0aW9uIiBudW1i\nZXI9IioqKio1Njc4Ij4KICAgICAgICAgICAgPC9PcmlnaW5hdGluZ0FjY291\nbnQ+CiAgICAgICAgICAgIDxSZXR1cm5lZERlYml0SXRlbSByZXR1cm5Db2Rl\nPSIwIiByZXR1cm5EZXNjcmlwdGlvbj0iUkVGRVIgVE8gUEFZRVIiIGN1cnJl\nbmN5PSJHQlAiIG9yaWdpbmFsUHJvY2Vzc2luZ0RhdGU9IjIwMTktMDMtMDUi\nIHJlZj0iU0QxMTkwMTEyMTY1MTM5MzMiIHZhbHVlT2Y9IjE5OS45NSIgdHJh\nbnNDb2RlPSIxNyI+CiAgICAgICAgICAgICAgPFBheWVyQWNjb3VudCBzb3J0\nQ29kZT0iKioqKioqIiBiYW5rTmFtZT0iQmFyY2xheXMiIHJlZj0iU0QxMTkw\nMTEyMTY1MTM5MzMiIGJyYW5jaE5hbWU9IkNpdHkiIG51bWJlcj0iMDAwNyIg\nbmFtZT0idGVzdC1hY2NvdW50Ij4KICAgICAgICAgICAgICA8L1BheWVyQWNj\nb3VudD4KICAgICAgICAgICAgPC9SZXR1cm5lZERlYml0SXRlbT4KICAgICAg\nICAgICAgPFRvdGFscyBjdXJyZW5jeT0iR0JQIiBudW1iZXJPZj0iMSIgdmFs\ndWVPZj0iMTk5Ljk1Ij4KICAgICAgICAgICAgPC9Ub3RhbHM+CiAgICAgICAg\nICA8L09yaWdpbmF0aW5nQWNjb3VudFJlY29yZD4KICAgICAgICA8L09yaWdp\nbmF0aW5nQWNjb3VudFJlY29yZHM+CiAgICAgIDwvQWR2aWNlPgogICAgPC9B\nUlVERD4KICA8L0RhdGE+CjwvQkFDU0RvY3VtZW50Pgo=\n\n"}],"_postman_id":"cc430d18-83b9-4d92-be33-334959c95356"}],"id":"15ff914d-ec65-435b-9b6b-0d7d3d257212","description":"

Description

Individual ARUDD files can be retrieved from the SmartDebit API in XML format. The files are returned as base64 encoded strings.

Response

The example response shows the ARUDD summary including the base64 encoded file within the file node.

The XML version of the ARUDD file is a filtered version of the original Bacs file. In the case that the referenced DDI has a Customer Id in SmartDebit the Customer Id is included in the ReturnedDebitItem as the payerReference attribute.

An XML ARUDD file consists of an OriginatingAccount tag, a number of ReturnedDebitItem tags, and a Totals tag within a BACSDocument > Data > ARUDD > Advice > OriginatingAccountRecords > OriginatingAccountRecord wrapper. The ARUDD tag also contains a Header tag, an AddresseeInformation tag, and a ServiceLicenseInformation tag. The data formats in the ARUDD file are preserved – dates are presented in the format YYYY-MM-DD.

All ReturnedDebitItems within an OriginatingAccountRecord have the same originalProcessingDate. Some ARUDD advices are received late. This can result in an ARUDD containing more than one OriginatingAccountRecord.

The Header tag can contain the following attributes:

reportType
adviceNumber
currentProcessingDate

The AddresseeInformation tag can contain the following attributes:

name
address1
address2
address3
address4
address5

The ServiceLicenseInformation tag identifies the service user and can contain the following attributes:

userName
userNumber

The OriginatingAccount tag details the service user's account. The OriginatingAccount tag can contain the following attributes:

name
number
sortCode
type
bankName
branchName

The ReturnedDebitItem tag can contain the following attributes:

ref (the reference number of the DDI or the collection reference)
payerReference (the Customer Id of the payer)
transCode
returnCode (refer to the list of reason codes)
returnDescription (refer to the list of reason codes)
originalProcessingDate (the expected value of which is the working day prior to the collection date)
valueOf
currency

Depending on the service user configuration, account details may be obscured.

An example XML ARUDD file, including payer-reference, would look like:

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<BACSDocument xsi:noNamespaceSchemaLocation=\"newbacs-advices.xsd\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n  <Data>\n    <ARUDD>\n      <Header reportType=\"REFT1019\" adviceNumber=\"999\" currentProcessingDate=\"2019-03-19\">\n      </Header>\n      <AddresseeInformation name=\"SERVICE USER LTD\">\n      </AddresseeInformation>\n      <ServiceLicenseInformation userName=\"SERVICE USER LTD\" userNumber=\"555666\">\n      </ServiceLicenseInformation>\n      <Advice>\n        <OriginatingAccountRecords>\n          <OriginatingAccountRecord>\n            <OriginatingAccount type=\"0\" branchName=\"WOKING\" sortCode=\"20-21-22\" name=\"SERVICE USER\" bankName=\"BARCLAYS BANK UK PLC\" number=\"87654321\">\n            </OriginatingAccount>\n            <ReturnedDebitItem originalProcessingDate=\"2019-03-14\" valueOf=\"100.00\" payerReference=\"7890\" currency=\"GBP\" transCode=\"17\" ref=\"ABC123456\" returnCode=\"0\" returnDescription=\"REFER TO PAYER\">\n              <PayerAccount branchName=\"BANK ACCOUNT 3\" ref=\"ABC123456\" sortCode=\"00-00-00\" name=\"R SMITH           \" bankName=\"Santander\" number=\"12345678\">\n              </PayerAccount>\n            </ReturnedDebitItem>\n            <Totals numberOf=\"1\" valueOf=\"100.00\" currency=\"GBP\">\n            </Totals>\n          </OriginatingAccountRecord>\n        </OriginatingAccountRecords>\n      </Advice>\n    </ARUDD>\n  </Data>\n</BACSDocument>\n

Errors

Errors can be avoided by retrieving only reports listed by arudd/list.

If the report cannot be found:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find AruddImport with ID=1235545</error>\n</errors>\n

If no report has been specified - {{base_url}}/arudd/

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find AruddImport without an ID</error>\n</errors>\n

If you do not have permission to view the report:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Permission Denied.</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"45f38fb1-6269-45df-b86b-e76bf3b40742","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"69da1e0c-307a-4f57-a53a-921555eaf45a","type":"text/javascript","exec":[""]}}],"_postman_id":"15ff914d-ec65-435b-9b6b-0d7d3d257212"},{"name":"4.8.7 List DDICA files","item":[{"name":"indemnity/list","event":[{"listen":"test","script":{"id":"ca4c6424-7ec5-4709-9dea-6b4deb3a2f4a","exec":["eval(pm.globals.get('jasmine'));","","pm.test(\"Response time is less than 300ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');","});","","","pm.test('Schema is valid', function() {"," var jsonObject = xml2Json(pm.response.text()); "," var jsonSchema = sd.api.schema.ddicaList; "," "," pm.expect(tv4.validate(jsonObject, jsonSchema)).to.be.true;"," ","});",""],"type":"text/javascript"}}],"id":"0f347b16-4e38-483f-a4cd-6ede1c2a5982","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","type":"text","description":"

Required
\nService user identifier

\n"},{"key":"query[max_results]","value":"{{max_results}}","type":"text","description":"

Format: integer, 1 to 1000
Default: 100

\n"},{"key":"query[start_index]","value":"{{start_index}}","type":"text","description":"

Format: integer
Default: 0

\n"},{"key":"query[id_from]","value":"{{id_from}}","type":"text","description":"

Format: integer

\n"},{"key":"query[from_date]","value":"{{from_date}}","type":"text","description":"

Conditional (required if till_date is used)
Format: YYYY-MM-DD

\n"},{"key":"query[till_date]","value":"{{till_date}}","type":"text","description":"

Format: YYYY-MM-DD

\n"}]},"url":"{{base_url}}/indemnity/list","urlObject":{"path":["indemnity","list"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4bbcff92-ae4a-4281-999c-30cee51ec1cd","name":"indemnity list","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid","key":"query[service_user][pslid]","type":"text","value":"{{pslid}}"},{"description":"Format: integer
Restrictions: 1 to 1000
Default: is 100","key":"query[max_results]","type":"text","value":""},{"description":"Format: integer
Restrictions: 0 or greater
Default: is 0","key":"query[start_index]","type":"text","value":""},{"description":"Format: integer
Restrictions: 0 or greater","key":"query[id_from]","type":"text","value":""},{"description":"Format: date YYYY-MM-DD","key":"query[from_date]","type":"text","value":""},{"description":"Format: date YYYY-MM-DD","key":"query[till_date]","type":"text","value":""}]},"url":"{{base_url}}/indemnity/list"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 05 Mar 2019 12:21:05 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.16024"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_874_1416256=a; Max-Age=0; path=/; expires=Mon, 04 Mar 2019 08:33:16 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_373_1416256=a; Max-Age=0; path=/; expires=Mon, 04 Mar 2019 08:33:16 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Mon, 04 Mar 2019 08:33:16 GMT; Domain=.ddprocessing.co.uk"},{"key":"Content-Length","value":"505"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"13-3320918-3323758 NNNN CT(0 0 0) RT(1551788533343 12327) q(0 0 0 -1) r(2 2) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n \n _DOWNLOADED_445566_DDICA_280539217.xml\n 2019-03-05 00:13:18\n DIRECT DEBIT INDEMNITY CLAIM ADVICE REPORT FOR 05/03/2019\n 199.95\n 44\n \n"}],"_postman_id":"0f347b16-4e38-483f-a4cd-6ede1c2a5982"}],"id":"f97a3125-9987-4582-93d7-a9617cfac0b4","description":"

Description

indemnity/list provides a paginated summary of all Direct Debit Indemnity Claim Advice (DDICA) files for a specified service user. By default the first 100 DDICA summaries are returned. Reports are listed in reverse order, most recent first. Each DDICA file summary includes the URI to retrieve the full file.

Usage

This call must be made as a POST. If made as a GET the uri attribute is incorrect.

Typically a client application would make this call once a day to list new reports.

<import_id> values are not contiguous but always increase. To list reports once only, keep a record of the maximum <import_id> value. When making the call, add one to the maximum and use this as the query[id_from] parameter.

Listing reports by date range can be unreliable.

Response

A successful response from indemnity/list is an XML list of DDICA file summaries. The root <indemnities> tag includes the number of results returned, the start index for the results returned, and the total number of results.

Note that the response does not have an XML header.

In the case that there are no DDICA files the root element is empty:

200 OK\n

<indemnities results='0' total_results='0' start_index='0'></indemnities>\n

Note the single quotes in this response.

Errors

Missing or invalid service user

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Invalid Service User ID: 'su_pslid'</error>\n</errors>\n

Invalid date value

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Unable to parse date 'yesterday' expected format is YYYY-MM-DD</error>\n</errors>\n

Value out of range

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Mysql::Error: #42000You have an error in your SQL syntax  [...]  </error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"c6cf2075-d8cb-43c5-8fea-9a3155eac566","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"51c0cc31-13ea-49ce-9c1e-a3099c47e055","type":"text/javascript","exec":[""]}}],"_postman_id":"f97a3125-9987-4582-93d7-a9617cfac0b4"},{"name":"4.8.8 Retrieve DDICA file","item":[{"name":"indemnity/{{id}}","event":[{"listen":"test","script":{"id":"43e57f10-16ed-4d7c-a842-d444e7f98fcd","exec":["pm.test(\"Response time is less than 300ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('');"," "," //var response = pm.response.text();"," //var pattern = //g;"," "," //pm.expect(pattern.test(response)).to.eql(true);"," pm.expect(pm.response.text()).to.include(''+ pm.environment.get('indemnity_file_name') +'');"," pm.expect(pm.response.text()).to.include('');"," pm.expect(pm.response.text()).to.include('');","});","","pm.test('Schema is valid', function() {"," var jsonObject = xml2Json(responseBody); "," var jsonSchema = sd.api.schema.ddicaList; "," "," pm.expect(tv4.validate(jsonObject, jsonSchema)).to.be.true;"," ","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"6a859b2d-e3d1-4a7d-ad51-aeef03eb0ed1","exec":["pm.sendRequest(\"https://sandbox.smartdebit.co.uk/Scripts/smartdebit.jasmine.js\", (err, res) => { pm.globals.set('jasmine' ,res.text() ) });","","eval(pm.globals.get('jasmine'));","","var authHash = btoa(pm.environment.get('api_user') + \":\" + pm.environment.get('api_user_password'));","","console.log(authHash);","","var dataGen = sd.testing;","","//var postData = {};","var query = {};","query.service_user = {};","query.service_user.pslid = pm.environment.get('pslid');","","","var postFormData = dataGen.json2formData(query, 'query');","","console.log(postFormData);","","const postDataRequest = {"," url: pm.environment.get('base_url') + '/indemnity/list',"," method: 'POST',"," header: `Authorization:Basic ${authHash}`,"," body: {"," mode: 'formdata',"," formdata: postFormData"," }","};","","pm.sendRequest(postDataRequest, function (err, res) {"," console.log('RESPONSE START');"," console.log(res.text());"," console.log('RESPONSE END');"," "," var jsonObject = xml2Json(res.text());"," "," pm.environment.set('indemnity_file_id',jsonObject.indemnities.indemnity.import_id);"," pm.environment.set('indemnity_file_name', jsonObject.indemnities.indemnity.file_name);","});"],"type":"text/javascript"}}],"id":"ebec5c28-3427-4f53-9887-c0ab817a9574","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/indemnity/{{indemnity_file_id}}","urlObject":{"path":["indemnity","{{indemnity_file_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ec7a3cf0-67f7-499a-acab-5934b0d5d9e4","name":"indemnity file","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/indemnity/{{indemnity_file_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 05 Mar 2019 13:54:42 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.19030"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Content-Length","value":"3331"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"14-5406204-5406216 SNNN RT(1551794162663 368) q(0 0 0 -1) r(2 2) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n _DOWNLOADED_445566_DDICA_280539217.xml\n 2019-03-05 00:13:18\n PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPFZvY2FE\nb2N1bWVudD4KICA8RGF0YT4KICAgIDxEb2N1bWVudCB0eXBlPSJESVJFQ1Qg\nREVCSVQgSU5ERU1OSVRZIENMQUlNIEFEVklDRSBSRVBPUlQiIHNjaGVtYVZl\ncnNpb249IjEuMCIgY3JlYXRlZD0iMjAxOS0wMy0wNSAgMDA6MTM6MTgiPgog\nICAgICA8Q29tcGFueU5hbWU+QmFjcyBQYXltZW50IFNjaGVtZXMgTGltaXRl\nZDwvQ29tcGFueU5hbWU+CiAgICAgIDxSZXBvcnRUaXRsZT5ESVJFQ1QgREVC\nSVQgSU5ERU1OSVRZIENMQUlNIEFEVklDRSBSRVBPUlQgRk9SIDA1LzAzLzIw\nMTk8L1JlcG9ydFRpdGxlPgogICAgICA8UmVwb3J0UHJvZHVjdGlvbkRhdGU+\nMjAxOS0wMy0wNSAgMDA6MTM6MTg8L1JlcG9ydFByb2R1Y3Rpb25EYXRlPgog\nICAgICA8U2VydmljZVVzZXJOdW1iZXI+NTAwMDE3PC9TZXJ2aWNlVXNlck51\nbWJlcj4KICAgICAgPFNlcnZpY2VVc2VyTmFtZT5BUEkgRG9jdW1lbnRhdGlv\nbjwvU2VydmljZVVzZXJOYW1lPgogICAgICA8TnVtYmVyT2ZBZHZpY2VzPjE8\nL051bWJlck9mQWR2aWNlcz4KICAgICAgPE5ld0FkdmljZXM+CiAgICAgICAg\nPERESUNBZHZpY2U+CiAgICAgICAgICA8U2VxTm8+MjAxOTAzMDUwM0E4NTYy\nNDI3MzI8L1NlcU5vPgogICAgICAgICAgPFBheWluZ0JhbmtSZWZlcmVuY2U+\nRERJQzA1MjUyNDAzPC9QYXlpbmdCYW5rUmVmZXJlbmNlPgogICAgICAgICAg\nPFNVTnVtYmVyPjAwMDAwMDwvU1VOdW1iZXI+CiAgICAgICAgICA8UGF5aW5n\nQmFua05hbWU+SFNCQyBCQU5LIFBMQzwvUGF5aW5nQmFua05hbWU+CiAgICAg\nICAgICA8U1VSZWZlcmVuY2U+U0QxMTkwMTE0MTM0MzEzMjc3PC9TVVJlZmVy\nZW5jZT4KICAgICAgICAgIDxSZWFzb25Db2RlPjQ8L1JlYXNvbkNvZGU+CiAg\nICAgICAgICA8UGF5ZXJTb3J0Q29kZT4qKioqKio8L1BheWVyU29ydENvZGU+\nCiAgICAgICAgICA8UGF5ZXJBY2NvdW50PioqKiowMDA3PC9QYXllckFjY291\nbnQ+CiAgICAgICAgICA8UGF5ZXJOYW1lPk1pYTwvUGF5ZXJOYW1lPgogICAg\nICAgICAgPE5vT2ZBZHZGb3JDbGFpbT4xPC9Ob09mQWR2Rm9yQ2xhaW0+CiAg\nICAgICAgICA8VG90YWxBbW91bnQ+MTk5Ljk1PC9Ub3RhbEFtb3VudD4KICAg\nICAgICAgIDxERENvbGxlY3Rpb25zPgogICAgICAgICAgICA8RERDb2xsZWN0\naW9uPgogICAgICAgICAgICAgIDxEYXRlT2ZEaXJlY3REZWJpdD4yMDE5LTAz\nLTA1PC9EYXRlT2ZEaXJlY3REZWJpdD4KICAgICAgICAgICAgICA8QW1vdW50\nPjE5OS45NTwvQW1vdW50PgogICAgICAgICAgICA8L0REQ29sbGVjdGlvbj4K\nICAgICAgICAgIDwvRERDb2xsZWN0aW9ucz4KICAgICAgICA8L0RESUNBZHZp\nY2U+CiAgICAgICAgPFRvdGFsTnVtYmVyT2ZOZXdBZHZpY2VzPjE8L1RvdGFs\nTnVtYmVyT2ZOZXdBZHZpY2VzPgogICAgICAgIDxUb3RhbFZhbHVlT2ZEZWJp\ndHM+MTk5Ljk1PC9Ub3RhbFZhbHVlT2ZEZWJpdHM+CiAgICAgICAgPERhdGVP\nZkRlYml0PjIwMTktMDMtMDU8L0RhdGVPZkRlYml0PgogICAgICA8L05ld0Fk\ndmljZXM+CiAgICAgIDxSZWFzb25Db2RlTWVhbmluZz4xID0gQW1vdW50IGFu\nZCAvIG9yIGRhdGUgb2YgRGlyZWN0IERlYml0IGRpZmZlciBmcm9tIEFkdmFu\nY2UgTm90aWNlLjIgPSBObyBBZHZhbmNlIE5vdGljZSByZWNlaXZlZCBieSBQ\nYXllci9vciB0aGUgYW1vdW50IHF1b3RlZCBpcyBkaXNwdXRlZC4zID0gRERJ\nIGNhbmNlbGxlZCBieSBwYXlpbmcgYmFuay40ID0gUGF5ZXIgaGFzIGNhbmNl\nbGxlZCBEREkgZGlyZWN0IHdpdGggc2VydmljZSB1c2VyLjUgPSBBVURESVMg\nc2VydmljZSB1c2VycyBvbmx5IC0gTm8gSW5zdHJ1Y3Rpb24gaGVsZC4gUGF5\nZXIgZGlzcHV0ZXMgaGF2aW5nIGdpdmVuIGF1dGhvcml0eS42ID0gQVVERElT\nIHNlcnZpY2UgdXNlcnMgb25seSAtIFNpZ25hdHVyZSBvbiBEREkgaXMgZnJh\ndWR1bGVudCBvciBub3QgaW4gYWNjb3JkYW5jZSB3aXRoIGFjY291bnQgYXV0\naG9yaXNlZCBzaWduYXR1cmUocykuNyA9IENsYWltIHJhaXNlZCBhdCBzZXJ2\naWNlIHVzZXJzIHJlcXVlc3QgYWZ0ZXIgRGlyZWN0IERlYml0IGFwcGxpZWQg\ndG8gcGF5ZXJzIGFjY291bnQuOCA9IFNlcnZpY2UgdXNlciBuYW1lIGRpc3B1\ndGVkLiBQYXllciBkb2VzIG5vdCByZWNvZ25pc2Ugc2VydmljZSB1c2VyIGNv\nbGxlY3RpbmcgRGlyZWN0IERlYml0LjwvUmVhc29uQ29kZU1lYW5pbmc+CiAg\nICA8L0RvY3VtZW50PgogIDwvRGF0YT4KPC9Wb2NhRG9jdW1lbnQ+Cg==\n\n"}],"_postman_id":"ebec5c28-3427-4f53-9887-c0ab817a9574"}],"id":"30a21318-9d4c-4551-b1b5-0ff0fdf3d71c","description":"

Description

Individual DDICA files can be retrieved from the SmartDebit API in XML format. The files are returned as base64 encoded strings.

Usage

You can match each collection in a claim to the original by the <SUReference>, the <DateOfDirectDebit> and <Amount>. The date may differ by a few days. Very occasionally the reference may differ slightly.

Where a claim is for more than one collection, this can appear either as a single <DDICAdvice> containing more than one <DDCollection>, or as more than one <DDICAdvice>, each containing a single <DDCollection>.

The <DateOfDebit> is the date on which the claims will be debited from the service user's bank account.

Note:

Indemnity claims may be cancelled before they are paid. Cancelled claims are reported to SmartDebit as DDICA cancellations. The API does not currently support DDICA cancellations.

Response

The example response shows the base64 encoded file within the file node.

The XML version of the DDICA file is a filtered version of the original Bacs file.

An XML DDICA file consists of a Document, NewAdvices and a number of DDICAdvice tags within a VocaDocument > Data wrapper. Within the DDICAdvice tag there is a DDCollections tag with one or more DDCollection child nodes. Each DDCollection node contains two nodes, DateOfDirectDebit and Amount. The data formats in the DDICA file are preserved – dates are presented in the format YYYY-MM-DD.

The Document tag can contain the following attributes:

type
schemaVersion
created

The Document tag can contain the following child nodes:

CompanyName
ReportTitle
ReportProductionDate
ServiceUserNumber
ServiceUserName
NumberOfAdvices

The DDICAdvice tag found under the NewAdvices tag can contain the following child nodes:

SeqNo
PayingBankReference
SUNumber
PayingBankName
SUReference
ReasonCode
PayerSortCode
PayerAccount
PayerName
NoOfAdvForClaim
TotalAmount

Depending on the service user configuration, account details may be obscured.

The DDCollection tag found under the DDCollections node contains the following child nodes:

DateOfDirectDebit
Amount

A successful response from indemnity/{{id}} is an XML summary of the DDICA file.

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?> \n<VocaDocument>\n  <Data>  \n    <Document type=\"DIRECT DEBIT INDEMNITY CLAIM ADVICE REPORT\" created=\"2019-01-04 00:32:40\" schemaVersion=\"1.0\">\n      <CompanyName>Bacs Payment Schemes Limited</CompanyName>\n      <ReportTitle>DIRECT DEBIT INDEMNITY CLAIM ADVICE REPORT FOR 03/01/2019</ReportTitle>\n      <ReportProductionDate>2019-01-04 00:32:40</ReportProductionDate>\n      <ServiceUserNumber>…</ServiceUserNumber>\n      <ServiceUserName>…</ServiceUserName>\n      <NumberOfAdvices>…</NumberOfAdvices>\n      <NewAdvices> \n        <DDICAdvice>  \n          <SeqNo>…</SeqNo>\n          <PayingBankReference>…</PayingBankReference>\n          <SUNumber>…</SUNumber>\n          <PayingBankName>…</PayingBankName>\n          <SUReference>…</SUReference>\n          <ReasonCode>…</ReasonCode>\n          <PayerSortCode>…</PayerSortCode>\n          <PayerAccount>…</PayerAccount>\n          <PayerName>…</PayerName>\n          <NoOfAdvForClaim>…</NoOfAdvForClaim>\n          <TotalAmount>…</TotalAmount>\n          <DDCollections>\n            <DDCollection>\n              <DateOfDirectDebit>…</DateOfDirectDebit>\n              <Amount>…</Amount>\n            </DDCollection>\n          </DDCollections>\n        </DDICAdvice>\n        <TotalNumberOfNewAdvices>…</TotalNumberOfNewAdvices>\n        <TotalValueOfDebits>…</TotalValueOfDebits>\n        <DateOfDebit>…</DateOfDebit>\n      </NewAdvices> \n      <ReasonCodeMeaning>…list of all reason codes…</ReasonCodeMeaning>\n    </Document>\n  </Data>\n</VocaDocument> \n

Errors

Errors can be avoided by retrieving only reports listed by indemnity/list.

If the report cannot be found:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find IndemnityImport with ID=123456789</error>\n</errors>\n

If no report has been specified - {{base_url}}/indemnity/

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Couldn't find IndemnityImport without an ID</error>\n</errors>\n

If you do not have permission to view the report:

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Permission Denied.</error>\n</errors>\n

\n\n

Version history

\n\n\n\n\n\n\n\n\n

API v1.1	Returns correctly-formatted XML.
	Returns malformed XML where there are multiple <DDICAdvice> nodes or where there are multiple <DDCollections> nodes within an advice.

","event":[{"listen":"prerequest","script":{"id":"6d66d328-5e78-4d93-a7fe-a8f438922081","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a31d3dde-9e76-4c62-84c5-5e9256de171a","type":"text/javascript","exec":[""]}}],"_postman_id":"30a21318-9d4c-4551-b1b5-0ff0fdf3d71c"}],"id":"93b2a4b7-3a24-43b8-b5e6-9f73952e247f","description":"

Bacs reports are notifications from the payers' banks via Bacs to the service user. The reports are XML documents containing one or more advices. SmartDebit processes these reports every working day, early in the morning, and makes them available to service users at the same time.

The SmartDebit API allows the following report types to be listed for each service user, and for individual files to be retrieved in XML format.

AUDDIS (Automated Direct Debit Instruction Service): failed or amended lodgement or cancellation transactions
ADDACS (Automated Direct Debit Amendment and Cancellation): cancellations or amendments to DDIs
ARUDD (Automated Return of Unpaid Direct Debit): failed collections
DDICA (Direct Debit Indemnity Claim Advice): claims relating to disputed collections

The files are filtered versions of the original Bacs files, returned as base64 encoded strings. Routines for decoding base64 are widely available.

Sort code and account number are masked by default. Contact SmartDebit if you require these values in full.

Some of the XML contains single quotation marks (') and some contains double quotation marks (\") due to different techniques used in generating the response.

\n","event":[{"listen":"prerequest","script":{"id":"a05fa44e-db33-42d1-be12-e097624d55c6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5f7f6a86-56db-4820-8679-51dde41a6342","type":"text/javascript","exec":[""]}}],"_postman_id":"93b2a4b7-3a24-43b8-b5e6-9f73952e247f"},{"name":"4.9 Re-present","item":[{"name":"represent_debit","event":[{"listen":"test","script":{"id":"f0fad740-017b-4229-9e36-d03ad3fe20ae","exec":["pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"f927e8c3-4ee5-4b4f-871e-8577fafffb7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_user_password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","description":"

Required
\nService user identifier

\n","type":"text"},{"key":"query[reference_number]","value":"{{reference_number}}","description":"

Required
The reference number of the failed collection

\n","type":"text"},{"key":"query[original_debit_date]","value":"{{original_debit_date}}","description":"

Required
The date of the failed collection
Format: YYYY-MM-DD

\n","type":"text"},{"key":"query[original_debit_amount]","value":"{{original_debit_amount}}","description":"

Required
The amount of the failed collection in pence

\n","type":"text"},{"key":"query[represent_debit_date]","value":"{{represent_debit_date}}","description":"

Optional
The date of the re-present, which must be a valid collection date, must allow time for submission and must be within one month of the failed collection
Format: YYYY-MM-DD

\n","type":"text"}]},"url":"{{base_url}}/represent_debit","urlObject":{"path":["represent_debit"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d93f4cf7-59e3-4baf-acb0-7eb46b4aec03","name":"represent debit","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"query[service_user][pslid]","value":"{{pslid}}","description":"Format: plain text
Restrictions: 5 to 255 characters, must match existing SU's pslid","type":"text"},{"key":"query[reference_number]","value":"ABC123456","description":"Format: plain text
Restrictions: must be the reference number of the failed debit","type":"text"},{"key":"query[original_debit_date]","value":"2019-04-01","description":"Format: date YYYY-MM-DD","type":"text"},{"key":"query[original_debit_amount]","value":"2000","description":"Format: Integer, the value of the debit amount in pence.
\nRestrictions: value has to match of the original setup","type":"text"},{"key":"query[represent_debit_date]","value":"","description":"Optional
Format: date YYYY-MM-DD
Restrictions: must be a valid collection date, within 1 calendar month of failed debit","type":"text","disabled":true}]},"url":"{{base_url}}/represent_debit"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 05 Mar 2019 15:17:34 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"private, max-age=0, must-revalidate"},{"key":"X-Runtime","value":"0.09922"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"auth_token=; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"_PSLLite_session_id=59c10b241683faff8f68dab95c0ecf7c; path=/; HttpOnly; secure"},{"key":"Set-Cookie","value":"incap_ses_874_1416256=a; Max-Age=0; path=/; expires=Mon, 04 Mar 2019 08:33:16 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_373_1416256=a; Max-Age=0; path=/; expires=Mon, 04 Mar 2019 08:33:16 GMT; Domain=.ddprocessing.co.uk"},{"key":"Set-Cookie","value":"incap_ses_454_1416256=a; Max-Age=0; path=/; expires=Mon, 04 Mar 2019 08:33:16 GMT; Domain=.ddprocessing.co.uk"},{"key":"Content-Length","value":"198"},{"key":"Status","value":"200 OK"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"X-Iinfo","value":"5-3945949-3945962 NNNN CT(2 14 0) RT(1551799134218 22) q(0 0 0 -1) r(2 2) U5"},{"key":"X-CDN","value":"Incapsula"}],"cookie":[],"responseTime":null,"body":"\n\n true\n ABC123456\n 2019/05/01\n 2000\n"}],"_postman_id":"f927e8c3-4ee5-4b4f-871e-8577fafffb7a"}],"id":"b1f50b7f-9a04-4400-b435-5efb8210123d","description":"

Description

Collections that fail with ARUDD reason code 0 (\"refer to payer\") may be re-presented within one calendar month. Bacs recommends that the payer be contacted before the re-presentation to ensure the payer has sufficient funds in their account. To re-present a failed collection, the DDI reference number, amount and date of the failed collection must be supplied. Optionally, the date on which the re-presented collection should be made can be provided. If no date is provided, SmartDebit calculates the earliest date on which the re-present can be made. In either case, the response from SmartDebit, if the call is successful, contains the DDI reference number, the due date and amount of the re-present. If unsuccessful, the reason why the re-present cannot be made is returned.

Response

A successful call to represent_debit returns an XML document with the status of the call, the reference number, the new collection date and the amount (in pence) to be collected.

The XML document returned from a successful call has the following format:

200 OK\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<represent>\n  <success>true</success>\n  <reference_number>ABC123456</reference_number>\n  <date>2019/05/01</date>\n  <amount>2000</amount>\n</represent>\n

Errors

Missing parameters

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No service user id supplied.</error>\n</errors>\n

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Missing required parameter(s) - Reference Number</error>\n</errors>\n

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Missing required parameter(s) - Debit date</error>\n</errors>\n

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Missing required parameter(s) - Debit amount</error>\n</errors>\n

Reference number not found

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Unable to find the reference number for the pslid provided</error>\n</errors>\n

Debit not found (example)

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>Original failed debit: Reference ABC123456 Date tomorrow Amount 1000 not found</error>\n</errors>\n

Collection cannot be re-presented

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>The original debit cannot be represented</error>\n</errors>\n

Trying to re-present an already re-presented collection (example)

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>An uncollected represent for Bacs reference ABC123456, has already been generated for collection on 2019-05-01</error>\n</errors>\n

Not allowing enough time for submission when specifying query[represent_debit_date] (example)

\n\n

500 Internal Server Error\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>The supplied represent date of 2019-05-29 is too soon or in the past</error>\n</errors>\n

","event":[{"listen":"prerequest","script":{"id":"27ffdb8d-1a86-410d-a534-aa5c3c3de3d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"80889a35-05d6-4303-816a-cf6cf409dab6","type":"text/javascript","exec":[""]}}],"_postman_id":"b1f50b7f-9a04-4400-b435-5efb8210123d"}],"id":"12a04988-ee1f-47e1-b285-c9779bd017d2","event":[{"listen":"prerequest","script":{"id":"760c4cdc-89ce-4aff-83e7-f513657ed3c0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"232a2ca8-b55e-40b7-af58-54856ff31881","type":"text/javascript","exec":[""]}}],"_postman_id":"12a04988-ee1f-47e1-b285-c9779bd017d2","description":""},{"name":"5 Input file formats & reference number rules","item":[{"name":"5.1 Payer file format","item":[],"id":"af952adc-d8b5-412c-96e6-e1064bd7a70d","description":"

A payer file is a CSV file containing 46 fields, many of which are not used. Values may be wrapped in double quotes.

The CSV fields are as follows:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Field	Field name	Restrictions	Comments
1		Leave blank
2	Reference number	Length: 6 – 18 characters (rules)	Not required for creation if generated by the system; otherwise required
3	Account name	Length: 3 – 18 characters	Required for creation
4	Sort code	Length: 6 digits	Required for creation
5	Account number	Length: 8 digits	Required for creation
6-14		Leave blank
15	Title	Optional. Length: 0 – 32 characters
16	Forename	Required. Length: 1 – 32 characters
17	Surname	Required. Length: 1 – 32 characters
18	Company name	Optional. Length: 0 – 32 characters
19	Address line 1	Optional. Length: 0 – 255 characters
20	Address line 2	Optional. Length: 0 – 32 characters
21	Address line 3	Optional. Length: 0 – 32 characters
22	City/town	Optional. Length: 0 – 32 characters
23	County	Optional. Length: 0 – 32 characters
24	Post code	Optional. Length: 0 – 32 characters
25	Country	Optional. Length: 0 – 32 characters	The value 'United Kingdom' is assumed on creation if blank
26		Leave blank
27		Leave blank
28	Email	Optional. Length: 0 – 64 characters
29		Leave blank
30	Frequency type	Variable DDIs: required. Values: 'W', 'M', 'Q', 'Y' Adhoc DDIs: must be blank	Permitted values depend on service user configuration
31	Regular amount	Variable DDIs: optional. Decimal number with two decimal point precision Adhoc DDIs: must be blank	Amount is in pounds. Maximum depends on service user configuration.
33		Leave blank
34		Leave blank
35	Start year	Optional. Format: YYYY
36	Start month	Optional. Format: MM
37	Start day	Optional. Format: DD
38	End year	Optional. Format: YYYY	End date is the last regular collection. The DDI remains live. If specified, the end date must be on or after the start date.
39	End month	Optional. Format: MM
40	End day	Optional. Format: DD
41-43		Leave blank
44	Frequency factor	Variable DDIs: valid values are blank, 1, 2 ,3, 4. Adhoc DDIs: leave blank	Leave blank unless required. Values of 2, 3, 4 are not permitted for Y. Permitted values depend on service user configuration.
45		Leave blank
46	Status	Optional. Values: 0, 3	Blank or 0 for creation, 3 to cancel, 0 to reinstate

\n\n

If SmartDebit is configured to generate the Bacs reference and a value is supplied in field 2 for creation then this value is stored as \"Customer ID\".

An example of some well formatted payer file CREATE entries:

,ABC123456,Ms Jones,123456,12345678,,,,,,,,,,Ms,Jane,Jones,,123 fake st,,,london,,nw6 4ed,UK,,,,,M,10.00,,,,,,,,,,,,,,,0 \n,ABC123457,MR SMITH,123456,12345678,,,,,,,,,,,Pete,Smith,,123 piper st,,,Plymouth,,po8 8ij,UK,,,,,M,10.00,,,,2019,06,15,,,,,,,,,\n

Two new DDIs are created with the properties supplied.

An example of some well formatted payer file UPDATE entries:

,ABC123456,,,,,,,,,,,,,,James,Smith,,123 piper st,,,Plymouth,,\"po8 8ij\",UK,,,,,M,10.00,15.95,,,2019,06,15,,,,,,,,,\n,\"ABC123457\",,,,,,,,,,,,,,\"J\",\"Smith\",,\"Central sqr\",\"\",,\"Dover\",,\"dv1 8ij\",\"UK\",,,,,\"M\",\"10.00\",,,,2019,06,15,,,,,,,,3\n

These two entries update the DDIs 'ABC123456' and 'ABC123457' respectively, overwriting any existing values. The second entry cancels DDI 'ABC123457' as the status has the value '3'.

\n","event":[{"listen":"prerequest","script":{"id":"b0f30723-ce41-4897-8416-5e5197704e4e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"34e6b07b-72bd-46b4-a796-fd79c5f9af3d","type":"text/javascript","exec":[""]}}],"_postman_id":"af952adc-d8b5-412c-96e6-e1064bd7a70d"},{"name":"5.2 Collection file format","item":[],"id":"7c167ef6-c64a-4f88-a592-4e422b2bc719","description":"

A collection file is a CSV file containing seven fields, though only three values are required. Values may be wrapped in double quotes.

The CSV fields are as follows:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Field	Field name	Restrictions	Comments
1		Leave blank
2	Reference number	Required. Length: 6 - 18 characters.	Must match the reference number of an existing DDI
3	Amount	Required. Decimal number with two decimal point precision (or integer for whole pounds).	Amount is in pounds. No currency symbol. No thousands separator.
4	Due date	Required. Format: YYYY/MM/DD or YY/MM/DD or YYYYMMDD or YYMMDD.
5	Comments	Length: 0 – 64 characters
6	Collection reference	Length: 0 – 18 characters	Format: reference number (field 2) followed by hyphen (-) followed by payment identifier e.g. ABC123456-AUG
7		Leave blank

\n\n

IMPORTANT NOTE:
A collection file entry with a reference number and date that matches an existing collection updates the existing collection. You cannot specify two separate collections on the same date. Instead, either specify the sum or use a different collection date. If a collection file contains two collections for the same payer for the same date, the result is only one collection which in most cases will be the second one.

The comments field is not submitted to Bacs and is not reported by either collection report.

Where used, the collection reference is submitted to Bacs. Thus, it must adhere to the reference number rules. This field was formerly known as \"user format debit reference\". It is reported by get_collection_report and get_successful_collection_report as \"transaction_ref\". If the collection fails, the ARUDD reports the collection reference in place of the DDI's reference number. ADDACS advices may also report the last-used collection reference in place of the DDI's reference number.

The collection reference allows a collection to be identified uniquely if the amount and date are not sufficient. For example, it could identify an invoice number where the DDI's reference number denotes the customer account.

Where several services are supplied to a customer, use of the collection reference to distinguish between those services is discouraged because it is not possible to cancel one service without cancelling them all.

If a collection is re-presented, the collection reference does not carry across to the re-present.

Examples of some well-formatted collection file entries:

,ABC123456,49.95,2019/06/15,,,\n,”ABC123457”,”15”,”19/06/15”,,,\n

These examples show that the format can be thought of as a reference, amount and date (where the year precedes the month and day) preceded by a comma and followed by three commas. Despite this simplicity, problems frequently occur when the data are derived from an Excel spreadsheet:

the first and last columns are easily lost
leading zeros may be lost from reference numbers
long reference numbers consisting only of numerals may be converted to scientific notation
the date format may be transposed

\n","event":[{"listen":"prerequest","script":{"id":"5e9a5f6c-cfe1-4c71-8cb8-d67165ab9430","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"069012f7-96f7-4bc5-9995-a69f2c5dea5c","type":"text/javascript","exec":[""]}}],"_postman_id":"7c167ef6-c64a-4f88-a592-4e422b2bc719"},{"name":"5.3 Reference number rules","item":[],"id":"4d8a7173-5301-41e1-b171-7d4fde1fef6b","description":"

The reference number is used to identify a DDI within the SmartDebit system and within the wider banking system. A valid reference number must:

comprise only valid characters
be between 6 and 18 characters long (only alphanumeric characters are considered in checking the minimum length)
be unique for the service user and SUN - the uniqueness test is case-insensitive and includes cancelled payers
begin with an alpahnumeric
not begin \"DDIC\"
not begin or end with a space
not consist of all the same character (e.g. all zeros)
not match another reference for the same service user and the same payer’s bank account in whole or in part
(in the case of a signed DDI) exactly match that on the signed DDI

These rules are not all rigorously enforced by SmartDebit. Non-compliant references are likely to result in an AUDDIS advice and an uncollectible DDI.

References cannot be re-used.

The character and length restrictions also apply to the collection reference.

Ampersands in reference numbers must be URL encoded when they form part of a call's URL.

Because this reference is submitted to Bacs, it is often referred to as the \"Bacs reference\".

\n","event":[{"listen":"prerequest","script":{"id":"ccc53059-5251-4f34-9abc-a917f3b10172","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2c40c864-a599-472b-ae45-b9996d1f51d0","type":"text/javascript","exec":[""]}}],"_postman_id":"4d8a7173-5301-41e1-b171-7d4fde1fef6b"},{"name":"5.4 Valid characters","item":[],"id":"86a42735-f1f4-4bb2-a135-81860b0f1313","description":"

Valid characters include all letters (aA to zZ), numbers and the following:

space ( )
ampersand (&)
hyphen (-)
solidus (/)
full stop (.)

If reference numbers contain solidus then they must be urlencoded in the update and cancel calls. This is because the reference number forms part of the URI.

All valid email characters are allowed in the email address field.

\n","event":[{"listen":"prerequest","script":{"id":"099f2b7a-d26b-47f0-b02c-e2f651b60b18","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"220bab23-fa5d-495f-9858-fa000f243c9d","type":"text/javascript","exec":[""]}}],"_postman_id":"86a42735-f1f4-4bb2-a135-81860b0f1313"}],"id":"d5a84235-9fa6-460e-aef3-df07145fc47f","_postman_id":"d5a84235-9fa6-460e-aef3-df07145fc47f","description":""},{"name":"6 Client code examples","item":[{"name":"6.1 Ruby client","item":[],"id":"220a488f-4682-4dce-b51c-8cd91c3689de","description":"

The following Ruby example uses core ruby classes. As the details of the SmartDebit API are modelled on the Rails ActiveResource pattern future versions of the API should work with an appropriately configured ActiveResource model.

Creating a Variable DDI using form parameters

def create\n    parsed_uri = URI.parse(\n        \"https://secure.ddprocessing.co.uk/api/ddi/variable/create\"\n    )\n\n    req = Net::HTTP::Post.new(\n        parsed_uri.path.blank? ? \"/\" : parsed_uri.path, \n        {\n            \"accept\" => \"application/XML\",\n            \"User-Agent\" => \"XYZ Co's Ruby SmartDebit Client\"\n        }\n    )\n\n    req.set_form_data({\n        'variable_ddi[service_user][pslid]' => \"su_pslid\",\n        'variable_ddi[reference_number]'    => \"ABC123456\",\n        'variable_ddi[first_name]'          => \"John\",\n        'variable_ddi[last_name]'           => \"Smith\",\n        'variable_ddi[address_1]'           => \"123 Fake St\",\n        'variable_ddi[town]'                => \"London\",\n        'variable_ddi[postcode]'            => \"se3 3ed\",\n        'variable_ddi[country]'             => \"United Kingdom\",\n        'variable_ddi[account_name]'        => \"John Smith\",\n        'variable_ddi[sort_code]'           => \"401223\",\n        'variable_ddi[account_number]'      => \"12345678\",\n        'variable_ddi[payer_reference]'     => \"external54321\",\n        'variable_ddi[regular_amount]'      => 1000,\n        'variable_ddi[frequency_type]'      => \"M\"\n    }, '&')\n\n    req.basic_auth \"apiuser\", \"api864\"\n\n    http = Net::HTTP.new(parsed_uri.host, parsed_uri.port)\n    http.use_ssl = true if parsed_uri.port == 443\n\n    response = http.start {|h| h.request(req) }\n    \n    case response\n    when Net::HTTPSuccess\n\n        puts \"Direct Debit Instruction created in SmartDebit\"\n    \n        idd_ref = \"\"\n        # extract ddi information\n        doc = REXML::Document.new(response.body)\n        doc.elements.each('variable_ddi/reference_number') do |ele|\n            idd_ref = ele.text\n        end\n\n        puts \"(iDD Reference #{idd_ref})\"\n\n    when Net::HTTPClientError\n\n        puts \"Unable to Create DDI:\\nHTTP Code #{response.code} #{response.message}\"\n    \n        doc = REXML::Document.new(response.body)\n        doc.elements.each('errors/error') do |ele|\n            puts \"  Error #{ele.text}\"\n        end\n\n    end\nend\n

Creating a Variable DDI using XML Body

The parameters to any SmartDebit API call can be passed in the form of an XML body. To use this feature the Content-Type of the request must be set to application/XML. This feature is of most use when initial debits are being set as it clearly groups the debit dates and amounts. An example of this is shown below under ‘Creating an Adhoc DDI w/ initial debits using XML Body’.

def create\n    parsed_uri = URI.parse(\n        \"https://secure.ddprocessing.co.uk/api/ddi/variable/create\"\n    )\n    \n    req = Net::HTTP::Post.new(\n        parsed_uri.path,\n        {\n            \"accept\" => \"application/XML\",\n            \"Content-Type\" => \"application/XML\",\n            \"User-Agent\" => \"XYZ Co's Ruby SmartDebit Client\"\n        }\n    )\n    \n    XML_body = \"\"\n    XML_body << \"<?XML version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n\"\n    XML_body << \"<variable_ddi>\\n\"\n    XML_body << \"  <reference_number>ABC123456</reference_number>\\n\"\n    XML_body << \"  <first_name>John</first_name>\\n\"\n    XML_body << \"  <last_name>Smith</last_name>\\n\"\n    XML_body << \"  <address_1>123 Fake St</address_1>\\n\"\n    XML_body << \"  <town>London</town>\\n\"\n    XML_body << \"  <postcode>se3 3ed</postcode>\\n\"\n    XML_body << \"  <country>United Kingdom</country>\\n\"\n    XML_body << \"  <account_name>John Smith</account_name>\\n\"\n    XML_body << \"  <sort_code>401223</sort_code>\\n\"\n    XML_body << \"  <account_number>12345678</account_number>\\n\"\n    XML_body << \"  <payer_reference>external54321</payer_reference>\\n\"\n    XML_body << \"  <default_amount>1000</default_amount>\\n\"\n    XML_body << \"  <frequency_type>M</frequency_type>\\n\"\n    XML_body << \"  <service_user><pslid>su_pslid</pslid></service_user>\\n\"\n    XML_body << \"</variable_ddi>\"\n    \n    req.body = XML_body\n    req.basic_auth \"apiuser\", \"api864\"\n\n    http = Net::HTTP.new(parsed_uri.host, parsed_uri.port)\n    http.use_ssl = true if parsed_uri.port == 443\n    \n    response = http.start {|h| h.request(req) }\n    \n    case response\n    when Net::HTTPSuccess\n    \n        puts \"Direct Debit Instruction created in SmartDebit\"\n\n        ddi_reference_number = \"\"\n        # extract ddi information\n        doc = REXML::Document.new(response.body)\n        doc.elements.each('variable_ddi/reference_number') do |ele|\n            ddi_reference_number = ele.text\n        end\n\n        puts \"(iDD Reference Number #{ddi_reference_number})\"\n\n    when Net::HTTPClientError\n\n        puts \"Unable to Create DDI:\\nHTTP Code #{response.code} #{response.message}\"\n            \n        doc = REXML::Document.new(response.body)\n        doc.elements.each('errors/error') do |ele|\n            puts \"  Error #{ele.text}\"\n        end\n\n    end\nend\n

Creating an Adhoc DDI with initial debits using form parameters

To create an Adhoc DDI with initial debits using form parameters, repeated instances of the same parameters need to be passed. In Ruby 1.8.5 the Net::HTTP::Post.set_form_data method does not support arrays (and a Ruby hash does not support multiple identical keys) so the form data needs to be compiled manually.

def create\n    parsed_uri = URI.parse(\n        \"https://secure.ddprocessing.co.uk/api/ddi/adhoc/create\"\n    )\n\n    req = Net::HTTP::Post.new(\n        parsed_uri.path.blank? ? \"/\" : parsed_uri.path, \n        {\n            \"accept\" => \"application/XML\",\n            \"User-Agent\" => \"XYZ Co's Ruby SmartDebit Client\"\n        }\n    )\n    \n    # Net::HTTP::Post.set_form_data does not support arrays in Ruby 1.8.5\n    form_data = []\n    form_data << \"adhoc_ddi[service_user][pslid]=su_pslid\"\n    form_data << \"adhoc_ddi[reference_number] = ABC123456\"\n    form_data << \"adhoc_ddi[first_name]=John\"\n    form_data << \"adhoc_ddi[last_name]=Smith\"\n    form_data << \"adhoc_ddi[address_1]=123 Fake St\"\n    form_data << \"adhoc_ddi[town]=London\"\n    form_data << \"adhoc_ddi[postcode]=se3 3ed\"\n    form_data << \"adhoc_ddi[country]=United Kingdom\"\n    form_data << \"adhoc_ddi[account_name]=John Smith\"\n    form_data << \"adhoc_ddi[sort_code]=401223\"\n    form_data << \"adhoc_ddi[account_number]=12345678\"\n    form_data << \"adhoc_ddi[start_date]=2019-05-23\"\n    form_data << \"adhoc_ddi[debits][debit][][amount]=500\"\n    form_data << \"adhoc_ddi[debits][debit][][date]=2019-05-23\"\n    form_data << \"adhoc_ddi[debits][debit][][amount]=1500\"\n    form_data << \"adhoc_ddi[debits][debit][][date]=2019-06-01\"\n    form_data << \"adhoc_ddi[debits][debit][][amount]=1500\"\n    form_data << \"adhoc_ddi[debits][debit][][date]=2019-07-01\"\n    \n    req.body = form_data.join(\"&\")\n\n    req.basic_auth \"apiuser\", \"api864\"\n\n    http = Net::HTTP.new(parsed_uri.host, parsed_uri.port)\n    http.use_ssl = true if parsed_uri.port == 443\n\n    response = http.start {|h| h.request(req) }\n    \n    case response\n\n    when Net::HTTPSuccess\n\n        puts \"Direct Debit Instruction created in SmartDebit\"\n\n        ddi_reference_number = \"\"\n        # extract ddi information\n        doc = REXML::Document.new(response.body)\n        doc.elements.each('adhoc_ddi/reference_number') do |ele|\n            ddi_reference_number = ele.text\n        end\n\n        puts \"(iDD Reference Number #{ddi_reference_number})\"\n\n    when Net::HTTPClientError\n\n        puts \"Unable to Create DDI:\\nHTTP Code #{response.code} #{response.message}\"\n            \n        doc = REXML::Document.new(response.body)\n        doc.elements.each('errors/error') do |ele|\n            puts \"  Error #{ele.text}\"\n        end\n        \n    end\nend\n

Creating an Adhoc DDI with initial debits using XML Body

The parameters to any SmartDebit API call can be passed in the form of an XML body. To use this feature the Content-Type of the request must be set to application/XML. This feature is of most use when initial debits are being set, as it clearly groups the debit dates and amounts.

def create\n    parsed_uri = URI.parse(\n        \"https://secure.ddprocessing.co.uk/api/ddi/adhoc/create\"\n    )\n    \n    req = Net::HTTP::Post.new(\n        parsed_uri.path, \n        {\n            \"accept\" => \"application/XML\",\n            \"Content-Type\" => \"application/XML\",\n            \"User-Agent\" => \"XYZ Co's Ruby SmartDebit Client\"\n        }\n    )\n    \n    XML_body = \"\"\n    XML_body << \"<?XML version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n\"\n    XML_body << \"<adhoc_ddi>\\n\"\n    XML_body << \"  <reference_number>ABC123456</reference_number>\\n\"\n    XML_body << \"  <first_name>John</first_name>\\n\"\n    XML_body << \"  <last_name>Smith</last_name>\\n\"\n    XML_body << \"  <address_1>123 Fake St</address_1>\\n\"\n    XML_body << \"  <town>London</town>\\n\"\n    XML_body << \"  <postcode>se3 3ed</postcode>\\n\"\n    XML_body << \"  <country>United Kingdom</country>\\n\"\n    XML_body << \"  <account_name>John Smith</account_name>\\n\"\n    XML_body << \"  <sort_code>401223</sort_code>\\n\"\n    XML_body << \"  <account_number>12345678</account_number>\\n\"\n    XML_body << \"  <payer_reference>external54321</payer_reference>\\n\"\n    XML_body << \"  <start_date>2019-05-23</start_date>\\n\"\n    XML_body << \"  <debits>\\n\"\n    XML_body << \"    <debit>\\n\"\n    XML_body << \"      <amount>500</amount><date>2019-05-23</date>\\n\"\n    XML_body << \"    </debit>\\n\"\n    XML_body << \"    <debit>\\n\"\n    XML_body << \"      <amount>1500</amount><date>2019-06-01</date>\\n\"\n    XML_body << \"    </debit>\\n\"\n    XML_body << \"    <debit>\\n\"\n    XML_body << \"      <amount>1500</amount><date>2019-07-01</date>\\n\"\n    XML_body << \"    </debit>\\n\"\n    XML_body << \"  </debits>\\n\"\n    XML_body << \"  <service_user><pslid>su_pslid</pslid></service_user>\\n\"\n    XML_body << \"</adhoc_ddi>\"\n    \n    req.body = XML_body\n\n    req.basic_auth \"apiuser\", \"api864\"\n\n    http = Net::HTTP.new(parsed_uri.host, parsed_uri.port)\n    http.use_ssl = true if parsed_uri.port == 443\n    \n    response = http.start {|h| h.request(req) }\n    \n    case response\n    when Net::HTTPSuccess\n\n        puts \"Direct Debit Instruction created in SmartDebit\"\n        ddi_reference_number = \"\"\n        # extract ddi information\n        doc = REXML::Document.new(response.body)\n        doc.elements.each('adhoc_ddi/reference_number') do |ele|\n            ddi_reference_number = ele.text\n        end\n\n        puts \"(iDD Reference Number #{ddi_reference_number})\"\n\n    when Net::HTTPClientError\n\n        puts \"Unable to Create DDI:\\nHTTP Code #{response.code} #{response.message}\"\n            \n        doc = REXML::Document.new(response.body)\n        doc.elements.each('errors/error') do |ele|\n                puts \"  Error #{ele.text}\"\n        end\n\n    end\nend\n

","event":[{"listen":"prerequest","script":{"id":"a9335a3f-d604-4dd5-9518-0b013ccfaa53","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5aeac109-dc64-4e3b-9ef6-a5fd759b47dd","type":"text/javascript","exec":[""]}}],"_postman_id":"220a488f-4682-4dce-b51c-8cd91c3689de"},{"name":"6.2 PHP client","item":[],"id":"7692a8b5-0afa-4bb0-9f08-1818ca3ecc96","description":"

This example uses Curl to create a Direct Debit Instruction using request parameters.

<?php\n\n    $request_host = 'https://secure.ddprocessing.co.uk';\n    $request_path = '/api/ddi/variable/create';\n    \n    $user         = \"apiuser\";\n    $password     = \"api864\";\n    \n    $options      = array(\n        CURLOPT_RETURNTRANSFER => true, // return web page\n        CURLOPT_HEADER => false, // don't return headers\n        CURLOPT_POST => true,\n        CURLOPT_USERPWD => $user . \":\" . $password,\n        CURLOPT_HTTPAUTH => CURLAUTH_BASIC,\n        CURLOPT_HTTPHEADER => array(\"Accept: application/XML\"),\n        CURLOPT_USERAGENT => \"XYZ Co's PHP iDD Client\" // Let SmartDebit see who we are\n    );\n    \n    $session      = curl_init($request_host . $request_path);\n    curl_setopt_array($session, $options);\n    \n    // tell cURL to accept an SSL certificate if presented\n    if (preg_match(\"/^https/\", $request_host)) {\n        curl_setopt($session, CURLOPT_SSL_VERIFYHOST, false);\n        curl_setopt($session, CURLOPT_SSL_VERIFYPEER, false);\n    }\n    \n    // The request parameters\n    $pslid            = 'testcustomer';\n    $reference_number = \"ABC123456\";\n    $payer_ref        = 'PHP-12345';\n    $first_name       = 'John';\n    $last_name        = 'Smith';\n    $address_1        = \"123 Fake St\";\n    $town             = \"London\";\n    $postcode         = \"se3 3ed\";\n    $country          = \"United Kingdom\";\n    $account_name     = \"John Smith\";\n    $sort_code        = \"401223\";\n    $account_number   = \"12345678\";\n    $regular_amount   = 1000;\n    $frequency_type   = \"M\";\n    \n    // urlencode and concatenate the POST arguments\n    $postargs = 'variable_ddi[service_user][pslid]=' . $pslid;\n    $postargs .= \"&variable_ddi[reference_number]=\" . urlencode($reference_number);\n    $postargs .= '&variable_ddi[payer_reference]=' . urlencode($payer_ref);\n    $postargs .= '&variable_ddi[first_name]=' . urlencode($first_name);\n    $postargs .= '&variable_ddi[last_name]=' . urlencode($last_name);\n    $postargs .= '&variable_ddi[address_1]=' . urlencode($address_1);\n    $postargs .= '&variable_ddi[town]=' . urlencode($town);\n    $postargs .= '&variable_ddi[postcode]=' . urlencode($postcode);\n    $postargs .= '&variable_ddi[country]=' . urlencode($country);\n    $postargs .= '&variable_ddi[account_name]=' . urlencode($account_name);\n    $postargs .= '&variable_ddi[sort_code]=' . urlencode($sort_code);\n    $postargs .= '&variable_ddi[account_number]=' . urlencode($account_number);\n    $postargs .= '&variable_ddi[regular_amount]=' . urlencode($regular_amount);\n    $postargs .= '&variable_ddi[frequency_type]=' . urlencode($frequency_type);\n    \n    // Tell curl that this is the body of the POST\n    curl_setopt($session, CURLOPT_POSTFIELDS, $postargs);\n    \n    // $output contains the output string\n    $output = curl_exec($session);\n    $header = curl_getinfo($session);\n    \n    if (curl_errno($session)) {\n        echo 'Curl error: ' . curl_error($session);\n    } else {\n        switch ($header[\"http_code\"]) {\n            case 200:\n                echo \"Variable DDI created\";\n                break;\n            default:\n                echo \"HTTP Error: \" . $header[\"http_code\"];\n        }\n    }\n    \n    // close curl resource to free up system resources\n    curl_close($session);\n?>\n

","event":[{"listen":"prerequest","script":{"id":"ea40b343-5c80-495f-8d78-83d4e903dee4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"92451797-e3bf-4225-b075-999dc317f045","type":"text/javascript","exec":[""]}}],"_postman_id":"7692a8b5-0afa-4bb0-9f08-1818ca3ecc96"},{"name":"6.3 .NET client","item":[],"id":"ebc741ea-b5ab-4255-8b98-aca5c9097cc4","description":"

This example validates a Variable DDI using either form data, an XML body or JSON body. Note that JSON is not supported at the time of writing.

const string user = \"apiuser\";\nconst string password = \"api864\";\nconst string pslid = \"su_pslid\";\n\n// Credentials will be added to the request header later using Basic authentication\nvar credentials = Convert.ToBase64String(Encoding.ASCII.GetBytes($\"{user}:{password}\"));\n\nstring domain = \"https://sandbox.ddprocessing.co.uk/\";\nstring endPoint = \"api/ddi/variable/validate\"; // Consider versioning\nstring url = $\"{domain}{endPoint}\";\n\n// Set your form data - option 1\nvar formContent = new FormUrlEncodedContent(new[]\n{\n    new KeyValuePair<string, string>(\"variable_ddi[reference_number]\", \"ABC123456\"),\n    new KeyValuePair<string, string>(\"variable_ddi[first_name]\", \"John\"),\n    new KeyValuePair<string, string>(\"variable_ddi[last_name]\", \"Smith\"),\n    new KeyValuePair<string, string>(\"variable_ddi[address_1]\", \"123 Fake St\"),\n    new KeyValuePair<string, string>(\"variable_ddi[town]\", \"London\"),\n    new KeyValuePair<string, string>(\"variable_ddi[postcode]\", \"SE3 3ED\"),\n    new KeyValuePair<string, string>(\"variable_ddi[country]\", \"UK\"),\n    new KeyValuePair<string, string>(\"variable_ddi[account_name]\", \"John Smith\"),\n    new KeyValuePair<string, string>(\"variable_ddi[sort_code]\", \"000000\"),\n    new KeyValuePair<string, string>(\"variable_ddi[account_number]\", \"12345678\"),\n    new KeyValuePair<string, string>(\"variable_ddi[frequency_type]\", \"M\"),\n    new KeyValuePair<string, string>(\"variable_ddi[service_user][pslid]\", pslid)\n});\n\n// Set your XML body - option 2\nstring validatePayerXml = $@\"<variable_ddi>\n    <reference_number>ABC123456</reference_number>\n    <first_name>John</first_name>\n    <last_name>Smith</last_name>\n    <address_1>123 Fake St</address_1>\n    <town>London</town>\n    <postcode>SE3 3ED</postcode>\n    <country>UK</country>\n    <account_name>John Smith</account_name>\n    <sort_code>000000</sort_code>\n    <account_number>12345678</account_number>\n    <frequency_type>M</frequency_type>\n    <service_user>\n        <pslid>{pslid}</pslid>\n    </service_user>\n</variable_ddi>\";\n\n// Set your json body - option 3 (not currently supported)\nvar jsonValidate = new\n{\n    variable_ddi = new\n    {\n        first_name = \"John\",\n        last_name = \"Smith\",\n        address_1 = \"123 Fake St\",\n        town = \"London\",\n        postcode = \"SE3 3ED\",\n        country = \"UK\",\n        account_name = \"John Smith\",\n        sort_code = \"000000\",\n        account_number = \"12345678\",\n        frequency_type = \"M\",\n        service_user = new { pslid }\n    }\n};\n\nusing (var httpClientHandler = new HttpClientHandler())\n{\n    httpClientHandler.ServerCertificateCustomValidationCallback = (message, cert, chain, errors) => { return true; };\n\n    using (HttpClient client = new HttpClient(httpClientHandler))\n    {\n        // Add credentials to the header\n        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", credentials);\n\n        // Option 1: form data\n        Task<HttpResponseMessage> getStringTask = client.PostAsync(url, formContent);\n\n        //// Option 2: content-type application/xml\n        //HttpContent httpContent = new StringContent(validatePayerXml, Encoding.UTF8, \"application/xml\"); \n        //Task<HttpResponseMessage> getStringTask = client.PostAsync(url, httpContent);\n\n        //// Option 3: content-type application/json (not currently available)\n        //string json = JsonConvert.SerializeObject(jsonValidate, Formatting.Indented);\n        //HttpContent httpContent = new StringContent(json, Encoding.UTF8, \"application/json\");\n        //Task<HttpResponseMessage> getStringTask = client.PostAsync(url, httpContent);\n\n        try\n        {\n            HttpResponseMessage response = await getStringTask;\n\n            string result;\n\n            using (var stream = await response.Content.ReadAsStreamAsync())\n            using (var reader = new StreamReader(stream))\n            {\n                result = reader.ReadToEnd();\n            }\n\n            if (response.StatusCode == HttpStatusCode.OK\n                || response.StatusCode == HttpStatusCode.Created\n                || response.StatusCode == HttpStatusCode.Accepted)\n            {\n                Console.WriteLine(result);\n            }\n\n            response.EnsureSuccessStatusCode();\n        }\n        catch (Exception e)\n        {\n            Console.WriteLine(e);\n            throw;\n            // log the exception appropriately \n        }\n    }\n}\n

","event":[{"listen":"prerequest","script":{"id":"7c727015-e8ec-4208-b234-a21ae6180ab9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fc91728e-8ef1-4a81-a842-f2a1fcdb61d7","type":"text/javascript","exec":[""]}}],"_postman_id":"ebc741ea-b5ab-4255-8b98-aca5c9097cc4"}],"id":"ca31fecb-3593-4ea1-b874-5f88291ce75e","description":"

The SmartDebit API can be easily accessed from a number of languages. This section contains examples for Ruby, PHP and .NET. Note that these are very simplistic examples which would need to be adapted to your own coding standards for use.

\n","event":[{"listen":"prerequest","script":{"id":"4135b890-600d-4574-b1d9-59b825459667","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2a10e8e9-3f8b-43d7-bfe4-33da55e234b8","type":"text/javascript","exec":[""]}}],"_postman_id":"ca31fecb-3593-4ea1-b874-5f88291ce75e"},{"name":"7 Public facing DDI sign-up","item":[{"name":"7.1 Internet sign-up screens","item":[],"id":"336500b5-c127-4594-83d1-5d3e14a0b060","description":"

In order to provide a public-facing internet Direct Debit script a number of mandatory requirements must be observed. The below is adapted from Bacs’ own guidelines. Visual examples are included in Section 8.2 and we would recommend that your own screens are based closely on these as any deviations might need further bank approval.

The following are suggested screen prompts for customers accessing an internet site or approved device for Direct Debit sign-up. Service users may be working with internet agencies or other experienced developers, but if not, they should use these scripts verbatim.

Rule: All service users must include the following mandatory items within their screens hence these are the minimum requirements:

SSL server security must be present and must be a minimum of SHA-256 SSL supporting TLS 1.2.
A postal and / or email address must be provided to the payer
A general enquiries / customer service contact number and / or the provision of a live chat facility must be given to assist the payer with any urgent issues or complaints
Verification that the customer is the account holder and therefore the payer. If the customer is not the account holder a paper DDI must be sent to the payer for completion or a copy must be available for printing.\nNote: The service user may, however, choose not to offer the option of a paper DDI. In such instances, customers would not be able to purchase the services offered using Direct Debit as a payment method. This is a service user’s business decision and is considered to be outside of the Direct Debit Scheme.
Taking the payer’s bank or building society account number, sort code and account name
Confirmation that the person entering into the transaction is the only person required to authorise debits from the account. If more than one person has to authorise debits from the account, a paper DDI must be sent to the payer for completion. Exceptions apply to service users using electronic signature as a method of sign-up. A copy complying with the mandatory format must be available for printing by the payer. Failure to obtain the correct authority could result in an increased risk of indemnity claims being received.
Confirmation of bank details back to the payer
A copy of the Direct Debit Guarantee including advice of the advance notice period and of the company name that will appear against the Direct Debit on the payer’s bank statement

Guidance: The information required to complete the DDI does not need to be captured directly onto an on-screen DDI, but once completed service users may wish to display a copy of the completed DDI.

Assuming the payer has agreed to the setting up of a Direct Debit and the payment amount to be debited has been agreed:

Stage one: Opening

Direct Debits can be set up online or over the telephone in addition to the postal method.

The Direct Debit safeguards and guarantees apply. No changes in the amount, date or frequency to be debited can be made without notifying you at least XX working days in advance of your account being debited. In the event of any error being made in the payment of your Direct Debit, you are entitled to an immediate refund from your bank or building society. You have the right to cancel a Direct Debit Instruction at any time simply by writing to your bank or building society, with a copy to us.

Stage two: Sign up of bank details

In order to set up your Direct Debit Instruction online you will need to provide the following information through the setting up procedure (your cheque book or your bank statement contain all the bank details that you require):

Your account number and sort code
If you are not the account holder, a paper Direct Debit Instruction will be sent for completion (optional, see * below). Please click to end.
If this is a personal account, continue with the set-up procedure
If it is a business account, or more than one person is required to authorise debits on this account, a paper Direct Debit Instruction will be sent to the payers for completion (optional, see * below). Please click to end.

Alternatively, you can print off your on-screen Direct Debit Instruction and post it to us. If you are unable to print please contact us on XXXXXX (tel no) and we will post you a paper Direct Debit Instruction (optional see * below).

If you do not wish to proceed any further, please click to END.

The details of your Direct Debit Instruction will be confirmed to you within 3 working days or no later than 10 working days before the first collection. Click the mouse on YES or NO to confirm details:

YES (onto next stage)

NO (redo form)

CANCEL to stop the set-up procedure (go back to start page).

* The service user may, however, choose not to offer the option of a paper DDI. In such instances, customers would not be able to purchase the services offered using Direct Debit as a payment method. This is a service user’s business decision and is considered to be outside of the Direct Debit Scheme.

Stage three: Reconfirming the details to the customer

These are the details that you have entered to set up the Direct Debit Instruction:

Name of account holder

Branch sort code /__ __/__ __/__ __/

Bank account number /__/__/__/__/__/__/__/__/

Amount to be debited from bank account (if known)\n£__/__/__/__/__/__/__/__.__/__/

Date each month for collection (or other collection frequency) /__/__/

The company name which will appear on your bank statement against the Direct Debit will be XXXXXXXX.

Click mouse on YES or NO to confirm details:

YES (onto next stage)

NO (redo form)

CANCEL to stop the set-up procedure (go back to start page).

Stage four: Address for the letter of confirmation

Your Direct Debit Instruction will be confirmed to you by e-mail within 3 working days. Alternatively, confirmation incorporating your advance notice will be available to you no later than XX (number of working days in accordance with advance notice period) working days prior to the first collection date. If you prefer to receive this by post please indicate the address you would like this to be sent to.

____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________

Click for next stage (stage five)

STAGE FIVE: COMPLETING THE SIGN-UP

That completes the setting up of your Direct Debit Instruction and the confirmation of the Instruction will be sent to you within 3 working days or be received by you no later than 10 working days before the first collection.

Thank you very much for your Direct Debit Instruction details. Here is the Direct Debit Guarantee for your information. (Direct Debit Guarantee appears on-screen).

\n","event":[{"listen":"prerequest","script":{"id":"7915f228-fecb-4a15-9961-e5ef09097117","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2a13e47a-a928-491b-87ca-2932422ad445","type":"text/javascript","exec":[""]}}],"_postman_id":"336500b5-c127-4594-83d1-5d3e14a0b060"},{"name":"7.2 Example screens","item":[],"id":"4015b9fe-8bd1-473e-9df8-406696652f63","description":"
\n

\nSuggested layout of internet script - page 1\n

\n\n

\n
\n
\n

\nSuggested layout of internet script - page 2\n

\nIf the payer answers no to the questions on the previous screen, this screen is presented and a Direct Debit Instruction is available for printing.\n

\n\n

\n
\n
\nIf the payer answers yes to the questions on the first screen and proceeds with the set-up, they are asked to review and confirm the account details they have entered. If they have requested a paper DDI to be sent to them, they are also asked to confirm the postal address.\n
\n
\n

\nSuggested layout of internet script - page 3\n

\n\n

\n
\n
\n

\nSuggested layout of internet script - page 4\n

\n\n

\n
\n
\n

\nSuggested layout of internet script - page 5\n

\n\n

\n
\n
\n

\nSuggested layout of internet script - page 6\n

\n\n

","event":[{"listen":"prerequest","script":{"id":"6dd00505-6418-49a6-b094-2a94cd02765b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9497a2d4-c813-4590-a788-ab6a573a70d4","type":"text/javascript","exec":[""]}}],"_postman_id":"4015b9fe-8bd1-473e-9df8-406696652f63"}],"id":"c544fa20-2554-4bec-b25d-98af50f3b64f","event":[{"listen":"prerequest","script":{"id":"c43e9bfe-b887-4a72-8b09-bb7abeded139","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f7ec0622-64bd-46d4-9e6d-efc3e2f9a74b","type":"text/javascript","exec":[""]}}],"_postman_id":"c544fa20-2554-4bec-b25d-98af50f3b64f","description":""},{"name":"8 Bacs reason codes","item":[],"id":"4855180e-d792-4547-bf87-667881b138bb","description":"

ADDACS reason codes

0 - Instruction cancelled - refer to payer

1 - Instruction cancelled by payer

2 - Payer deceased

3 - Account transferred to another bank/building society

B - Account closed

C - Account transferred to a different branch of bank/building society

D - Advance notice disputed

E - Instruction amended

R - Instruction reinstated

AUDDIS reason codes

1 - Instruction cancelled by payer

2 - Payer deceased

3 - Account transferred to another bank/building society

5 - No account

6 - No Instruction

7 - DDI amount not zero

B - Account closed

C - Account transferred to a different branch of bank/building society

F - Invalid account type

G - Bank will not accept Direct Debits on account

H - Instruction expired

I - Payer reference is not unique

K - Instruction cancelled by bank

L - Incorrect payer's account details

M - Transaction code/User status incompatible

N - Transaction disallowed at payer's branch

O - Invalid reference

P - Payer's name not present

Q - Service user's name blank

Codes 7 and L to Q are generated by the Bacs service and occur as a result of its validation of DDI records.

ARUDD reason codes

0 - Refer to payer

1 - Instruction cancelled

2 - Payer deceased

3 - Account transferred

4 - Advance notice disputed

5 - No account (or wrong account type)

6 - No Instruction

7 - Amount differs

8 - Amount not yet due

9 - Presentation overdue

A - Service user differs

B - Account closed

Further detail about ARUDD reason codes can be found on SmartDebit's website.

\n","event":[{"listen":"prerequest","script":{"id":"100e2f81-e4f5-499c-96af-3dc63b0c0f38","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"db04896b-01bc-4a70-8932-7f2c14c861ce","type":"text/javascript","exec":[""]}}],"_postman_id":"4855180e-d792-4547-bf87-667881b138bb"},{"name":"9 API version history","item":[],"id":"605af7a4-5a20-41e1-8ff2-ff26f1b7d94a","description":"\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n

API version	Date	Change description (reference)
v1.1	Mar 2019	get_successful_collection_report shows claimed collections as \"paid\" (8853)\n indemnity/{{id}} response includes the correct number of <DDICAdvice> nodes (410)
	Jan 2015	All changes up to document version 1.21

","event":[{"listen":"prerequest","script":{"id":"b6dbfd88-9e0a-48b3-baa2-3ec0aa38293a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bac6ba67-df62-4bc3-b813-8f4706db56e2","type":"text/javascript","exec":[""]}}],"_postman_id":"605af7a4-5a20-41e1-8ff2-ff26f1b7d94a"},{"name":"10 Document version history","item":[],"id":"0953b9f0-283a-492d-8d16-7184a038ab9a","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Version	Date	Author	Change description (reference)
2.3	Sep 2022	DP	SmartDebit is part of Access Paysuite Ltd\n
2.2	Jul 2021	DP	Refresh the .NET code example. New advice on removing an end date with variable update. Remove reference to TLS 1.1.
2.1	Aug 2019	DP	Adds variable reinstate and adhoc reinstate calls (10051)
2.0	Jun 2019	DP	Document re-write: new structure, new sections, numerous corrections and clarifications. Introduces API versioning. API version 1.1. Address fields are optional, address_1 allows up to 255 characters. Allows solidus in reference numbers. Adds support for large collection files. Successful collection report referred to as reconciliation report. Deprecations: see the audit log, collection report, ddi/adhoc/validate and data/dump sections.
1.21	22/01/15	ND	Included successful collection report
1.20	29/09/14	ND	Charge files now known as Collection Files
1.19	01/09/14	ND	Removed restriction on hyphens in reference number
1.18	14/05/14	ND	Included call to represent failed collection
1.17	03/03/14	ND	Included collection report retrieve
1.16	27/11/2013	ND	Included account details for retrieve payer contact details
1.15	19/08/2013	ND	Included frequency factoring
1.15	21/06/13	ND	Included retrieval of Bacs DDICA reports
1.14	12/06/12	ND	Removed Fixed Frequency Fixed Amount section and corrected some errors
1.13	30/04/12	ND	Added AUDDIS collection details
1.12	14/02/11	ND	Audit log retrieval
1.11	22/02/11	ND	Reference number format restrictions
1.10	03/12/10	ND	Added extra column to Data Dump
1.9	28/09/10	RD	Branding update to SmartDebit. Section 11 Contents wording updated
1.8	31/03/10	RD/ND	Update Sections 9&10
1.7	05/03/10	ND	Added list of valid characters allowed for payer details. Added API call to retrieve payer contact details and status. Included bank details (name and branch of bank that holds the account) in Validation response. Added 'Support Gift Aid' param to create and update of DDI's.
1.6	18/01/10	ND	Added warning to Charge File Import page to clarify the use of duplicate entries.
1.5	29 Oct 2009	RC	Added asynchronous payer file import and ddi cancellation calls
1.4	22 Oct 2009	RC	Added conditional parameters for DDI verification and creation.
1.3	20 Oct 2009	RC/ ND	Added BACS Report Retrieval and sample .NET code
1.2	29 June 2009	RC/ND	Added Service User’s Guide extract and screenshots from the iDD payer site as a guide for public facing DDI sign-ups
1.1	14 April 2009	RC	Added detail for v1.1: update DDIs, import new payer file, import charge file.
1.0	24 Mar 2009	RC	Added detail for creating initial debits with DDI creation, http status codes on return examples
0.3	2 Mar 2009	RC	Added create and validate for Variable and Adhoc DDIs
0.2	9 Feb 2009	RC	Added detail, initial iDD styling.
0.1	3 Feb 2009	RC	Initial Draft for guide w/ system status, validate fixed, and create fixed.

","event":[{"listen":"prerequest","script":{"id":"33e19bb5-bff2-4e83-9982-a00a4f87fd2a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"42233a18-65db-4b88-b9b0-8255df961fab","type":"text/javascript","exec":[""]}}],"_postman_id":"0953b9f0-283a-492d-8d16-7184a038ab9a"},{"name":"11 Glossary","item":[],"id":"f8e07a45-2eed-47e3-a70f-60f1fc14d69c","description":"

ADDACS - Automated Direct Debit Amendment and Cancellation Service

An ADDACS advice is a notification from a bank of an amendment to or cancellation of a DDI. An ADDACS report may contain one or more ADDACS advices.

Adhoc

Processing model that does not support scheduled collections. If enabled, advance notice is sent for each collection. See also Variable.

ARUDD - Automated Return of Unpaid Direct Debit

An ARUDD advice is a notification from a bank of a failed collection. An ARUDD report may contain one or more ARUDD advices. A failed collection is \"returned unpaid\" - it is literally taken from, and then returned to, the payer's account.

AUDDIS - Automated Direct Debit Instruction Service

An AUDDIS advice is a notification from Bacs or from a bank that a new DDI has not been set up or has been amended, or that a cancellation has failed. An AUDDIS report may contain one or more AUDDIS advices.

Collection

A single payment, or debit, from a payer’s bank account on a specific date.

Customer ID

A free text field available for use as required. Example uses are:

to link to another system such as a CRM
customer account number
membership number and/or type
source or referrer

Customer ID is not subject to the same rules as the reference number. In most cases the field name is payer-reference or payer_reference (and payerReference in the data/dump response) but the collection reports present it as customer_id.

DDICA - Direct Debit Indemnity Claim Automation

A DDICA advice is a notification of an indemnity claim raised against a service user. A DDICA report may contain one or more DDICA advices.

Direct Debit Instruction (DDI)

The DDI represents the authority given by the payer to the service user to collect monies from their bank account. The DDI is defined within the Bacs scheme by the the reference number, the payer's bank details and the service user's SUN. Within SmartDebit, additional attributes such as name and address, email address, and possibly a collection schedule are attached. Hence within SmartDebit the term \"payer\" may be used instead.

Lead times

The number of days that must be allowed between setting up a new payer (\"payer lead time\") or creating a collection (\"collection lead time\") and a collection taking place. May be calculated on a calendar or working day basis.

Payer

An organisation's customer, subscriber, member or donor (depending on the organisation’s business) who pays by Direct Debit. See also Direct Debit Instruction.

Payer reference

See Customer ID.

PSLID

A parameter used throughout the API to identify the service user.

Reference number

Often referred to as a Bacs reference, the reference number is used to identify the DDI within SmartDebit and by the paying bank. It does not have to be numeric but must conform to rules stipulated by Bacs. In some places it may be referred to as the payer reference.

Service user

The organisation that collects payments from its payers, identified throughout the API by its PSLID and within the Bacs scheme by its service user number (SUN).

Service user number (SUN)

The SUN identifies the service user within the Bacs scheme. The SUN can be considered to be the service user's licence to use the scheme, issued by their sponsoring bank. SUNs may sometimes be shared. The SUN is not a feature of the API.

Variable

Processing model that supports scheduled collections. If enabled, advance notice is sent at creation and subsequently only if the amount differs from the previous collection. See also Adhoc.

\n","event":[{"listen":"prerequest","script":{"id":"f2356db5-8335-4bca-bf18-2df2d4497bf5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ebdf9f41-baaa-4ac9-b83e-376fd9a9b13d","type":"text/javascript","exec":[""]}}],"_postman_id":"f8e07a45-2eed-47e3-a70f-60f1fc14d69c"},{"name":"12 API support","item":[],"id":"2bbace77-f8e7-40f1-9d9b-593df776f4fc","description":"

Call during business hours or email us for support:

support@smartdebit.com
Customer support: 01276 851820
Sales: 01276 819291

\nSmartDebit: an Access company. Access PaySuite Ltd - The Old School, Stratford St Mary, Colchester, Essex CO7 6LZ. Regulated as a Payment Institution by the Financial Conduct Authority - FRN: 730815 Company Reg. No. 4595169

\n","event":[{"listen":"prerequest","script":{"id":"4753418e-6d3f-41f8-ab6e-eee86fba1343","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eeb8ecbd-58b8-4a03-81f6-d927434c568c","type":"text/javascript","exec":[""]}}],"_postman_id":"2bbace77-f8e7-40f1-9d9b-593df776f4fc"}],"event":[{"listen":"prerequest","script":{"id":"2b152d4d-a701-4c6e-b278-95831ad21202","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9fb78779-6ceb-4492-ba44-9bdad030352e","type":"text/javascript","exec":[""]}}]}