create_mandate
POST - Création et signature d'un mandat
| Argument | Description | Type - Taille | Exemple | Obligatoire |
|---|---|---|---|---|
| safedebit_consumer_reference | Référence Safedebit du consommateur | String - 35 | OUI | |
| url_ok | URL vers laquelle le consommateur sera redirigé en fin de signature | String - 256 | https:// | OUI |
| url_ko | URL vers laquelle le consommateur sera redirigé en cas d'erreur interne Safedebit | String - 256 | https:// | OUI |
| url_cancel | URL vers laquelle le consommateur sera redirigé en cas d'annulation de signature | String - 256 | https:// | OUI |
| umr | Identifiant unique du mandat | String - 35 | NON | |
| sign_option | Option de signature du mandat | String - 8 | Valeurs possibles : "SMS" "EMAIL" | NON |
| sequence_type | Séquence d'utilisation du mandat | String - 4 | Valeurs possibles : "OOFF" "RCUR" | NON |
| status | Statut du mandat | String - 2 | Exemple : 6 (En attente d'activation) | NON |
En retour vers url_ok les données UMR, IBAN et BIC seront placées en POST.
Si l'intégrateur souhaite tracer plus d'informations, alors il passe ces informations dans le GET de url_ok, url_ko ou url_cancel.
- sign_option : l'option de signature par défaut est le SMS.
- 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/create_mandate HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"safedebit_consumer_reference": "XXXXXXXXXXXXX",
"url_ok": "https://xxxxx.xxx/ok",
"url_ko": "https://xxxxx.xxx/ko",
"url_cancel": "https://xxxxx.xxx/cancel"}
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"signature_url" : "https://xxxxxxxxx",
"umr" : "XXXXXXXXXXXXX",
"status" : "1"
}
b) Si l'initialisation de la signature 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 |
| signature_url | Lien de la signature |
| umr | Identifiant unique du mandat |
| status | Statut du mandat |
| code | Voir codes d'erreur en annexe. |
Requête
HTTP/1.1 200 OK
POST /ssp/create_mandate HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json