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

post https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/{id}/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.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

string

required

Id of account to create Direct Debit for.

Body Params

name

string

required

length between 0 and 40

Name for mandate

reference

string

required

length between 6 and 18

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

externalReference

string

required

length between 0 and 50

External reference for mandate

accountName

string

required

length between 1 and 100

Payee's account name

sortCode

string

required

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

accountNumber

string

required

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

address

object

required

Payee's address

phone

string

required

length between 0 and 14

Payee's phone number

string

length between 0 and 100

Payee's email address

payeeAccountBid

string

Payee's accountBid

Responses

Response body

object

string

required

Unique id for direct-debit-mandate.

accountId

string

required

Unique id for account for this mandate.

reference

string

required

DDI reference that was used during creation.

externalReference

string

required

External reference that was used during creation (appears on the bank statement).

createdDate

date-time

required

Datetime when direct-debit-mandate was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

status

string

required

Status of the direct-debit-mandate. mandates must be 'ACTIVE' to make collections. Can be one of

nextValidCollectionDate

string

required

The earliest date a collection can be created. Format is yyyy-MM-dd.

Name given on Mandate

string

Address given on Mandate

object

addressLine1

string

required

length between 0 and 50

addressLine2

string

length between 0 and 50

postTown

string

required

length between 0 and 50

postCode

string

required

length between 0 and 8

country

string

required

AT BE BG CY CZ DK EE FI FR DE GR HR HU IS IE IT LV LI LT LU MT NL NO PL PT RO SK SI ES SE GB MQ YT GP GF RE MF GI GG IM JE MC CH AD SM VA AX PM BL AF AL DZ AS AO AI AQ AG AR AM AW AU AZ BS BH BD BB BY BZ BJ BM BT BO BQ BA BW BV BR IO VG BN BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CK CR CU CW CD DJ DM DO TL EC EG SV GQ ER SZ ET FK FO FJ PF TF GA GM GE GH GL GD GU GT GN GW GY HT HM HN HK IN ID IR IQ IL CI JM JP JO KZ KE KI XK KW KG LA LB LS LR LY MO MG MW MY MV ML MH MR MU MX FM MD MN ME MS MA MZ MM NA NR NP AN NC NZ NI NE NG NU NF KP MK MP OM PK PW PS PA PG PY PE PH PN PR QA CG RU RW SH KN LC VC WS ST SA SN RS SC SL SG SX SB SO ZA KR GS SS LK SD SR SY SJ TW TJ TZ TH TG TK TO TT TN TR TM TC TV UG UA AE UM US UY UZ VU VE VN VI WF EH YE ZM ZW

sortCode

string

required

Sort Code of the account for which direct-debit-mandate has been created.

accountNumber

string

required

Account Number for which direct-debit-mandate has been created.

payeeAccountBid

string

Unique id for individual recipient account used for internal transfers

bulkCreateRequestId

string

Id associate to the bulk create request of this mandate.

bulkCancelRequestId

string

Id associate to the bulk cancel request of this mandate.

Language

Credentials

Header


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts//mandates \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "address": {
8
    "country": "AT"
9
  }
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200OK

400Validation errors

404Not Found