Internet Paperless Direct Debit
Our Internet Paperless Direct Debit solution allows your customers to sign up for Direct Debit payments through a secure online form — with no paperwork required. The process meets BACS compliance standards, validating all customer and bank account details in real time before setting up a Direct Debit Instruction (DDI).
To save you the time and complexity of developing your own Direct Debit pages, we offer a hosted solution where your customers securely enter their details via PayPoint’s white label or embedded web pages. Our service handles:
Real-time data validation of the customer details including - Payer Name Verification, Bank Modulus Check and EISCD Sort code lookup
The compliant displaying of the Direct Debit Guarantee and the way your SUN and Bank Account Details are displayed to the customer
This speeds up and simplifies the sign-up process, whilst at the same time further increasing your administrative cost savings.
We offer three flexible integration methods, based on your development resources and branding needs:
HTTP POST
You can integrate your website to our hosted IPDD pages by simple adding the following link: https://{clientname}.directdebits.paypoint.com/. However if you want to pass fixed elements to the page you will need to HTTP POST that information to https://{clientname}.directdebits.paypoint.com/Orchestration/Post. The following example details how having a button in side a form allows you to POST hidden parameters to the IPDD pages.
<form method="post" action="https://{clientname}.directdebits.paypoint.com/Orchestration/Post">
<input type="hidden" id="instructionReference" name="DirectDebit_DDInstruction" value="" />
<input type="hidden" id="customerAccountId" name="DirectDebit_CustomerAccountId" value="" />
<input type="hidden" id="startDate" name="Schedule_StartDate" value="" />
<input type="hidden" id="endDate" name="Schedule_EndDate" value="" />
<input type="hidden" id="amount" name="Schedule_Amount" value="" />
<input type="hidden" id="intervalUnit" name="Schedule_IntervalUnit" value="" />
<input type="hidden" id="interval" name="Schedule_Interval" value="" />
<input type="hidden" name="AdHoc" value="false" />
<button type="submit">Setup a Direct Debit</button>
</form>DirectDebit_DDInstruction -string - Your unique reference to help you identity an instruction.
DirectDebit_CustomerAccountId - Your Id for your customer, for Vend clients 19 digits, else Alphanumeric, max 50
Schedule_StartDate - string - the first working day after the instruction has been approved by BACS, this is normally at least 5 working days.
Schedule_EndDate - string - not mandated, but can be provided if a fixed length contract.
Schedule_Amount- - decimal - the fixed amount to be table, must be above 0 and not exceed your BACS Item Limit.
Schedule_IntervalUnit - weekly/monthly
Schedule_Interval - integer - the number of interval units, i.e. 12 monthly is annually.
AdHoc - true/false - if set to true, schedule detail are not required and IPDD will setup just a Direct Debit Instruction allowing for you to collect irregular amounts on non fixed dates.
API & Redirect
Alongside the traditional POST method above, we can offer a way for you to generate an URL to the prefilled IPDD pages that can then either simply redirect the customer from your website/portal or for you to include in a communication with the customer for them to complete in their own time. Like our other APIs, communication is conducted over a HTTPS connection using TLS v1.2 and you will require an API Subscription Key from PayPoint which must be specified in each request using the Ocp-Apim-Subscription-Key header.
The following example shows the payload that can be sent to the endpoint and the 201 Create synchronous response containing the URL to the prefilled IPDD pages:
POST https://production.api-paypoint.com/gateway/ipdd/v1/instruction HTTP/1.1
{
"clientInstructionId":"ClientReference",
"customerAccountId":"1234567890987654321",
"accountType":"",
"amount":"19.99",
"startDate":"01/08/2025",
"endDate":"01/08/2027",
"intervalUnit":"Monthly",
"interval":"1",
"adhoc":"false",
}
HTTP/1.1 201
{
"id": "7a6f1eab-8ffb-4a30-bf03-4903ea3cda83",
"orchestrationType": "DirectDebit",
"redirectUrl": "https://{clientname}.directdebits.paypoint.com/7a6f1eab-8ffb-4a30-bf03-4903ea3cda83",
"createdAt": "07/08/2025 08:51:55"
}
Embedded Page
As modern alternative to using iframes, the embedded page approach is a simple integration method, where the content is dynamically rendered into your website or customer portal, whilst still being hosted by PayPoint.
To embed all the BACS approved pages alongside the built-in bank validation including Payer Name Verification, you will need to include the following into the <head> of the HTML page.
<script>
const scriptSrc = "https://jolly-field-0aa415003.6.azurestaticapps.net/web-component.js?v=" + new Date().getTime();
const script = document.createElement('script');
script.src = scriptSrc;
document.head.appendChild(script);
</script>
You will also need to include the following into the <body> of the HTML page in the exact location where you wish the page to be rendered:
<ipdd-orchestration-form
InstructionReference="InstructionRef"
CustomerAccountID="AccountId"
ScheduleStartDate="2025-06-26"
ScheduleEndDate="2026-06-26"
ScheduleAmount="100.23"
ScheduleIntervalUnit="Week"
ScheduleInterval="1"
AdHoc="false"
publishablekey="{Provided by PayPoint}">
</ipdd-orchestration-form>
The IPDD component allows you to also include some preset values like the other integration method above, where you can send the IPDD pages customer details and schedule details. When a customer visits the HTML page the browser will action the JavaScript in the head and will substitute the IPDD component with the embedded PayPoint hosted pages.
Please Note: If you are embedding the IPDD pages into your website you will need to include a general enquiries / customer service contact number and / or the provision of a live chat facility to assist the payer if they have any urgent issues or a complaint to raise.