search_control
GET - Search for a levy
| Search parameter | Description | Type - Length | Example |
|---|---|---|---|
| amount | Levy amount in cents | String - 18 | |
| amount_min | Min levy amount in cents | String - 18 | |
| amount_max | Max levy amount in cents | String - 18 | |
| date | Guarantee date | String - 10 | DD/MM/YYYY |
| date_min | Minimum guarantee date | String - 10 | DD/MM/YYYY |
| date_max | Maximum Guarantee date | String - 10 | DD/MM/YYYY |
| iban | IBAN guarantee | String - 34 | |
| type | Guarantee type | Char - 1 | See table in annex |
| encours_type | Oustading details | Char - 1 | See table in annex |
| safedebit_secure_reference | Safedebit guarantee reference | String - 10 | |
Request
GET /xxxx/search_control?safedebit_secure_reference=XXXXX HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
If guarantee data was successfully fetched
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"datas" : [
{"iban":"FR75XXXXXXXXXXX","safedebit_secure_reference":"SF_XXX01"},
{"iban":"FR76XXXXXXXXXXXXX","safedebit_secure_reference": "SF_XXX02"}
]
}If data fetching 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 |
| datas | Json array of records responding to search arguments |
| code | See (error codes in annex). |
Request
GET /ssp/search_control? HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Accept: application/json