Register a SDD Mandate

post

https://api.lemonway.fr/mb/ENV-NAME/directkitrest/v2/moneyins/sdd/mandate

A SEPA Direct Debit (SDD) mandate is a signed authorization given by a debtor to a creditor, allowing the creditor to collect payments directly from the debtor's bank account. The mandate must be registered and signed before any SDD collection can be initiated.

This method allows you to pre-register a mandate.

If you register a mandate with electronic signature, the mandate will be pending. You need to use the Generate an Electronic Signature of a Document call to sign the mandate. The status will change accordingly.
If you register a mandate with opt-in signature, the mandate will be automatically validated. Please refer to the Support Team for this option.

Body Params

wallet

string

required

length between 0 and 256

Payment Account ID

holder

string

required

length between 0 and 100

Debtor Name

bic

string

required

length between 0 and 11

BIC Code (SWIFT)

iban

string

required

length between 15 and 34

IBAN

isB2B

boolean

Indicates if the mandate is a SEPA business to business direct debit

isRecurring

boolean

required

If true, mandate is for recurring payments
If false, mandate is for one payment only

street

string

length between 0 and 256

Client Number and Street
Mandatory if you plan to electronically sign the mandate

postCode

string

length between 0 and 10

Client Postal Code/ZIP
Mandatory if you plan to electronically sign the mandate

city

string

length between 0 and 256

Client City
Mandatory if you plan to electronically sign the mandate

country

string

length between 0 and 256

Client Country
Mandatory if you plan to electronically sign the mandate.

mandateLanguage

string

length between 2 and 2

Language of the automatically generated mandate(for electronic signature).
Currently, the available languages are: fr, en, de, es, it.
If you need another, please contact us.
"fr" is used by default if no language is requested.

rum

string

Unique Mandate Reference Number (UMR)

signerFirstName

string

length between 0 and 256

Signer's First Name
Required when SignerLastName is provided.

signerLastName

string

length between 0 and 256

Signer's Last Name.
Required when SignerFirstName is provided.

Headers

Authorization

string

required

Authorization bearer (OAuth 2)

PSU-Accept-Language

string

Response language accepted by final client (PSU). English by default

PSU-IP-Address

string

required

IP address of the final client (PSU).

PSU-User-Agent

string

User-agent of the final client (PSU).

Responses

401

Unauthorized

500

InternalServerError

Language

Loading…

Response

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

application/json

200OK