search_deposit
GET - Search for deposit (no collecting)
| Search parameter | Description | Type - Length |
|---|---|---|
| deposit_reference | Deposit reference | String - 35 |
| deposit_date_min | Deposit minimum date | String - 10 |
| deposit_date_max | Deposit maximum date | String - 10 |
Request
GET /xxxx/search_deposit?deposit_reference=remisexxx HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
If deposit data was successfully fetched
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": true,
"datas": [
{
"deposit_reference": "FRXXXXX-0001",
"amount": "333",
"deposit_date": "02/01/2020"
},
{
"deposit_reference": "FRXXXXX-0002",
"amount": "444",
"deposit_date": "04/01/2020"
}
]
}
If deposit 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 |
| deposit_reference | Deposit reference |
| amount | Discount total amount |
| deposit_date | Date of deposit |
| code | See (error codes in annex). |
Request
GET /ssp/search_deposit?safedebit_consumer_reference=HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Accept: application/json