Register a SDD Mandate

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
string
required
length between 0 and 256

Payment Account ID

string
required
length between 0 and 100

IBAN Holder

string
required
length between 0 and 11

BIC Code (SWIFT)

string
required
length between 15 and 34

IBAN

boolean

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

boolean
required
  1. If true, mandate is for recurring payments
  2. If false, mandate is for one payment only
string
length between 0 and 256

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

string
length between 0 and 10

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

string
length between 0 and 256

Client City Mandatory if you plan to electronically sign the mandate

string
length between 0 and 256

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

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.

string

Unique Mandate Reference Number (UMR)

Headers
string
required

Authorization bearer (OAuth 2)

string

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

string
required

IP address of the final client (PSU).

string

User-agent of the final client (PSU).

Responses

401

Unauthorized

500

InternalServerError

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