edit_mandate
POST -- Modify a mandate
| Search argument | Description | Max size | Example | Mandatory |
|---|---|---|---|---|
| umr | Unique mandate reference | String - 35 | YES |
| Parameter to modify | Description | Max size | Example | Mandatory |
|---|---|---|---|---|
| status | Mandate statut | String - 2 | 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_address_complement | Consumer address: additional information | 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
POST /xxxx/edit_mandate HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"umr": "REF_XXX",
"status": "1",
"consumer_last_name": "famille",
"consumer_first_name": "claude",
"consumer_address_street_number": "7",
"consumer_address_street_type": "rue",
"consumer_address_street_name": "laurent vibert",
"consumer_address_complement": "5ème étage",
"consumer_zip_code": "69006",
"consumer_city": "Lyon",
"consumer_country": "FR",
"consumer_email": "newemail@xxx.com",
"consumer_phone_number": "0600000000",
"iban": "FRXXXXXXXXX"}
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true
}
If modification 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 |
| code | See (error codes in annex). |
Request
HTTP/1.1 200 OK
POST /ssp/edit_mandate HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json