search_mandate
GET - Search mandates
| Search parameter | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| status | Mandate statut | Char - 2 | 1 : Active 2 : Suspended 3 : Revoqued | NO |
| sequence_type | Mandate sending sequence | String - 4 | Possible values : "OOFF" "RCUR" | NO |
| umr | Unique mandate reference | String - 35 | NO | |
| sign_date | Signature date | String - 10 | DD/MM/YYYY | NO |
| sign_date_min | Minimum signature date | String - 10 | DD/MM/YYYY | NO |
| sign_date_max | Maximum signature date | String - 10 | DD/MM/YYYY | NO |
| sign_city | Signature date | String - 35 | NO | |
| consumer_reference | Consumer reference | String - 32 | NO | |
| safedebit_consumer_reference | Safedebit consumer reference | String - 35 | NO | |
| consumer_first_name | Consumer first name | String - 70 | NO | |
| consumer_last_name | Consumer last name | String - 70 | NO | |
| consumer_address_street_number | Consumer address: number | String - 16 | NO | |
| consumer_address_street_type | Consumer address: road type | String - 16 | NO | |
| consumer_address_street_name | Consumer address: road name | String - 70 | NO | |
| consumer_zip_code | Zip code | String - 16 | NO | |
| consumer_city | Town/place | String - 35 | NO | |
| consumer_country | Country | String - 35 | NO | |
| consumer_email | Consumer e-mail | String - 70 | NO | |
| consumer_phone_number | Consumer phone | String - 16 | NO | |
| iban | Consumer's IBAN bank account | String - 34 | NO |
Request
GET /xxxx/search_mandate?safedebit_consumer_reference=XXXXX HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
If mandate data was successfully fetched
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"datas": [
{
"umr": "XXXXX_01",
"iban": "FR76-3006-6100-4100-0105-7380-116",
"sequence_type": "RCUR",
"status": "5",
"sign_date": null,
"sign_city": null,
"consumer_reference": "123456",
"safedebit_consumer_reference": "1624957285892343",
"consumer_first_name": "claude",
"consumer_last_name": "famille",
"consumer_address_street_number": "4",
"consumer_address_street_type": "avenue",
"consumer_address_street_name": "voie",
"consumer_zip_code": "69001",
"consumer_city": "Paris",
"consumer_country": "FR",
"consumer_email": "email@test.com",
"consumer_phone_number": "+33699320216",
"consumer_data": "null",
"url": "https://XXXXX.com/XXXX"
}
]
}
If mandate 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_mandate? HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Accept: application/json