initiate_signature
POST - Signature d'un mandat électronique
| Argument | Description | Type - Taille | Exemple | Obligatoire |
|---|---|---|---|---|
| safedebit_consumer_reference | Référence Safedebit du consommateur | String - 35 | XXXXX | NON |
| consumer_reference | Référence commerçant du consommateur | String - 64 | XXXXXX | OUI |
| consumer_type | Type du consommateur | Integer - 1 | 0: Particulier - 1: Société - 2: Association | OUI |
| consumer_ip_address | Adresse IP du consommateur | String - 32 | OUI | |
| consumer_store | Référence boutique Safedebit | String - 32 | OUI * | |
| consumer_address_street_number | Adresse du consommateur : numéro sur la voie | String - 16 | OUI | |
| consumer_address_street_type | Adresse du consommateur : type de voie | String - 16 | NON | |
| consumer_address_street_name | Adresse du consommateur : nom de la voie | String - 70 | OUI | |
| consumer_zip_code | Code postal | String - 16 | OUI | |
| consumer_city | Ville | String - 35 | OUI | |
| consumer_country | Pays | String - 32 | OUI | |
| consumer_birth_date | Date de naissance | String - 10 | DD/MM/YYYY | NON |
| consumer_birth_city | Ville de naissance | String - 32 | NON | |
| consumer_nationality | Nationalité du consommateur | String - 2 | NON | |
| consumer_gender | Genre du consommateur | Char - 1 | NON | |
| consumer_email | Email du consommateur | String - 64 | OUI *** | |
| otu_email | Support email | Boolean - 1 | OUI ** | |
| consumer_phone_number | Téléphone du consommateur | String - 16 | OUI *** | |
| otu_sms | Support sms | Boolean - 1 | OUI ** | |
| consumer_iban | IBAN du compte bancaire du consommateur | String | OUI | |
| force_ais | Force AIS | Integer - 1 | NON | |
| umr | Identifiant unique du mandat | String - 35 | NON | |
| url_callback_status | Url de rappel | String - 35 | NON | |
| beneficiary_reference | Référence unique du bénéficiaire | String - 32 | NON | |
Particulier (consumer_type = 0)
| Argument | Description | Type - Taille | Exemple | Obligatoire |
|---|---|---|---|---|
| consumer_last_name | Nom du consommateur | String - 64 | OUI | |
| consumer_first_name | Prénom du consommateur | String - 64 | OUI | |
Société (consumer_type = 1)
| Argument | Description | Type - Taille | Exemple | Obligatoire |
|---|---|---|---|---|
| social_reference | Raison sociale | String - 32 | OUI | |
| siren | SIREN de la société | String - 9 | OUI | |
| nic | NIC de la société | String - 5 | NON | |
| tva_interco | TVA inter communautaire de la société | String - 32 | NON | |
Association (consumer_type = 2)
| Argument | Description | Type - Taille | Exemple | Obligatoire |
|---|---|---|---|---|
| social_reference | Raison sociale | String - 32 | OUI | |
| waldec | Numéro national unique de l'association | String - 10 | OUI | |
| siren | SIREN de la société | String - 9 | NON | |
| nic | NIC de la société | String - 5 | NON | |
| tva_interco | TVA inter communautaire de la société | String - 32 | NON | |
* Si le marchand possède plusieurs boutique la référence de la boutique qui sera associé au mandat sera obligatoire
** Afin de pouvoir signer le mandat l'OTU sms ou email seront obligatoire
*** Si le code de validation du mandat doit étre envoyé via email , l'email du client sera obligatoire
** Afin de pouvoir signer le mandat l'OTU sms ou email seront obligatoire
*** Si le code de validation du mandat doit étre envoyé via email , l'email du client sera obligatoire
Requête
POST /xxxx/add_mandate HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"consumer_iban": "FRXXXXXX",
"consumer_reference": "XXXX",
"consumer_store": "XXXXXXX",
"social_reference": "XXXXXX",
"consumer_last_name": "TestLastName",
"consumer_first_name": "TestFirstName",
"consumer_address_street_number": "41",
"consumer_type": "1",
"consumer_address_street_type": "avenue",
"consumer_address_street_name": "xxxxx",
"consumer_zip_code": "92700",
"consumer_city": "colombes",
"consumer_country": "France",
"umr": "UMR_XXXXXX",
"otu_email": "XXX",
"consumer_email": "XXX.XXXXX@XXXX.com",
"consumer_phone_number": "0652377054",
"consumer_gender": "M",
"consumer_birth_city": "Paris",
"consumer_ip_address": "192.128.1.1",
"nic": "145",
"siren": "95236"}
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": true,
"safedebit_consumer_reference": "xxxxxxxxxxxxxxxxxxxxxx",
"mandate_umr": "xxxxxxxxxxxxxxxxxxxxxxx"
}
Si la création du mandat a échoué
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": false,
"code": "xxxxx",
"message": "xxxxxxxxxxxxxxxxxxxx"
}
| Argument | Description |
|---|---|
| result | true ou false : true : action réalisée avec succès false : action échouée |
| code | Voir codes d'erreur en annexe. |