search_sct
GET - Search for a SCT
| Search parameter | Description | Type - Length | Example |
|---|---|---|---|
| safedebit_consumer_reference | Safedebit consumer reference | String - 35 | |
| consumer_store | Safedebit store reference | String - 32 | |
| umr | Unique mandate reference | String - 35 | |
| sct_reference | field.sct_reference.label is missing | String - 35 | |
| 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 | |
| due_date | Direct debit due date | String - 10 | DD/MM/YYYY |
| due_date_min | Minimum date for levy | String - 10 | DD/MM/YYYY |
| due_date_max | Maximum date for levy | String - 10 | DD/MM/YYYY |
| safedebit_secure_reference | Safedebit guarantee reference | String - 10 | DD/MM/YYYY |
| sct_status | Transfer status | String - 10 | See table in annex |
Request
GET /xxxx/search_sct?safedebit_consumer_reference=XXXXX HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
If levy data successfully fetched
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": true,
"datas": [
{
"sct_reference": "REF_XXX1",
"amount": "3.33",
"due_date": "01/01/2018",
"safedebit_secure_reference": "SF_22345",
"sct_status": "GUARANTEED",
"reject_reason": null,
"reject_date": null,
"payment_reference": "XXXXX1",
"safedebit_consumer_reference":"XXXXXXXXX1",
"consumer_store": null
},
{
"sct_reference": "REF_XXX1",
"amount": "3.33",
"due_date": "01/01/2018",
"safedebit_secure_reference": "SF_22345",
"sct_status": "REJECTED",
"reject_reason": "AM04",
"reject_date": "01/02/2018",
"payment_reference": "XXXXX2",
"safedebit_consumer_reference":"XXXXXXXXX2",
"consumer_store": null
}
]
}
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_sct? HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Accept: application/json