MoneyIns | Direct Debits

Register a SDD Mandate

This method allows you to pre-register a mandate.<br /><ul><li>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.</li><li>If you register a mandate with opt-in signature, the mandate will be automatically validated. Please refer to the Support Team for this option.</li></ul>

post/v2/moneyins/sdd/mandate

Request

  • Base URL
    https://ws.lemonway.fr/mb/env-name/prod/directkitrest
  • URL
    https://ws.lemonway.fr/mb/env-name/prod/directkitrest/v2/moneyins/sdd/mandate
  • Auth
    none declared. Required headers: Authorization, PSU-IP-Address

Headers

Authorizationstring required

Authorization bearer (OAuth 2)

PSU-Accept-Languagestring

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

PSU-IP-Addressstring required

IP address of the final client (PSU).

PSU-User-Agentstring

User-agent of the final client (PSU).

Request body

walletstring required

Payment Account ID

holderstring required

Debtor Name

bicstring required

BIC Code (SWIFT)

ibanstring required

IBAN

isB2Bboolean

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

isRecurringboolean required
  1. If true, mandate is for recurring payments
  2. If false, mandate is for one payment only
streetstring

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

postCodestring

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

citystring

Client City Mandatory if you plan to electronically sign the mandate

countrystring

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

mandateLanguagestring

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.

rumstring

Unique Mandate Reference Number (UMR)

signerFirstNamestring

Signer's First Name Required when SignerLastName is provided.

signerLastNamestring

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

signerEmailstring

Signer's Email (optional).

Example request

{
  "wallet": "33612345678",
  "holder": "Jean Dupont",
  "bic": "ABCDEFGHIJK",
  "iban": "FR1420041010050500013M02606",
  "isB2B": true,
  "isRecurring": true,
  "street": "26 rue de Paris",
  "postCode": "93100",
  "city": "Montreuil",
  "country": "FRANCE",
  "mandateLanguage": "es",
  "rum": "123456",
  "signerFirstName": "Gael",
  "signerLastName": "Durand",
  "signerEmail": "gael.durand@example.com"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.