Documentation

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.

uuid
required

Merchant ID that this mandate is associated with.

string
required
length between 1 and 256

Customer's first name.

string
required
length between 1 and 256

Customer's last name.

string
required
length between 1 and 100

First line of the customer's address.

string | null

Second line of the customer's address. Optional.

string
required
length between 1 and 10

Customer's postal code.

string
required
length between 1 and 128

Customer's city.

string
required
length between 1 and 2

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

string | null

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

string | null

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

string | null

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

string
required
length ≥ 1

Customer's email address.

string | null

Field that you can use as reference.

boolean | null

Indicates whether this mandate is single-use or recurring.

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.

Updated 9 months ago

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

Updated 9 months ago