initiate_transfer
POST - Initialisation d'un paiement par virement
| Argument | Description | Type - Taille | Exemple | Obligatoire |
|---|---|---|---|---|
| safedebit_consumer_reference | Référence Safedebit du consommateur | String - 35 | OUI * | |
| consumer_reference | Référence commerçant du consommateur | String - 35 | NON *** | |
| payment_reference | Référence du paiement/commande | String - 64 | OUI | |
| sms_option | Option d'envoi du lien de paiement par sms | Char - 1 | NON | |
| email_option | Option d'envoi du lien de paiement par email | Char - 1 | NON | |
| url_ko | URL d'erreur | String - 128 | https:// | NON |
| url_cancel | URL d'annulation | String - 128 | https:// | NON |
| code_bank | Code de la banque | String - 8 | NON | |
| consumer_first_name | Prénom du consommateur | String - 70 | OUI * | |
| consumer_last_name | Nom du consommateur | String - 70 | OUI * | |
| consumer_phone_number | Téléphone du consommateur | String - 16 | NON | |
| consumer_email | Email du consommateur | String - 70 | NON | |
| amount | Montant total en centimes | String - 18 | OUI | |
| url_ok | URL de confirmation | String - 128 | https:// | OUI ** |
| url_callback | URL de notification | String - 128 | https:// | OUI ** |
- MABANQUE : banque de test.
- SOGEFRPP : Société Générale.
- AGRIFRPP : Crédit Agricole.
- CMCIFRPP : Crédit Mutuel.
- BOUSFRPP : Boursourama.
- BNPAFRPP : BNP Paribas.
- ALL : toutes les banques.
** Une url de confirmation est nécessaire (url_ok : retour manuel ou url_callback : retour automatique).
*** Si le consumer_reference est renseigné et qu'il correspond à un consumer existant, l'initialisation du paiement sera annulée.
Les informations du consommateur nécessaires sont donc : safedebit_consumer_reference ou (consumer_first_name + consumer_last_name + code_bank)
Requête
POST /xxxx/initiate_transfer HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"safedebit_reference_consommateur": "XXXXXX",
"consumer_reference": "XXXXXX",
"amount": "1000",
"payment_reference": "Commande 12345",
"sms_option": "1",
"email_option": "1",
"url_ok": "https://.......",
"url_ko": "https://.......",
"url_cancel": "https://.......",
"url_callback": "https://.......",
"consumer_last_name": "Dupont",
"consumer_first_name": "Jean",
"consumer_phone_number": "0615985048",
"consumer_email": "jean.dupont@gmail.com"}
Si le lien de paiement par virement a été généré avec succès
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"link" : "https://xxxxx"
}
Si la génération du lien de paiement par virement 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 paiement par virement |
| code | Voir codes d'erreur en annexe. |
Callback
Après la validation du paiement par virement une notification est envoyée vers l'url : url_callback aves les paramètres suivants| Argument | Description |
|---|---|
| payment_reference | Référence du paiement/commande |
| payment_status | VALIDATED,CANCELED,ERROR |
| amount | Montant total en centimes |
| validation_date | Date de validation |
| safedebit_consumer_reference | Référence Safedebit du consommateur |
Requête
HTTP/1.1 200 OK
POST /ssp/initiate_transfer HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json