| Title |
Cardinality |
WSDL Format |
Fonctional Format |
Mandatory |
Condition |
Order |
Comment |
Is Default Parameter Stored in Creditor Configuration? |
| SessionParametersType |
| transactionId |
1 |
String |
String (1-70) |
M |
|
1 |
Identify the transaction of the session |
No |
| validation |
0 - 1 |
Boolean |
Boolean [true / false] |
O |
|
2 |
If Validation = TRUE --> ORG If Validation = FALSE --> OTU |
Yes |
| skipFirstPage |
0 - 1 |
Boolean |
Boolean [true / false] |
O |
|
3 |
Skip the first step page |
Yes |
| skipSummaryPage |
0 - 1 |
Boolean |
Boolean [true / false] |
O |
|
4 |
Skip the last step page |
Yes |
| displayAttachments |
0 - 1 |
Boolean |
Boolean [true / false] |
O |
|
5 |
Display attachment |
No |
| isSPS |
0 - 1 |
Boolean |
Boolean [true / false] |
0 |
|
6 |
Allows to identify that WS call comes from SPS |
No |
| sendMndByEmail |
0-1 |
Boolean |
Boolean [true / false] |
O |
|
7 |
Send signed mandate by email to debtor |
No |
| googleAnalyticsConsent |
0-1 |
Boolean |
Boolean [true / false] |
O |
|
8 |
Debtor consent to use google analytics |
No |
| agreementScheme |
0 - 1 |
AgreementSchemeType |
enum |
O |
|
9 |
OTP scheme |
Yes |
| bankAccount |
0 - 1 |
BankAccountIdentificationType |
enum |
O |
|
10 |
Debtor Bank Account |
No |
| creditorBankAccount |
0 - 1 |
BankAccountIdentificationType |
enum |
O |
|
11 |
Creditor Bank Account |
No |
| SCI |
0 - 1 |
SCITextType |
enum |
O |
|
12 |
Creditor ICS |
Yes (no if several ICS) |
| customerId |
0 - 1 |
String |
String (1-35) |
O |
|
13 |
Debtor External Id |
No |
| customerType |
0 - 1 |
CustomerType |
enum |
O |
|
14 |
Debtor Type |
No |
| aliasMandate |
0 - 1 |
String |
string[70] |
O |
|
15 |
alias of the mandate |
No |
| UMR |
0 - 1 |
String |
[a-zA-Z+?()-:/.,_'0-9]{1,35} |
O |
|
16 |
UMR |
No |
| UIR |
0 - 1 |
String |
[a-zA-Z+?()-:/.,_'0-9]{1,35} |
O |
|
17 |
UIR |
No |
| urlOK |
0 - 1 |
anyURI |
anyURI |
O |
|
18 |
URL for OK |
Yes |
| urlKO |
0 - 1 |
anyURI |
anyURI |
O |
|
19 |
URL for KO |
Yes |
| urlCancel |
0 - 1 |
anyURI |
anyURI |
O |
|
20 |
URL for Cancel |
Yes |
| language |
0 - 1 |
string |
[A-Z]{1,2} |
O |
|
21 |
[FR, EN, ES, DE, NL, IT...] Cinematic GUI and Mandate language (If language is not supported, the language will be the one set on the creditor) |
Yes |
| periodicSchedule |
0 - 1 |
PeriodicScheduleType |
enum |
O |
|
22 |
Create a Periodic Schedule over SPS |
No |
| variableSchedule |
0 - * |
VariableScheduleType |
enum |
C |
|
23 |
Create a Variable Schedule over SPS |
No |
| firstPaymentAmount |
0 - 1 |
decimal |
decimal |
C |
Mandatory if agreementScheme = PAYMENT |
24 |
Decimal. Min "0", fraction digits "5", total digits "18" |
No |
| mandateSeqType |
0 - 1 |
MandateSeqType |
enum |
O |
|
25 |
|
No |
| mandateType |
0 - 1 |
MandateType |
enum |
O |
|
26 |
|
No |
| companyName |
0 - 1 |
String |
String (max lenght ?) |
C |
Mandatory if mandateType = B2B Taken into account only if CompanyInfos is not present in the request |
27 |
Company Name. (Raison Sociale) |
No |
| RCS |
0 - 1 |
String |
String (max lenght ?) |
C |
Taken into account only if CompanyInfos is not present in the request |
28 |
List of company registers. (Registre du commerce et des societes) |
No |
| PostalAddressType |
| BldngNm |
0 - 1 |
string |
String (1-16) |
M |
|
1 |
Street Number |
No |
| StrNm |
0 - 1 |
string |
String (1-70) |
M |
|
2 |
Street name |
No |
| PstCd |
0 - 1 |
string |
String (1-16) |
M |
|
3 |
Postal Code |
No |
| City |
0 - 1 |
string |
String (1-35) |
M |
|
4 |
City |
No |
| Ctry |
0 - 1 |
string |
[A-Z]{2,2} |
M |
|
5 |
Country |
No |
| SignerInfos |
| ++LastName |
1 |
string |
string (1-255) |
M |
|
1 |
Debtor last name |
No |
| ++FirstName |
1 |
string |
string (1-255) |
C |
Mandatory for OTU only |
2 |
Debtor first name |
No |
| ++Gender |
1 |
Gender |
[M, F] |
C |
Mandatory for OTU only |
3 |
gender |
No |
| ++Address |
0 - 1 |
string |
Not used |
O |
|
4 |
Not used Depricated |
No |
| ++Phone |
0 - 1 |
|
^+\d{10,14}$ |
O |
|
5 |
Debtor phone - International format E.164 |
No |
| ++Email |
0 - 1 |
string |
^\s*?(.+)@(.+?)\s*$ |
O |
|
6 |
Debtor mail |
No |
| ++Custom |
0 - 1 |
string |
anyType |
O |
|
7 |
Not used Depricated |
No |
| CompanyInfos |
| corporateIndicator |
0 - 1 |
Boolean |
Boolean [true / false] |
O |
|
1 |
Defined by SIPS to create "Mandat Core Entreprise" Mandatory if the type of the mandate is Core Entreprise |
No |
| companyName |
0 - 1 |
String |
String |
O |
Mandatory if (mandateType=B2B) or (mandateType = Core and corporateIndicator=true) |
2 |
Company Name |
No |
| businessName |
0 - 1 |
string |
String |
O |
Mandatory if mandateType = B2B |
3 |
Raison Sociale |
No |
| businessIdentifier |
0 - 1 |
String |
String |
O |
Mandatory if mandateType = B2B |
4 |
RCS or SIREN or SIRET |
No |
| signerPositionOccupied |
0 - 1 |
string |
String |
O |
Mandatory if (mandateType=B2B) or (mandateType = Core and corporateIndicator=true) |
5 |
position Occupied by the Signer |
No |
| SipsParameters |
| CaptureMode |
0 - 1 |
CaptureModeType |
enum |
O |
|
1 |
Defined by SIPS to initiate a payment |
No |
| endToEndTicketVersion |
0 - 1 |
string |
string (1-16) |
O |
|
2 |
Use to calculate the endToEndTicket and the SEAL associated |
No |
| BankAccountIdentificationType |
Debtor |
|
| AcctId |
0 - 1 |
|
|
C |
Choice between AcctId/FinInstnId and DomAcctId/FinInstnId |
1 |
Bank Account Id |
No |
| +IBAN |
1 |
String |
[a-zA-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30} |
0 |
|
2 |
Iban |
Yes |
| FinInstnId |
0 - 1 |
|
|
C |
Choice between AcctId/FinInstnId and DomAcctId/FinInstnId |
3 |
Financial institution servicing the account |
No |
| +BIC |
1 |
String |
[A-Z]{6,6}[A-Z2-9]A-NP-Z0-9{0,1} |
O |
|
4 |
Bank Idenfiant Account |
YES |
| DomAcctId |
0 - 1 |
|
|
O |
Choice between AcctId/FinInstnId and DomAcctId/FinInstnId |
5 |
Domestic bank account ID |
No |
| +DbtrBBAN |
1 |
String |
[a-zA-Z0-9]{1,30} |
0 |
|
6 |
BBAN |
No |
| FinInstnId |
0 - 1 |
|
|
C |
Choice between AcctId/FinInstnId and DomAcctId/FinInstnId |
7 |
Financial institution ID |
No |
| +DbtrCtry |
1 |
String |
[a-zA-Z]{2,2} |
0 |
|
8 |
[FR, UK, NL, …] |
No |
| SCITextType |
| country |
1 |
String |
[a-zA-Z]{2,2} |
M |
|
1 |
[FR, UK, NL, …] |
No |
| checkDigit |
1 |
String |
[a-zA-Z]{2,2} |
M |
|
2 |
SCI check digit |
No |
| businessCode |
1 |
String |
[a-zA-Z]{3,3} |
M |
|
3 |
Businness code |
No |
| nationalIdentifier |
1 |
String |
[a-zA-Z]{1,18} |
M |
|
4 |
NNE (3 int digit for FR) |
No |
| PeriodicScheduleType |
| FrstDueDt |
1 |
date |
date (AAAA-MM-DD) |
M |
|
1 |
First due date |
No |
| FrstAmount |
0-1 |
decimal |
decimal |
O |
|
2 |
First amount (Decimal. Min "0", fraction digits "5", total digits "18") |
No |
| DfltAmount |
1 |
decimal |
decimal |
M |
|
3 |
Default amount (Decimal. Min "0", fraction digits "5", total digits "18") |
No |
| NbOcc |
0 - 1 |
int |
int |
C |
|
4 |
Number of occurrences |
No |
| LstDueDt |
0 - 1 |
date |
date (AAAA-MM-DD) |
C |
|
5 |
Last due date |
No |
| LastAmount |
0 - 1 |
decimal |
decimal |
O |
|
6 |
Last amount (Decimal. Min "0", fraction digits "5", total digits "18") |
No |
| Period |
1 |
PaymentSchedulePeriodType |
enum |
M |
|
7 |
Period |
No |
| LstIsFinal |
0 - 1 |
Boolean |
Boolean [true / false] |
O |
|
8 |
Is last Sdd the Final from the Mandate? |
No |
| VariableScheduleType |
| Dt |
1 |
Date |
date (AAAA-MM-DD) |
M |
|
1 |
Due Date |
No |
| Amnt |
1 |
decimal |
decimal |
M |
|
2 |
Amount (Decimal. Min "0", fraction digits "5", total digits "18") |
No |
| GenericResponseType |
| Sts |
1 |
TransactionStatusType |
enum |
M |
|
1 |
Status |
No |
| StsCd |
1 |
String |
String |
M |
|
2 |
[Return code](#New Return Codes!A1) |
No |
| StsInf |
1 |
String |
String |
M |
|
3 |
[Status Information](#Legacy Return_codes!D5) |
No |
| OptionalMandateFieldsType |
| contractId |
1 |
String |
String (1-35) |
O |
|
1 |
contract number |
No |
| contractDescription |
1 |
String |
String (1-35) |
O |
|
2 |
description of the contract |
No |
| ultimateDebtorId |
1 |
String |
String (1-70) |
O |
|
3 |
id of the third debtor |
No |
| ultimateDebtorName |
1 |
String |
String (1-70) |
O |
Mandatory if ultimateDebtorId is set ! |
4 |
name of the third debtor |
No |