UK - Accept bank direct debit payments - Partner software managed payment page

Introduction

This developer guide will allow you to incorporate the necessary form fields to your application to accept bank account direct debits. The platform will pick up the scheduled direct debits and submit the direct debit through the processing countries banking system with the standard 2 business day bank processing time to finalise the direct debit transaction and identify if it was successful or unsuccessful.

Note - In the UK, a Bank Account direct debit schedule in the UK must allow 6 business days notice before the payment due date. Scheduled Bank Account debits may not be altered or removed once it is within the 6 business day notice period as per UK regulations. A Credit Card direct debit does not fall under the same UK BACS requirements for the 6 business day rule and can be scheduled, altered or removed at any time prior to processing.

UK - Flowchart to bank account direct debits through Partner software managed page

• Partner Software managed payment solution - Bank direct debit - UK.pdf

API steps to accept bank account direct debit payments

1. Your application will need to collect necessary contact information of the account holder to create a payer record in the system.

2. Create a payer record with the contact information - POST Add a new Payer

3. Add bank account details to relevant payer record - PUT Add or update a Payers bank account details

4. Most software services already contain the information regarding the Payer and when they are to be debited. In this case it is much simpler for the software to manage the schedule and send a request as and when required with the minimum 6 business day notice period.

5. Schedule single or multiple payments:

   1. POST Schedule a single payment

   2. POST Schedule multiple future payments

6. Determine result of scheduled debit - GET Search for transaction status change

7. Remove transaction from data set - POST Acknowledge transaction status change

1. Recommend calling our GET Search for transaction status changes at approximately 10AM AEST as a general timeframe daily which will pull a set of all transactions for your business that have had a change of transaction status.

2. Following the above API, use our POST Acknowledge transaction status change to acknowledge the transactions and remove them from the data set when you next call the Get New Status Search above.

3. If the transaction status changes again after you have removed it from the data set, it will be returned in the GET Search for transaction status changes to notify you of the change in status.

Bank Account details for testing

Test Bank Account Details

What to do if a scheduled debit has failed?

If the result of the transaction has returned and been identified as failed / rejected, pending on your application’s workflow, you can simply schedule another debit to capture payment and then identify the result of the following debit in the same flow, GET Search for transaction status then POST Acknowledge transaction status change.

How to cancel a scheduled debit from processing?

In order to cancel a scheduled debit from processing, it must be cancelled 6 days in advance as per the BaCs regulation. If the scheduled debit is within the 6 day advance notice timeframe, you can no longer cancel or stop the debit from processing. Utilise any of the 'Find Schedule Details ' API in conjunction with the DELETE Delete Single Payment to confirm the scheduled debit was cancelled successfully.

Example

1. Call GET Look up a scheduled payment or GET Find a Payers scheduled payments or GET Search all scheduled payments to identify the 'scheduledpaymentid'.

   • If the 'scheduledpaymentid' that you are planning to cancel is returned in this API call, the debit has not yet been picked up for processing and you are still able to cancel the scheduled debit.

   • If the 'scheduledpaymentid' is not returned, the debit has been processed and can no longer be cancelled.

2. Cancel the scheduled debit by calling Delete Single Payment

   • This will return a 200 response

3. Confirm the cancellation by calling either of the 3 GET API calls.

   • If the 'scheduledpaymentid' is not returned, the scheduled debit has been deleted.

Self-service function to manually instantly trigger debit or settlement process

Refer to our self-service function here to instantly trigger the debit or settlement process. This will allow you to test the processes without waiting for the automated process in the sandbox environment.

Compliance requirements

When accepting card or bank account payments through a non-worldpay hosted payment page, the PCI and banking compliance regulations fall under your softwares responsbility. As you may be aware, every organisation that handles card payments must comply with the Payment Card Industry Data Security Standard (PCI DSS). Annual compliance is mandated by the payment card schemes and banks. Due to this there are certain requirements that need to be met when building a Payment Page. Refer to our Risk and Compliance guide to assist you through the payment page requirements and eDDR requirements.