recherche_mandat
GET - Chercher des mandats
Pour effectuer la recherche d’un mandat, 3 arguments de recherche sont possibles. Il faut choisir un de ses arguments en fonction du cas d’usage.
| Argument de recherche | Description | Taille max | Exemple | Obligatoire |
|---|---|---|---|---|
| safedebit_reference_patient ou |
Référence Safedebit du consommateur (référence unique par patient générée par SSP et retournée à l’éditeur suite à la création du mandat) | String - 35 | OUI | |
| id_patient ou |
Référence commerçant du consommateur que l’éditeur doit transmettre. Etant donné qu’un même identifiant patient peut être utilisé par 2 éditeurs différents, chaque éditeur doit ajouter un incrément à ses identifiants patient afin d’éviter un blocage lié au contrôle des doublons effectué par SSP. | OUI | ||
| rum | OUI |
| Paramètre de recherche | Description | Type - Taille | Exemple | Obligatoire |
|---|---|---|---|---|
| statut | Statut du mandat | Char - 2 | 1 : Active 2 : Suspendu 3 : Révoqué | NON |
| type_sequence | Séquence d'utilisation du mandat | String - 4 | Valeurs possibles : "OOFF" "RCUR" | NON |
| rum | Identifiant unique du mandat | String - 35 | NON | |
| sign_date | Date de signature | String - 10 | DD/MM/YYYY | NON |
| sign_date_min | Date de signature minimum | String - 10 | DD/MM/YYYY | NON |
| sign_date_max | Date de signature maximum | String - 10 | DD/MM/YYYY | NON |
| sign_ville | Date de signature | String - 35 | NON | |
| id_patient | Référence commerçant du patient | String - 32 | NON | |
| safedebit_reference_patient | Référence Safedebit du patient | String - 35 | NON | |
| patient_prenom | Prénom du patient | String - 70 | NON | |
| patient_nom | Nom du patient | String - 70 | NON | |
| patient_adresse_numero_voie | Adresse du patient : numéro sur la voie | String - 16 | NON | |
| patient_adresse_type_voie | Adresse du patient : type de voie | String - 16 | NON | |
| patient_adresse_voie_nom | Adresse du patient : nom de la voie | String - 70 | NON | |
| patient_code_postal | Code postal | String - 16 | NON | |
| patient_ville | Ville | String - 35 | NON | |
| patient_pays | Pays | String - 35 | NON | |
| patient_email | Email du patient | String - 70 | NON | |
| patient_numero_mobile | Téléphone du patient | String - 16 | NON | |
| iban | IBAN du compte bancaire du patient | String - 34 | NON |
Requête
GET /xxxx/recherche_mandat?safedebit_reference_patient=XXXXX HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
Si les données des mandats ont été récupérées avec succès
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"datas": [
{
"rum": "XXXXX_01",
"iban": "FR76-3006-6100-4100-0105-7380-116",
"type_sequence": "RCUR",
"statut": "5",
"sign_date": null,
"sign_ville": null,
"id_patient": "123456",
"safedebit_reference_patient": "1624957285892343",
"patient_prenom": "claude",
"patient_nom": "famille",
"patient_adresse_numero_voie": "4",
"patient_adresse_type_voie": "avenue",
"patient_adresse_voie_nom": "voie",
"patient_code_postal": "69001",
"patient_ville": "Paris",
"patient_pays": "FR",
"patient_email": "email@test.com",
"patient_numero_mobile": "+33699320216",
"patient_data": "null",
"url": "https://XXXXX.com/XXXX"
}
]
}
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/recherche_mandat? HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Accept: application/json