API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In

Create a Direct Debit mandate for the given account-id.

post
https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts//mandates

Setting up a Mandate is the first step in creating a Direct Debit. You can only set up scheduled payments ('collections') after there is a Mandate created with the details of the payee.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id of account to create Direct Debit for.

Body Params

Details of the Direct Debit mandate.

string
required
length between 0 and 40

Name for mandate

string
required
length between 6 and 18

Mandate reference, should contain only letters, numbers, space, dot, ampersand, forward-slash , hyphen

string
required
length between 0 and 50

External reference for mandate

string
required
length between 1 and 100

Payee's account name

string
required

Payee's sort code of account for which direct-debit-mandate has to be created.

string
required

Payee's account number for which direct-debit-mandate has to be created.

address
object
required

Payee's address

string
required
length between 0 and 14

Payee's phone number

string
length between 0 and 100

Payee's email address

string

Payee's accountBid

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 28 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 28 days ago