| 🛈 The webservice InitSession exists in REST. We recommend you to use the REST protocol | ||||||
| InitSession | Request | Title | Mandatory or Optional? | Format | Cardinality | Comment |
| +creditorId | M | String | 1 | Identifier of the creditor over SPS-SIGNATURE. (This identifier can be generated by SPS-SIGNATURE) | ||
| +parameters | M | SessionParameters | 1 | Session Parameters in order to initiate the mandate | ||
| +postalAddress | O | PostalAddressType | 0 - 1 | Debtor Postal Address | ||
| +optionalMandateFields | O | OptionalMandateFieldsType | 0 - 1 | Optional fields specific for mandate information: contract and third debtor | ||
| +SignerInfos | C | SignerInfos | 0 - 1 | OTU and Validation Fields | ||
| +companyInfos | C | companyInfos | 0 - 1 | Company information | ||
| +SipsParameters | C | SipsParameters | 0 - 1 | SIPS Fields | ||
| +SubjectInfos | C | 0 - 1 | SIPS Fields | |||
| Response | Title | Mandatory or Optional? | Format | Cardinality | Comment | |
| +response | M | GenericResponseType | 1 | Response message | ||
| +url | O | anyURI | 0 - 1 | Url of SPS SIGN session that has been created | ||
| +umr | O | string | 0 - 1 | UMR of the mandate to sign (skipFirstStep) | ||
| 🛈 The webservice InitSessionForMandateUpdate exists in REST. We recommend you to use the REST protocol | ||||||
| InitSessionForMandateUpdate | Request | Title | Mandatory or Optional? | Format | Cardinality | Comment |
| +transactionId | M | NumericTextType | 1 | Identify the mandate update transaction of the session | ||
| +creditorId | M | String | 1 | Identifier of the creditor over SPS-SIGNATURE. (This identifiant can be generated by SPS-SIGNATURE) | ||
| +UMR | M | String | 1 | UMR of the mandate to update | ||
| +SCI | M | SCITextType | 1 | Creditor SCI | ||
| +language | O | String | 0 - 1 | Cinematic GUI and Mandate language<br>( If language is not supported the language will be EN) | ||
| +urlOK | M | anyURI | 0 - 1 | Url for OK | ||
| +urlKO | M | anyURI | 0 - 1 | Url for KO | ||
| +urlCancel | M | anyURI | 0 - 1 | Url for Cancel | ||
| Response | Title | Mandatory or Optional? | Format | Cardinality | Comment | |
| +url | O | anyURI | 0 - 1 | Url of SPS-SIGN mandate update session that has been created | ||
| +Sts | M | TransactionStatusType | 1 | Status | ||
| +StsCd | O | String | 0 - 1 | Return code | ||
| 🛈 The webservice GetSessionStatus exists in REST. We recommend you to use the REST protocol | ||||||
| GetSessionStatus | Request | Title | Mandatory or Optional? | Format | Cardinality | Comment |
| +creditorId | M | String | 1 | Technical id provided by SPS-SIGNATURE | ||
| +TransactionId | M | String | 1 | Id of the transaction. This id is transmitted through the initSession method to distinguish the session | ||
| Response | Title | Mandatory or Optional? | Format | Cardinality | Comment | |
| +Sts | M | GenericResponseType | 1 | Status of the transaction. ACCT (accepted) / RJCT (rejected). | ||
| +StsCd | M | 1 | Status codes of the session / AUTH\_FAILED (authentication failed) / CONFIG\_ERROR (configuration error) / INTERNAL\_ERROR (internal error) | |||
| +StsInf | M | 1 | Description of the status of the session / Description of the error generated. | |||
| 🛈 The webservice CancelSession exists in REST. We recommend you to use the REST protocol | ||||||
| CancelSession | Request | Title | Mandatory or Optional? | Format | Cardinality | Comment |
| +creditorId | M | String | 1 | Technical id provided by SPS-SIGNATURE | ||
| +TransactionId | M | String | 1 | Id of the transaction. This id is sent through the initSession method to distinguish the session. | ||
| Response | Title | Mandatory or Optional? | Format | Cardinality | Comment | |
| +Sts | M | GenericResponseType | 1 | Status of the transaction. ACCT (accepted) / RJCT (rejected). | ||
| +StsCd | M | 1 | Status codes of the session / AUTH\_FAILED (authentication failed) / CONFIG\_ERROR (configuration error) / INTERNAL\_ERROR (internal error) | |||
| +StsInf | M | 1 | Description of the status of the session / Description of the error generated. | |||