Appearance

Get a collection request​

direct-debit
GET
/api/v1/direct-debit/{collectionReference}

Retrieve the full details of a single direct debit collection request by its reference.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Header Parameters

x-region*

Mandatory routing header to direct the request to the appropriate regional products

Type
string
Required
Valid values
"EU"

Path Parameters

collectionReference*

Your unique reference for the collection request.

Type
string
Required
Example"COL-SEPA-2024-001"
Min Length
5
Max Length
50
Pattern
"^[a-zA-Z0-9\\-]+$"

Responses​

Full details of the collection request.

application/json
object

Payment scheme identifier. Currently supported: SEPA — Single Euro Payments Area (EU).

Valid values"SEPA"

Client-provided unique mandate reference. Uppercase, lowercase, alphanumeric and hyphens only.

Min Length5
Max Length50
Pattern"^[a-zA-Z0-9\\-]+$"

Your unique reference for this collection request. Uppercase, lowercase, alphanumeric and hyphens only.

Min Length5
Max Length50
Pattern"^[a-zA-Z0-9\\-]+$"

Lifecycle status of a direct debit collection request:

  • PENDING — Created, not yet submitted to the scheme
  • SUBMITTED — Sent to the payment scheme
  • PROCESSING — Accepted and being processed by the scheme
  • SETTLED — Funds successfully collected
  • FAILED — Collection attempt failed
  • CANCELLED — Cancelled before submission
  • RETURNED — Funds returned after initial settlement
  • REJECTED — Rejected by the scheme or debtor bank
Valid values"PENDING""SUBMITTED""PROCESSING""SETTLED""FAILED""CANCELLED""RETURNED""REJECTED"

Decimal string. 1–999999999.99, max 2 dp, no leading zeros. (String, not number, to avoid number/multipleOf floating-point validation errors.)

Pattern"^[1-9]\\d{0,8}(\\.\\d{1,2})?$"

ISO 4217 currency code. Always EUR for SEPA collections.

Valid values"EUR"

Full legal name of the debtor.

Your internal reference for the debtor (e.g., customer ID).

Min Length1
Max Length100

Requested settlement date. ISO 8601 format (YYYY-MM-DD).

Format"date"
Pattern"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"

Payment purpose shown on the debtor's bank statement.

Min Length1
Max Length140

SEPA collection sequence type:

  • FRST — First collection in a series
  • OOFF — One-off collection
  • RCUR — Recurring collection
  • FNAL — Final collection
Valid values"FRST""OOFF""RCUR""FNAL"

IBAN of the debtor's bank account (SEPA collections).

SEPA creditor identifier.

The date and time the collection request was initiated in ISO 8601 format.

Format"date-time"
Pattern"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$"

The date and time the collection request was last updated in ISO 8601 format.

Format"date-time"
Pattern"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$"

Response Headers

Deprecation

Indicates deprecation (boolean)

Typestring
Exampletrue
Sunset

Sunset date in HTTP-date format [ISO 8601]. Example: `2024-03-24T03:14:15Z`.

Typestring (date-time)
Example2024-03-24T03:14:15Z

Samples​