secure
POST - Guarantee a levy
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| safedebit_consumer_reference | Safedebit consumer reference | String - 35 | XXXXX | YES |
| amount | Guaranteed amount in cents | String - 18 | 10000 | YES |
| type | Type of securisation | Char - 1 | See table in annex | YES |
| echeance_number | Number of levy deadlines | String - 2 | YES | |
| sdd | SDD list | Json | YES * | |
| umr | Unique mandate reference | String - 35 | YES | |
| ics | Beneficary's SEPA | String - 35 | YES ** | |
| due_date | Levy first date | String - 10 | DD/MM/YYYY | YES *** |
** Possibly mandatory, contract-dependant
*** Mandatory only for recurring levy (type = 0) and deferred levy (type = 5)
Request
POST /xxxx/secure HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"safedebit_consumer_reference": "XXXXXXX",
"amount": "1000",
"echeance_number": "2",
"type": "2",
"sdd": [
"refSdd1",
"refSdd2"
],
"umr": "UMR_XXXXX"}
If guarantee allowed
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"safedebit_secure_reference": "SF_XXXX"
}
If guarantee refused
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : false,
"code" : "NOK_001"
}
| Argument | Description |
|---|---|
| result | true or false : true : action succeeded false : action failed |
| safedebit_secure_reference | Safedebit guarantee reference |
| code | See (error codes in annex). |
Request
HTTP/1.1 200 OK
POST /ssp/secure HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json