SSP-API

initiate_ais

POST - Signature d'un mandat électronique

Description

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		NON
consumer_phone_number	Téléphone du consommateur	String - 16		NON
bank_id	Id de la banque	String - 26		OUI
umr	Identifiant unique du mandat	String - 35		NON
url_callback_status	Url de rappel	String - 35		OUI **
url_callback_success	Url success de rappel	String - 35		OUI **
url_callback_failed	Url failed de rappel	String - 35		OUI **
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	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	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 faire le callback 'url callback status' ou le couple 'url callback success et url callback failed' seront obligatoire.
Si vous souhaitez que le retour se fasse en Json de façon asynchrone, il faut opter pour l'url_callback_status, sinon pour les URL de succes et d'erreur. Auquel cas, vous serez redirigé directement.

Requête

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


{
"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",
"url_callback_status": "https://callback.com",
"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",
"bank_id": "XXXXXXXXXXXXXXXXXXXXXXXXXX"}

Si le mandat a été créé avec succès avec un statut 'en attente de signature' et l'url de connexion pour la bank est généré

Réponse

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


{
    "result": true,
    "safedebit_consumer_reference": "xxxxxxxxxxxxxxxxxxxxxx",
    "mandate_umr": "xxxxxxxxxxxxxxxxxxxxxxx",
    "url_connection_bank": "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.

API Documentation

initiate_ais

POST - Signature d'un mandat électronique

Particulier (consumer_type = 0)

Société (consumer_type = 1)

Association (consumer_type = 2)

Requête

Réponse

Réponse