Create a direct debit collection request

direct-debit

POST

/api/v1/direct-debit

Initiates a direct debit collection request against an existing active mandate. The mandate must be in ACTIVE status before a collection can be initiated.

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"

Request Body

application/json

object

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

Valid values"SEPA"

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

Min Length5

Max Length50

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

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

Min Length5

Max Length50

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

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. Must be EUR for SEPA collections.

Valid values"EUR"

Requested settlement date. Must be a future business date in ISO 8601 format (YYYY-MM-DD). SEPA requires at least 2 business days ahead.

Format"date"

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

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"

SEPA creditor identifier issued by the creditor's bank (e.g., DE98ZZZ09999999999).

Human-readable payment purpose shown to the debtor on their bank statement.

Min Length1

Max Length140

Responses

Collection request created successfully.

Content-Type

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