The API allows you to retrieve and update retry settings, and trigger retries for failed Direct Debit payments. This provides the same core functionality as Access PaySuite DDCMS, enabling automated retry management and payment re-presentation.
Before you start
The following is required before using the API:
Configurable Represents must be enabled for your organisation
A valid API key
Your client prefix
📌Note: All requests must include your API key in the request header.
Available endpoints
The API provides three main endpoints:
GET /api/v3/client/{clientPrefix}/unpaidPaymentRetrySettings – retrieves the current retry settings.
PATCH /api/v3/client/{clientPrefix}/unpaidPaymentRetrySettings – updates retry configuration, including delay and number of attempts.
POST /api/v3/client/{clientPrefix}/contract/{contractId}/payment/{paymentId}/retry – triggers a re-presentation for an eligible failed payment.
The payment must:
Be within one calendar month of the original payment date
Have an active Direct Debit Instruction
Not already be Pending or Paid
Example request
POST /api/v3/client/{clientPrefix}/contract/{contractId}/payment/{paymentId}/retry
{
"ProcessingDate": "2026-06-21T00:00:00.000Z"
}
The ProcessingDate sets the collection date for the retry.
📌Note: The ProcessingDate must be a valid working day and within the Bacs one calendar month limit.
After submission
When a retry is triggered:
A new payment is created with a Pending status
The original payment is updated to Represented
The retry is automatically included in the next Bacs submission file
Validation and errors
All retries are validated against the original payment date to ensure they stay within the Bacs one calendar month limit.
Common responses:
200 OK – request successful
400 Bad Request – invalid data, ineligible payment, or Bacs limit exceeded
401 Unauthorised – missing or invalid API key
403 Forbidden – payment belongs to a different client
404 Not Found – payment or contract not found