search_consumer
GET - Chercher des consommateurs
| Paramètre de recherche | Description | Type - Taille | Exemple | Obligatoire |
|---|---|---|---|---|
| safedebit_consumer_reference | Référence Safedebit du consommateur | String - 35 | NON | |
| consumer_reference | Référence commerçant du consommateur | String - 64 | OUI | |
| consumer_store | Référence boutique Safedebit | String - 32 | NON | |
| consumer_gender | Genre du consommateur | Char- 1 | M : masculin F : féminin | NON |
| consumer_first_name | Prénom du consommateur | String - 70 | NON | |
| consumer_use_name | Nom d'usage | String - 70 | NON | |
| consumer_pseudonyme | Pseudonyme | String - 70 | NON | |
| consumer_last_name | Nom du consommateur | String - 70 | NON | |
| consumer_other_last_name | Autres prénoms | String - 70 | NON | |
| identity_type | Type de la pièce d'identité | Char - 1 | 1 : CNI 2 : permis 3 : passeport 4 : carte résident 5 : carte de séjour | NON |
| id_number | Numéro de la pièce d'identité | String - 18 | NON | |
| emission_date | Date d'émission de la pièce | String - 10 | DD/MM/YYYY | NON |
| emission_date_min | Date d'émission minimum de la pièce | String - 10 | DD/MM/YYYY | NON |
| emission_date_max | Date d'émission maximum de la pièce | String - 10 | DD/MM/YYYY | NON |
| expire_date | Date d'expiration de la pièce | String - 10 | DD/MM/YYYY | NON |
| expire_date_min | Date d'expiration minimum de la pièce | String - 10 | DD/MM/YYYY | NON |
| expire_date_max | Date d'expiration maximum de la pièce | String - 10 | DD/MM/YYYY | NON |
| consumer_birth_day | Date de naissance | String - 10 | DD/MM/YYYY | NON |
| consumer_birth_day_min | Date de naissance minimum | String - 10 | DD/MM/YYYY | NON |
| consumer_birth_day_max | Date de naissance maximum | String - 10 | DD/MM/YYYY | NON |
| consumer_birth_city | Ville de naissance | String - 35 | NON | |
| nationality | Nationalité du consommateur | String - 3 | FR,ES,IT... | NON |
| consumer_address_street_number | Adresse du consommateur : numéro sur la voie | String - 16 | NON | |
| 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 | NON | |
| consumer_address_complement | Complément d'adresse | String - 70 | NON | |
| consumer_zip_code | Code postal | String - 16 | NON | |
| consumer_city | Ville | String - 35 | NON | |
| consumer_country | Pays | String - 35 | NON | |
| consumer_email | Email du consommateur | String - 70 | NON | |
| consumer_phone_number | Téléphone du consommateur | String - 16 | NON | |
| consumer_ip | Adresse IP du consommateur | String - 16 | NON | |
| iban | IBAN du compte bancaire du consommateur | String - 34 | NON | |
| consumer_type | Type du consommateur | String - 1 | 0: Particulier 1: Société 2: Association | NON |
| social_reference | Raison sociale | String - 32 | NON | |
| siren | SIREN de la société | String - 9 | NON | |
| nic | NIC de la société | String - 5 | NON | |
| naf | NAF de la société | String - 32 | NON | |
| tva_interco | TVA inter communautaire de la société | String - 32 | NON | |
| waldec | Numéro national unique de l'association | String - 16 | NON | |
| beneficiary_reference | Référence unique du bénéficiaire | String - 32 | NON |
Requête
GET /xxxx/search_consumer?consumer_reference=XXXXX HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
Si les données des consommateurs ont été récupérées avec succès
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": true,
"datas": [
{
"safedebit_consumer_reference": "XXXXXXXXXXXXXXX",
"consumer_reference": "XXXXXX",
"consumer_first_name": "Nom",
"consumer_last_name": "Prenom",
"consumer_use_name": null,
"consumer_pseudonyme": null,
"consumer_other_last_name": null,
"id_number": "92017410",
"emission_date": "01/01/2010",
"expire_date": "01/01/2020",
"consumer_birth_city": "Paris",
"consumer_birth_day": "01/01/1990",
"identity_type": "1",
"consumer_gender": "M",
"nationality": "FR",
"consumer_address_street_number": 1,
"consumer_address_street_type": "Rue",
"consumer_address_street_name": "du test",
"consumer_address_complement": "5ème étage",
"consumer_zip_code": "00000",
"consumer_city": "Ville",
"consumer_country": "FR",
"consumer_email": "test@test.com",
"consumer_phone_number": "0000000000",
"consumer_ip": "127.0.0.1",
"iban": "FR76-3006-6100-4100-0105-7380-116",
"bic": "PSSTFRPPLYO",
"social_reference": "Safedebit",
"siren": "123456789",
"nic": "001",
"naf": "3600Z",
"tva_interco": "FR31439800040",
"waldec": "W784000090",
"consumer_store": null,
"consumer_data": "null"
}
]
}
Si la récupération des données a échoué
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : false,
"code" : "XXXX"
}
| Argument | Description |
|---|---|
| result | true ou false : true : action réalisée avec succès false : action échouée |
| datas | Tableau Json des enregistrements répondant aux arguments de recherche |
| code | Voir codes d'erreur en annexe. |
Requête
GET /ssp/search_consumer? HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Accept: application/json