SSP-API

initiate_consumer

POST -- Génération d'un formulaire de création d'un nouveau consommateur. Pour la création de consommateur par API, cf. create_consumer

Description
SandBox

Argument	Description	Type - Taille	Exemple	Obligatoire
consumer_type	Type du consommateur	String - 1	0: Particulier 1: Société 2: Association	NON
consumer_reference	Référence commerçant du consommateur	String - 64		NON
consumer_store	Référence boutique Safedebit	String - 32	373222055	NON *
beneficiary_reference	Référence unique du bénéficiaire	String - 32	field.beneficiary_reference.example is missing	NON
consumer_first_name	Prénom du consommateur	String - 70		NON
consumer_last_name	Nom du consommateur	String - 70		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_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
sms_option	Option d'envoi du formulaire par sms	String - 1		NON
email_option	Option d'envoi du formulaire par email	String - 1		NON
url_ok	URL de confirmation (retour manuel)	String - 256	https://	NON
url_ko	URL d'erreur (retour manuel)	String - 256	https://	NON
url_cancel	URL d'annulation (retour manuel)	String - 256	https://	NON
url_callback	URL des retours automatiques	String - 256	https://	NON
consumer_data	field.consumer_data.label is missing	String - 145		OUI
consumer_gender	Genre du consommateur	Char- 1	M : masculin F : féminin	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 6 : Autres pièces 7 : Titre 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
expire_date	Date d'expiration de la pièce	String - 10	DD/MM/YYYY	NON
consumer_birth_day	Date de naissance	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_complement	Complément d'adresse	String - 70		NON
consumer_ip	Adresse IP du consommateur	String - 16		NON
iban	IBAN du compte bancaire du consommateur	String - 34		NON
sequence_type	Séquence d'utilisation du mandat	String - 4	Valeurs possibles : "OOFF" "RCUR"	NON

Société (consumer_type = 1)

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

Paramètres des retours manuels et automatiques

Argument	Description	Type - Taille	Exemple
safedebit_consumer_reference	Référence Safedebit du consommateur	String - 35
umr	Identifiant unique du mandat	String - 35
status	Statut du mandat	String - 10	"OK" ,"CANCEL", "ERROR"

Le seul paramètre obligatoire est soit le numéro de téléphone soit l'email, la réponse est un lien qui sera aussi transmis par sms ou email au client en fonction de l'option (email_option ou/et sms_option)

- 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/initiate_consumer HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json


{
"consumer_reference": "XXXXX",
"consumer_store": "XXXXX",
"beneficiary_reference": "XXXXX",
"consumer_first_name": "Jean",
"consumer_last_name": "Dupont",
"consumer_birth_day": "21/01/2001",
"consumer_address_street_number": "98",
"consumer_address_street_type": "Route",
"consumer_address_street_name": "Avenue des pissenlits",
"consumer_zip_code": "75008",
"consumer_city": "Paris",
"consumer_country": "France",
"consumer_email": "xxx@xxx.com",
"consumer_phone_number": "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",
"consumer_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,
    "link" : "https://xxxxxxxxxxxxx",
    "safedebit_consumer_reference" : "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
link	Lien de formulaire de création de consommateur
safedebit_consumer_reference	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/initiate_consumer HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json

API Documentation

initiate_consumer

POST -- Génération d'un formulaire de création d'un nouveau consommateur. Pour la création de consommateur par API, cf. create_consumer

Société (consumer_type = 1)

Association (consumer_type = 2)

Paramètres des retours manuels et automatiques

Requête

Réponse

Réponse

Requête