v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Direct Debits

Get Mandates based on search criteria.

If trying to find one or several particular mandates, then you can narrow down your search by using the filters available here. These include the mandate id, either the submitted or created date range, the account name on the mandate, etc...

get/mandates

Query parameters

idstring[]

Id(s) of Mandate(s) to fetch.

accountIdstring[]

Id(s) of account to fetch Mandates for.

qstring

Query parameter. ID, name or reference of mandate to search for

Query parameter. ID, name or reference of mandate to search for

fromCreatedDatestring

Mandates created on or after this date.

Mandates created on or after this date.

toCreatedDatestring

Mandates created on or before this date.

Mandates created on or before this date.

fromSubmittedDatestring

Mandates submitted on or after this date.

Mandates submitted on or after this date.

toSubmittedDatestring

Mandates submitted on or before this date.

Mandates submitted on or before this date.

statusstring[]

Status of the Mandate

namestring

Account Name on the Mandate

Account Name on the Mandate

referencestring

reference of the Mandate

reference of the Mandate

externalReferencestring

externalReference of the Mandate

externalReference of the Mandate

bulkCreateRequestIdstring

Bulk create request ID

Bulk create request ID

bulkCancelRequestIdstring

Bulk cancel request ID

Bulk cancel request ID

sortFieldstring

Sort by field

Sort by field

sortOrder'ASC' | 'DESC'

Sort order

Example:asc

Sort order

pageinteger

Page to fetch (zero-indexed)

Page to fetch (zero-indexed)

sizeinteger

Size of page to fetch.

Size of page to fetch.

Response

OK