SSP-API

creation_mandat

POST -- Génération d'un formulaire de création d'un nouveau patient et mise en place d’un mandat SEPA.

Description

Argument	Description	Type - Taille	Exemple	Obligatoire
patient_type	Type du patient	String - 1	0: Particulier 1: Société 2: Association	NON
id_patient	Référence commerçant du patient 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.	String - 64		OUI
reference_regie	Référence unique de la régie de l’établissement de santé	String - 32		OUI
reference_etablissement	Référence unique de l'établissement de santé de santé	String - 32		OUI
patient_prenom	Prénom du patient	String - 70		OUI
patient_nom	Nom du patient	String - 70		OUI
patient_adresse_numero_voie	Adresse du patient : numéro sur la voie	String - 16		OUI
patient_adresse_type_voie	Adresse du patient : type de voie	String - 16		OUI
patient_adresse_voie_nom	Adresse du patient : nom de la voie	String - 70		OUI
patient_code_postal	Code postal	String - 16		OUI
patient_ville	Ville	String - 35		OUI
patient_pays	Pays	String - 35		OUI
patient_email	Email du patient	String - 70		OUI
patient_numero_mobile	Téléphone du patient	String - 16		OUI
sms_option	Option d'envoi du formulaire par sms	String - 1		OUI
email_option	Option d'envoi du formulaire par email	String - 1		OUI
url_ok	URL de confirmation (retour manuel)	String - 256	https://	OUI
url_ko	URL d'erreur (retour manuel)	String - 256	https://	OUI
url_cancel	URL d'annulation (retour manuel)	String - 256	https://	OUI
url_rappel	URL des retours automatiques	String - 256	https://	OUI
patient_data	field.consumer_data.label is missing	String - 145		OUI
patient_genre	Genre du patient	Char- 1	M : masculin F : féminin	NON
patient_autre_nom	Autres prénoms	String - 70		NON
type_piece_identite	Type de la pièce d'identité	Char - 1	1 : CNI 2 : permis 3 : passeport 4 : carte résident 5 : carte de séjour 6 : Autres pièces 7 : Titre de séjour	NON
numero_id	Numéro de la pièce d'identité	String - 18		NON
date_emission	Date d'émission de la pièce	String - 10	DD/MM/YYYY	NON
date_expiration	Date d'expiration de la pièce	String - 10	DD/MM/YYYY	NON
patient_date_naissance	Date de naissance	String - 10	DD/MM/YYYY	NON
patient_ville_naissance	Ville de naissance	String - 35		NON
patient_nationalite	Nationalité du patient	String - 3	FR,ES,IT...	NON
patient_complement_adresse	Complément d'adresse	String - 70		NON
patient_ip	Adresse IP du patient	String - 16		NON
iban	IBAN du compte bancaire du patient	String - 34		NON
type_sequence	Séquence d'utilisation du mandat	String - 4	Valeurs possibles : "OOFF" "RCUR"	NON

Société (consumer_type = 1)

Argument	Description	Type - Taille	Obligatoire
raison_sociale	Raison sociale	String - 32	NON
siren	SIREN de la société	String - 9	OUI
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

Association (consumer_type = 2)

Argument	Description	Type - Taille	Obligatoire
raison_sociale	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

Paramètres des retours manuels et automatiques

Argument	Description	Type - Taille	Exemple ou précision
safedebit_reference_patient	Référence Safedebit du patient	String - 35	Référence unique par patient générée par SSP et à stocker par l’éditeur pour faire le lettrage avec la référence id_patient
rum	Identifiant unique du mandat	String - 35
statut	Statut du mandat	String - 10	"OK" ,"CANCEL", "ERROR"

- consumer_store : Requis si le marchand possède plusieurs boutiques
- umr : caractères autorisés : lettres de A-Z (majuscules recommandées), chiffres de 0-9, / - ? : ( ) . , ' + (à éviter si possible)
- sequence_type : OOFF = mandat utilisé pour un seul prélèvement / RCUR = prélèvement réccurent
- status : statut initial qui sera défini pour le mandat après la signature (Voir liste des status : ici )

Requête

POST /xxxx/creation_mandat HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json


{
"id_patient": "XXXXX",
"reference_regie": "XXXXX",
"reference_etablissement": "XXXXX",
"patient_prenom": "Jean",
"patient_nom": "Dupont",
"patient_date_naissance": "21/01/2001",
"patient_adresse_numero_voie": "98",
"patient_adresse_type_voie": "Route",
"patient_adresse_voie_nom": "Avenue des pissenlits",
"patient_code_postal": "75008",
"patient_ville": "Paris",
"patient_pays": "France",
"patient_email": "xxx@xxx.com",
"patient_numero_mobile": "0600000000",
"email_option": "1",
"sms_option": "1",
"url_ok": "https://xxxxx.xxx/ok",
"url_ko": "https://xxxxx.xxx/ko",
"url_cancel": "https://xxxxx.xxx/cancel",
"patient_data": "7-006379-0023-0_066846419"}

Si le formulaire a été généré avec succès

Réponse

HTTP/1.1 200 OK
Content-Type: application/json


{
    "result" : true,
    "lien" : "https://xxxxxxxxxxxxx",
    "safedebit_reference_patient" : "XXXXXXXXXXXX"
}

Si la génération du formulaire 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
lien	Lien de formulaire de création de patient
safedebit_reference_patient	Voir codes d'erreur en annexe.

Type du consommateur *

Référence commerçant du consommateur

Genre du consommateur

Prénom

Nom

Autres prénoms

Date de naissance

Ville de naissance

Nationalité du consommateur

Numéro de voie

Type de voie

Nom de la voie

Complément d'adresse

Code postal

Ville

Pays

Email du consommateur * Adresse email non valide

Téléphone du consommateur *

Adresse IP du consommateur

Type de la pièce d'identité

Numéro de la pièce

Date d'émission

Date d'expiration de la pièce

IBAN

Raison sociale *

SIREN de la société *

NIC de la société

NAF de la société

TVA inter communautaire de la société

Numéro national unique de l'association *

Envoi du formulaire par email *

Envoi du formulaire par sms *

Séquence d'utilisation du mandat

URL redirigé en fin de signature

URL redirigé en cas d'erreur interne Safedebit

URL redirigé en cas d'annulation de signature

URL des retours automatiques

Référence Safedebit du consommateur

Identifiant unique du mandat

Statut du mandat

Merci de remplir tous les champs obligatoires

Requête

HTTP/1.1 200 OK
POST /ssp/creation_mandat HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json

API Documentation

creation_mandat

POST -- Génération d'un formulaire de création d'un nouveau patient et mise en place d’un mandat SEPA.

Société (consumer_type = 1)

Association (consumer_type = 2)

Paramètres des retours manuels et automatiques

Requête

Réponse

Réponse

Requête