RegisterSddMandate
Important
The mandate will expire 36 months after its last use for a direct debit.
How it works
This method allows you to pre-register a Mandate.
- If you register a Mandate with an electronic signature, the Mandate will be pending. You need to use Generate an Electronic Signature of a Document call to sign the Mandate. The status will change accordingly.
- If you register a Mandate with an opt-in signature, the Mandate will be automatically validated. Please refer to the Support Team for this option.
XML
<RegisterSddMandate xmlns="Service_mb">
<wlLogin>string</wlLogin>
<wlPass>string</wlPass>
<language>string</language>
<version>string</version>
<walletIp>string</walletIp>
<walletUa>string</walletUa>
<wallet>string</wallet>
<holder>string</holder>
<bic>string</bic>
<iban>string</iban>
<isRecurring>string</isRecurring>
<isB2B>string</isB2B>
<street>string</street>
<postCode>string</postCode>
<city>string</city>
<country>string</country>
<mandateLanguage>string</mandateLanguage>
<rum>string</rum>
</RegisterSddMandate>
<SDDMANDATE>
<S>0</S>
<ID>11</ID>
<RUM>LW123456</RUM>
</SDDMANDATE>
JSON
{
"wlLogin":"string",
"wlPass":"string",
"language":"string",
"version":"string",
"walletIp":"string",
"walletUa":"string",
"wallet":"string",
"holder":"string",
"bic":"string",
"iban":"string",
"isRecurring":"string",
"isB2B":"string",
"street":"string",
"postCode":"string",
"city":"string",
"country":"string",
"mandateLanguage":"string",
"rum":"string"
}
{
"SDDMANDATE":{
"S":"0",
"ID":"11",
"RUM":"LW123456"
}
}
Request Input Description
| Element | Description | Required | Format | Example |
|---|---|---|---|---|
| wallet | Account ID | Yes | [0: 256] char | 33612345678 or taxi67 |
| the Technical wallet or KYC1 wallet is not authorized (except for some special partners) | ||||
| holder | IBAN holder | Yes | [1:100] char | Jean Dupont |
| bic | BIC / SWIFT Code | Yes | [11] char | ABCDEFGHIJK |
| iban | IBAN | Yes | [15: 34] char | FR1420041010050500013M02606 |
| isRecurring | 1: recurrent payment | Yes | [1] char | 1 |
| 0: one payment | ||||
| isB2B | 1: SEPA business to business | No | [1] char | 1 |
| 0: SEPA Core | ||||
| By default 0 | ||||
| street | Client's number and street. | Yes | [0:256] car | 26 rue de Paris |
| postCode | Client's postcode/ZIP | Yes | [0:10] car | 93100 |
| city | Client's city | Yes | [0:256] car | Montreuil |
| country | Client's country | Yes | [0:256] car | FRANCE |
| mandateLanguage | Language of the generated mandate. | No | [2] chars | es |
| Currently, the available languages are fr, en, de, es, and it. | ||||
| If you need another, please contact us. | ||||
| EN is used by default if no language is requested. | ||||
| rum | Unique mandate reference number (UMR) | No | [0:35] car | 123456 |
Response Output Description
| Element | Description | Example |
|---|---|---|
| ID | Mandate ID | 253 |
| S | Mandate status: | 0 |
| 0: pending approval | ||
| 5: validated | ||
| RUM | Unique mandate reference number (UMR) | LW123456 |