add_mandate
POST - Adding an already signed mandate
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| safedebit_consumer_reference | Safedebit consumer reference | String - 35 | XXXXX | YES |
| sign_date | Mandate signature date | String - 10 | DD/MM/YYYY | NO** |
| sign_city | Town/place of mandate signature | String - 35 | Paris | NO** |
| umr | Unique mandate reference | String - 35 | YES | |
| ics | Beneficary's SEPA | String - 35 | YES * | |
| file_data | Mandate file in base64 format | base64Binary | YES | |
** If parameter 'sign_date' is filled, the mandate is considered 'signed' otherwise it will be considered as 'waiting for signature'.
** If 'sign_date' is filled, the parameter 'sign_city' is mandatory
Request
POST /xxxx/add_mandate HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"safedebit_consumer_reference": "XXXXXXXX",
"sign_date": "01/01/1990",
"sign_city": "Test",
"umr": "UMR_XXXX",
"ics": "FRXXXX",
"file_data": "ZGF0YTphcHBsaWNhdGlvbi9wZGY7F...."}
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true
}
If mandate creation failed
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : false,
"code" : "XXXX"
}
| Argument | Description |
|---|---|
| result | true or false : true : action succeeded false : action failed |
| code | See (error codes in annex). |
Request
HTTP/1.1 200 OK
POST /ssp/add_mandate HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json