Direct Debits
Direct Debit is a cost effective and technically efficient way of ‘pulling’ payments from your customers. You retain the control whilst other method involve the customer setting up or initiating the transaction. Our Direct Debit offering integrates into your processes and management of the process can be through the advanced portal, or APIs. We are able to work with a broad range of back office systems.
Reporting is a key part of the Direct Debit process. We handle all the mandatory BACS reports to ensure you continue to be compliant. The integration methods can also remove the need for manual reconciliation and create a fully automated reconciliation process in your back office systems. In addition we provide a range in additional insight reports to support your understanding.
Your API Subscription Key must be specified in each request using the Ocp-Apim-Subscription-Key header and the request body should be in the format of application/json.
Payment Instructions
The following APIs allow you to create and manage a payment instruction held with PayPoint. If the payment instruction has agreed payment schedule, PayPoint will then automatically request each Direct Debit payment collection.
The Payment Instructions APIs are available to download as Open API 3 yaml specification file.
Create a Payment Instruction
To create a payment instruction, you will need to send a Create Payment Instruction API Request containing: payer details including bank account details, and any payment schedule details. A synchronous response containing the result of the request is returned including the instruction id if successful.
For details on how to Create a Payment Instruction, refer to the detailed API Documentation.
Get a Payment Instruction
To receive details on a payment instruction, send a Payment Instruction GET Request that contains the instructionId. A synchronous response is returned containing the instruction's details including amount, payer details and schedule details.
For details on how to Get a Payment Instruction refer to the detailed API Documentation.
Update a Payment Instruction
To update a payment instruction, you will need to send an Update Request containing the instructionId and the full instruction details including the changes that you wish to update. A synchronous response containing the result of the request is returned and if successful the payment instruction will be updated.
For details on how to Update a Payment Instruction, refer to the detailed API Documentation.
Cancel a Payment Instruction
To cancel a payment instruction, you will need to send a Cancel Request containing the instructionId that you wish to cancel. A synchronous response containing the result of the request is returned and if successful the payment instruction will be flagged as cancelled.
For details on how to Cancel a Payment Instruction, refer to the detailed API Documentation.
Suspend a Payment Instruction
To suspend a payment instruction, you will need to send a Suspend Request containing the instructionId that you wish to suspend. A synchronous response containing the result of the request is returned and if successful the payment instruction will be flagged as suspend.
For details on how to Suspend a Payment Instruction, refer to the detailed API Documentation.
Resume a Payment Instruction
To resume a suspended payment instruction, you will need to send a Resume Request containing the instructionId that you wish to resume. A synchronous response containing the result of the request is returned and if successful the payment instruction will be active again.
For details on how to Resume a Payment Instruction, refer to the detailed API Documentation.
Payment Schedules
Add a Payment Instruction Schedule
To add a schedule to a payment instruction, you will need to send an Add Schedule Request containing the instructionId and the details of the additional schedule associated to the payment instruction. A synchronous response containing the result of the request is returned and if successful the schedule Id will be returned and the schedule would have been added to the payment instruction record.
For details on how to Add a Payment Instruction Schedule, refer to the detailed API Documentation.
Update a Payment Instruction Schedule
To update a schedule associated to a payment instruction, you will need to send an Update Schedule Request containing the instructionId and scheduleId and include the changes that you wish to update on the schedule. A synchronous response containing the result of the request is returned and if successful the payment instruction schedule will be updated.
For details on how to Update a Payment Instruction Schedule, refer to the detailed API Documentation.
Cancel a Payment Instruction Schedule
To cancel a schedule associated to a payment instruction, you will need to send an Cancel Schedule Request containing the instructionId and scheduleId to cancel. A synchronous response containing the result of the request is returned and if successful the payment instruction schedule will be cancelled.
For details on how to Cancel a Payment Instruction Schedule, refer to the detailed API Documentation.
Get Payment Instruction Schedule(s)
To receive details on a specific schedule, send a Schedule Details GET Request that contains the scheduleId and instructionId . A synchronous response is returned containing the schedules details including amount and collection date. To receive details off all the schedules for an instruction send a Schedules GET Request containing the instructionId.
For details on how to GET an Instruction Schedule, refer to the detailed API Documentation.
For details on how to GET all instruction Schedules, refer to the detailed API Documentation.
Payment Request
The following APIs allow you to create a payment collection request and manage the payment request prior to its collection date.
The Payment APIs are available to download as Open API 3 yaml specification file.
Create a Payment Request
To make an adhoc payment collection, you will need to send a Create a Payment API Request containing: Amount, your SUN, Direct Debit Payment instruction Id, and the future payment collection date. A synchronous response containing the result of the request is returned including the payment id if successful.
For details on how to Create a Payment Request, refer to the API Documentation.
Get Payment Details
To receive details on a payment, send a Payment Details GET Request that contains the PaymentId. A synchronous response is returned containing the payments details including amount and collection date.
For details on how to GET Payment Details, refer to the API Documentation.
Cancel a Payment
To cancel a payment request up to 3 days before collection date, you will need to send a Cancel Request containing the paymentId returned in the original adhoc or scheduled payment request.
For details on how to Cancel a Payment, refer to the API Documentation.
Represent a Payment
When a collection of a Direct Debit payment has failed, depending of the failure reason you may wish to represent the payment request by sending a Represent Request containing the original failed paymentId and a new collection date.
For details on how to Represent a Payment, refer to the API Documentation.