create_mandate
POST - Creation and signature of a mandate
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| safedebit_consumer_reference | Safedebit consumer reference | String - 35 | YES | |
| url_ok | Destination URL where the customer will be routed after signature | String - 256 | https:// | YES |
| url_ko | Destination URL where the customer will be routed if error occurs | String - 256 | https:// | YES |
| url_cancel | Destination URL where the customer will be routed when cancelling signature | String - 256 | https:// | YES |
| umr | Unique mandate reference | String - 35 | NO | |
| sign_option | Mandate signature options | String - 8 | Possible values : "SMS" "EMAIL" | NO |
| sequence_type | Mandate sending sequence | String - 4 | Possible values : "OOFF" "RCUR" | NO |
| status | Mandate statut | String - 2 | Example : 6 (Waiting for activation) | NO |
UMR data returned to url_ok, IBAN and BIC placed in POST.
If integrator wants more trace information, put information in GET of url_ok, url_ko or url_cancel.
- sign_option : the default signature option is SMS.
- sequence_type : OOFF = single-use mandate / RCUR = recurring levy
- status : initial status defined for the mandate after signing (See status list : here )
Request
POST /xxxx/create_mandate HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"safedebit_consumer_reference": "XXXXXXXXXXXXX",
"url_ok": "https://xxxxx.xxx/ok",
"url_ko": "https://xxxxx.xxx/ko",
"url_cancel": "https://xxxxx.xxx/cancel"}
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"signature_url" : "https://xxxxxxxxx",
"umr" : "XXXXXXXXXXXXX",
"status" : "1"
}
b) If signature initialization has 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 |
| signature_url | Link to signature |
| umr | Unique mandate reference |
| status | Mandate statut |
| code | See (error codes in annex). |
Request
HTTP/1.1 200 OK
POST /ssp/create_mandate HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json