List all collection requests

direct-debit

GET

/api/v1/direct-debit

Returns a paginated list of direct debit collection requests sorted by initiatedAt in reverse chronological order.

Uses cursor-based pagination. Pass the nextCursor value from a previous response to retrieve the next page.

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"

Query Parameters

cursor

Pagination cursor returned in a previous response as nextCursor. Omit to start from the first page.

Type

string

Example"eyJjcmVhdGVkQXQiOiIyMDI0LTA2LTEwVDEwOjAwOjAwWiIsImlkIjoiQ09MLTAwMTIzIn0"

limit

Maximum number of records per page.

Type

integer

Minimum

1

Maximum

500

Default

100

scheme

Filter by payment scheme.

Type

array

status

Filter by collection request status.

Type

array

mandateReference

Filter by mandate reference.

Type

string

Example"MAND-SEPA-2024-001"

Min Length

5

Max Length

50

Pattern

"^[a-zA-Z0-9\\-]+$"

debtorReference

Filter by your internal reference for the debtor.

Type

string

Example"CUST-00123"

Min Length

1

Max Length

100

initiatedFrom

Return collections initiated on or after this date-time (inclusive). ISO 8601 format. Example: 2024-01-01T00:00:00Z.

Type

string

Example"2024-01-01T00:00:00Z"

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$"

initiatedTo

Return collections initiated on or before this date-time (inclusive). ISO 8601 format. Example: 2024-06-30T23:59:59Z.

Type

string

Example"2024-06-30T23:59:59Z"

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$"

amountMin

Return collections with amount greater than or equal to this value.

Type

number

Example50

Format

"double"

Minimum

0.01

amountMax

Return collections with amount less than or equal to this value.

Type

number

Example5000

Format

"double"

Minimum

0.01

Responses

Paginated list of collection requests.

Content-Type

application/json

object

Total number of records matching the applied filters across all pages.

true if more pages are available beyond this response.

Opaque cursor for retrieving the next page. Pass as the cursor query parameter in the next request. null when hasMore is false.

object[]

Required

List of collection request summaries for the current page.

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

Min Length5

Max Length50

Pattern"^[a-zA-Z0-9\\-]+$"

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\\-]+$"

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.

Min Length1

Max Length100

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])$"

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$"