Appearance

Deactivate a mandate​

mandates
DELETE
/api/v1/mandates/{mandateReference}

Deactivate an existing mandate. The mandate transitions to CANCELLED status and can no longer be used for direct debit collections.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Header Parameters

x-region*

Regional routing header. Must be EU for SEPA mandates.

Type
string
Required
Valid values
"EU"

Path Parameters

mandateReference*

The client-provided mandate reference identifier.

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

Responses​

Mandate deactivated successfully.

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​