Creates a Direct Debit mandate.

post

https://api-sandbox.nofrixion.com/api/v1/mandates

Authorization: End user or Merchant token is required.

User permissions required: CanCreateMandates

Body Params

Mandate, customer and bank account information model.

merchantID

uuid

required

Merchant ID that this mandate is associated with.

firstName

string

required

length between 1 and 256

^[a-zA-Z0-9\-,'. ]+$

Customer's first name.

lastName

string

required

length between 1 and 256

^[a-zA-Z0-9\-,'. ]+$

Customer's last name.

addressLine1

string

required

length between 1 and 100

^[a-zA-Z0-9\-,'./ ]+$

First line of the customer's address.

addressLine2

string | null

^[a-zA-Z0-9\-,'./ ]+$

Second line of the customer's address. Optional.

postalCode

string

required

length between 1 and 10

^[a-zA-Z0-9\-,. /]+$

Customer's postal code.

city

string

required

length between 1 and 128

^[a-zA-Z0-9\-,'. ]+$

Customer's city.

countryCode

string

required

length between 1 and 2

2-character country code of the customer's bank account.

iban

string | null

IBAN of the customer's bank account in case of EUR account.

accountNumber

string | null

^[0-9]*$

Account number of the customer's bank account in case of GBP account.

sortCode

string | null

^[0-9\-]*$

Sort code of the customer's bank account in case of GBP account.

emailAddress

string

required

length ≥ 1

Customer's email address.

reference

string | null

Field that you can use as reference.

isRecurring

boolean | null

Indicates whether this mandate is single-use or recurring.

currency

string

enum

required

Currency of the mandate.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201

Mandate information.

400

Configuration error.

403

Unauthorized error.

Language

Credentials

Header

Loading…

Response

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

text/plain

application/json

text/json

200OK