List all mandates

mandates

GET

/api/v1/mandates

Retrieve mandates you have created. Use query parameters to filter results.

The mandates are sorted by the createdAt date in reverse chronological order.

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"

Query Parameters

status

Filter by mandate status. Possible values: APPROVED, ACTIVE, CANCELLED, EXPIRED.

Type

array

scheme

Filter by payment scheme.

Type

string

Valid values

"SEPA"

createdBefore

Retrieves mandates with createdAt < createdBefore. Default is the current date and time.

Provided in ISO 8601 format. Example: 2024-03-24T03:14:15Z.

Type

string

Example"2024-03-24T03:14:15Z"

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

counterpartyReference

Filter by counterparty reference.

Type

string

Example"CUST-001"

limit

Number of mandates per page. Maximum 1000.

Type

integer

Format

"int64"

Minimum

1

Maximum

1000

Default

100

page

Page number.

Type

integer

Example1

Minimum

1

Default

1

Responses

List of mandates.

Content-Type

application/json

object

object

Required

This is the page number.

Minimum0

The page size, indicating the number of entries returned per page.

Minimum0

true if there are more pages available beyond this one.

object[]

Required

Lifecycle status of the mandate.

• APPROVED — Mandate registered and pending activation.
• ACTIVE — Mandate is live and can be used for direct debit collections.
• CANCELLED — Mandate deactivated via DELETE. Cannot be used for collections.
• EXPIRED — Mandate passed its endDate and is no longer valid.

Valid values"APPROVED""ACTIVE""CANCELLED""EXPIRED"

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

object

object

object

Mandate collection parameters. Valid field combinations for SEPA:

type	debitType	Use
ONE_OFF	EXACT_AMOUNT	Single collection only. Provide amount.
RECURRING	EXACT_AMOUNT or MAXIMUM_AMOUNT	Ongoing regular collections. Provide amount (EXACT_AMOUNT) or maxAmount (MAXIMUM_AMOUNT).

mode rules: CORE only — SEPA Core Direct Debit (consumers; 5-day first-collection notice).

frequency is optional.
Do not pair type=ONE_OFF with debitType=MAXIMUM_AMOUNT — these are contradictory.

The date and time the mandate was created in ISO 8601 format. Example: 2024-03-24T03:14:15Z.

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 mandate was last updated in ISO 8601 format. Example: 2024-03-24T03:14:15Z.

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 mandate expired in ISO 8601 format. Example: 2024-03-24T03:14:15Z.

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