API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In
Start typing to search…

Get Mandates based on search criteria.

get https://api-sandbox.modulrfinance.com/api-sandbox-token/mandates

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...

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Query Params
id
array of strings

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

id
accountId
array of strings

Id(s) of account to fetch Mandates for.

accountId
string

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

string

Mandates created on or after this date.

string

Mandates created on or before this date.

string

Mandates submitted on or after this date.

string

Mandates submitted on or before this date.

status
array of strings

Status of the Mandate

status
string

Account Name on the Mandate

string

reference of the Mandate

string

externalReference of the Mandate

string

Bulk create request ID

string

Bulk cancel request ID

string

Sort by field

string

Sort order

int32
≥ 0

Page to fetch (zero-indexed)

int32
≤ 500

Size of page to fetch.

Responses

Updated over 1 year ago

Did this page help you?
Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated over 1 year ago

Did this page help you?