Direct Debit

Configurable Represents

Configurable Represents lets you control how failed Direct Debit payments are automatically retried, and lets you manually trigger a re-presentation for a specific failed payment.

These three endpoints allow you to retrieve and update your retry settings, and to trigger a re-presentation for a specific payment programmatically.

GET/client/{clientCode}/unpaidPaymentRetrySettingsReturns the current retry configuration for your client#
description:

Returns the current retry configuration for your client.

authorization:ApiKeyAuth
content-type: application/json
path parameters:
shared schema directDebit/path/client
{
  • clientCode
    string (≤ 6 chars)MandatoryThe client code provided in your welcome email.
}

Responses

200OK
response body:
{
  • AllowRetryFailedPayments
    booleanWhether Configurable Represents is enabled for your organisation.
  • RetryPaymentsDelayDays
    integerNumber of working days configured between a failed payment and its re-presentation.
  • FailedPaymentRetries
    integerMaximum number of retry attempts configured (1-3).
}
Example request
Endpoint
GET /client/{clientCode}/unpaidPaymentRetrySettings
cURL
curl -L -g -X GET 'https://ddcms.accesspaysuite.com/api/v3/client/{clientCode}/unpaidPaymentRetrySettings' -H 'apiKey: {apiKey}'
Response
HTTP/1.1 200 OK

{
  "AllowRetryFailedPayments": true,
  "RetryPaymentsDelayDays": 10,
  "FailedPaymentRetries": 2
}
PATCH/client/{clientCode}/unpaidPaymentRetrySettingsUpdates the retry configuration for your client#
description:

Updates the retry configuration for your client.

authorization:ApiKeyAuth
content-type: application/json
path parameters:
shared schema directDebit/path/client
{
  • clientCode
    string (≤ 6 chars)MandatoryThe client code provided in your welcome email.
}
request body:
{
  • AllowRetryFailedPayments
    booleanMandatorySet to true to enable Configurable Represents, false to disable.
  • RetryPaymentsDelayDays
    integerWorking days between a failed payment and re-presentation. Minimum = your look-forward days setting; maximum = 20. Required when AllowRetryFailedPayments is true.
  • FailedPaymentRetries
    integerMaximum retry attempts. Range: 1-3. Required when AllowRetryFailedPayments is true.
}

Responses

200OK
response body:
{
  • AllowRetryFailedPayments
    booleanWhether Configurable Represents is enabled for your organisation.
  • RetryPaymentsDelayDays
    integerNumber of working days configured between a failed payment and its re-presentation.
  • FailedPaymentRetries
    integerMaximum number of retry attempts configured (1-3).
}
Example request
Endpoint
PATCH /client/{clientCode}/unpaidPaymentRetrySettings
Request body
{
  "AllowRetryFailedPayments": false,
  "RetryPaymentsDelayDays": 0,
  "FailedPaymentRetries": 0
}
cURL
curl -L -g -X PATCH 'https://ddcms.accesspaysuite.com/api/v3/client/{clientCode}/unpaidPaymentRetrySettings' -H 'apiKey: {apiKey}' -H 'Content-Type: application/json' --data-raw '{
    "AllowRetryFailedPayments": true,
    "RetryPaymentsDelayDays": 10,
    "FailedPaymentRetries": 2
  }'
Response
HTTP/1.1 200 OK

{
  "AllowRetryFailedPayments": true,
  "RetryPaymentsDelayDays": 10,
  "FailedPaymentRetries": 2
}
POST/client/{clientCode}/contract/{contractId}/payment/{paymentId}/retryTriggers a re-presentation for a specific failed payment#
description:

Triggers a re-presentation for a specific failed payment. The payment must be eligible: within 1 calendar month of the original payment date, the Direct Debit Instruction must be active, and the payment must not already be in a Pending or Paid status.

authorization:ApiKeyAuth
content-type: application/json
path parameters:
shared schema directDebit/path/client-contract-payment
{
  • clientCode
    string (≤ 6 chars)MandatoryThe client code provided in your welcome email.
  • contractId
    string (guid)MandatoryThe contract ID for the payment.
  • paymentId
    string (guid)MandatoryThe payment ID to represent.
}
request body:
{
  • ProcessingDate
    string (date-time)MandatoryThe date the re-presented payment should be collected. Must be a working day within 1 calendar month of the original payment date.
}

Responses

200OK
response body:
{
  • Message
    stringConfirms the payment retry has been scheduled.
}
400Bad RequestBad Request - payment not eligible, processing date not a valid working day, date exceeds Bacs limit, or required fields missing.
401UnauthorizedUnauthorised - invalid or missing API key.
403ForbiddenForbidden - the payment belongs to a different client.
404Not FoundNot Found - payment or contract not found.
Example request
Endpoint
POST /client/{clientCode}/contract/{contractId}/payment/{paymentId}/retry
Request body
{
  "ProcessingDate": "YYYY-MM-DDT00:00:00.000Z"
}
cURL
curl -L -g -X POST 'https://ddcms.accesspaysuite.com/api/v3/client/{clientCode}/contract/{contractId}/payment/{paymentId}/retry' -H 'apiKey: {apiKey}' -H 'Content-Type: application/json' --data-raw '{
    "ProcessingDate": "2026-06-21T00:00:00.000Z"
  }'
Response
HTTP/1.1 200 OK

{
  "Message": "Payment retry scheduled successfully."
}
HTTP/1.1 400 Bad Request

{
  "ErrorCode": 3,
  "Message": "Payment is not eligible for retry."
}
HTTP/1.1 401 Unauthorized

{
  "Message": "API not enabled"
}
HTTP/1.1 403 Forbidden

{
  "Message": "Payment cannot be accessed"
}
HTTP/1.1 404 Not Found

{
  "Message": "Payment not found"
}