Upload
others
View
6
Download
0
Embed Size (px)
Citation preview
Ajouter le bouton de paiement SEPA DirectDebit - Prélèvement Ponctuel (One Off)
Guide d'implémentation
Version du document 2.17
Sommaire
1. HISTORIQUE DU DOCUMENT........................................................................................................ 4
2. OBTENIR DE L'AIDE......................................................................................................................... 7Consulter la documentation................................................................................................................................ 7Contacter l'assistance.......................................................................................................................................... 7
3. SEPA : PAYER PAR PRÉLÈVEMENT............................................................................................. 83.1. Identifier les informations obligatoires sur le mandat................................................................................ 83.2. Distinguer les mandats en fonction du type de prélèvement...................................................................... 93.3. Identifier les délais encadrant l'émission d'un prélèvement SEPA........................................................... 10
Complément d’informations dans le cadre d’un prélèvement SEPA...................................................103.4. Visualiser la cinématique du prélèvement SEPA..................................................................................... 153.5. Identifier le canal de transmission des ordres de prélèvement SEPA à la banque....................................163.6. Gérer les impayés......................................................................................................................................16
Mettre en place le flux d'impayés........................................................................................................ 16Visualiser les impayés dans le Back Office Marchand........................................................................16Tableau des motifs d'impayés.............................................................................................................. 17Réémettre une demande de prélèvement..............................................................................................19
4. SE CONNECTER AU BACK OFFICE MARCHAND..................................................................... 20
5. PRÉSENTATION DU MOYEN DE PAIEMENT........................................................................... 215.1. Prérequis.................................................................................................................................................... 215.2. Stocker et archiver les mandats signés..................................................................................................... 215.3. Visualiser le déroulement d'un prélèvement unique sur la page de paiement.......................................... 235.4. Visualiser les transactions SEPA dans le Back Office Marchand............................................................ 265.5. Visualiser le détail des mandats dans le Back Office Marchand..............................................................265.6. Notifier le débiteur.................................................................................................................................... 27
Un e-mail pour la pré-notification....................................................................................................... 27Un e-mail pour notifier le paiement.....................................................................................................27Activer la pré-notification.....................................................................................................................28Personnaliser l'e-mail de pré-notification.............................................................................................28
5.7. Importer les mandats de prélèvement SEPA............................................................................................ 28
6. ÉTABLIR LE DIALOGUE AVEC LA PLATEFORME DE PAIEMENT......................................296.1. Définir l'URL de la page de paiement......................................................................................................296.2. S'identifier lors des échanges.................................................................................................................... 296.3. Choisir le mode Test ou Production......................................................................................................... 326.4. Gérer le dialogue vers le site marchand................................................................................................... 336.5. Gérer la sécurité........................................................................................................................................ 356.6. Afficher la page de paiement dans une iframe.........................................................................................376.7. Paramétrer les délais encadrant l'émission d'un prélèvement SEPA.........................................................39
7. CONFIGURER LES NOTIFICATIONS........................................................................................... 407.1. Configurer la notification à la fin du paiement........................................................................................ 407.2. Configurer la notification en cas d'abandon/annulation............................................................................417.3. Configurer la notification pour valider les fichiers SEPA envoyés à la banque.......................................427.4. Activer le rejeu automatique..................................................................................................................... 42
8. GÉNÉRER UN FORMULAIRE DE PAIEMENT........................................................................... 458.1. Effectuer une demande de prélèvement unique........................................................................................47
9. UTILISER DES FONCTIONS COMPLÉMENTAIRES................................................................. 509.1. Personnaliser la RUM............................................................................................................................... 509.2. Modifier la date d'échéance souhaitée d'un prélèvement..........................................................................51
9.3. Activer le retour automatique vers le site marchand................................................................................ 529.4. Gérer le retour vers le site marchand....................................................................................................... 53
Définir les URL de retour.................................................................................................................... 53
10. CALCULER LA SIGNATURE........................................................................................................ 56
11. ENVOYER LA DEMANDE DE PAIEMENT................................................................................5811.1. Rediriger l'acheteur vers la page de paiement........................................................................................ 5811.2. Gérer les erreurs...................................................................................................................................... 58
12. ANALYSER LE RÉSULTAT DU PAIEMENT.............................................................................5912.1. Récupérer les données retournées dans la réponse................................................................................. 60
Récupérer les données lors de la notification instantanée................................................................... 61Récupérer les données lors du retour à la boutique.............................................................................61
12.2. Calculer la signature de l'IPN................................................................................................................. 6212.3. Comparer les signatures.......................................................................................................................... 6212.4. Analyser la nature de la notification.......................................................................................................6312.5. Analyser le résultat du paiement.............................................................................................................6412.6. Récupérer les détails du mandat............................................................................................................. 64
13. OPÉRATIONS SUR LES TRANSACTIONS................................................................................6613.1. Identifier les opérations indisponibles.................................................................................................... 6613.2. Identifier les opérations autorisées..........................................................................................................66
14. ACTIVER LA BOUTIQUE EN MODE PRODUCTION............................................................. 6714.1. Générer la clé de production...................................................................................................................6714.2. Basculer votre site marchand en production...........................................................................................6714.3. Réaliser un premier paiement en production.......................................................................................... 6814.4. Regénérer la clé de production............................................................................................................... 68
15. DICTIONNAIRE DE DONNÉES................................................................................................... 69
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 4 / 186
1. HISTORIQUE DU DOCUMENT
Version Auteur Date Commentaire
2.17 Lyra Network 26/07/2019 • Ajout de la description des fichiers ARA dans le chapitrePrérequis.
• Précions apportées sur le calcul de signature de l'IPN.
• Précision apportée sur le format des champsvads_product_label, vads_cust_zip, vads_order_id,vads_cust_first_name, vads_cust_last_name,vads_cust_phone, vads_cust_cell_phone, vads_cust_id,vads_cust_city, vads_cust_address
• • vads_auth_result: correction du format du champ (an..11)
2.16 Lyra Network 03/07/2019 Ajout de précision dans le chapitre Enregistrer un mandat deSEPA Recurrent
2.15 Lyra Network 17/06/2019 L'algorithme de hachage est désormais disponible dans le menuParamétrage > Boutique, onglet Clés.
2.14 Lyra Network 22/05/2019 • Ajout du chapitre Annexes dans SEPA Recurrent : création etrésiliation d'abonnement via les web services
• Suppression du chapitre Utiliser une i-frame
• Ajout du chapitre Afficher la page de paiement dans uneiframe
• Sous-chapitre(s) de Générer un formulaire de paiement :ajout de précisions sur l'envoi du code de sécurité par SMS
• Ajout du chapitre Configurer les e-mails envoyés à l'acheteur
• Dictionnaire de données : mise à jour de vads_trans_date
2.13 Lyra Network 26/10/2018 Précision sur le stockage et l'archivage des mandats signésMise à jour dans SEPA Recurrent :
• Créer un alias en mode Test depuis le Back Office Marchand: Mises à jour des étapes de création de l'alias.
• Créer un alias depuis le Back Office Marchand : Mises à jourdes étapes de création de l'alias.
2.12 Lyra Network 01/10/2018 Ajout du chapitre :
• Se connecter au Back Office Marchand
Dictionnaire de données
• vads_effective_amount : ajout de précisions
• vads_payment_config : ajout de précisions
2.11 Lyra Network 22/06/2018 Ajout du chapitre Sélectionner l'algorithme de hachageMise à jour du chapitre S'identifier lors des échanges : clé(certificat) alphanumériqueAjout de précisions concernant la validation des fichiers dans leschapitres :
• Prérequis
• Identifier le canal de transmission des ordres deprélèvement SEPA à la banque
• Configurer la notification pour valider les fichiers SEPAenvoyés à la banque
2.10 Lyra Network 06/02/2018 Possibilité de choisir l'algorithme de calcul de signature (SHA-1 ouHMAC-SHA-256)Dictionnaire de données
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 5 / 186
Version Auteur Date Commentaire• vads_currency : mise à jour de la liste des devises supportées
2.9 Lyra Network 27/12/2017 Diverses corrections et reformulations apportées dans leschapitres :
• Identifier les informations obligatoires sur le mandat
• Distinguer les mandats en fonction du type de prélèvement
• Identifier les délais encadrant l'émission d'un prélèvementSEPA
• Visualiser la cinématique du prélèvement SEPA
• Tableau des motifs d'impayés
• Stocker et archiver les mandats signés
• Visualiser le déroulement d'un prélèvement
• Configurer la notification pour valider les fichiers SEPAenvoyés à la banque
• Délai de pré-notification
2.8 Lyra Network 04/12/2017 • Mise à jour du chapitre Distinguer les mandats en fonction dutype de prélèvement avec les informations sur la révocation etla fin de validité du mandat.
• Ajout de précisions sur les délais de remise dans le chapitreIdentifier les délais encadrant l'émission d'un prélèvementSEPA
• Ajout de précisions dans le chapitre Gérer les impayés
• Ajout de précisions dans le chapitre Représenter un paiement
• Précision sur le BIC qui n'est plus obligatoire.
• Ajout du chapitre Mise à jour de l’adresse e-maildans SEPARecurrent
• Ajout du chapitre Amendement d’un mandat de prélèvementSEPA dans SEPA Recurrent
• Ajout de précision dans le Dictionnaire de donnéesvads_cust_address : Adresse obligatoire selon le pays dedomiciliation du compte débiteur.
2.7 Lyra Network 03/07/2017 • Mise à jour des informations liées aux délais de pré-notificationsuite aux nouvelles règles en vigueur à partir du 20 novembre2016.
2.6 Lyra Network 07/06/2016 • URL de notification à la création d’un paiement récurrentdevient URL de notification à la création d'un abonnement
2.5 Lyra Network 08/02/2016 • Informations complémentaires à propos des pays compatiblesavec le moyen de paiement SEPA
• Chapitre supplémentaire : Gérer les impayés
• Chapitres supplémentaires dans SEPA Recurrent:
• Résilier manuellement un abonnement depuis le BackOffice Marchand
• Résilier automatiquement un abonnement par Webservices
2.4 Lyra Network 23/11/2015 Chapitre supplémentaire :
• Configurer la notification pour valider les fichiers SEPAenvoyés à la banque
2.3 Lyra Network 01/10/2015 Informations complémentaires :
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 6 / 186
Version Auteur Date Commentaire• Prérequis pour mettre en place les remboursements par
virements SEPA.
• Signature des mandats par e-mail.
2.2 Lyra Network 18/09/2015 Modification des chapitres suivants dans SEPA Recurrent :
• Utiliser une i-frame
• Enregistrer un mandat
• Effectuer un paiement en un clic
• Enregistrer un mandat et définir un abonnement fixe
• Enregistrer un mandat et effectuer un paiement
• Mettre à jour un mandat et effectuer un paiement
Modification des chapitres suivants dans de SEPA Prélèvementponctuel :
• Utiliser une i-frame
• Effectuer une demande de prélèvement unique
2.1 Lyra Network 22/07/2015 • Passage de la plateforme de paiement en version 2.4
Modifications apportées à propos de la date d'échéancesouhaitée.Modification des chapitres suivants dans SEPA Recurrent :
• Paramétrer les délais encadrant l'émission d'un prélèvementSEPA
• Délai de remise
• Enregistrer un mandat et définir un abonnement fixe
• Modifier la date d'échéance souhaitée d'un prélèvement
• Analyser le résultat du paiement
Ajout des chapitres suivants dans SEPA Recurrent :
• Activer la pré-notification
• Effectuer un paiement en 1 clic (utilisation d'un mandatexistant)
• Analyser le résultat d'un paiement en 1 clic
2.0 Lyra Network 17/03/2015 • Passage de la plateforme de paiement en version 2.3
• Remboursement par virement
• Réception des journaux d'impayés par e-mail ou ftp
• Personnalisation de l'e-mail de pré-notification deprélèvement sepa dans le centre de notification
1.0 Lyra Network 16/09/2014 Version initiale
Ce document et son contenu sont strictement confidentiels. Il n’est pas contractuel. Toute reproductionet/ou distribution de ce document ou de toute ou partie de son contenu à une entité tierce sont
strictement interdites ou sujettes à une autorisation écrite préalable de Lyra Network. Tous droits réservés.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 7 / 186
2. OBTENIR DE L'AIDE
Consulter la documentation
Vous cherchez de l'aide? Consultez nos sites documentaires
En France https://payzen.io/fr-FR/faq/sitemap.htmlEn Europe https://payzen.io/en-EN/faq/sitemap.htmlEn Amérique Latine (hors Brésil) https://payzen.io/lat/faq/sitemap.htmlAu Brésil https://payzen.io/pt-BR/faq/sitemap.htmlEn Inde https://payzen.io/in/faq/sitemap.html
Nous veillons à améliorer constamment la compréhension et la bonne utilisation de notre documentationproduit. Vos remarques constructives sont des éléments significatifs pour nous.
Merci d’envoyer vos commentaires et suggestions au sujet de la documentation à l’[email protected].
Contacter l'assistance
Pour toute question technique ou demande d'assistance, nos services sont disponibles du lundi auvendredi, de 9h à 18h
Par téléphone Par e-mail
En France [email protected]
En Europe [email protected]
En Amérique Latine (hors Brésil) N/A [email protected]
Au Brésil+55 (11) 3336-9217+55 (11) 3336-9209
En Inde +91 (022) 33864910 / 932 [email protected] via votre Back Office Marchand, menu Aide > Contacter le support
Pour faciliter le traitement de vos demandes, il vous sera demandé de communiquer votre identifiant deboutique (numéro à 8 chiffres).
Cette information est disponible dans l'e-mail d'inscription de votre boutique ou dans le Back OfficeMarchand (menu Paramétrage > Boutique > Configuration).
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 8 / 186
3. SEPA : PAYER PAR PRÉLÈVEMENT
Le prélèvement SEPA (Single Euro Payments Area ou espace unique de paiement en euro) égalementappelé SEPA Direct Debit (SDD), est un projet européen qui vise à créer des moyens de paiement en euro(virements, prélèvements et cartes bancaires) communs à l'ensemble des pays européens.
Ce moyen de paiement est proposé par un créancier (marchand) à un débiteur (acheteur) afin de réglerautomatiquement des factures récurrentes ou ponctuelles.
Le prélèvement SEPA s’appuie sur un formulaire unique : le « Mandat de prélèvement SEPA ».
Pays où le moyen de paiement SEPA est valide :
Zone Pays
Pays Union Européenne zone euro Allemagne, Autriche, Belgique, Chypre (partie grecque),Espagne, Estonie, Finlande, France, Grèce, Irlande, Italie,Luxembourg, Malte, Pays-Bas, Portugal, Slovaquie, Slovénie,Croatie.
Pays Union Européenne zone non euro Bulgarie, Danemark, Hongrie, Lettonie, Lituanie, Pologne,République Tchèque, Roumanie, Royaume Uni, Suède.
Pays de l'AELE (Association Européenne de Libre Echange) lslande, Norvège, Liechtenstein et Suisse.
Tableau 1 : Liste des pays compatibles avec SEPA
Remarque :
En ce qui concerne la France, les départements et régions d'outre-mer (Guadeloupe, Martinique, Guyane,Réunion et Mayotte), de même que les territoires de Saint-Pierre-et-Miquelon, Saint-Barthélemy et lapartie française de Saint-Martin font partie de l'espace SEPA ainsi que la principauté de Monaco.
En revanche, les principautés et micros états comme Andorre, le Vatican, Saint-Marin et Gibraltar sonthors zone SEPA.
3.1. Identifier les informations obligatoires sur le mandat
Le mandat de prélèvement SEPA contient les éléments suivants :
• Le type de prélèvement du mandat : ponctuel ou récurrent.
• La RUM (Référence Unique de Mandat) : c'est une référence unique qui identifie chaque mandat signé.
• Les coordonnées (nom) du débiteur.
• L'IBAN (International Bank Account Number) du débiteur : le numéro de compte est destiné à identifierde manière fiable le destinataire d'un virement ou d'un prélèvement.
Le BIC (Business Identifier Code) qui complétait l'IBAN dans l'identification est, lui, devenu optionnel.
• Les coordonnées (nom et adresse) du créancier.
• L'ICS (Identifiant Créancier SEPA) du créancier : c'est un code unique identifiant chaque société habilitéeà prélever. L'ICS est attribué par la Banque de France par l'intermédiaire d'un établissement bancaire.
• La date de signature du mandat.
• La signature du débiteur autorisé par sa banque à faire fonctionner le compte sur lequel s'opèrent lesprélèvements.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 9 / 186
Image 1 : Exemple de formulaire de mandat de prélèvement
3.2. Distinguer les mandats en fonction du type de prélèvement
On distingue deux types de mandats :
• Ponctuel
Le mandat signé vaut pour un prélèvement unique. Il expire après cet unique prélèvement.
• Récurrent
Le mandat signé vaut pour une série de prélèvements. Il devient caduc à l'issue de 36 mois sanspaiement ou après un prélèvement "FNAL".
Le prélèvement SEPA fonctionne selon des « séquences ». Le tableau ci-dessous liste les séquencespossibles pour le prélèvement et le code associé en fonction du type de mandat.
Type de mandat Séquence possible pour le prélèvement Code
Ponctuel ONE OFF : prélèvement unique, non suivi par d’autres prélèvements au titre dumême mandat.
OOFF
FIRST1 : 1er prélèvement d’une série. FRST
RECURRENT : prélèvements consécutifs au 1er d’une série. RCUR
Récurrent
FINAL : dernier prélèvement d’une série. FNAL
Tableau 2 : Séquences possibles en fonction du type de prélèvement
1. Depuis le 20 novembre 2016, la séquence FIRST est optionnelle. Le premier prélèvement SEPA d'unesérie peut être indifféremment émis avec la séquence de présentation "RCUR" ou avec la séquence deprésentation "FRST".
Révocation
Le mandat de prélèvement SEPA est révocable à tout moment par le débiteur ou le créancier.
Dans le cas où la révocation est à l’initiative du débiteur, la banque qui tient le compte n’informe pas laplate-forme de paiement. Les éventuelles futures transactions portant sur le mandat seront placées enimpayés. Celles-ci peuvent être identifiées dans le journal de rapprochement des impayés, le code retourétant MD01 (absence de mandat).
Fin de validité
Un mandat devient caduc après 36 mois sans paiement ou suite à un prélèvement "FNAL". La plateformede paiement refusera alors de créer de nouvelles transactions sur ce mandat (il n’y aura donc pas deprésentation en banque).
Si de nouveaux prélèvements sont à envisager avec ce client, un nouveau mandat devra être signé.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 10 / 186
3.3. Identifier les délais encadrant l'émission d'un prélèvement SEPA
Une pré-notification doit être envoyée au moins 14 jours calendaires avant la date d'échéance duprélèvement. Depuis le 20 novembre 2016, avec accord bilatéral, ce délai peut être réduit mais la pré-notification doit obligatoirement précéder l'échange entre banques des ordres de prélèvement soit :
• 1 jour ouvré bancaire avant la date d’échéance.
Valable aussi bien pour un prélèvement SEPA ponctuel (One-Off - OOFF) que pour un prélèvementSEPA récurrent(Récurrent RCUR ou Final FNAL)
On appelle jour ouvré bancaire un jour hors week-end et jours fériés.
Remarque :
Si le délai de pré-notification pourrait être de 1 jour ouvré bancaire avant la date d’échéance, le délai deremise des ordres de prélèvement SEPA par le marchand/créancier doit-intégrer le délai de traitementdu prélèvement SEPA par la banque du créancier (soit 1 jour ouvré supplémentaire pour Lyra Network).
Au final, dans le Back Office Marchand, le marchand doit :
• Pré-notifier son acheteur entre 2 et 14 jours avant l’échéance,
• Remettre ses formulaires de paiements 2 jours ouvrés avant la date d’échéance du prélèvementSEPA, faute de quoi la date d’échéance sera recalculée par Lyra Network.
Exemple de prélèvement SEPA soumis en décembre 2016:
Avec ses jours fériés, le mois de décembre est le parfait exemple pour illustrer les délais encadrantl’encaissement par prélèvement SEPA.
Un prélèvement SEPA au 1er janvier (date d’échéance) doit être présenté à la banque du débiteur :
• Au plus tôt le 18 décembre, c'est-à-dire 14 jours calendaires avant la date d'échéance.
• Au plus tard le 31 décembre, c'est-à-dire 1 jour ouvré bancaire avant la date d'échéance pour unprélèvement ponctuel remis par le marchand à Lyra Network le 30 décembre.
• Au plus tard le 31 décembre, c'est-à-dire 1 jour ouvré bancaire avant la date d'échéance pour unprélèvement récurrent remis par le marchand à Lyra Network le 30 décembre.
Le 1er janvier est un jour férié. Cette date d’échéance ne correspond pas à un jour ouvré bancaire. L’ordrede prélèvement SEPA est exécuté le jour ouvré bancaire suivant, c’est-à-dire le 4 janvier.
Complément d’informations dans le cadre d’un prélèvement SEPA
Ce chapitre apporte un complément d’informations sur les différentes variables influant sur la date deprésentation du paiement dans le cadre d’un prélèvement SEPA.
Lors de la création d'une transaction de prélèvement SEPA , plusieurs éléments peuvent faire varier la dateà laquelle le paiement sera présenté :
• La date de création de la transaction.
• La date de l'échéance demandée par le marchand.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 11 / 186
• Le délai de pré-notification, paramétré au niveau du contrat.
• Le délai de remise, paramétré au niveau de la boutique.
• Le délai de présentation à la banque, fixé à 1 jour ouvré bancaire pour l’ensemble des prélèvementsSEPA (depuis le 20 novembre 2016).
Si la date d’échéance demandée par le marchand ne respecte pas les différents délais, la plateforme depaiement repoussera cette date d’autant de jours que nécessaire.
Si le marchand ne donne pas de date d’échéance, la plateforme calculera une date au plus tôt, toujoursen accord avec ces règles. La date ainsi calculée sera retournée dans les réponses aux créations destransactions (fichier, réponse web service …)
Le délai de pré-notification est le nombre de jours minimum qui doit s’écouler entre l’envoi de l'e-mail depré-notification au client et le transfert de fonds. Ce délai peut être redéfini mais il est incompressible : ilrepoussera d’autant la date de transfert de fonds voulue.
Image 2 : Schéma - délai de pré-notification
Le délai de remise est le nombre de jours minimum qui doit s’écouler entre la création de la transactionet le transfert de fonds. Dans le cas du paiement SEPA, il n’a pas d’influence s’il est inférieur au délai depré-notification (on revient au cas du schéma ci-dessus). S’il est supérieur à ce délai, c’est lui qui repoussela date de transfert de fonds et il ajoute un délai entre la création de la transaction et l’envoi de l'e-mailde pré-notification :
Image 3 : Schéma - délai de remise
Dans les exemples suivants, on a un délai de remise à zéro (valeur par défaut).
1. Calcul de la date de transfert de fonds minimale
• Si le délai de pré-notification est inférieur ou égal à 2 jours :
Date de transfert de fonds minimale = Date de création de la transaction + Délai d’envoi du fichierde remise (la nuit suivante) + Délai de présentation (fixé à 1 jour)
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 12 / 186
Soit une date de transfert de fonds au minimum 2 jours après la création de la transaction (premierjour ouvré bancaire à partir de la date de présentation minimale calculée).
• Si le délai de pré-notification est supérieur à 2 jours
Date de transfert de fonds minimale = Date de création de la transaction + Délai de pré-notification
Soit pour un délai de pré-notification de 14 jours, une date de transfert de fonds au minimum 14jours après la date de création de la transaction (premier jour ouvré bancaire à partir de la date deprésentation minimale calculée).
2. Comparaison avec la date d’échéance demandée par le marchand
Si le marchand a demandé une date d’échéance lors de la création de la transaction, une comparaisonest réalisée entre la date d’échéance demandée et la date de transfert de fonds minimale calculée dansles étapes précédentes.
Si la date d’échéance demandée est supérieure à la date de transfert de fonds minimale, alors :
Date de transfert de fonds = Date d’échéance demandée par le marchand
Conclusion
Dans le cas où le marchand souhaite que les paiements soient réalisés à une date précise, il est nécessaireque :
• La date d’échéance demandée soit un jour ouvré bancaire.
• Le délai entre la date de création de la transaction et la date d’échéance souhaitée soit supérieur audélai de pré-notification paramétré (ou au délai de remise si celui-ci est supérieur au délai de pré-notification).
• Dans le cas où le délai de pré-notification est inférieur ou égal à 2 jours, le délai minimum entre ladate de création de la transaction et la date de transfert de fonds souhaitée est de deux jours.
Note complémentaire
Dans le cas d’une utilisation de fichiers de paiements, ces derniers sont traités deux fois par jour à 07h00et 13h00, et ceci chaque jour de la semaine. Si le marchand envoie son fichier de paiements après 13h00,les transactions correspondantes seront créées le lendemain matin à 07h00.
Exemples :
Date d’échéance non renseignée (ou souhaitée le jour même de création de la transaction)
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 13 / 186
Date de création de latransaction
Date d’échéancedemandée
Délai de pré-notification paramétré
Date de présentation àla banque
Date de transfert defonds
Lun 02/01/2017 Lun 02/01/2017 0 Mar 03/01/2017 Mer 04/01/2017 (1)
Lun 02/01/2017 Lun 02/01/2017 1 Mar 03/01/2017 Mer 04/01/2017 (1)
Lun 02/01/2017 Lun 02/01/2017 2 Mar 03/01/2017 Mer 04/01/2017 (1)
Lun 02/01/2017 Lun 02/01/2017 3 Jeu 05/01/2017 Ven 06/01/2017
Lun 02/01/2017 Lun 02/01/2017 5 Ven 06/01/2017 Lun 09/01/2017 (2)
Lun 02/01/2017 Lun 02/01/2017 7 Ven 06/01/2017 Lun 09/01/2017
Lun 02/01/2017 Lun 02/01/2017 14 Ven 13/01/2017 Lun 16/01/2017
1. Le délai minimum de traitement étant de deux jours, le transfert de fonds ne peut être demandé à labanque avant le 04/01/2017.
2. En respectant le délai de pré-notification de 5 jours, la date de transfert de fonds de la transactionserait le samedi 07/01/2017. Celle-ci devant être un jour ouvré bancaire, elle est donc décalée au lundi09/01/2017.
Date d’échéance souhaitée à une date dans le futur (exemple le 6 du mois)
Date de création de latransaction
Date d’échéancedemandée
Délai de pré-notification paramétré
Date de présentation àla banque
Date de transfert defonds
Lun 02/01/2017 Ven 06/01/2017 0 Jeu 05/01/2017 Ven 06/01/2017 (1)
Lun 02/01/2017 Ven 06/01/2017 1 Jeu 05/01/2017 Ven 06/01/2017 (1)
Lun 02/01/2017 Ven 06/01/2017 2 Jeu 05/01/2017 Ven 06/01/2017 (1)
Lun 02/01/2017 Ven 06/01/2017 3 Jeu 05/01/2017 Ven 06/01/2017 (2)
Lun 02/01/2017 Ven 06/01/2017 5 Ven 06/01/2017 Lun 09/01/2017 (3)
Lun 02/01/2017 Ven 06/01/2017 7 Ven 06/01/2017 Lun 09/01/2017 (3)
Lun 02/01/2017 Ven 06/01/2017 14 Ven 13/01/2017 Lun 16/01/2017 (3)
1. Le délai entre la date de création de la transaction et la date de présentation demandée par le marchandétant supérieur au délai de traitement, le transfert de fonds est demandé à la banque le 06/01/2017comme souhaité.
2. Le délai entre la date de création de la transaction et la date d’échéance demandée par le marchandétant supérieur au délai de pré-notification, le transfert de fonds est demandé à la banque le 06/01/2017comme souhaité.
3. Le délai entre la date de création de la transaction et la date d’échéance demandée par le marchandétant inférieur au délai de pré-notification, la date de transfert de fonds est déterminée à partir du délaide pré-notification.
Date d’échéance souhaitée à une date qui n’est pas un jour ouvré bancaire
Date de création de latransaction
Date d’échéancedemandée
Délai de pré-notification paramétré
Date de présentation àla banque
Date de transfert defonds
Mar 01/08/2017 Sam 05/08/2017 0 Ven 04/08/2017 Lun 07/08/2017 (1)
Mar 01/08/2017 Sam 05/08/2017 1 Ven 04/08/2017 Lun 07/08/2017 (1)
Mar 01/08/2017 Sam 05/08/2017 2 Ven 04/08/2017 Lun 07/08/2017 (1)
Mar 01/08/2017 Sam 05/08/2017 3 Ven 04/08/2017 Lun 07/08/2017 (1)
Mar 01/08/2017 Sam 05/08/2017 5 Ven 04/08/2017 Lun 07/08/2017 (1)
Mar 01/08/2017 Sam 05/08/2017 7 Lun 07/08/2017 Mar 08/08/2017 (2)
Mar 01/08/2017 Sam 05/08/2017 14 Lun 14/08/2017 Mer 16/08/2017 (3)
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 14 / 186
1. Le transfert de fonds devant être un jour ouvré bancaire, la date est décalée au lundi 07/08/2017. Defait, en respect des délais de pré-notification et de présentation, le transfert de fonds est réalisé le07/08/2017 comme « demandé » par le marchand.
2. Le délai entre la date de création de la transaction et la date d’échéance demandée par le marchandétant inférieur au délai de pré-notification, la date de présentation est déterminée en respect du délaide pré-notification.
3. En respectant le délai de pré-notification de 14 jours, la date de transfert de fonds de la transactionserait le mardi 15/08/2017. La date de transfert de fonds devant être un jour ouvré bancaire, elle estdonc décalée au mercredi 16/08/2017.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 15 / 186
3.4. Visualiser la cinématique du prélèvement SEPA
Ci-dessous la cinématique générale des échanges pour un prélèvement SEPA :
Image 4 : Cinématique générale des échanges pour un prélèvement SEPA
Etapes 1, 2 et 3 – Echanges de documents
Le prélèvement SEPA repose sur un mandat de prélèvement SEPA à signer par le débiteur et matérialisantson consentement vis-à-vis du créancier pour prélever toutes les sommes dues sur son compte. Chaquemandat est identifié par une Référence Unique de Mandat qui permet d’identifier le contrat pour lequelles prélèvements SEPA sont dus.
Pour chaque prélèvement SEPA, le créancier doit envoyer au débiteur une pré-notification, 14 jourscalendaires avant la date d’échéance du prélèvement, pour l’avertir du prélèvement.
Etapes 4 et 5 – Envois de messages
Le créancier fait parvenir à sa banque l’ordre de prélèvement SEPA. Cette dernière va se mettre en relationavec la banque du débiteur afin de procéder au prélèvement SEPA interbancaire.
Etapes 6, 7 et 5 – Transferts de fonds
Le compte bancaire du débiteur va être débité au profit du compte bancaire du créancier.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 16 / 186
3.5. Identifier le canal de transmission des ordres de prélèvement SEPA àla banque
Les ordres de prélèvement SEPA sont transmis à la banque, le plus souvent via le protocole EBICS(Electronic Banking Internet Communication Standard : protocole de télétransmission standard).
On distingue deux protocoles EBICS :
• EBICS T avec « signature disjointe » : le créancier doit confirmer les ordres de prélèvements sur soninterface bancaire. Veuillez-vous rapprocher de votre banque pour connaître le processus de validation.
C'est ce protocole de communication qui est utilisé par la plateforme de paiement.
Remarque : pour des raisons de sécurité, la validation des prélèvements par fax n'est plus possible depuisjanvier 2017.
• EBICS TS avec « signature jointe » : Avant que les ordres de prélèvements ne soient transférésà la banque, le créancier les signe numériquement avec un certificat délivré par une autorité decertification.
Ce protocole n'est pas supporté par la plateforme de paiement.
3.6. Gérer les impayés
Si un problème intervient suite à un prélèvement, votre banque retournera un code motif de rejet.
La plateforme de paiement récupère ces informations régulièrement et vous les présente dans le BackOffice Marchand et dans les journaux de rapprochement des impayés (le motif apparaît dans le champUNPAID_CODE). Pour plus de détails sur ce champ vous pouvez consulter la documentation Descriptiondes journaux de reporting disponible sur notre site documentaire.
Mettre en place le flux d'impayés
Côté banque :
Activez le flux Flux d'impayés de prélèvements SEPA auprès de votre banque.
Côté PayZen :
Veuillez-vous assurer que votre offre PayZen contient la réconciliation visuelle des impayés.
La mise en place est automatique. Une fois la connexion EBICS et le flux Flux d'impayés de prélèvementsSEPA activés, votre plateforme de paiement vous communique toutes les informations relatives auximpayés.
Visualiser les impayés dans le Back Office Marchand
1. Selectionnez le menu Gestion > Transactions.
2. Selectionnez l'onglet Transactions remisées.
Les transactions faisant l'objet d'un impayé sont visibles depuis l'onglet Transactions remisées.
3. Recherchez à travers l'outils de recherche, le critère Litiges.
Le critère Litiges est situé dans le groupe Statut.
4. Sélectionnez Oui afin de filtrer les résultats.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 17 / 186
5. Cliquez sur Chercher.
6. Double cliquez sur une transaction SEPA pour en obtenir le détail.
Le contenu de l'onglet Informations s'affiche par défaut.
7. Reportez-vous dans le groupe Cycle de vie de la transaction à la ligne Motif impayé.
Un code rejet est associé au motif de l'impayé.
Reportez-vous au tableau ci-après pour analyser la raison de cet impayé et identifier l'action àentreprendre.
Tableau des motifs d'impayés
Code ISO Motif - Description Action requise
AC01 Coordonnées bancaires incorrectes
• Le code IBAN ou BIC fourni par l'acheteur estincorrect.
• Le compte n’est pas en euros.
Contactez l'acheteur pour confirmer le bon IBAN.Depuis le Back Office Marchand, modifiez l'alias pourmettre à jour le BIC et/ou IBAN.Représentez le paiement (voir chapitre suivant).
AC04 Compte clôturéLe compte a été fermé.L'acheteur peut avoir utilisé un ancien numérode compte ou fermé le compte depuis la mise enplace du mandat.
Contactez l'acheteur pour obtenir les informations dunouveau compte.Depuis le Back Office Marchand, modifiez l'alias pourmettre à jour le BIC et/ou IBAN.Représentez le paiement (voir chapitre suivant).
AC06 Opposition sur compte / Compte bloquéLe compte a été bloqué pour les prélèvements :
• soit par la banque
• soit par l'acheteur
Contactez l'acheteur pour demander un compte depaiement de remplacement.Depuis le Back Office Marchand, modifiez l'alias pourmettre à jour le BIC et/ou IBAN.Représentez le paiement (voir chapitre suivant).
AG01 Opération non admise sur ce type de compteLe prélèvement SEPA ne peut pas être mis en placesur ce type de compte.Exemple : un compte d'épargne.
Contactez l'acheteur pour des renseignementsconcernant le compte à utiliser.Depuis le Back Office Marchand, modifiez l'alias pourmettre à jour le BIC et/ou IBAN.Représentez le paiement (voir chapitre suivant).
AG02 Code opération incorrectErreur technique
Contactez la plateforme de paiement.
AM04 Provision insuffisanteLa banque du débiteur n'a pas pu payer leprélèvement en raison de fonds insuffisants.
Contactez l'acheteur pour qu'il provisionne son compteet représentez le paiement (voir chapitre suivant).
AM05 DoublonL'encaissement a déjà été fait. Cela peut être dûsoit à un identifiant de transaction erroné, soitparce que deux transactions ont été soumises.
Vérifiez que l'encaissement est vraiment dupliqué.
BE05 Emetteur non reconnuL'identifiant du créancier fourni est incorrect oun'est pas valide.
Envoyez l'identifiant du créancier (ICS) à l'interlocuteurde votre plateforme de paiement.
FF01(Ex MD03)
Format invalideErreur technique
Contactez votre plateforme de paiement.
FF05 Type de prélèvement incorrectErreur technique
Contactez votre plateforme de paiement.
MD01 Absence de mandatLe mandat n'est plus valide sur le compte del'acheteur. Le mandat peut avoir été annulé parl'acheteur.Il est également utilisé quand un acheteurdemande un remboursement, déclarant quec'était une opération non autorisée. Cela peut seproduire jusqu'à 13 mois après le règlement.
Vérifiez la date d'expiration dans le Back OfficeMarchand.Dans le cas d'un remboursement, contactez l'acheteurpour plus de détails.
MD02 Données mandat manquantes ou incorrectes Contactez votre plateforme de paiement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 18 / 186
Code ISO Motif - Description Action requiseErreur technique.
MD03 Format invalideErreur technique.
Contactez votre plateforme de paiement.
MD06 Opération contestée par le débiteurL'acheteur a demandé un remboursement d'unetransaction autorisée. L'ordre peut être reçujusqu'à huit semaines après le prélèvement.
Contactez l'acheteur.
MD07 Titulaire décédéVous avez essayé de mettre en place un mandatsur le compte de quelqu'un qui est décédé.Extrêmement rare.
Mettez fin au contrat.
MS02 Refus du destinataire - raison non communiquéeL'acheteur refuse le prélèvement.Ce code peut être reçu avant ou après leprélèvement, en fonction de la rapidité aveclaquelle la banque du débiteur répond au refus.
Contactez l'acheteur.
MS03 Raison non communiquéeL'un des codes d'erreur les plus courants. Souventutilisé lorsque les banques choisissent de ne pasfournir des codes de raison plus spécifiques, telsque MD07 et AM04, sous motif de la protectiondes données.
Contactez l'acheteur pour qu'il se rapproche de sabanque pour obtenir la raison du rejet.
RC01 Code banque incorrectLe code BIC fourni par l'acheteur est incorrect.
Contactez l'acheteur pour obtenir le bon BIC.Depuis le Back Office Marchand, modifiez l'alias pourmettre à jour le BIC.Représentez le paiement (voir chapitre suivant).
RR01 Motif réglementaire - compte du débiteurnécessaireErreur technique.
Contactez votre plateforme de paiement.
RR02 Motif réglementaire - nom du débiteur nécessaireErreur technique.
Contactez votre plateforme de paiement.
RR03 Motif réglementaire - nom du créancier nécessaireErreur technique.
Contactez votre plateforme de paiement.
RR04 Motif réglementaireR04 peut être utilisé que pour une raisonréglementaire autre que les RR01, RR02 ou RR03.
Demandez à votre banque de contacter la banque dudébiteur afin de connaître le motif du refus.
SL01 Service spécifique proposé par la banque dudébiteurLa demande se heurte à des instructionsspécifiques que l'acheteur a donné à son compte.Exemple : le créancier est sur liste noire.
Contactez l'acheteur
TM01 Fichier reçu après l'heure limiteHeure limite dépassée.
Contactez votre plateforme de paiement.
Tableau 3 : Codes ISO et motifs d'impayés
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 19 / 186
Réémettre une demande de prélèvement
La plateforme de paiement ne représentera pas automatiquement un impayé, quelle qu’en soit la raison.C’est à vous de déterminer s’il faut refaire une demande de paiement, en tenant compte notamment ducode retour d’impayé.
Le paiement ainsi créé sera une nouvelle transaction, sans lien avec le paiement qui a échoué. Son cycle devie sera le même que pour toute nouvelle transaction (envoi d’une pré-notification, calcul des délais, etc.)
Pour réémettre une demande de prélèvement ayant fait l'objet d'un rejet, procédez à un paiement manuel.
1. Sélectionnez le menu Gestion > Transactions.
2. Cliquez sur Paiement manuel situé sur la partie supérieure du panneau de visualisation destransactions.
3. Sélectionnez le moyen de paiement SEPA.
4. Renseignez la RUM dans le champ alias.
5. Renseignez les champs nécessaires pour compléter le paiement.
Remarque :
Les paiements suivants utiliseront automatiquement les nouvelles coordonnées bancaires.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 20 / 186
4. SE CONNECTER AU BACK OFFICE MARCHAND
Votre Back Office est accessible à l’adresse URL suivante :
https://secure.payzen.eu/vads-merchant/
1. Saisissez votre identifiant de connexion.
Votre identifiant de connexion vous a été communiqué par e-mail ayant pour objet Identifiants deconnexion - [nom de votre boutique].
2. Saisissez votre mot de passe.
Votre mot de passe vous a été communiqué par e-mail ayant pour objet Identifiants de connexion -[nom de votre boutique].
3. Cliquez sur Valider.
Au bout de 3 erreurs dans la saisie du mot de passe, le compte de l’utilisateur est bloqué. Cliquezalors sur Mot de passe oublié ou compte bloqué pour réinitialiser.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 21 / 186
5. PRÉSENTATION DU MOYEN DE PAIEMENT
Ce document présente l’encaissement par prélèvement unique via la signature d’un mandat.
Par la suite, la RUM (Référence Unique de Mandat) est appelée :
• Identifiant acheteur sur la page de paiement,
• Identifiant de compte client dans le Back Office Marchand.
5.1. Prérequis
Pour utiliser ce moyen de paiement, le marchand doit :
• Souscrire à un contrat d'abonnement télétransmission EBICS T avec sa banque ou demander la créationd'un nouvel utilisateur EBICS T sur sa connexion EBICS.
Attention
Le protocole EBICS TS n'est pas supporté par la plateforme de paiement.
• Souscrire à l'option Paiement par prélèvement SEPA DD auprès de la plateforme.
• Communiquer son ICS à la plateforme de paiement.
• Demander la procédure de validation des fichiers de prélèvement auprès de sa banque.
Pour recevoir les journaux d'impayés par e-mail ou ftp, le marchand doit :
• Souscrire aux flux d'impayés auprès de sa banque.
• Souscrire à l'option Rapprochement bancaire auprès de PayZen.
Pour mettre en place des remboursements par virements SEPA :
• Activer les flux SDD, SCT et RDD sur votre connexion EBICS auprès de votre banque.
Remarque
La terminologie utilisée pour nommer les flux peut différer selon le client, l'acquéreur ou la plateforme.
Exemple : flux RDD = flux d'impayés.
Pour s'assurer de demander le bon flux, vous trouverez ci-dessous les noms techniques :
• SDD = pain.008
• SCT = pain.001
• RDD = camt.054
5.2. Stocker et archiver les mandats signés
Le lieu de stockage et d'archivage dépend du mode de signature :
• Signature par SMS
Par défaut, la signature des mandats s'effectue par la saisie d'un code reçu par SMS.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 22 / 186
Le mandat bénéficie d'un archivage à valeur légale. La plateforme de paiement se charge de transmettrele mandat signé pour stockage et archivage dans le coffre-fort électronique de la Caisse des Dépôts etConsignations.
En cas de contestation, cette signature garantit que le mandat n'a subi aucune transformation par untiers. La Caisse des Dépôts et Consignations fournit un faisceau de preuves qui ne peut être contestéou objecté.
• Signature par e-mail
La signature du mandat s'effectue en renseignant un code reçu par e-mail. L'archivage à valeur légaleest également appliquée sur ce mode de signature.
Vous pouvez cependant, si vous le souhaitez, désactiver la signature d'un mandat par SMS ou e-mail.Pour cela, veuillez contacter l'administration des ventes .
• Signature par case à cocher
La signature du mandat s'effectue en cochant la mention En cochant cette case, vous certifiez avoir luet compris les informations présentées dans ce mandat et y apposer votre signature.
La plateforme de paiement se charge du stockage et de l'archivage du mandat signé.
Le créancier (marchand) a aussi la possibilité d’assurer lui-même le stockage et l’archivage du mandat.Mais à ce moment-là, il aura besoin d'importer les RUM des mandats dans la plateforme réaliser desdemandes de prélèvement (par formulaire ou par fichier).
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 23 / 186
5.3. Visualiser le déroulement d'un prélèvement unique sur la page depaiement
Le mandat ponctuel vaut pour un prélèvement unique et ne donnera pas lieu à une série de prélèvements.
Il sera impossible d’effectuer d’autres prélèvements avec le même mandat.
Voici le déroulement de l’encaissement par prélèvement:
1. Le débiteur sélectionne le moyen de paiement Prélèvement SEPA.
Image 5 : Choix du moyen de paiement
2. Il clique sur Valider.
3. La page suivante récapitule les informations de la transaction (Identifiant du marchand, Numérode transaction et Montant). Le débiteur doit renseigner les champs Nom, Prénom, e-mail, IBAN etnuméro de télephone si ce dernier n'est pas pré-renseigné.
Image 6 : Saisie des coordonnées bancaires du débiteur
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 24 / 186
Remarque :
Une autre forme de signature est disponible (signature par case à cocher). Veuillez vous rapprocher del'interlocuteur de votre plateforme de paiement pour plus d'informations.
4. Une fois les données renseignées, le débiteur clique sur Valider.
5. Plusieurs vérifications sont effectuées afin de contrôler la validité de l'IBAN renseignés (notammentsa compatibilité SEPA).
Si les données sont erronées, le message Le compte bancaire indiqué n'est pas compatible avec cemoyen de paiement est affiché.
Si le contrôle de l'IBAN a abouti avec succès, le mandat de prélèvement SEPA contenant l'ensembledes informations requises est affiché. Le débiteur doit vérifier l'exactitude de ces informations.
Image 7 : Validation du mandat
6. Pour pouvoir valider ce mandat, le débiteur doit :
• renseigner le champ Code avec le code reçu sur son téléphone portable (ou par e-mail selonl'option de l'offre de la boutique).
• cocher la mention En cochant cette case, vous certifiez avoir lu et compris les informationsprésentées dans ce mandat et y apposer votre signature.
7. Le débiteur clique sur Valider.
8. Un récapitulatif est ensuite affiché.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 25 / 186
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 26 / 186
5.4. Visualiser les transactions SEPA dans le Back Office Marchand
Les transactions sont visibles dans le Back Office Marchand depuis le menu Gestion > Transactions.
Tant que la date d'échéance n'est pas atteinte, les transactions sont présentes dans l'onglet Transactionsen cours.
Une fois la présentation interbancaire réalisée, les transactions sont présentes dans l'onglet Transactionsremisées.
Double cliquez sur une transaction SEPA pour en obtenir le détail.
5.5. Visualiser le détail des mandats dans le Back Office Marchand
Les informations des mandats complétés et signés sont accessibles depuis le Back Office Marchand.
Il suffit de sélectionnez un Alias depuis le menu Gestion > Abonnements > onglet Alias
Vous pouvez également recevoir un mandat par e-mail (clic droit sur l’identifiant compte client > Recevoirle mandat par e-mail).
Ce dernier est uniquement traduit dans les langues de l’union européenne : Français, Allemand, Anglais,Espagnol, Italien, Néerlandais, Polonais, Portugais et Suédois.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 27 / 186
5.6. Notifier le débiteur
Deux e-mails peuvent être envoyés au débiteur par la plateforme de paiement :
Un e-mail pour la pré-notification
L'e-mail pour la pré-notification est désactivé par défaut (voir chapitre Activer la pré-notification à la page28).
La plateforme de paiement peut notifier le débiteur par e-mail 14 jours ouvrés maximum avant la dated’échéance.
Si un accord est établit entre les deux parties, ce délai peut être réduit (voir chapitre Identifier les délaisencadrant l'émission d'un prélèvement SEPA à la page 10).
Modèle de pré-notification :
Remarque :
Le modèle de l'e-mail pour la pré-notification peut être personnalisé (voir chapitre Personnaliser l'e-mailde pré-notification à la page 28).
Un e-mail pour notifier le paiement
La plateforme de paiement notifie le débiteur par e-mail pour lui confirmer l’enregistrement de la demandede son prélèvement.
Modèle d’e-mail pour cette notification :
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 28 / 186
Activer la pré-notification
Pour activer l'e-mail de la pré-notification :
1. Depuis votre Back Office Marchand, allez dans le menu : Paramétrage > Règles de notifications.
2. Sélectionnez l'onglet E-mail envoyé à l'acheteur.
3. Effectuez un clic droit sur le libellé E-mail de pré-notification de prélèvement SEPA à destination del'acheteur.
4. Sélectionnez Activer la règle.
Personnaliser l'e-mail de pré-notification
Le modèle de l'e-mail pour la pré-notification peut être personnalisé. Pour cela :
1. Depuis votre Back Office Marchand, cliquez sur Paramétrage > Règles de notifications > onglet E-mail envoyé à l'acheteur.
2. Effectuez un clic droit sur le libellé E-mail de pré-notification de prélèvement SEPA à destination del'acheteur.
3. Sélectionnez Gérer la règle dans le menu contextuel.
4. Dans Paramétrage e-mail acheteur, sélectionnez la langue de l'e-mail puis cliquez sur Restaurer desvaleurs de texte par défaut afin de personnaliser le contenu de l'e-mail.
Vous pouvez prévisualiser l'e-mail de pré-notification avant de sauvegarder vos modifications encliquant sur le bouton Prévisualiser l'e-mail situé en bas de la boîte de dialogue Gestion de la règle.
5. Cliquez sur Sauvegarder.
5.7. Importer les mandats de prélèvement SEPA
Il est possible d’importer des mandats de prélèvement SEPA.
Pour plus d’informations, veuillez contacter le support technique.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 29 / 186
6. ÉTABLIR LE DIALOGUE AVEC LA PLATEFORME DE PAIEMENT
Le dialogue avec la plateforme de paiement est décrit dans le Guide d'implémentation API Formulairedisponible sur le site documentaire.
Le dialogue entre le site marchand et la plateforme de paiement s’effectue par un échange de données.
Pour créer un paiement, ces données sont envoyées au moyen d'un formulaire HTML via le navigateurde l’acheteur.
A la fin du paiement, le résultat est transmis au site marchand de deux manières :
• automatiquement au moyen de notifications appelées URL de notification instantanée (égalementappelée IPN pour Instant Payment Notification).
• par le navigateur lorsque l’acheteur clique sur le bouton pour revenir au site marchand.
Pour assurer la sécurité des échanges, les données sont signées au moyen d’une clé connue uniquementdu marchand et de la plateforme de paiement.
6.1. Définir l'URL de la page de paiement
Le site marchand communique avec la plateforme de paiement en redirigeant l’acheteur vers l'URL cidessous.
https://secure.payzen.eu/vads-payment/
6.2. S'identifier lors des échanges
Pour dialoguer avec la plateforme de paiement, le marchand a besoin de deux informations :
• L’identifiant boutique : permet d'identifier le site marchand durant les échanges. Sa valeur esttransmise dans le champ vads_site_id.
• La clé: permet de calculer la signature alphanumérique transmise dans le champ signature.
Pour récupérer ces valeurs :
1. Connectez-vous à votre Back Office Marchand : https://secure.payzen.eu/vads-merchant/
2. Saisissez votre identifiant de connexion.
Votre identifiant de connexion vous a été communiqué par e-mail ayant pour objet Identifiants deconnexion - [nom de votre boutique].
3. Saisissez votre mot de passe.
Votre mot de passe vous a été communiqué par e-mail ayant pour objet Identifiants de connexion -[nom de votre boutique].
4. Cliquez sur Valider.
Au bout de 3 erreurs dans la saisie du mot de passe, le compte de l’utilisateur est bloqué. Cliquezalors sur Mot de passe oublié ou compte bloqué pour réinitialiser.
5. Cliquez sur Paramétrage > Boutique.
6. Sélectionnez l’onglet Clés.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 30 / 186
Image 8 : Onglet Clés
Deux types de clé sont mis à disposition :
• La clé de test qui permet de générer la signature d’un formulaire en mode test.
• La clé de production qui permet de générer la signature d'un formulaire en mode production.
Ces clés peuvent être numériques ou alphanumériques.
Pour un maximum de sécurité, il est recommandé d'utiliser une clé alphanumérique.
Pour changer le format de votre clé de test, cliquez sur le bouton Régénérer une clé de test, puissélectionnez le format ("ALPHANUMERIQUE" ou "NUMERIQUE").
Pour changer le format de votre clé de production, cliquez sur le bouton Régénérer une clé de production,puis sélectionnez "ALPHANUMERIQUE" ou "NUMERIQUE").
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 31 / 186
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 32 / 186
6.3. Choisir le mode Test ou Production
Le choix du mode TEST ou PRODUCTION s'effectue en utilisant le champ vads_ctx_mode (Voir chapitreGénérer un formulaire de paiement à la page 45).
• Le mode TEST permet de réaliser des paiements de test.
Il est toujours disponible, même après la génération de la clé de production.
Si vous créez un nouveau site marchand (ou disposez d’un environnement de recette), vous pourrezeffectuer vos tests sans impacter le site actuellement en production.
Les transactions de TEST sont visibles dans le Back Office Marchand depuis le menu Gestion >Transactions de TEST
• Le mode PRODUCTION n’est disponible qu’une fois la clé de production générée.
Il permet de réaliser des paiements réels.
Les transactions de PRODUCTION sont visibles dans le Back Office Marchand depuis le menu Gestion> Transactions.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 33 / 186
6.4. Gérer le dialogue vers le site marchand
La gestion du dialogue vers le site marchand est réalisée grâce à deux types d’URL :
• Url de notification instantanée, également appelée IPN (Instant Payment Notification),
• Url de retour vers le site marchand.
Url de notification instantanée - IPN (Instant Payment Notification)
La plateforme de paiement notifie automatiquement au site marchand le résultat du paiement. Lesdonnées sont envoyées en mode POST.
La plateforme est capable de contacter le site marchand quel que soit le protocole utilisé (http ou https).
Les notifications sont envoyées depuis une adresse IP comprise dans la plage 194.50.38.0/24 en modeTest et en mode Production.
Pour traiter ces notifications, le marchand doit créer une page sur son site qui :
• analyse les données reçues en mode POST,
• s’assure de l’intégrité des informations reçues en calculant la signature,
• vérifie qu’il ne s’agit pas d’un doublon de notification (renvoi de la notification depuis le Back OfficeMarchand par exemple),
• déclenche la mise à jour de sa base de données (état de la commande, stock, etc.),
• envoie des e-mails à l’acheteur (facture, suivi de commande, etc.).
Le temps de traitement influe directement sur le délai d’affichage de la page de résumé du paiement. Plusle traitement est long, plus l’affichage est retardé.
Pour recevoir les notifications, le marchand doit paramétrer les règles de notifications depuis son BackOffice Marchand (voir chapitre Paramétrer les notifications).
En cas de problème de communication vers le site marchand, la plateforme de paiement envoie un e-mailà l’administrateur de la boutique, précisant la raison de l’échec (erreur http, etc.) ainsi que la procédure àsuivre pour renvoyer la notification depuis le Back Office Marchand.
Url de retour vers le site marchand
Le marchand peut paramétrer dans le Back Office Marchand les URL de retour "par défaut" depuis le menuParamétrage > Boutique > onglet Configuration :
Image 9 : Spécification des URL de retour
Il peut configurer une URL de retour à la boutique différente en fonction du mode.
Par défaut, l'acheteur est redirigé vers l'URL de retour, et ce, quel que soit le résultat du paiement.
Si toutefois aucune URL n’est configurée à ce niveau, alors la redirection utilisera l'URL principale de laboutique (paramètre URL défini dans l'encadré Détails de la boutique).
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 34 / 186
Le marchand a la possibilité de surcharger cette configuration dans son formulaire de paiement (voirchapitre Définir les URL de retour).
Remarque :
Le statut de la règle "URL de notification à la fin du paiement" (IPN) est affiché dans cet écran. Si cettedernière est non paramétrée, veillez à la renseigner (voir chapitre Paramétrer les notifications).
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 35 / 186
6.5. Gérer la sécurité
Plusieurs moyens sont mis en place afin d’assurer la sécurité des transactions de paiement en ligne.
Garantir l'intégrité des échanges
L’intégrité des informations échangées est garantie par un échange de signatures alphanumériques entrela plateforme de paiement et le site marchand.
Le dialogue entre la plateforme de paiement et le site marchand s’effectue par soumission de formulairesHTML.
Un formulaire contient une liste de champs spécifiques (voir chapitre Générer un formulaire de paiement)utilisés pour générer une chaîne.
Cette chaîne est ensuite convertie en une chaîne d'une taille inférieure grâce à une fonction de hachage(SHA-1, HMAC-SHA-256).
Le marchand pourra choisir l'algorithme de hachage dans son Back Office Marchand (voir chapitreSélectionner l'algorithme de hachage).
La chaîne résultante est appelée empreinte (digest en anglais) de la chaîne initiale.
L'empreinte doit être transmise dans le champ signature (voir chapitre Calculer la signature).
Modélisation des mécanismes de sécurité :
Image 10 : Diagramme mécanisme de sécurité
1. Le site marchand construit les données du formulaire et calcule la signature.
2. Le site marchand envoie le formulaire à la plateforme.
3. La plateforme réceptionne les données du formulaire et calcule la signature avec les données reçues.
4. La plateforme compare la signature calculée avec la signature transmise par le site marchand.
5. Si les signatures diffèrent, la demande de paiement est rejetée.
Sinon, la plateforme procède au paiement.
6. La plateforme construit les données de la réponse et calcule la signature de la réponse.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 36 / 186
7. En fonction du paramétrage de la boutique (voir chapitre Paramétrer les notifications), la plateformetransmet le résultat du paiement au site marchand.
8. Le site marchand réceptionne les données et calcule la signature. Il compare la signature calculéeavec la signature transmise par la plateforme.
9. Si les signatures diffèrent, le marchand analyse l’origine de l’erreur (erreur dans le calcul, tentative defraude etc.)
Sinon, le site marchand procède à la mise à jour de sa base de données (état du stock, statut de lacommande etc.).
Sélectionner l'algorithme de hachage
Depuis le Back Office Marchand (menu Paramétrage > Boutique > Clés), le marchand a la possibilité dechoisir la fonction de hachage à utiliser pour générer les signatures.
Par défaut, c'est l'algorithme HMAC-SHA-256 qui sera appliqué.
Important
Vous pouvez sélectionner un algorithme différent pour le mode Test et pour le mode Production.
Veillez cependant à utiliser la même méthode pour générer vos formulaires de paiement et pour analyserles données transmises par la plateforme de paiement lors des notifications.
Afin de faciliter le changement d'algorithme, les signatures en SHA-1 ou en HMAC-SHA-256 serontacceptées sans générer de rejet pour erreur de signature pendant 24h.
Conserver la clé de production
Dès le premier paiement réalisé avec une carte réelle, la clé de production est masquée pour des raisonsde sécurité.
Nous vous conseillons fortement de conserver cette clé en lieu sûr (fichier chiffré, base de données etc.).
En cas de perte, le marchand aura la possibilité d’en générer une nouvelle depuis son Back OfficeMarchand.
Pour rappel, la clé de production est visible dans le Back Office Marchand depuis le menu Paramétrage> Boutique > onglet Clés.
Gérer les données sensibles
Des règles strictes régissent les transactions de paiement en ligne (Certification PCI-DSS).
En tant que marchand, vous devez vous assurer de ne jamais retranscrire en clair des données quipourraient s’apparenter à un numéro de carte bancaire. Votre formulaire serait rejeté (code 999 - Sensitivedata detected).
Evitez notamment les numéros de commandes de longueur comprise entre 13 et 16 caractères numériqueset commençant par 3, 4 ou 5.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 37 / 186
6.6. Afficher la page de paiement dans une iframePour plus de détails, consultez notre guide d'intégration des pages de paiement dans une iframedisponible sur notre site documentaire.
1. Créer une balise HTML <iframe> dans la page où vous souhaitez afficher le formulaire de saisie (cettepage devrait correspondre à l'étape "Paiement" de votre parcours d'achat):
...<body> <iframe id="idFrame" name="nameFrame" src="https://www.mystore.com/payment/form.php" /></body></html>
Valorisez l'attribut src avec l'URL de votre formulaire de paiement.
IMPORTANTPour un affichage correct des pages 3D-Secure, nous vous conseillons une taille minimum de 400px * 400px.
Exemple de page de paiement intégrée:
Exemple de page 3D Secure intégrée:
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 38 / 186
2. Modifier votre formulaire de paiement:
• valorisez le paramètre vads_action_mode à IFRAME pour activer le mode iframe et obtenir unaffichage épuré de la page de paiement,
• ajoutez l'attribut target à votre balise <form> et valorisez le avec le nom de votre iframe,
• en mode iframe, l'acheteur ne peut pas consulter ou télécharger le ticket de paiement. Ce dernierdoit être envoyé par email à l'acheteur. Le paramètre vads_cust_email devient donc indispensable,
• utilisez le champ vads_iframe_options si vous souhaitez personnaliser la couleur de fond et la policedes champs de saisie.
vads_iframe_options = {"fieldsBackgroundColor":"#000000","fieldsFontColor":"#FFFFFF"}
...<form method="POST" action="" target="nameFrame" > <input type="hidden" name="vads_action_mode" value="IFRAME" /> ......
3. Gérer la fin du paiement.
En mode iframe, il n'y a pas de bouton pour annuler ou pour retourner à la boutique. Vous pouveznéanmoins rediriger automatiquement l'acheteur vers votre page de confirmation de commande.
Pour cela, dans votre formulaire de paiement, valorisez les paramètres ci-dessous:
• vads_redirect_success_timeout et vads_redirect_error_timeout à "0",
• vads_url_success avec l'URL de votre page de confirmation de commande,
• vads_url_return avec l'URL de votre page de retour en cas de paiement refusé,
• vads_return_mode avec la valeur "POST" ou "GET" pour récupérer le résultat du paiement et lesafficher sur votre page de confirmation de commande si nécessaire,
• vads_theme_config avec la valeur "FORM_TARGET=_top" pour définir comment afficher la pagede retour.
Vous pouvez aussi utiliser les valeurs suivantes en fonction de votre besoin : "_self", "_parent","_framename".
Exemple de page de confirmation qui affiche les données du paiement
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 39 / 186
6.7. Paramétrer les délais encadrant l'émission d'un prélèvement SEPA
Vous pouvez modifier:
• Le délai entre la soumission du formulaire et la date d'échéance souhaitée (délai de remise),
• Le délai de pré-notification à destination du débiteur (acheteur).
Délai de remise
Modifiable depuis le Back Office Marchand (Menu Paramétrage > Boutique > Configuration).
Par défaut, le délai de remise est configuré à 0 jour.
Il peut être modifié via le formulaire de paiement (voir chapitre Modifier la date d'échéance souhaitéed'un prélèvement à la page 51 ).
Toute modification du délai entrainera la modification de la date de pré notification.
Délai de pré-notification
Modifiable uniquement sur demande auprès du service client.
Il est par défaut de 14 jours calendaires.
Sa valeur peut être comprise entre 14 et :
• 1 jour au minimum pour un prélèvement ponctuel ou pour le premier d'une série,
• 1 jour au minimum pour un prélèvement récurrent.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 40 / 186
7. CONFIGURER LES NOTIFICATIONS
Plusieurs types de notifications sont mises à disposition dans le Back Office Marchand. Elle permettent degérer les évènements (abandon par l'acheteur, annulation par le marchand, validation par le marchand...)qui génèreront l'envoi d'une notification vers le site marchand et de configurer l'URL de la page à contacter.
Si la plateforme n'arrive pas à joindre l'URL de votre page, alors un e-mail est envoyé à l'adresse e-mailspécifiée.
Il contient :
• Le code HTTP de l'erreur rencontrée
• Des éléments d'analyse en fonction de l'erreur
• Ses conséquences
• La procédure à suivre depuis le Back Office Marchand pour renvoyer la requête vers l’URL déjà définieplus haut.
Pour accéder à la gestion des règles de notification :
Allez dans le menu : Paramétrage > Règles de notifications.
7.1. Configurer la notification à la fin du paiement
Cette notification est indispensable pour communiquer le résultat d'une demande de paiement.
Dans votre Back Office Marchand, vous devez paramétrer une URL qui sera systématiquement appeléeaprès un paiement. Elle informera le site marchand du résultat du paiement même si votre client n’a pascliqué sur retour à la boutique.
Ce paramètre s’appelle URL de notification à la fin du paiement.
Pour paramétrer cette notification :
1. Effectuez un clic droit sur la ligne URL de notification à la fin du paiement.
2. Sélectionnez Activer la règle.
3. Effectuez à nouveau un clic droit sur URL de notification à la fin du paiement.
4. Sélectionnez Gérer la règle.
5. Renseignez l’URL de votre page dans les champs URL à appeler en mode TEST et URL à appeler enmode PRODUCTION.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 41 / 186
6. Renseignez le champ Adresse(s) e-mail(s) à avertir en cas d’échec.
7. Pour spécifier plusieurs adresses e-mails, séparez-les par un point-virgule.
8. Configurez le Rejeu automatique en cas d’échec.
Cette option permet de renvoyer automatiquement la notification vers le site marchand en casd'échec, et ce, jusqu'à 4 fois.
Pour plus d'informations, reportez-vous au chapitre
9. Sauvegardez vos modifications.
7.2. Configurer la notification en cas d'abandon/annulation
La plateforme de paiement peut notifier systématiquement le site marchand :
• En cas d’abandon/annulation de la part de l’acheteur, via le bouton Annuler et retourner à la boutique.
• Lorsque l'acheteur n'a pas terminé son paiement avant l'expiration de sa session de paiement.
La durée maximale d'une session de paiement est de 10 minutes.
Pour paramétrer cette notification :
1. Effectuez un clic droit sur la ligne URL de notification sur annulation.
2. Sélectionnez Gérer la règle.
3. Renseignez l’URL de votre page dans les champs URL à appeler en mode TEST et URL à appeler enmode PRODUCTION.
4. Renseignez Adresses(s) e-mail(s) à avertir en cas d’échec.
5. Pour spécifier plusieurs adresses séparez-les par un point-virgule.
6. Configurez le Rejeu automatique en cas d’échec.
Cette option permet de renvoyer automatiquement la notification vers le site marchand en casd'échec, et ce, jusqu'à 4 fois.
7. Sauvegardez vos modifications.
8. Effectuez à nouveau un clic droit sur la ligne URL de notification sur annulation
9. Sélectionnez Activer la règle.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 42 / 186
7.3. Configurer la notification pour valider les fichiers SEPA envoyés à labanque
La plateforme de paiement peut notifier systématiquement le marchand lorsqu'un fichier d'ordre deprélèvements/virements SEPA est envoyé à sa banque.
Cette notification a pour objectif d'aviser le marchand pour que ce dernier le valide auprès de sa banqueet ainsi recevoir l'argent. Le marchand doit, au préalable, se rapprocher de sa banque pour connaître leprocessus de validation.
Pour envoyer la notification :
• Configurer la notification par SMS
1. Sélectionnez l'onglet SMS envoyé au marchand.
2. Effectuez un clic droit sur SMS de confirmation d'envoi d'un fichier de prélèvements/virements.
3. Sélectionnez Gérer la règle.
La boîte de dialogue Gestion de la règle s'affiche.
4. Renseignez le numéro de téléphone à notifier dans l'onglet Paramétrage.
5. Cliquez sur Sauvegarder.
• Configurer la notification par e-mail
1. Sélectionnez l'onglet E-mail envoyé au marchand.
2. Effectuez un clic droit sur E-mail de confirmation d'envoi d'un fichier de prélèvements/virements.
3. Sélectionnez Gérer la règle.
La boîte de dialogue Gestion de la règle s'affiche.
4. Renseignez l'adresse e-mail à notifier dans l'onglet Paramétrage.
5. Cliquez sur Sauvegarder.
Remarque :
Vous pouvez personnaliser ces libellés ainsi que le contenu de ces messages.
Les noms des variables sont donnés à titre informatif. Respectez leur nommage si vous souhaitez les utiliser.
7.4. Activer le rejeu automatique
Cette option permet de renvoyer automatiquement la notification vers le site marchand en cas d'échec,et ce, jusqu'à 4 fois.
Une notification sera considérée en échec si le code retour HTTP renvoyé par le serveur marchand ne faitpas partie de la liste suivante: 200, 201, 202, 203, 204, 205, 206, 301, 302.
Les codes retours HTTP sont standardisés par le W3C dans le RFC 2616.
Le rejeu automatique ne s'applique pas aux notifications déclenchées manuellement depuis le BackOffice Marchand.
Pour activer le rejeu automatique :
1. Depuis le Back Office Marchand, allez dans le menu : Paramétrage > Règles de notifications.
2. Effectuez un clic droit sur une des règles de notifications affichées.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 43 / 186
3. Sélectionnez Gérer la règle.
4. Renseignez le champ Adresse(s) e-mail(s) à avertir en cas d’échec.
5. Pour spécifier plusieurs adresses e-mails, séparez-les par un point-virgule.
6. Configurez le Rejeu automatique en cas d’échec.
Les tentatives d'appel sont programmées à heures fixes toutes les 15 minutes (00, 15, 30, 45). Aprèschaque tentative infructueuse, un e-mail d'alerte est envoyé à l'adresse saisie précédemment.
L'objet de l'e-mail d'alerte contient le numéro de la tentative d'envoi de la notification. Il est présentésous la forme attempt # suivi du numéro de tentative.
Exemple d'objet d'un e-mail d'alerte reçu suite au premier échec de notification à la fin d'unpaiement :
[MODE TEST] Ma Boutique - Tr. réf. 067925 / ECHEC lors de l'appel de votre URL de notification [unsuccessful attempt #1]
Exemple d'objet d'e-mail reçu lors d'un deuxième échec :
[MODE TEST] Ma Boutique - Tr. réf. 067925 / ECHEC lors de l'appel de votre URL de notification [unsuccessful attempt #2]
Exemple d'objet d'e-mail reçu lors d'un troisième échec :
[MODE TEST] Ma Boutique - Tr. réf. 067925 / ECHEC lors de l'appel de votre URL de notification [unsuccessful attempt #3]
Pour notifier au site marchand l'échec de la dernière tentative de notification, l'objet de l'e-mailcomportera la mention attempt #last.
Exemple d'objet d'e-mail reçu lors de la dernière tentative :
[MODE TEST] Ma Boutique - Tr. réf. 067925 / ECHEC lors de l'appel de votre URL de notification [unsuccessful attempt #last]
Pour chacun des e-mails reçus, le contenu de l'e-mail détaillera :
• le problème rencontré
• des éléments d'analyse en fonction de l'erreur
• ses conséquences
• la procédure à suivre depuis le Back Office Marchand pour renvoyer la requête vers l’URL définie àl’étape 4
Remarque :
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 44 / 186
Après la quatrième tentative, il est toujours possible de rejouer l'URL de notification manuellementdepuis votre Back Office Marchand.
Attention, pendant la période de rejeu automatique, tout appel manuel à l'URL de notificationinfluera sur le nombre de tentatives automatiques :
• un appel manuel réussi provoquera l'arrêt du rejeu automatique
• un appel manuel en échec n'aura aucun impact sur le rejeu automatique en cours.
7. Sauvegardez vos modifications.
Remarque :
Lors du rejeu automatique, certaines informations ne sont pas enregistrées en base de données ou sontmodifiées.
Exemples de champs non disponibles / non enregistrés en base de données :
• vads_page_action
• vads_payment_config
• vads_action_mode
Exemples de champs envoyés avec des valeurs différentes :
• vads_url_check_src valorisé à RETRY
• vads_trans_status.Le statut de la transaction suite à cette opération varie en fonction de son statut au moment où l'URLest appelée
• vads_hash valorisé différemment en tenant compte des nouvelles valeurs
• signature valorisé différemment en tenant compte des nouvelles valeurs
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 45 / 186
8. GÉNÉRER UN FORMULAIRE DE PAIEMENT
Pour générer une demande de paiement, vous devez construire un formulaire html comme suit :
<form method="POST" action="https://secure.payzen.eu/vads-payment/"> <input type="hidden" name="parametre1" value="valeur1" /> <input type="hidden" name="parametre2" value="valeur2" /> <input type="hidden" name="parametre3" value="valeur3" /> <input type="hidden" name="signature" value="signature"/> <input type="submit" name="payer" value="Payer"/></form>
Il contient :
Les éléments techniques suivants :
• Les balises <form> et </form> qui permettent de créer un formulaire HTML.
• L’attribut method="POST" qui spécifie la méthode utilisée pour envoyer les données.
• L’attribut action="https://secure.payzen.eu/vads-payment/" qui spécifie où envoyer les données duformulaire.
Les données du formulaire :
• L’identifiant de la boutique.
• Les caractéristiques du paiement en fonction du cas d’utilisation.
• Les informations complémentaires en fonction de vos besoins.
• La signature qui assure l'intégrité du formulaire.
Ces données sont ajoutées au formulaire en utilisant la balise <input> :
<input type="hidden" name="parametre1" value="valeur1" />
Pour valoriser les attributs name et value, référez-vous au Dictionnaire de données disponible égalementsur le site documentaire.
Toutes les données du formulaire doivent être encodées en UTF-8.
Les caractères spéciaux (accents, ponctuation etc.) seront ainsi correctement interprétés par la plateformede paiement. Dans le cas contraire, le calcul de signature sera erroné et le formulaire sera rejeté.
Le bouton Payer qui va permettre l’envoi des données :
<input type="submit" name="payer" value="Payer"/>
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 46 / 186
Des cas d’utilisation sont présentés dans les chapitres suivants. Ils vous permettront de construire votreformulaire de paiement en fonction de vos besoins.
Le tableau suivant vous donne des indications sur les différents formats que vous pourrez rencontrer lorsde la construction de votre formulaire.
Notation Description
a Caractères alphabétiques (de ‘A’ à ‘Z’ et de ‘a’ à ‘z’)
n Caractères numériques
s Caractères spéciaux
an Caractères alphanumériques
ans Caractères alphanumériques et spéciaux (à l'exception de "<" et ">")
3 Longueur fixe de 3 caractères
..12 Longueur variable jusqu’à 12 caractères
json JavaScript Object Notation.Objet contenant des paires de clé/valeur séparées par une virgule.Il commence par une accolade gauche " { et se termine par une accolade droite " } ".Chaque paire clé/valeur contient le nom de la clé entre double-quotes suivi par " : ", suivi par une valeur.Le nom de la clé doit être alphanumérique.La valeur peut être :
• une chaine de caractères (dans ce cas elle doit être encadrée par des doubles-quotes)
• un nombre
• un objet
• un tableau
• un booléen
• vide
Exemple: {"name1":45,"name2":"value2", "name3"=false}
enum Caractérise un champ possèdant un nombre fini de valeurs.La liste des valeurs possibles est donnée dans la définition du champ.
liste d'enum Liste de valeurs séparées par un " ; ".La liste des valeurs possibles est donnée dans la définition du champ.Exemple: vads_payment_cards=VISA;MASTERCARD
map Liste de paires clé/valeur séparées par un " ; ".Chaque paire clé/valeur contient le nom de la clé suivi par " = ", suivi par une valeur.La valeur peut être :
• une chaine de caractères
• un booléen
• un objet json
• un objet xml
La liste des valeurs possibles pour chaque paire de clé/valeur est donnée dans la définition du champ.Exemple: vads_theme_config=SIMPLIFIED_DISPLAY=true;RESPONSIVE_MODEL=Model_1
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 47 / 186
8.1. Effectuer une demande de prélèvement unique
Dans le cas d'un encaissement par prélèvement unique, l'acheteur autorise le marchand à prélever latotalité de son achat en une seule fois.
1. Utilisez l'ensemble des champs présents dans le tableau ci-après pour construire votre formulaire depaiement.
Nom du champ Description Valeur
vads_site_id Identifiant de la boutique Ex : 12345678
vads_ctx_mode Mode de fonctionnement TEST ou PRODUCTION
vads_trans_id Numéro de la transaction Ex : 123456
vads_trans_date Date et heure UTC du formulaire de paiement Ex : 20160129130025
vads_amount Montant du paiement dans sa plus petite unitémonétaire
Ex : 3000 pour 30,00 EUR
vads_currency Code de la devise Ex : 978 pour l'euro (EUR)
vads_action_mode Mode d’acquisition des données bancaires. INTERACTIVE
vads_page_action Action à réaliser PAYMENT
vads_version Version du protocole d’échange V2
vads_payment_config Type de paiement SINGLE
vads_capture_delay Délai avant remise en banque 0
vads_cust_email Adresse e-mail de l’acheteur.Remarque :Lorsque l'adresse e-mail de l'acheteur est pré-renseignée sur la page de paiement, l'acheteurne peut la modifier lors de la signature dumandat.Si l'adresse e-mail n'est pas connue, l'acheteursera invité à la renseigner sur la page depaiement.
Ex : [email protected]
Tableau 4 : Liste des champs - Paiement par prélèvement SDD One Off
2. Valorisez le champ vads_page_action à PAYMENT dans le cas d’un encaissement par prélèvementponctuel.
3. Valorisez le champ vads_payment_config à SINGLE.
Le paiement par prélèvement SDD n’est pas compatible avec le mode MULTI.
4. Valorisez le champ vads_action_mode à INTERACTIVE.
Le prélèvement SDD n’est pas compatible avec le mode SILENT.
5. Valorisez le champ vads_currency à 978 (code de la devise euro).
Seule la devise euro est acceptée pour ce moyen de paiement.
6. Valorisez le champ vads_capture_delay à 0 pour que le transfert de fonds soit effectué au maximum14 jours calendaires après l’achat.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 48 / 186
7. Si vous souhaitez pré-renseigner des champs avec des informations déjà connues, utilisez l'ensembledes champs optionnels présents dans le tableau ci-après pour construire votre formulaire depaiement :
Nom du champ Description Valeur
vads_cust_title Permet de définir la civilité de l’acheteur. Ex :
• M.
• Mme
• Mlle
vads_cust_last_name Permet de définir le nom de l’acheteur. Ex : Dupont
vads_cust_first_name Permet de définir le prénom de l’acheteur. Ex : Jean
vads_cust_cell_phone Numéro de téléphone portable de l'acheteur pour l'envoi ducode de sécurité (par SMS).Remarque :Lorsque le numéro de téléphone portable de l'acheteur (numérode téléphone enregistré lors d'une inscription) est pré-renseignésur la page de paiement, l'acheteur ne peut le modifier lors de lasignature du mandat. Seul le titulaire du GSM ayant enregistréce numéro de téléphone lors de son inscription peut recevoir parSMS ce code d'accès à usage unique.Si le numéro de téléphone portable de l'acheteur n'est pasconnu, l'acheteur sera invité à le renseigner sur la page depaiement.
Ex : 0612345678
vads_cust_address Adresse de l'acheteurRemarqueL'adresse est requise si le client possède un compte bancairedans les départements, territoires ou pays suivants : Suisse,Monaco, Saint-Marin, Mayotte, Saint-Pierre-et-Miquelon,Guernesey, Jersey, Île de Man.
vads_cust_country Permet de spécifier le code du pays de l’acheteur à la norme ISO3166.
Ex : FR
IMPORTANTSi la valeur du champ vads_cust_cell_phone est fournie dans un format international (+336xxxxxxxx) ou si leschamps vads_cust_cell_phone et vads_cust_country sont tous les deux valorisés, alors le code de sécurité serasystématiquement envoyé par SMS indépendamment du mode de signature paramétré au niveau de la boutique.
8. Si vous souhaitez pré-renseigner le ou les moyens de paiement affichés, valorisez le champ optionnelvads_payment_cards.
Remarque :
• Si la liste ne contient qu'un moyen de paiement, la page de saisie des données de ce moyen depaiement sera directement présentée.
Pour proposer le prélèvement SEPA, la valeur attendue est SDD.
• Sinon la page de sélection des moyens de paiement sera présentée.
• Si ce paramètre est vide (conseillé) alors tous les moyens de paiement éligibles (en fonction de ladevise, du montant min ou max, des contraintes techniques comme la présence des données panier,adresse porteur, adresse de livraison, etc.) associés à la boutique seront proposés.
9. Ajoutez les champs optionnels en fonction de vos besoins (voir chapitre Utiliser des fonctionscomplémentaires).
10.Calculez la valeur du champ signature en utilisant l'ensemble des champs de votre formulaire, dont lenom commence par vads_ (voir chapitre Calculer la signature).
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 49 / 186
Exemple de formulaire:
<form method="POST" action="https://secure.payzen.eu/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="2990" /> <input type="hidden" name="vads_capture_delay" value="0" /> <input type="hidden" name="vads_ctx_mode" value="TEST" /> <input type="hidden" name="vads_currency" value="978" /> <input type="hidden" name="vads_cust_country" value="FR" /> <input type="hidden" name="vads_cust_email" value="[email protected]" /><input type="hidden" name="vads_cust_first_name" value="Paul" /> <input type="hidden" name="vads_cust_last_name" value="Juve" /> <input type="hidden" name="vads_cust_title" value="M." /> <input type="hidden" name="vads_page_action" value="PAYMENT" /> <input type="hidden" name="vads_payment_config" value="SINGLE" /> <input type="hidden" name="vads_site_id" value="91335531" /> <input type="hidden" name="vads_trans_date" value="20160716080441" /> <input type="hidden" name="vads_trans_id" value="362812" /> <input type="hidden" name="vads_validation_mode" value="0" /> <input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="86b2a17b9a5fcefb6c0120c57b25ec86ad1704ee"/><input type="submit" name="payer" value="Payer"/></form>
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 50 / 186
9. UTILISER DES FONCTIONS COMPLÉMENTAIRES
Pour obtenir un formulaire personnalisé et adapté à vos besoins, vous pouvez utiliser des fonctionscomplémentaires parmi la liste ci-dessous :
• Pré-remplir le formulaire de saisie
• Personnaliser la RUM
• Activer le retour automatique vers le site marchand à la fin du paiement
• Modifier la date d'échéance d'un prélèvement
• Gérer les URL de retour vers le site marchand
D’autres fonctionnalités sont présentées dans le guide d'implémentation API Formulaire. Elles vouspermettront de construire facilement votre formulaire de paiement.
9.1. Personnaliser la RUM
Par défaut la RUM est générée par la plateforme de paiement.
Cependant, le marchand peut générer et transmettre la valeur en respectant les conditions suivantes:
• La valeur doit être transmise dans le champ vads_identifier.
• Le marchand doit s’assurer de l’unicité de la RUM.
Toute demande de prélèvement ponctuel ou récurrent réalisée sur une RUM existante engendrera uneerreur et l’affichage d’un message d’incident technique.
• Longueur : jusqu’à 35 caractères.
• Caractères autorisés :
• a b c d e f g h i j k l m n o p q r s t u v w x y z
• A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
• 0 1 2 3 4 5 6 7 8 9 / - ? : ( ) . , ' +
• L’espace n’est pas un caractère autorisé.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 51 / 186
9.2. Modifier la date d'échéance souhaitée d'un prélèvement
Par défaut, dans le Back Office Marchand :
• Le délai de remise est configuré à 0 jour,
• Le délai de pré notification est configuré à 14 jours.
Avec cette configuration :
• La date de pré notification sera à J,
• La date d’échéance souhaitée (date de remise) sera à J+14,
Cette configuration peut être modifiée directement dans le Back Office Marchand.
Elle peut être aussi surchargée dans le formulaire en valorisant le paramètre vads_capture_delay avecune valeur supérieure au délai de pré-notification.
Exemple :
Valeur du délai de capture Date de pré notification Date d'échéance souhaitée
0 J J+14
7 J J+14
15 J+1 J+15
Tableau 5 : Exemples de valorisations du champ vads_capture_delay
Attention, en modifiant cette valeur, vous influencez directement la date de remise et la date de pré-notification.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 52 / 186
9.3. Activer le retour automatique vers le site marchand
Le marchand peut indiquer dans son formulaire s’il souhaite rediriger automatiquement le navigateur del’acheteur vers le site marchand à la fin du paiement.
Si vous utilisez un code de tracking (Google AnalyticsTM ou autre) sur votre site, vous devez implémentercette fonctionnalité.
1. Utilisez les champs facultatifs ci-dessous en fonction de vos besoins.
Nom du champ Description
vads_redirect_success_timeout Définit le délai d’attente avant redirection après un paiement réussi.Ce délai est exprimé en seconde et doit être compris entre 0 et 300 secondes.
vads_redirect_success_message Définit le message d’attente avant la redirection après un paiement réussi.
vads_redirect_error_timeout Définit le délai d’attente avant redirection après un paiement refusé.Ce délai est exprimé en seconde et doit être compris entre 0 et 300 secondes.
vads_redirect_error_message Définit le message d’attente avant la redirection après un paiement refusé.
Remarque
Si vous choisissez un timeout à zéro votre redirection s'effectuera de la manière suivante :
• Pour un paiement accepté, l'acheteur sera redirigé vers vads_url_success.
• Pour un paiement annulé, l'acheteur sera redirigé vers vads_url_cancel si le paramètre est défini.
• Si le paramètre n'est pas renseigné, l'acheteur sera redirigé vers l’URL de retour renseignée dansle champ vads_url_return ou vers l’URL de retour renseignée dans le Back Office Marchand.
• Si l’URL de retour n'est pas définie, il sera redirigé vers l’URL de la boutique.
• Pour un paiement refusé, l'acheteur sera redirigé vers vads_url_refused si le paramètre est défini.
• Si le paramètre n'est pas renseigné, l'acheteur sera redirigé vers l’URL de retour renseignée dansle champ vads_url_return ou vers l’URL de retour renseignée dans le Back Office Marchand.
• Si l’URL de retour n'est pas définie, il sera redirigé vers l’URL de la boutique.
2. Valorisez le champ vads_return_mode à GET .
Exemple de formulaire de paiement :
<form method="POST" action="https://secure.payzen.eu/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="978" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_redirect_error_message" value="Vous allez être redirigé vers votre site marchand" /><input type="hidden" name="vads_redirect_error_timeout" value="0" /><input type="hidden" name="vads_redirect_success_message" value="Vous allez être redirigé vers votre site marchand" /><input type="hidden" name="vads_redirect_success_timeout" value="0" /><input type="hidden" name="vads_return_mode" value="GET" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20190626101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_url_return" value="http://demo.com/return.php" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="AzTJmizS5N0muYzu63nVvCUWo0ixnMJfpqQmuEa4CSY="/><input type="submit" name="payer" value="Payer"/></form>
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 53 / 186
9.4. Gérer le retour vers le site marchand
A la fin du paiement, le navigateur de l’acheteur peut être redirigé vers une URL définie par le marchand.Cette URL est appelée URL de retour.
A ne pas confondre avec l’URL de notification instantanée (également appelée IPN) (voir chapitre Gérerle dialogue vers le site marchand).
Définir les URL de retour
Dans le formulaire de paiement, le marchand peut surcharger la configuration du Back Office Marchand.Pour cela il peut:
• Utiliser 4 URL différentes en fonction du résultat du paiement:
• Paiement accepté
• Paiement refusé
• Paiement abandonné
• Paiement en erreur
• Utiliser une seule URL quel que soit le résultat du paiement.
Définir les URL de retour en fonction du résultat du paiement
Utilisez les champs facultatifs présentés dans le tableau ci-dessous pour concevoir le formulaire depaiement adapté à vos besoins.
Si aucune URL n’est valorisée dans le formulaire, la valeur configurée dans le Back Office Marchandsera prise en compte.
Nom du champ Description Format Valeur
vads_url_cancel URL où sera redirigé l’acheteur après appuisur "annuler et retourner à la boutique" avantd'avoir procédé au paiement
ans..1024Ex: http://demo.com/cancel.php
vads_url_error URL où sera redirigé l’acheteur en cas d'erreurde traitement par la plateforme de paiement
ans..1024Ex: http://demo.com/error.php
vads_url_refused URL où sera redirigé l’acheteur, en cas de refusdu paiement, après appui sur "retourner à laboutique"
ans..1024Ex: http://demo.com/refused.php
vads_url_success URL où sera redirigé l’acheteur, en cas desuccès du paiement, après appui sur "retournerà la boutique"
ans..1024Ex: http://demo.com/success.php
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 54 / 186
Exemple de formulaire de paiement avec définition d'URL de retour en fonction du résultat du paiement:
<form method="POST" action="https://secure.payzen.eu/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="978" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20190626101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_url_cancel" value="http://demo.com/cancel.php" /><input type="hidden" name="vads_url_error" value="http://demo.com/error.php" /><input type="hidden" name="vads_url_refused" value="http://demo.com/refused.php" /><input type="hidden" name="vads_url_success" value="http://demo.com/success.php" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="lZIHzigiwCc6+uLStp8I5DQnbSqXu63Jtfo6Saeq3Mc="/><input type="submit" name="payer" value="Payer"/></form>
Définir une URL de retour unique quelque soit le résultat du paiement
Utilisez le champ facultatif vads_url_return pour définir l’url de redirection à la fin du paiement.
Si aucune URL n’est valorisée dans le formulaire, la valeur configurée dans le Back Office Marchandsera prise en compte.
Exemple de formulaire de paiement avec une URL de retour unique quelque soit le résultat du paiement:
<form method="POST" action="https://secure.payzen.eu/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="978" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20190626101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_url_return" value="http://demo.com/return.php" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="ZI/GhI0GbeqqoXGeoZuPOy55SKQSYzRO1i6r5ku6vOs="/><input type="submit" name="payer" value="Payer"/></form>
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 55 / 186
Définir la méthode de réception des données
Pour des besoins de statistiques ou pour afficher des pages personnalisées, le site marchand doit pouvoiranalyser certaines données transmises au navigateur de l'acheteur.
Par défaut, la plateforme de paiement ne transmet aucune donnée lors de la redirection vers l'URL deretour.
Le site marchand peut cependant activer l'envoi des données à l'URL de retour via le formulaire depaiement.
Utilisez le champ facultatif vads_return_mode pour indiquer la méthode de transmission desdonnées vers le site marchand.
Valeur Description
Absent, vide ou NONE Aucune donnée n'est transmise.
GET Les données sont transmises dans l’URL du navigateur.
POST Les données sont transmises par formulaire HTTP POST.
La méthode GET permet d'éviter l’affichage d’un message d'avertissement lorsque le retour se fait surun environnement non sécurisé (http).
Exemple de formulaire de paiement avec définition du mode de transmission des données :
<form method="POST" action="https://secure.payzen.eu/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="978" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_return_mode" value="GET" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20190626101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_url_return" value="http://demo.com/return.php" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="oTCT+7Oc+xttdGmcp9qa6/0pSSfNxoMtl8U1J1l+LtE="/><input type="submit" name="payer" value="Payer"/></form>
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 56 / 186
10. CALCULER LA SIGNATURE
Afin de pouvoir calculer la signature vous devez être en possession :
• de la totalité des champs dont le nom commence par vads_
• du type d'algorithme choisi dans la configuration de la boutique
• de la clé
La valeur de la clé est disponible dans votre Back Office Marchand depuis le menu Paramétrage > Boutique> onglet Clés.
Le type d'algorithme est défini dans votre Back Office Marchand depuis le menu Paramétrage > Boutique> onglet Configuration.
Pour un maximum de sécurité, il est recommandé d'utiliser l'algorithme HMAC-SHA-256 ainsi qu'une cléalphanumérique.
Pour calculer la signature :
1. Triez les champs dont le nom commence par vads_ par ordre alphabétique.
2. Assurez-vous que tous les champs soient encodés en UTF-8.
3. Concaténez les valeurs de ces champs en les séparant avec le caractère "+".
4. Concaténez le résultat avec la clé de test ou de production en les séparant avec le caractère "+".
5. Selon l'algorithme de signature défini dans la configuration de votre boutique:
a. si votre boutique est configurée pour utiliser "SHA-1", appliquez la fonction de hachage SHA-1 surla chaîne obtenue à l'étape précédente.
b. si votre boutique est configurée pour utiliser "HMAC-SHA-256", calculez et encodez au formatBase64 la signature du message en utilisant l'algorithme HMAC-SHA-256 avec les paramètressuivants:
• la fonction de hachage SHA-256,
• la clé de test ou de production (en fonction de la valeur du champ vads_ctx_mode) comme clépartagée,
• le résultat de l'étape précédente comme message à authentifier.
6. Sauvegardez le résultat de l'étape précédente dans le champ signature.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 57 / 186
Exemple de paramètres envoyés à la plateforme de paiement:
<form method="POST" action="https://secure.payzen.eu/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="5124" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="978" /> <input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20170129130025" /><input type="hidden" name="vads_trans_id" value="123456" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="ycA5Do5tNvsnKdc/eP1bj2xa19z9q3iWPy9/rpesfS0= " /> <input type="submit" name="payer" value="Payer"/></form>
Cet exemple de formulaire s'analyse de la manière suivante:
1. On trie par ordre alphabétique les champs dont le nom commence par vads_ :
• vads_action_mode
• vads_amount
• vads_ctx_mode
• vads_currency
• vads_page_action
• vads_payment_config
• vads_site_id
• vads_trans_date
• vads_trans_id
• vads_version
2. On concatène la valeur de ces champs avec le caractère "+" :
INTERACTIVE+5124+TEST+978+PAYMENT+SINGLE+12345678+20170129130025+123456+V2
3. On ajoute la valeur de la clé de test à la fin de la chaîne en la séparant par le caractère "+". Dans cetexemple, la clé de test est 1122334455667788
INTERACTIVE+5124+TEST+978+PAYMENT+SINGLE+12345678+20170129130025+123456+V2+1122334455667788
4. Si vous utilisez l’algorithme SHA-1, appliquez le à la chaîne obtenue.
Le résultat à transmettre dans le champ signature est :59c96b34c74b9375c332b0b6a32e6deeec87de2b
5. Si votre boutique est configurée pour utiliser "HMAC-SHA-256", calculez et encodez au format Base64la signature du message en utilisant l'algorithme HMAC-SHA-256 avec les paramètres suivants:
• la fonction de hachage SHA-256,
• la clé de test ou de production (en fonction de la valeur du champ vads_ctx_mode) comme clépartagée,
• le résultat de l'étape précédente comme message à authentifier.
Le résultat à transmettre dans le champ signature est :
ycA5Do5tNvsnKdc/eP1bj2xa19z9q3iWPy9/rpesfS0=
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 58 / 186
11. ENVOYER LA DEMANDE DE PAIEMENT
Pour chaque transaction, l’acheteur doit être redirigé vers la page de paiement afin de finaliser son achat.
Son navigateur doit transmettre les données du formulaire de paiement.
11.1. Rediriger l'acheteur vers la page de paiement
L’URL de la plateforme de paiement est la suivante :
https://secure.payzen.eu/vads-payment/
Exemple de paramètres envoyés à la plateforme de paiement:
<form method="POST" action="https://secure.payzen.eu/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /> <input type="hidden" name="vads_amount" value="2990" /> <input type="hidden" name="vads_ctx_mode" value="TEST" /> <input type="hidden" name="vads_currency" value="978" /><input type="hidden" name="vads_cust_country" value="FR" /><input type="hidden" name="vads_cust_email" value="[email protected]" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /> <input type="hidden" name="vads_site_id" value="12345678" /> <input type="hidden" name="vads_trans_date" value="20190626101407" /> <input type="hidden" name="vads_trans_id" value="362812" /> <input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="NM25DPLKEbtGEHCDHn8MBT4ki6aJI/ODaWhCzCnAfvY="/><input type="submit" name="payer" value="Payer"/></form>
11.2. Gérer les erreurs
Si la plateforme détecte une anomalie lors de la réception du formulaire, un message d’erreur sera affichéet l’acheteur ne pourra pas procéder au paiement.
En mode TEST
Le message indique l’origine de l’erreur et propose un lien vers la description du code erreur pour vousaider à identifier les causes possibles.
En mode PRODUCTION
Le message indique simplement à l’acheteur qu’un problème technique est survenu.
Dans les deux cas, le marchand reçoit un e-mail d'avertissement.
Il contient :
• l’origine de l’erreur,
• un lien vers les causes possibles pour ce code d'erreur pour faciliter le diagnostic,
• l’ensemble des champs contenus dans le formulaire.
Une description des codes d'erreur avec leurs causes possibles est disponible sur notre site.
https://payzen.io/fr-FR/error-code/error-00.html
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 59 / 186
12. ANALYSER LE RÉSULTAT DU PAIEMENT
Pour traiter le résultat des paiements, le site marchand doit disposer d'un script sur une page dédiée(exemple : analyse_paiement.php).
Cette page sera appelée automatiquement après chaque paiement (accepté ou refusé) : les paramètresliés au résultat du paiement sont envoyés en mode POST par la plateforme de paiement.
Prérequis :
• L'URL de la page qui analyse le résultat du paiement devra obligatoirement être renseignée dans leBack Office Marchand). Voir chapitre Configurer les notifications
• Le marchand doit s'assurer que cette URL soit joignable par la plateforme de paiement et ce, sansredirection.
Les redirections entrainent la perte des données présentes dans le POST.
• En cas de restriction mise en place du côté du site marchand, il faudra autoriser la plage d'adressesd'IP 194.50.38.0/24.
Les notifications sont envoyées depuis une adresse IP comprise dans la plage 194.50.38.0/24 en modeTest et en mode Production.
• La page ne devra pas comporter d'affichage HTML.
L'accès aux ressources telles que les images ou feuilles de styles peuvent ralentir les échanges entre laplateforme de paiement et le site marchand.
De plus, la plateforme lit systématiquement les 512 premiers caractères retournés par le site marchand.
Ces caractères sont ensuite affichés dans l'historique des transactions.
• Evitez au maximum d'intégrer des tâches consommatrices de temps comme la génération de factureou l'envoi d'e-mail dans ce script.
Le temps du traitement influe directement sur le délai de l’affichage de la page de résumé du paiement.Plus le traitement de la notification est long, plus l’affichage est retardé.
Au delà de 35s, la plateforme considèrera que l'appel a échoué (timeout).
Echec de notification (IPN)
En cas d'échec de l'appel à l’URL de notification (IPN), un e-mail d'avertissement est envoyé à l’adressespécifiée dans le Back Office Marchand (voir chapitre Paramétrer les notifications).
Il contient :
• le code HTTP de l’erreur rencontrée,
• des éléments d’analyses en fonction de l’erreur,
• la procédure à suivre depuis le Back Office Marchand pour renvoyer la notification.
Concevoir le script de traitement
Le script de traitement devra comporter au moins les étapes ci-dessous:
• Récupérer la liste des champs présents dans la réponse envoyée en POST
• Calculer la signature
• Comparer la signature calculée avec celle réceptionnée
• Analyser la nature de la notification
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 60 / 186
• Récupérer le résultat du paiement
Le script peut par exemple tester l'état de la commande (ou l'information de votre choix) pour vérifierqu'elle n'ait pas déja été mise à jour.
Une fois ces étapes réalisées, le script peut mettre à jour la base de données (nouvel état de la commande,mise à jour du stock, enregistrement des informations du paiement etc.).
12.1. Récupérer les données retournées dans la réponse
Les données retournées dans la réponse dépendent des paramètres envoyés dans le formulaire depaiement, du type de paiement réalisé et des options de votre boutique. Ces données constituent une listede champs. Chaque champ contient une valeur réponse. La liste de champs peut être amenée à évoluer.
Les données sont toujours envoyées en POST par la plateforme de paiement.
La première étape consiste donc à récupérer le contenu reçu en mode POST.
Exemples :
• En PHP, les données seront stockées dans la superglobale $_POST.
• En ASP.NET (C#), vous devez utiliser la propriété Form de la classe HttpRequest.
• En java, vous devez utiliser la méthode getParameter de l'interface HttpServletRequest.
Le script devra effectuer une boucle pour récupérer la totalité des champs transmis.
Exemple de données envoyées lors de la notification d’un prélèvement ponctuel :
vads_amount= 2990vads_auth_mode= FULLvads_auth_number= vads_auth_result= 00vads_capture_delay= 6vads_card_brand= SDDvads_card_number= FR7630002005701234567890158_CRLYFRPPvads_payment_certificate= vads_ctx_mode= TESTvads_currency= 978vads_effective_amount= 2990vads_site_id= 91335531vads_trans_date= 20160812102855vads_trans_id= 426085vads_validation_mode= 0vads_version= V2vads_warranty_result= NOvads_payment_src= ECvads_cust_email= [email protected]_cust_title= M.vads_cust_name= Paul Juvevads_sequence_number= 1vads_contract_used= FR7630002005701234567890158vads_trans_status= AUTHORISEDvads_identifier_status= CREATEDvads_pays_ip= FRvads_presentation_date= 20140818103142vads_effective_creation_date= 20160812103104vads_identifier= 20160812zVNOcOvads_operation_type= DEBITvads_threeds_enrolled= vads_threeds_cavv= vads_threeds_eci= vads_threeds_xid= vads_threeds_cavvAlgorithm= vads_threeds_status= vads_threeds_sign_valid= vads_threeds_error_code= 4vads_threeds_exit_status= 4vads_result= 00vads_trans_uuid= 1cd9994823334e31bbb579b4d716832dvads_extra_result= 00
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 61 / 186
vads_card_country= vads_language= frvads_hash= 3894b953f1ab44d70aa3a29120a0dd2ec802c1c6cbd3ffa4353b927a894dfc4fvads_url_check_src= PAYvads_action_mode= INTERACTIVEvads_payment_config= SINGLEvads_page_action= PAYMENTsignature= N1tBWwRk64s/7SPKZYieJ6a82X8b5gYg7iA+Bhp8ZTI=
Récupérer les données lors de la notification instantanée
Les données sont toujours envoyées en POST par la plateforme de paiement.
Parmi les informations transmises :
• le champ vads_url_check_src précise la règle de notification appliquée :
Valeur Règle appliquée
PAY URL de notification appelé à la fin du paiement.
BO Exécution de la notification à la fin du paiement depuis le Back Office Marchand.
BATCH_AUTO URL de notification appelée lors de la demande d’autorisation sur un paiement qui était dans unstatut "En attente d’autorisation".Non applicable pour le prélèvement ponctuel.
REC URL de notification appelée pour les paiements issus d'une récurrence (option abonnement).Non applicable pour le prélèvement ponctuel.
MERCH_BO URL de notification appelée lors d'une opération réalisée depuis le Back Office.
Tableau 6 : Valorisations du champ vads_url_check_src
Vous devez tester sa valeur pour identifier la nature de la notification.
• le champ vads_hash représentant une clé unique associée à la transaction.
Ces deux champs ne seront pas envoyés lors du retour à la boutique.
Récupérer les données lors du retour à la boutique
Par défaut aucune donnée ne sera envoyée par le navigateur.
Cependant, en fonction de la configuration utilisée, (voir chapitre Définir le mode de transmission desdonnées), les paramètres pourront être envoyés par le navigateur:
• Soit en GET : paramètres présents dans l’url sous la forme : ?param1=valeur1¶m2=valeur2.
• Soit en POST : paramètres envoyés dans un formulaire POST.
Les paramètres retournés sont identiques à ceux transmis à l’url de notification, excepté les deux champsspécifiques vads_url_check_src et vads_hash.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 62 / 186
12.2. Calculer la signature de l'IPN
La signature se calcule selon la même logique utilisée lors de la création du formulaire de paiement.
IMPORTANT
Les données transmises par la plateforme de paiement sont encodées en UTF-8. Toute altération des données reçuesaboutira à un calcul de signature erroné.
Vous devez calculer la signature avec les champs reçus dans la notification et pas ceux que vous avez transmis dans votreformulaire de paiement.
Pour calculer la signature:
1. Prenez en considération la totalité des champs dont le nom commence par vads_.
2. Triez ces champs par ordre alphabétique.
3. Concaténez les valeurs de ces champs en les séparant avec le caractère "+".
4. Concaténez le résultat avec la clé de test ou de production en les séparant avec le caractère "+".
5. Selon l'algorithme de signature défini dans la configuration de votre boutique:
a. si votre boutique est configurée pour utiliser "SHA-1", appliquez la fonction de hachage SHA-1 surla chaîne obtenue à l'étape précédente.
b. si votre boutique est configurée pour utiliser "HMAC-SHA-256", calculez et encodez au formatBase64 la signature du message en utilisant l'algorithme HMAC-SHA-256 avec les paramètressuivants:
• la fonction de hachage SHA-256,
• la clé de test ou de production (en fonction de la valeur du champ vads_ctx_mode) comme clépartagée,
• le résultat de l'étape précédente comme message à authentifier.
12.3. Comparer les signatures
Pour s’assurer de l’intégrité de la réponse, vous devez comparer la valeur du champ signature reçue dansla réponse, avec celle calculée à l’étape "Calculer la signature de l'IPN.
IMPORTANTIl ne faut pas comparer la signature de l'IPN avec la signature que vous avez transmis dans votre formulaire.
Si les signatures correspondent,
• alors vous pouvez considérer la réponse comme sûre et procéder à la suite de l’analyse.
• sinon, le script devra lever une exception et avertir le marchand de l'anomalie.
Les signatures ne correspondent pas en cas :
• d’erreur d'implémentation (erreur dans votre calcul, problème d’encodage UTF-8, etc.),
• d’erreur dans la valeur de la clé utilisée ou dans celle du champ vads_ctx_mode (problème fréquentlors du passage en production),
• de tentative de corruption des données.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 63 / 186
12.4. Analyser la nature de la notification
Le champ vads_url_check_src permet de différencier les notifications en fonction de leur évènementdéclencheur :
• création d'un mandat (avec ou sans souscription à un abonnement).
• création d'une transaction.
• renvoi de la notification depuis le Back Office Marchand par le marchand.
Il précise la règle de notification appliquée :
Valeur Règle appliquée
PAY La valeur PAY est envoyée dans les cas suivants :
• paiement immédiat (paiement comptant ou première échéance d'un paiement en plusieurs fois)
• paiement différé à moins de 7 jours
• paiement abandonné ou annulé par l'acheteuruniquement si le marchand a configuré la règle URL de notification sur annulation.
BO Exécution de la notification depuis le Back Office Marchand (clic droit sur une transaction > Exécuterl'URL de notification).
BATCH La valeur BATCH est envoyée dans le cas de la mise à jour du statut d'une transaction aprèssynchronisation auprès de l'acquéreur.Uniquement si le marchand a configuré la règle URL de notification sur modification par batch.
BATCH_AUTO La valeur BATCH_AUTO est envoyée dans les cas suivants:
• paiement différé à plus de 7 jours
• échéances d'un paiement en plusieurs fois (hormis la première)uniquement si le marchand a configuré la règle URL de notification sur autorisation par batch.
La notification est envoyée lors de la demande d’autorisation d'un paiement dont le statut est "Enattente d’autorisation".Non applicable pour le prélèvement ponctuel.
REC La valeur REC est envoyée uniquement pour les paiements par abonnement si le marchand aconfiguré la règle URL de notification à la création d'un paiement récurrent.Non applicable pour le prélèvement ponctuel.
MERCH_BO La valeur MERCH_BO est envoyée :
• lors d'une opération réalisée depuis le Back Office Marchand (annulation, remboursement,modification, validation, duplicata, création et/ou mise à jour d'alias), si le marchand a configuréla règle de notification : URL de notification sur une opération provenant du Back Office
RETRY Rejeu automatique de l’URL de notification.
Tableau 7 : Valeurs associées au champ vads_url_check_src
En testant sa valeur, le script peut réaliser un traitement différent en fonction de la nature de lanotification.
Par exemple :
Si vads_url_check_src est valorisé à PAY ou BATCH_AUTO alors le script met à jour le statut de lacommande, ...
Si vads_url_check_src est valorisé à REC alors le script récupère la référence de l'abonnement etincrémente le nombre d'échéances échues en cas de paiement accepté, ...
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 64 / 186
12.5. Analyser le résultat du paiement
Le statut de la transaction permet de connaitre rapidement le résultat du paiement :
Il est renvoyé dans le champ vads_trans_status :
Valeur Description
AUTHORISED Accepté, en attente de remiseLa pré-notification a été envoyée. Le prélèvement est enattente de présentation à la banque.
ABANDONED Paiement abandonné par l’acheteur.La transaction n’est pas créée et n’est donc pas visible dansle Back Office Marchand.
REFUSED RefuséStatut retourné en cas de paiement par identifiant lorsqu'ona défini des règles dans la gestion des risques ou lorsque lemandat a expiré.
AUTHORISED_TO_VALIDATE À valider et autoriserLa demande de prélèvement a été réalisée en mode"validation manuelle". Le marchand doit valider la transactionmanuellement dans son Back Office Marchand pour autoriserl’envoi du mandat à la banque.La pré-notification ne sera envoyée qu’après validation de latransaction.Un processus automatique d’envoi d’e-mail s’opère tous lesjours et ce, plusieurs fois par jour (toutes les 3 heures) sansaucune intervention de votre part.La transaction peut être validée tant que la date d'expirationde la demande d'autorisation n’est pas dépassée. Si cettedate est dépassée alors le paiement prend le statut EXPIRED.Le statut Expiré est définitif.
WAITING_AUTHORISATION En attente d'autorisationLa pré-notification n’est pas encore envoyée.La demande de prélèvement est réalisée avec un délai deremise supérieur ou égal à 7 jours pour un paiement ponctuellorsque le contrat a un délai de pré-notification de 14 jours.
WAITING_AUTHORISATION_TO_VALIDATE A valider et autoriserLe délai de remise en banque est supérieur à la durée devalidité de l'autorisation.Le marchand doit valider manuellement la transaction afinque la demande d’autorisation et la remise aient lieu.
Dans le cas d’un paiement refusé, vous pouvez affiner l’analyse du résultat en vérifiant les élémentssuivants :
• Le motif du rejet par la banque.
• Résultat des contrôles associés à la fraude.
12.6. Récupérer les détails du mandat
Les principaux détails du mandat sont renvoyés dans les champs:
Champ Description
vads_identifier Renvoie la Référence Unique du Mandat.Cette valeur sera utilisée pour l'échange de fichiers.
vads_card_number Renvoie l'IBAN et le BIC (s'il est renseigné), séparés par un "_".Le BIC est optionnel, il peut ne pas être présent.
vads_presentation_date Renvoie la date d'échéance souhaitée.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 65 / 186
Champ DescriptionElle est exprimée au format YYYYmmDDhhmmss dans le fuseau horaire UTC( 20140818103142) ou GMT+0 (et non pas GMT+1 ou GMT+2 suivant l'heure d'été oud'hiver).
Tableau 8 : Champs dans l'analyse de la réponse
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 66 / 186
13. OPÉRATIONS SUR LES TRANSACTIONS
Votre Back Office Marchand met à disposition un certain nombre d'opérations sur les transactionscorrespondant au prélèvement SEPA SDD.
Dans la liste des transactions :
1. Sélectionnez un prélèvement SEPA.
2. Effectuez un clic droit pour afficher la liste des opérations autorisées.
Les chapitres suivants vont détailler les :
• Opérations indisponibles.
• Opérations autorisées.
13.1. Identifier les opérations indisponibles
Les opérations suivantes ne sont pas permises dans le cas d'un paiement de type SDD :
• Dupliquer
• Modifier
13.2. Identifier les opérations autorisées
Les opérations autorisées sont les suivantes:
• Annuler
• Valider
• Editer la référence de la commande
Permet de modifier le numéro de commande.
• Exécuter l'URL de notification
Permet de renvoyer la notification de fin de paiement vers le site marchand lorsque l’appel initial aéchoué.
• Renvoyer l'e-mail de confirmation de la transaction au marchand et Renvoyer l'e-mail deconfirmation de la transaction à l'acheteur
Permet de renvoyer les e-mails de confirmation de paiement marchand ou acheteur.
• Remboursement par virement
Permet de procéder à un remboursement par virement depuis le Back Office Marchand.
Pour cela, il est nécessaire d'activer les flux SCT (virements) sur votre connexion EBICS auprès de votrebanque.
• Résilier
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 67 / 186
14. ACTIVER LA BOUTIQUE EN MODE PRODUCTION
Ce chapitre vous détaille de quelle manière vous pouvez :
• Générer la clé de production.
• Basculer votre site marchand en production.
• Réaliser un premier paiement en production.
• Régénérer la clé de production (en cas de problème).
14.1. Générer la clé de production
Vous pouvez générer la clé de production depuis le menu Paramétrage > Boutique > Onglet Clés > boutonGénérer la clé de production.
Une fois la clé de production générée, sa valeur apparaît sous l'onglet Clés.
Un e-mail est envoyé à l'interlocuteur en charge du dossier (responsable administratif de la société) pourlui confirmer la génération de la clé de production.
14.2. Basculer votre site marchand en production
Passage en production:
• La variable vads_ctx_mode doit être valorisée à PRODUCTION dans votre formulaire.
• La variable qui contient votre certificat doit être modifiée avec le certificat de production.
• Renseignez correctement l’URL de notification instantannée (IPN) en mode PRODUCTION dans l’ongletParamétrage > Boutique > onglet Configuration.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 68 / 186
14.3. Réaliser un premier paiement en production
Il est conseillé au marchand d'effectuer une transaction réelle afin de vérifier le fonctionnement de bout-en-bout en environnement de production. Cette transaction pourra être, par la suite, annulée depuis leBack Office Marchand de la solution de paiement.
Les transactions sont désormais consultables en visualisation via le Back Office Marchand (menu Gestion> Transactions, situé en haut à gauche de l’interface).
Vérifier le bon fonctionnement de l’url de notification (IPN) renseignée dans le Back Office Marchand, sanscliquer sur le bouton Retour à la boutique.
14.4. Regénérer la clé de production
En cas de perte ou de corruption de la clé de production, le marchand a la possibilité de générer unenouvelle clé depuis son Back Office Marchand. Pour cela :
1. Dans le Back Office Marchand, sélectionnez Paramétrage > Boutique > onglet Clés.
2. Cliquez sur Générer à nouveau.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 69 / 186
15. DICTIONNAIRE DE DONNÉES
Le dictionnaire de données présente la liste complète des champs pouvant être utilisés dans le formulairede paiement.
Il détaille tout d'abord les principales catégories (telles que les informations techniques, les informationssur la commande...). L'ensemble des champs appartenant à une catégorie sont présentés.
Ces tableaux sont présentés de la manière suivante :
• Nom du champ : nom du paramètre, tel qu'il sera utilisé dans une requête HTTP
• Format : format des données
• Description : description du champ
• Entrée : caractérise un champ à transmettre dans la requête
• Sortie : caractérise un champ transmis dans la réponse
Le dictionnaire de données présente ensuite le détail pour chacun des champs. Chaque champ est décritde la manière suivante :
• Description : description du champ
• Format : format des données (voir tableau Liste champs et formats ci-dessus)
• Valeurs possibles : valeurs attendues lorsque le champ doit être valorisé avec des valeurs spécifiques
• Exemple : exemple de codage correct des données
• Code erreur : en cas d’erreur dans l’interfaçage entre le site marchand et la plateforme de paiement,cette dernière indiquera par un code numérique le paramètre fautif dans le champ vads_extra_result
• Remarque : information complémentaire, précision
• Catégorie : catégorie à laquelle est affilié le champ
Précisions sur les codes erreur :
Code erreur correspond au numéro de l’erreur lors de la soumission d’un formulaire de paiement incorrect.
• En mode test ce code sera affiché sur la page de paiement.
• En mode production un e-mail d’alerte sera envoyé en précisant le code erreur et le nom duparamètre incorrect.
Exemple : Erreur 09 correspond à une erreur sur le montant. Le montant envoyé ne respecte donc pasle format requis.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 70 / 186
Visualiser les paramètres classés par catégorie
Référez-vous à la catégorie souhaitée pour obtenir la liste des paramètres sous-jacents.
• Informations sur l'authentification 3DS
• Informations sur l'abonnement
• Informations sur l'acheteur
• Informations sur le moyen de paiement
• Informations sur la commande
• Informations sur la livraison
• Informations techniques
• Informations sur la transaction
• Personnalisation de la page de la page de paiement
• Redirection automatique
Informations techniques
Nom du champ Format Description Entrée Sortie
signature an40Signature garantissant l'intégrité desrequêtes échangées entre le site marchandet la plateforme de paiement.
x x
vads_action_mode enum Mode d’acquisition des données de la carte x x
vads_override_payment_cinematic enumCinématique de paiement à appliquer.Surcharge la valeur enregistrée sur lecontrat.
x
vads_contrib ans..128Nom de la solution e-commerce utilisée surle site marchand ainsi que son numéro deversion.
x x
vads_ctx_mode enumMode de communication avec laplateforme de paiement
x x
vads_extra_result n2Code complémentaire de réponse. Sasignification dépend de la valeur renseignéedans vads_result.
x
vads_hash an64Clé unique renvoyée uniquement à l’URLde notification (IPN).
x
vads_page_action enum Définit l'opération à réaliser. x x
vads_payment_error n..3 Codes d'erreur sur un paiement refusé. x
vads_result n2Code retour général du résultat dupaiement.
x
vads_site_id n8 Identifiant de la boutique x x
vads_url_check ans..1024URL de la page à notifier à la fin dupaiement. Surcharge la valeur saisie dans leparamétrage des règles de notification.
x
vads_url_check_src enumCe paramètre définit l’origine de l’appelURL de notification (IPN Server).
x
vads_version enumVersion du protocole d’échange avec laplateforme de paiement
x x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 71 / 186
Informations sur la commande
Nom du champ Format Description Entréé Sortie
vads_authent_paypal_protection_eligibilityenum
Type de protection des marchands envigueur pour la transaction.
x
vads_ext_info
ans
Champs personnalisables permettantd'ajouter des données supplémentairesdans l'e-mail de confirmation envoyé aumarchand et dans l'URL de notification.
x x
vads_ext_info_soft_descriptorans
Permet de personaliser le nom de lamarque
x
vads_nb_products n..12 Nombre d’articles présents dans le panier x
vads_order_id ans..64 Numéro de commande x x
vads_order_infoan..255
Informations supplémentaires sur lacommande
x x
vads_order_info2an..255
Informations supplémentaires sur lacommande
x x
vads_order_info3an..255
Informations supplémentaires sur lacommande
x x
vads_pretax_amount n..12Montant hors taxe de l’ensemble de lacommande
x
vads_product_amountNn..12
Montant de l’article. N correspond à l'indicede l'article (0 pour le premier, 1 pour lesecond...)
x
vads_product_ext_idN
an..100
Code barre du produit dans le site webdu marchand. N correspond à l'indice del'article (0 pour le premier, 1 pour lesecond...)
x
vads_product_labelNan..255
Libellé de l’article. N correspond à l'indicede l'article (0 pour le premier, 1 pour lesecond...)
x
vads_product_qtyNn..12
Quantité d’article. N correspond à l'indicede l'article (0 pour le premier, 1 pour lesecond...)
x
vads_product_refNan..64
Référence de l’article. N correspond àl'indice de l'article (0 pour le premier, 1 pourle second...)
x
vads_product_typeNenum
Type de l’article. N correspond à l'indicede l'article (0 pour le premier, 1 pour lesecond...)
x
vads_product_vatNn..12
TVA de l'article. N correspond à l'indicede l'article (0 pour le premier, 1 pour lesecond...)
x
vads_tax_amount n..12Montant des taxes pour l’ensemble de lacommande
x
vads_tax_rate enum Taux de TVA appliqué sur la commande x x
vads_totalamount_vat n..12Montant global des taxes pour l’ensemblede la commande
x x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 72 / 186
Informations sur l'acheteur
Nom du champ Format Description Entrée Sortie
vads_avs_result a1 Address verification system (AVS) x
vads_cust_address ans..255 Adresse postale x x
vads_cust_address_number ans..64 Numéro de rue x x
vads_cust_address2 ans..255 Deuxième ligne d'adresse x x
vads_cust_cell_phone an..32 Numéro de téléphone mobile x x
vads_cust_city an..128 Ville x x
vads_cust_countrya2
Code pays suivant la norme ISO 3166alpha-2
x x
vads_cust_district ans..127 Quartier x x
vads_cust_email ans..150 Adresse e-mail de l’acheteur x x
vads_cust_first_name ans..63 Prénom x x
vads_cust_idan..63
Référence de l’acheteur sur le sitemarchand
x x
vads_cust_last_name ans..63 Nom x x
vads_cust_legal_name an..100 Raison sociale de l'acheteur x
vads_cust_name an..127Utilisez vads_cust_first_name etvads_cust_last_name.
x x
vads_cust_national_id ans..255 Identifiant national x x
vads_cust_phone an..32 Numéro de téléphone x x
vads_cust_state ans..127 Etat / Région x x
vads_cust_status enum Statut x x
vads_cust_title an..63 Civilité de l’acheteur x x
vads_cust_zip an..64 Code postal x x
vads_ext_info_bil_address_complement ans..250 Complément d'adresse pour la facturation x
vads_ext_info_bil_date_of_birthDatetime
Date de naissance de l'acheteur sur lafacture
x
vads_ext_info_bil_gendern1
Précision du genre de l'acheteur sur lafacture
x
vads_ext_info_fingerprint_id string Identifiant unique de session x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 73 / 186
Informations sur la livraison
Nom du champ Format Description Entrée Sortie
vads_ext_info_deadlinen
Précision du délai de livraison en jour (Njours)
x
vads_ext_info_ship_address_complement ans..250 Complément d'adresse pour la livraison x
vads_ext_info_ship_date_of_birthDatetime
Date de naissance de l'acheteur pour lalivraison
x
vads_ext_info_ship_gendern1
Précision du genre de l'acheteur pour lalivraison
x
vads_ship_to_city an..128 Ville x x
vads_ship_to_country a2 Code pays suivant la norme ISO 3166 x x
vads_ship_to_delayenum
Délai de livraison, obligatoire pour unelivraison prioritaire
x
vads_ship_to_delivery_company_name ans..127 Nom du transporteur x
vads_ship_to_district ans..127 Quartier x x
vads_ship_to_first_name ans..63 Prénom x
vads_ship_to_last_name ans..63 Nom x
vads_ship_to_legal_name an..100 Raison sociale x
vads_ship_to_nameans..63
Déprécié. Nom de l’acheteur.Utilisez vads_ship_to_first_name etvads_ship_to_last_name.
x x
vads_ship_to_phone_num ans..32 Numéro de téléphone x x
vads_ship_to_speed enum Rapidité de livraisondesc_ship_to x
vads_ship_to_state ans..127 Etat / Région x x
vads_ship_to_status enum Définit le type d'adresse de livraison x x
vads_ship_to_street ans..255 Adresse postale x x
vads_ship_to_street_number an..5 Numéro de rue x x
vads_ship_to_street2 ans..255 Deuxième ligne d’adresse x x
vads_ship_to_type enum Type de transport x
vads_ship_to_user_infoans..255
Informations sur l'acheteur (Identifiantlégal CPF/CNPJ)
x x
vads_ship_to_zip an..64 Code postal x x
vads_shipping_amount n..12 Montant des frais de livraison x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 74 / 186
Informations sur le moyen de paiement
Nom du champ Format Description Entrée Sortie
vads_bank_code n5 Code banque associé à la banque émettrice. x
vads_bank_productan..3
Code produit de la carte utilisée pour lepaiement.
x
vads_birth_day n..2 Jour de naissance du porteur. x
vads_birth_month n..2 Mois de naissance du porteur. x
vads_birth_year n4 Année de naissance du porteur. x
vads_card_brand an..127 Type de carte utilisé pour le paiement. x x
vads_card_countrya2
Code alpha-2 (ISO 3166) du pays de la carteutilisée pour le paiement.
x
vads_card_number n..36 Numéro de carte masqué. x
vads_card_holder_nameans..255
Ce champ correspond au nom du porteur decarte.
x
vads_expiry_monthn..2
Mois d'expiration de la carte utilisée pour lepaiement.
x
vads_expiry_yearn4
Année d'expiration de la carte utilisée pourle paiement.
x
vads_proof_of_id_numberan..13
Champ réservé à la saisie du numéro de lapièce d'identité de l'acheteur sur la page depaiement.
x
vads_proof_of_id_typeenum
Ce champ correspond au type de pièced'identité sélectionné par l'acheteur.
x
vads_brand_management
json
Ce champ indique au marchand :
• si l'acheteur a utilisé une autre marqueque celle définie par défaut par lemarchand
• la marque choisie par l'acheteur
• la liste des marques disponibles
x
vads_walletan..127
Permet au marchand d'identifier le type dewallet qui a servi pour le paiement.
x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 75 / 186
Informations sur la transaction
Nom du champ Format Description Entrée Sortie
vads_acquirer_transient_datajson
Informations spécifiques propres àl'acquéreur.
x
vads_amountn..12
Montant de la transaction exprimé dans laplus petite unité de la devise (le centimepour l'euro) .
x x
vads_auth_mode enum Mode réalisée la demande d’autorisation. x
vads_auth_numberan..6
Numéro d'autorisation retourné par leserveur bancaire.
x
vads_auth_resultan..11
Code retour de la demande d'autorisationretournée par la banque émettrice.
x
vads_authent_nsuans..255
Numéro de Séquence Unique. Utilisé enAmérique Latine.
x
vads_capture_delayn..3
Délai en nombre de jours avant remise enbanque.
x
vads_change_ratestring
Taux de change utilisé pour calculer lemontant réél du paiement (paiement multi-devise).
x
vads_contract_used ans..250 Contrat commerçant utilisé. x
vads_contracts map Contrat commerçant à utiliser. x
vads_currencyn3
Code numérique de la monnaie à utiliserpour le paiement.
x x
vads_effective_amount
n..12
Montant du paiement exprimé dans laplus petite unité de la devise utilisée poureffectuer la remise en banque (le centimepour l'euro) .
x
vads_effective_creation_daten14
Date d'enregistrement de la transaction,dans le fuseau UTC (ou GMT+0) au formathoraire 24h (AAAAMMJJHHMMSS).
x
vads_effective_currencyn3
Devise dans laquelle la remise en banque vaêtre effectuée.
x
vads_ext_trans_id enum Réference externe de transaction. x
vads_first_installment_delayn..3
Nombre de mois de différé à utiliser sur lapremière échéance lors d'un paiement enplusieurs échéances.
x
vads_operation_typeenum
Type d'opération : débit, crédit(remboursement), vérification.
x
vads_payment_cards listed'enum
Liste des moyens de paiement à proposer àl’acheteur.
x
vads_payment_certificatean40
Champ valorisé par la plateforme depaiement dans le cas où l’autorisation a étéréalisée avec succès.
x
vads_payment_configenum
Type du paiement : comptant ou enplusieurs fois.
x x
vads_payment_option_code an..5 Code de l'option de paiement utilisée. x x
vads_payment_seq json Séquence d'un paiement fractionné. x
vads_payment_srcenum
Mode de saisie des données du moyen depaiement.
x x
vads_presentation_date n14 Date de remise en banque demandée. x
vads_requestorenum
Pour modifier la valeur du champ "Aceite"sur un Boleto Bancario
x x
vads_sequence_numbern..3
Numéro de séquence de la transaction(numéro d'échéance).
x
vads_token_id an..32 Identifiant de l'ordre de paiement associé àla transaction.
x
vads_trans_daten14
Date et heure, dans le fuseau UTC(ou GMT+0) au format horaire 24h(AAAAMMJJHHMMSS).
x x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 76 / 186
Nom du champ Format Description Entrée Sortie
vads_trans_id n6 Identifiant unique d'une transaction. x x
vads_trans_status enum Statut de la transaction. x
vads_trans_uuidans32
Référence unique de la transaction généréepar la plateforme de paiement.
x
vads_validation_mode n1 Mode de validation de la transaction. x x
vads_warranty_resultenum
Transfert de responsabilité dans le cas d’unpaiement accepté.
x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 77 / 186
Authentification 3DS
Nom du champ Format Description Entrée Sortie
vads_threeds_auth_type
enum
Désigne le type d’authentificationdu porteur (CHALLENGE ouFRICTIONLESS) . Retourné uniquementlorsque l’acheteur s’est correctementauthentifié (vads_threeds_status vaut « Y »ou « A »).
x
vads_threeds_cavv
ans..28
Désigne la vérification de l’authentificationdu porteur par l’ACS.Il est valorisé par le serveurd’authentification 3DS (ACS) lorsquel’acheteur s’est correctement authentifié(vads_threeds_status vaut « Y » ou « A »).
x
vads_threeds_cavvAlgorithm
n1
Algorithme utilisé par l’ACS pour générerla valeur du cavv.Il est valorisé par le serveurd’authentification 3DS (ACS) lorsquel’acheteur s’est correctement authentifié(vads_threeds_status vaut « Y » ou « A »).
x
vads_threeds_eci
n..2
Désigne l’Indicateur de CommerceElectronique.Il est valorisé par le serveurd’authentification 3DS (ACS) lorsquel’acheteur s’est correctement authentifié(vads_threeds_status vaut « Y » ou « A »).
x
vads_threeds_enrolled
a1
Désigne le statut de l’enrôlement duporteur.Il est valorisé par les serveurs VISA etMASTERCARD (DS) durant le processus 3DSecure
x
vads_threeds_error_coden..2
Deprécié.Utilisez vads_threeds_exit_status.
x
vads_threeds_exit_status
n..2
Désigne le statut final du processus 3DSecure.Il est valorisé par la plateforme depaiement.
x
vads_threeds_mpin1
Active / désactive le processus 3DS lors d’unpaiement e-commerce
x
vads_threeds_sign_valid
n1
Désigne la validité de la signature dumessage PARes.Il est valorisé par la plateforme depaiement.
x
vads_threeds_status
a1
Désigne le statut de l’authentification duporteur.Il est valorisé par le serveurd’authentification 3DS (ACS) durant leprocessus 3D Secure.
x
vads_threeds_xid
ans..28
Désigne la référence unique de latransaction 3DS.Il est valorisé par le serveurd’authentification (ACS) durant leprocessus 3D Secure.
x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 78 / 186
Personnalisation de la page de paiement
Nom du champ Format Description Entrée Sortie
vads_available_languages listed'enum
Permet de spécifier les langues disponiblessur la page de paiement sous forme de liste.
x x
vads_language a2Définit la langue dans laquelle est affichéela page de paiement (norme ISO 639-1).
x x
vads_iframe_options json Permet de personnaliser la couleur de fondet la police des champs de saisie en modeiframe.
x
vads_shop_name
ans..127
Permet de définir le nom de la boutique quiapparait dans les e-mails de confirmationde paiement et sur le récapitulatif de latransaction.
x x
vads_shop_urlans..1024
Permet de surcharger l'URL de la boutiquequi apparait sur la page de paiement et lese-mails de confirmation de paiement.
x x
vads_theme_config mapPermet de personnaliser certains élémentsde la page de paiement.
x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 79 / 186
Redirection vers le site marchand
Nom du champ Format Description Entrée Sortie
vads_redirect_error_message
ans..255
Redirection automatique :Message affiché sur la page de paiementavant redirection vers le site marchanddans le cas d'un paiement refusé /accepté.
x
vads_redirect_error_timeout
n..3
Redirection automatique :Délai ( en secondes ) avant redirectionvers le site marchand après un paiementrefusé / accepté.
x
vads_redirect_success_message
ans..255
Redirection automatique :Spécifie le message à la fin d’un paiementaccepté dans le cas d’une redirectionautomatique vers le site marchand.
x
vads_redirect_success_timeout
n..3
Redirection automatique :Délai en secondes avant redirection versle site marchand à la fin d’un paiementaccepté. Sa valeur est comprise entre 0 et600s.
x
vads_return_modeenum
Permet de spécifier le mode detransmission des données aux URLs deretour vers le site marchand.
x
vads_url_cancel
ans..1024
URL où sera redirigé l’acheteur si celui-ci appuie sur " annuler et retourner àla boutique " avant d'avoir procédé aupaiement.
x
vads_url_checkans..1024
URL de la page à notifier à la fin dupaiement. Surcharge la valeur saisie dans leparamétrage des règles de notification.
x
vads_url_check_srcenum
Ce paramètre définit l'évènementdéclencheur de la notification instantanée(aussi appelée IPN ou URL de notification).
x
vads_url_error ans..1024URL où sera redirigé l’acheteur en casd'erreur de traitement interne.
x
vads_url_post_walletans..1024
URL sur laquelle sera rappelée le marchanden cas d'utilisation de wallet lors dupaiement.
x x
vads_url_refused ans..1024URL où sera redirigé l’acheteur en cas derefus
x
vads_url_returnans..1024
URL par défaut où sera redirigé l'acheteursi celui-ci appuie sur "retourner à laboutique".
x
vads_url_success ans..1024URL où sera redirigé l’acheteur en cas desuccès.
x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 80 / 186
Informations sur l'abonnement
Nom du champ Format Description Entrée Sortie
vads_identifier ans..50Identifiant unique associé à un moyen depaiement.
x x
vads_identifier_status enum Statut de l'enregistrement du mandat. x
vads_recurrence_number n..2 Numéro de l'échéance de l'abonnement. x
vads_recurrence_status enum Statut de la création d'une récurrence.
vads_sub_amount
n..12
Montant des échéances de l’abonnementpour toutes les échéances, hormiscelles éventuellement définies parvads_sub_init_amount_number
x
vads_sub_currencyn3
Code numérique de la monnaie à utiliserpour l’abonnement, selon la norme ISO4217.
x x
vads_sub_descans..255
Règle de récurrence à appliquer suivant laspécification iCalendar RFC5545.
x x
vads_sub_effect_date n8 Date d'effet de l'abonnement. x x
vads_sub_init_amountn..12
Montant des échéances de l’abonnementpour les premières échéances.
x x
vads_sub_init_amount_numbern..3
Nombre d’échéances auxquelles ilfaudra appliquer le montantvads_sub_init_amount.
x x
vads_subscription ans..50 Identifiant de l'abonnement à créer. x x
Informations sur l'analyse de risques
Nom du champ Format Description Entrée Sortie
vads_risk_analysis_resultenum
Résultat de l'analyse de fraude effectuépar un système externe (ClearSale,CyberSource,...).
x
vads_risk_assessment_resultenum
Résultat de l'analyse de gestion des risquesavancée effectuée par la plateforme depaiement.
x
vads_risk_control map Résultat des contrôles associés à la fraude. x
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 81 / 186
signature
Description Paramètre obligatoire.
Permet de vérifier l’intégrité des requêtes transmises.
Sa valeur est calculée :
• par le site marchand lors de la demande de paiement
• par la plateforme de paiement lors de la réponse.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an40
Code erreur 00 - signature lorsque la valeur de ce champ est incorrecte.
70-empty params si le champ est absent ou si ce dernier est posté à vide.
Erreurs fréquentes:
• Les différents champs du formulaire n'ont pas été encodés en UTF-8.
• Le MODE (test ou production) ou la clé utilisée est incorrecte.
• Retour à la ligne et/ou retour chariot postés dans le formulaire.
• Caractère guillemets ["] posté dans le formulaire.
• Le type d'algorithme de calcul utilisé n'est pas le bon
• La signature envoyée ne répond pas à la régle de calcul de signature.
Catégorie Informations techniques.
vads_acquirer_transient_data
Description Permet de transmettre des informations spécifiques à un ou plusieurs réseaux.
Remarque
Une erreur sera renvoyée dès la soumission du formulaire si la valeur saisie nerespecte pas les règles établies par l'acquéreur.
Pour une transaction Conecs, ce champ permet de transmettre le montant éligibleen Titre-Restaurant.
Champ d'entrée.
Format json
Valeurs possibles Pour une transaction par titre-restaurant Conecs, le format JSON attendu est lesuivant :vads_acquirer_transient_data ={"CONECS":{"eligibleAmount":"1725"}}
Codes erreurs 130, 133, 134, 135, 136, 137
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 82 / 186
vads_action_mode
Description Paramètre obligatoire.
Mode d’acquisition des informations de la carte.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Code erreur 47
Valeurs possibles INTERACTIVE: saisie des informations de la carte sur la page de paiement de laplateforme de paiement.
IFRAME : saisie des informations de la carte sur une page de paiement simplifiée etallégée que le marchand peut imbriquer dans la page web de son choix.
Catégorie Informations techniques.
vads_amount
Description Montant de la transaction exprimé dans la plus petite unité de la monnaie ou devise(le centime pour l'euro) .
Exemple : pour une transaction de 10 EUR et 28 centimes, la valeur du paramètreest 1028.
Le formulaire de paiement sera rejeté dans les cas suivants :
• Un montant égal à zéro [vads_amount=0],
• Un montant négatif [vads_amount=-100],
• Un montant composé de décimales ou de points [vads_amount=100.50]
• Un formulaire sans le champ vads_amount (absence de montant).
Un message d’incident technique sera associé à un code retour 09(vads_extra_result).
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..12
Code erreur 09
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 83 / 186
vads_auth_mode
Description Spécifie de quelle manière est réalisée la demande d’autorisation.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Valeurs possiblesFULL : correspond à une autorisation du montant total de la transaction.
Valeur utilisée dans le cas d’un paiement comptant, si la durée séparant la date deremise demandée de la date du jour est strictement inférieure à la durée de validitéde l'autorisation.
MARK : correspond à une autorisation de 1 EUR (ou demande de renseignement surle réseau CB si l'acquéreur le supporte).
Valeur utilisée dans le cas d'un paiement différé, si la durée séparant la date deremise demandée de la date du jour est strictement supérieure à la durée de validitéde l'autorisation.
Catégorie Informations sur la transaction.
vads_auth_number
Description Numéro d'autorisation retourné par le serveur bancaire, si disponible (sinon vide).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..6
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 84 / 186
vads_auth_result
Description Code retour de la demande d'autorisation retournée par la banque émettrice, sidisponible.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..3
Valeurs possibles
Valeur DescriptionMotiffrauduleux
Valeur DescriptionMotiffrauduleux
00 Transaction approuvée ou traitéeavec succès
38 Date de validité de la carte dépassée
02 Contacter l’émetteur de carte 41 Carte perdue OUI
03 Accepteur invalide OUI 43 Carte volée OUI
04 Conserver la carte OUI 51 Provision insuffisante ou créditdépassé
05 Ne pas honorer OUI 54 Date de validité de la carte dépassée OUI
07 Conserver la carte, conditionsspéciales
OUI 55 Code confidentiel erroné
08 Approuver après identification 56 Carte absente du fichier OUI
12 Transaction invalide OUI 57 Transaction non permise à ceporteur
OUI
13 Montant invalide OUI 58 Transaction non permise à ceporteur
14 Numéro de porteur invalide OUI 59 Suspicion de fraude OUI
15 Emetteur de carte inconnu OUI 60 L’accepteur de carte doit contacterl’acquéreur
17 Annulation acheteur 61 Montant de retrait hors limite
19 Répéter la transactionultérieurement
63 Règles de sécurité non respectées OUI
20 Réponse erronée (erreur dans ledomaine serveur)
68 Réponse non parvenue ou reçue troptard
24 Mise à jour de fichier non supportée 75 Nombre d’essais code confidentieldépassé
25 Impossible de localiserl’enregistrement dans le fichier
76 Porteur déjà en opposition, ancienenregistrement conservé
OUI
26 Enregistrement dupliqué, ancienenregistrement remplacé
90 Arrêt momentané du système
27 Erreur en « edit » sur champ de listeà jour fichier
91 Émetteur de cartes inaccessible
28 Accès interdit au fichier 94 Transaction dupliquée
29 Mise à jour impossible 96 Mauvais fonctionnement du système
30 Erreur de format 97 Échéance de la temporisation desurveillance globale
31 Identifiant de l’organisme acquéreurinconnu
OUI 98 Serveur indisponible routage réseaudemandé à nouveau
33 Date de validité de la carte dépassée OUI 99 Incident domaine initiateur
34 Suspicion de fraude OUI
Tableau 9 : Codes retour spécifiques au réseau CB
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 85 / 186
Code Description
0 Approved or completed successfully
2 Call Voice-authorization number; Initialization Data
3 Invalid merchant number
4 Retain card
5 Authorization declined
10 Partial approval
12 Invalid transaction
13 Invalid amount
14 invalid card
21 No action taken
30 Format Error
33 Card expired
34 Suspicion of Manipulation
40 Requested function not supported
43 Stolen Card, pick up
55 Incorrect personal identification number
56 Card not in authorizer's database
58 Terminal ID unknown
62 Restricted Card
78 Stop payment order
79 Revocation of authorization order
80 Amount no longer available
81 Message-flow error
91 Card issuer temporarily not reachable
92 The card type is not processed by the authorization center
96 Processing temporarily not possible
97 Security breach - MAC check indicates error condition
98 Date and time not plausible
99 Error in PAC encryption detected
Tableau 10 : Codes retournés sur le réseau GICC
Code Description
000 Approuvée
001 Approuvée avec pièce d’identité
002 Autorisation partielle (Cartes prépayées seulement)
100 Refusée
101 Carte expirée / Date d’expiration invalide
106 Nombre d’essais permis de saisie du NIP dépassé
107 Veuillez appeler l’émetteur
109 Marchand invalide
110 Montant invalide
111 Compte invalide / MICR invalide
115 Fonction demandée non prise en charge
117 NIP invalide
119 Titulaire non inscrit / non permis
122 Code de sécurité de la carte invalide (alias NIC/C4C)
125 Date d’entrée en vigueur invalide
181 Erreur de format
183 Code de devise invalide
187 Refusée - Nouvelle carte émise
189 Refusée - Compte annulé
200 Refusée - Reprendre Carte
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 86 / 186
Code Description
900 Acceptée - Synchronisation ATC
909 Dysfonctionnement du système (erreur cryptographique)
912 Émetteur non disponible
Tableau 11 : Codes retournés par l'acquéreur Amex Global
Code Description
0 Transaction approuvée ou traitée avec succès
2 Dépassement de plafond
4 Conserver la carte
5 Ne pas honorer
96 Mauvais fonctionnement du système
97 Échéance de la temporisation de surveillance globale
Tableau 12 : Codes retournés par l'acquéreur Amex
Autres codes retour Pour des moyens de paiement différents de ceux présentés ci-dessus, veuillez :
• vous reporter à la documentation technique spécifique au moyen de paiement.
ou
• contacter le support technique pour plus de détails.
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 87 / 186
vads_authent_paypal_protection_eligibility
Description Type de protection des marchands en vigueur pour la transaction.
Trois valeurs possibles :
• ELIGIBLE
Le marchand est protégé par le règlement sur la Protection des Marchands PayPalpour les paiements non autorisés et les objets non reçus.
• PARTIALLY_ELIGIBLE
Le marchand est protégé par le règlement sur la Protection des Marchands PayPalpour les objets non reçus.
• INELIGIBLE
Le marchand n'est pas protégé par le règlement sur la Protection des MarchandsPayPal.
Spécifique au moyen de paiement PayPal.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Catégorie Informations sur la commande.
vads_authent_nsu
Description Numéro de séquence unique (Amérique Latine).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 88 / 186
vads_available_languages
Description Permet de spécifier les langues disponibles sur la page de paiement sous forme deliste.
Chaque élément de la liste doit être séparé par un point-virgule ( ; ).
Est matérialisé par l’affichage de drapeaux sur la page de paiement .
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format langue1;langue2;langue3
Code erreur 71
Valeurs possibles Langue Valeur Drapeau affiché par défaut
Allemand de x
Anglais en x
Chinois zh x
Espagnol es x
Français fr x
Italien it x
Japonais ja x
Néerlandais nl x
Polonais pl
Portugais pt x
Russe ru x
Suédois sv x
Turc tr x
Exemple : pour afficher les drapeaux des langues français et anglais, il faut postervads_available_languages=fr;en
Catégorie Personnalisation de la page de paiement.
vads_avs_result
Description Transmet le résultat de la vérification d'adresse réalisée par l'acquéreur.
Cette vérification ne concerne que la partie numérique de l'adresse de facturation.
L'Address Verification Service est supporté aux USA, Canada et Royaume-Uni.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format a1
Valeurs possibles Code Visa MasterCard Discover American Express
Y Address & 5-digit or 9-digit ZIPmatch
Address & 5-digitZIP match
Address onlymatches
Address & ZIPmatch
A Address matches,ZIP does not
Address matches,ZIP does not
Address & 5-digitZIP match
Address onlymatches
S AVS notsupported
AVS notsupported
AVS notsupported
AVS notsupported
R Systemunavailable,rerowy
Systemunavailable,rerowy
Not applicable Systemunavailable,rerowy
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 89 / 186
Code Visa MasterCard Discover American Express
U Information notavailable
Information notavailable
Systemunavailable,rerowy
Information notavailable
Z Either 5-digit or9-digit ZIP match,address does not
5-digit ZIPmatches, addressdoes not
5-digit ZIPmatches, addressdoes not
ZIP code onlymatches
N Neither ZIP noraddress match
Neither ZIP noraddress match
Neither ZIP noraddress match
Neither ZIP noraddress match
W Not applicable For U.S., 9-digitZIP matches,address does not.For non-U.S., ZIPmatches, addressdoes not
Information notavailable
Not applicable
X Not applicable For U.S., all digitsmatch. For non-U.S., ZIP andaddress match.
Address & 9-digitZIP match
Not applicable
B Address matches,ZIP not verified
Not applicable Not applicable Not applicable
T Not applicable Not applicable 9-digit ZIPmatches, addressdoes not
Not applicable
P ZIP matches,address notverified
Not applicable Not applicable Not applicable
C Address and ZIPnot verified
Not applicable Not applicable Not applicable
D Address &ZIP match(Internationalonly)
Not applicable Not applicable Not applicable
G Address notverified forInternational(Internationalonly)
Not applicable Not applicable Not applicable
I Addressnot verified(Internationalonly)
Not applicable Not applicable Not applicable
M Address &ZIP match(Internationalonly)
Not applicable Not applicable Not applicable
F Address & ZIPmatch (UK only)
Not applicable Not applicable Not applicable
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 90 / 186
vads_bank_code
Description Code banque associé à la banque émettrice.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n5
Catégorie Informations sur le moyen de paiement.
vads_bank_label
Description Nom de la banque émettrice de la carte utilisée pour le paiement.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Remarque : format de type caractères alphanumériques et spéciaux pouvant contenirdes caractères accentués (à l'exception de "<" et ">").
Catégorie Informations sur le moyen de paiement.
vads_bank_product
Description Code produit de la carte utilisée pour le paiement.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..20
Valeurs possibles
VISA Désignation
A Visa Traditional
B Visa Traditional Rewards
C Visa Signature
D Visa Signature Preferred
E Proprietary ATM
F Visa Classic
G Visa Business
G1 Visa Signature Business
G2 Reserved
G3 Visa Business Enhanced
H Reserved
I Visa Infinite
J Reserved
J1 Reserved
J2 Reserved
J3 Visa Healthcare
J4 Reserved
K Visa Corporate T&E
K1 Visa GSA Corporate T&E
L Electron
N Visa Platinium
N1 TBA
P Visa Gold
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 91 / 186
VISA Désignation
Q Private Label
Q1 Reserved
R Proprietary
S Visa Purchasing
S1 Visa Purchasing
S2 Visa Purchasing
S3 Visa Purchasing
S4 Government Services Loan
S5 Commercial Transport EBT
S6 Business Loan
S7 Visa Distribution
T Reserved
U Visa TravelMoney
V Visa VPay
W Reserved
X Reserved
Y Reserved
Z Reserved
I2 VISA ULTRA HIGH NET WORTH
G5 VISA BUSINESS REWARDS
G4 VISA INFINITE BUSINESS
I1 VISA INFINITE PRIVILEGE
N2 VISA SELECT
Q2 PRIVATE LABEL BASIC
Q3 PRIVATE LABEL STANDARD
Q4 PRIVATE LABEL ENHANCED
Q5 PRIVATE LABEL SPECIALIZED
Q6 PRIVATE LABEL PREMIUM
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 92 / 186
MASTERCARD Désignation
BPD BUSINESS PREMIUM DEBIT
CIR CIRRUS
DAG GOLD DEBIT MASTERCARD SALARY
DAP PLATINUM DEBIT MASTERCARD SALARY
DAS STANDARD DEBIT MASTERCARD SALARY
DDB DOMESTIC DEBIT BRAND
DLG DEBIT GOLD DELAYED DEBIT
DLH DEBIT WORLD EMBOSSED DELAYED DEBIT
DLP DEBIT PLATINUM DELAYED DEBIT
DLS MASTERCARD CARD-DELAYED DEBIT
DOS STANDARD DEBIT MASTERCARD SOCIAL
DWF DEBIT MASTERCARD HUMANITARIAN PREPAID
M MASTERCARD
MAB WORLD ELITE MASTERCARD
MAC MASTERCARD CORPORATE WORLD ELITE
MBB MASTERCARD PREPAID CONSUMER
MBC MASTERCARD PREPAID VOUCHER
MBD MASTERCARD PROFESSIONAL DEBIT BUSINESS CARD
MBE MASTERCARD ELECTRONIC BUSINESS CARD
MBK MASTERCARD BLACK
MBP MASTERCARD UNKNOWN PRODUCT
MBS MASTERCARD B2B PRODUCT
MBT MASTERCARD CORPORATE PREPAID TRAVEL
MBW WORLD MASTERCARD BLACK EDITION – DEBIT
MCB MASTERCARD BUSINESS CARD
MCC MASTERCARD CREDIT MIXED BIN CARD
MCD MASTERCARD DEBIT CARD
MCE MASTERCARD ELECTRONIC CARD
MCF MASTERCARD FLEET CARD
MCG MASTERCARD GOLD CARD
MCH MASTERCARD PREMIUM CHARGE
MCO MASTERCARD CORPORATE CARD
MCP MASTERCARD PURCHASING CARD
MCS MASTERCARD STANDARD CARD
MCT TITANIUM MASTERCARD CARD
MCV MERCHANT BRANDED PROGRAM
MCW WORLD MASTERCARD CARD
MDB DEBIT MASTERCARD BUSINESSCARD CARD
MDG DEBIT GOLD MASTERCARD CARD
MDH DEBIT OTHER EMBOSSED
MDJ DEBIT OTHER 2 EMBOSSED
MDL BUSINESS DEBIT OTHER EMBOSSED
MDN BUSINESS DEBIT OTHER 2 EMBOSSED
MDO DEBIT OTHER CARD
MDP DEBIT PLATINUM CARD
MDR DEBIT BROKERAGE CARD
MDS DEBIT MASTERCARD CARD
MDT MASTERCARD BUSINESS DEBIT
MDW WORLD ELITE DEBIT MASTERCARD / MASTERCARD BLACK DEBIT
MEB MASTERCARD EXECUTIVE BUSINESS CARD
MEC MASTERCARD ELECTRONIC COMMERCIAL CARD
MEF ELECTRONIC PAYMENT ACCOUNT
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 93 / 186
MASTERCARD Désignation
MEO MASTERCARD CORPORATE EXECUTIVE CARD
MET TITANIUM DEBIT MASTERCARD
MFB FLEX WORLD ELITE
MFD FLEX PLATINUM
MFE FLEX CHARGE WORLD ELITE
MFH FLEX WORLD
MFL FLEX CHARGE PLATINUM
MFW FLEX CHARGE WORLD
MGF MASTERCARD GOUVERNMENT COMMERCIAL CARD
MHA MASTERCARD HEALTHCARE PREPAID NON-TAX
MHB MASTERCARD HSA SUBSTANTIATED
MHD HELOC DEBIT STANDARD
MHH MASTERCARD HSA NON-SUBSTANTIATED
MHL HELOC DEBIT GOLD
MHM HELOC DEBIT PLATINUM
MHN HELOC DEBIT PREMIUM
MIA PREPAID MASTERCARD UNEMBOSSED STUDENT CARD
MIP PREPAID DEBIT MASTERCARD STUDENT CARD
MIU DEBIT MASTERCARD UNEMBOSSED
MLA MASTERCARD CENTRAL TRAVEL SOLUTIONS AIR CARD
MLD MASTERCARD DISTRIBUTION CARD
MLL MASTERCARD CENTRAL TRAVEL SOLUTIONS LAND CARD
MNF MASTERCARD PUBLIC SECTOR COMMERCIAL CARD
MNW MASTERCARD NEW WORLD
MOC MASTERCARD UNKNOWN PRODUCT
MOG MAESTRO GOLD
MOP MAESTRO PLATINIUM
MOW MAESTRO WORLD
MPA MASTERCARD PREPAID DEBIT STANDARD-PAYROLL
MPB PREFERRED BUSINESS CARD
MPC MPC
MPF MASTERCARD PREPAID DEBIT STANDARD-GIFT
MPG MASTERCARD UNEMBOSSED PREPAID STUDENT CARD
MPH MASTERCARD CASH PREPAID
MPJ PREPAID DEBIT MASTERCARD CARD GOLD
MPK PREPAID MASTERCARD GOUVERNMENT COMMERCIAL CARD
MPL PLATINIUM MASTERCARD CARD
MPM MASTERCARD PREPAID DEBIT STANDARD-CONSUMER INCENTIVE
MPN MASTERCARD PREPAID DEBIT STANDARD-INSURANCE
MPO MASTERCARD PREPAID DEBIT STANDARD-OTHER
MPP PRE-PAID CARD
MPR MASTERCARD PREPAID DEBIT STANDARD-TRAVEL
MPT MASTERCARD PREPAID DEBIT STANDARD-TEEN
MPV MASTERCARD PREPAID DEBIT STANDARD-GOVERNMENT
MPW DEBIT MASTERCARD BUSINESS CARD PREPAID WORK B2B
MPX MASTERCARD PREPAID DEBIT STANDARD-FLEX BENEFIT
MPY MASTERCARD PREPAID DEBIT STANDARD-EMPLOYEE INCENTIVE
MPZ MASTERCARD PREPAID DEBIT STANDARD – GOVERNMENT CONSUMER
MRC MASTERCARD ELECTRONIC CONSUMER PREPAID
MRF STANDARD DEFERRED
MRG MASTERCARD STANDARD PREPAID
MRH MASTERCARD UNKNOWN PRODUCT
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 94 / 186
MASTERCARD Désignation
MRJ PREPAID MASTERCARD GOLD CARD
MRK PREPAID MASTERCARD PUBLIC SECTOR COMMERCIAL CARD
MRL MASTERCARD PREPAID BUSINESS PREFERRED
MRO MASTERCARD REWARDS ONLY
MRP STANDARD RETAILER CENTRIC PAYMENTS
MRW MASTERCARD CREDIT BUSINESS CARD PREPAID
MSA PREPAID MAESTRO PAYROLL CARD
MSB MAESTRO SMALL BUSINESS CARD
MSF PREPAID MAESTRO GIFT CARD
MSG PREPAID MAESTRO CONSUMER RELOADABLE CARD
MSI MAESTRO
MSJ PREPAID MAESTRO GOLD
MSM PREPAID MAESTRO CONSUMER PROMOTION CARD
MSN PREPAID MAESTRO INSURANCE CARD
MSO PREPAID MAESTRO OTHER CARD
MSQ RESERVED FOR FUTURE USE
MSR PREPAID MAESTRO TRAVEL CARD
MST PREPAID MAESTRO TEEN CARD
MSV PREPAID MAESTRO GOVERNMENT BENEFIT CARD
MSW PREPAID MAESTRO CORPORATE CARD
MSX PREPAID MAESTRO FLEX BENEFIT CARD
MSY PREPAID MAESTRO EMPLOYEE INSENTIVE CARD
MSZ PREPAID MAESTRO EMERGENCY ASSISTANCE CARD
MTP MASTERCARD PLATINUM PREPAID TRAVEL CARD
MUW WORLD DOMESTIC AFFLUENT
MWB WORLD MASTERCARD FOR BUSINESS
MWD WORLD DEFERRED
MWE MASTERCARD WORLD ELITE
MWF MASTERCARD HUMANITARIAN PREPAID
MWO MASTERCARD CORPORATE WORLD
MWR WORLD RETAILER CENTRIC PAYMENTS
OLB MAESTRO SMALL BUSINESS DELAYED DEBIT
OLG MAESTRO GOLD DELAYED DEBIT
OLP MAESTRO PLATINUM DELAYED DEBIT
OLS MAESTRO-DELAYED DEBIT
OLW MAESTRO WORLD DELAYED DEBIT
PVA PRIVATE LABEL A
PVB PRIVATE LABEL B
PVC PRIVATE LABEL C
PVD PRIVATE LABEL D
PVE PRIVATE LABEL E
PVF PRIVATE LABEL F
PVG PRIVATE LABEL G
PVH PRIVATE LABEL H
PVI PRIVATE LABEL I
PVJ PRIVATE LABEL J
PVL PRIVATE LABEL CARD
SAG GOLD MASTERCARD SALARY–IMMEDIATE DEBIT
SAL STANDARD MAESTRO SALARY
SAP PLATINUM MASTERCARD SALARY–IMMEDIATE DEBIT
SAS STANDARD MASTERCARD SALARY–IMMEDIATE DEBIT
SOS STANDARD MASTERCARD SOCIAL–IMMEDIATE DEBIT
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 95 / 186
MASTERCARD Désignation
SUR PREPAID MASTERCARD UNEMBOSSED (NON-US)
TBE MASTERCARD ELECTRONIC BUSINESS IMMEDIATE DEBIT
TCB MASTERCARD BUSINESS CARD-IMMEDIATE DEBIT
TCC MASTERCARD MIXED BIN-IMMEDIATE DEBIT
TCE MASTERCARD ELECTRONIC IMMEDIATE DEBIT
TCF MASTERCARD FLEET CARD IMMEDIATE DEBIT
TCG LD MASTERCARD CARD-IMMEDIATE DEBIT
TCO MASTERCARD CORPORATE IMMEDIATE DEBIT
TCP MASTERCARD PURCHASING CARD IMMEDIATE DEBIT
TCS MASTERCARD STANDARD CARD-IMMEDIATE DEBIT
TCW WORLD SIGNIA MASTERCARD CARD-IMMEDIATE DEBIT
TEB MASTERCARD EXECUTIVE BUSINESS CARD IMMEDIATE DEBIT
TEC MASTERCARD ELECTRONIC COMMERCIAL IMMEDIATE DEBIT
TEO MASTERCARD CORPORATE EXECUTIVE IMMEDIATE DEBITCARD
TIU TIU
TNF MASTERCARD PUBLIC SECTOR COMMERCIAL CARD IMMEDIATE DE
TNW MASTERCARD NEW WORLD-IMMEDIATE DEBIT
TPB PREFERRED BUSINESS CARD IMMEDIATE DEBIT
TPL PLATINUM MASTERCARD IMMEDIATE DEBIT
TWB WORLD MASTERCARD BLACK EDITION – IMMEDIATE DEBIT
WBE MASTERCARD UNKNOWN PRODUCT
WDR WORLD DEBIT MASTERCARD REWARDS
WMR WORLD MASTERCARD REWARDS
CB Désignation
1 Carte nationale de retrait
2 Carte nationale de retrait et de paiement
3 Carte nationale de paiement
4 Carte nationale de paiement et de retrait à autorisation systématique
5 Carte nationale de paiement à autorisation systématique
Autre codes produits Désignation
AX AMERICAN EXPRESS
DI DISCOVER
DN DINERS
JC JCB
Catégorie Informations sur le moyen de paiement.
vads_birth_day
Description Jour de naissance du porteur.
Champ d'entrée.
Format n..2
Code erreur 76
Catégorie Informations sur le moyen de paiement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 96 / 186
vads_birth_month
Description Mois de naissance du porteur.
Champ d'entrée.
Format n..2
Code erreur 76
Catégorie Informations sur le moyen de paiement.
vads_birth_year
Description Année de naissance du porteur.
Champ d'entrée.
Format n4
Code erreur 76
Catégorie Informations sur le moyen de paiement.
vads_brand_management
Description Indique au marchand :
• si l'acheteur a utilisé une autre marque que celle définie par défaut par lemarchand (attribut userChoice),
• la marque choisie par l'acheteur (attribut brand),
• la liste des marques disponibles (attribut brandList).
Ce champ est renvoyé uniquement si le choix de la marque est activé sur le contratCB utilisé pour le paiement.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format json
Valeurs possibles Exemple :
vads_brand_management={"userChoice":true,"brand":"CB","brandList":"CB|VISA"}
Catégorie Informations sur le moyen de paiement.
vads_capture_delay
Description Indique le délai en nombre de jours avant remise en banque.
Si ce paramètre n’est pas transmis, alors la valeur par défaut définie dans le BackOffice Marchand sera utilisée. Cette dernière est paramétrable dans le Back OfficeMarchand par toutes les personnes dûment habilitées.
Remarques:
• La valeur de vads_capture_delay n'est pas prise en compte dans le cas d'unpaiement en plusieurs fois MULTI_EXT.
• Si le délai avant remise est supérieur à 365 jours dans la requête de paiement,il est automatiquement repositionné à 365 jours.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 97 / 186
Champ d'entrée.
Format n..3
Code erreur 06
Catégorie Informations sur la transaction.
vads_card_brand
Description Moyen de paiement utilisé, si disponible (vide sinon).
La valeur est issue des fichiers de plages de BIN.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..127
Valeurs possibles Se référer au paramètre vads_payment_cards.
Catégorie Informations sur le moyen de paiement.
vads_card_country
Description Code pays de la carte utilisée pour le paiement à la norme ISO 3166.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ISO 3166
Catégorie Informations sur le moyen de paiement.
vads_card_holder_name
Description Ce champ correspond au nom du porteur de carte.
En Amérique Latine, ce paramètre est obligatoire pour DECIDIR et VISANET.
Champ d'entrée.
Format ans..255
Code d'erreur 45
Catégorie Informations sur le moyen de paiement.
vads_card_number
Description • Numéro de carte masqué. Contient les 6 premiers chiffres du numéro, suivi par“XXXXXX” et enfin les 4 derniers numéros.
• IBAN et BIC (s'il est renseigné) utilisés pour le paiement, séparés par un « _ »dans le cas d’un paiement par prélèvement.
Le BIC est optionnel donc le numéro peut juste être l'IBAN.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..36
Catégorie Informations sur le moyen de paiement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 98 / 186
vads_change_rate
Description Taux de change utilisé pour calculer le montant réél du paiement (lors d'unpaiement multi-devise).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format string
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 99 / 186
vads_contracts
Description Permet :
• de spécifier, pour chaque réseau d’acceptation, le contrat commerçant àutiliser, sous forme de liste,
• d'exclure un réseau.
Ce paramètre est facultatif et n’est utile que dans le cas où vous avez plusieurscontrats sur le même réseau et si vous souhaitez en changer dynamiquement enfonction du paiement.
Si ce paramètre n’est pas renseigné ou absent, le paiement sera réalisé avec le(s)contrat(s) commerçant selon l'ordre de priorité défini dans le Back Office Marchand(Menu Paramétrage > Boutique > onglet Association contrats).
Champ d'entrée.
Format map
Code d'erreur 62
Valeurs possibles Pour exclure un réseau, il faut utiliser la syntaxe nom_du_réseau=NO
Exemple : RESEAU1=contrat1;RESEAU2=contrat2;RESEAU3=NO
Les différents réseaux possibles sont :
Code Réseau Description
ACCORD Réseau Oney (cartes cadeau et privatives)
ACCORD_SANDBOX Réseau Oney (cartes cadeau et privatives) - mode sandbox
AMEX Réseau American Express
AMEXGLOBAL Réseau American Express
ANCV Réseau ANCV (e-chèques vacances)
AURORE Réseau CETELEM Aurore (cartes Enseignes et cartes AuroreUniverselles)
CARDCOMPLETE Réseau CARDCOMPLETE
CB Réseau CB
CERIDIAN Réseau CERIDIAN (carte cadeau)
COFINOGA Réseau Cofinoga (cartes Be Smart et enseignes)
CONECS Réseau Titre-Restaurant Conecs
EDENRED Réseau Edenred (Tickets Restaurant, Tickets EcoChèque, TicketsCompliments)
EVO Réseau EVO
FULLCB Réseau FULL CB (Paiement en 3 ou 4 fois sans frais par BNPP PF)
GATECONEX Réseau GATECONEX
GICC Réseau GICC
GICC_DINERS Réseau GICC (cartes Diners Club)
GICC_MAESTRO Réseau GICC (cartes Maestro)
GICC_MASTERCARD Réseau GICC (cartes Mastercard)
GICC_VISA Réseau GICC (cartes Visa)
GIROPAY Réseau GIROPAY
GOOGLEPAY Réseau Google Pay
HOBEX_DD Réseau Hobex Direct Debit
IDEAL Réseau iDeal
JCB Réseau JCB
KLARNA Réseau Klarna Internet Banking
MASTERPASS Réseau MasterPass
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 100 / 186
Code Réseau Description
ONEY Réseau Oney (Paiement en 3 ou 4 fois par FacilyPay)
ONEY_SANDBOX Réseau Oney (Paiement en 3 ou 4 fois par FacilyPay) - mode sandbox
PAYDIREKT Réseau PayDirekt
PAYLIB Réseau Paylib
PAYPAL Réseau PayPal
PAYPAL_SB Réseau PayPal - mode sandbox
POSTFINANCEV2 Réseau POSTFINANCE
PPRO Réseau PPRO
REDSYS Réseau RedSys
SECURETRADING Réseau Secure Trading
SEPA Réseau SEPA (SDD et SCT)
SOFINCO Réseau Sofinco
SOFORT Réseau Sofort Banking
WIRECARD Réseau Wirecard
Exemple pour forcer le contrat à utiliser:
vads_contracts="CB=1231231;AMEXGLOBAL=949400444"
Exemple pour interdire le paiement sur un réseau particulier:
vads_contracts="CB=1231231;AMEXGLOBAL=NO"
Pour forcer le Terminal ID (TID) :
La syntaxe à respecter est la suivante: "RESEAU=MID:TID".
Exemple:
vads_contracts="PSE=123456789:123"
Catégorie Informations sur la transaction.
vads_contract_used
Description Ce champ définit la valeur du contrat associé à la transaction. Il est valorisé parle contrat enregistré par défaut dans votre boutique ou prend la valeur du champvads_contracts passé lors de la demande de paiement.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..250
Catégorie Informations sur la transaction.
vads_contrib
Description Information complémentaire facultative destinée à indiquer le nom de lacontribution utilisée lors du paiement (Joomla, osCommerce...). Si vous utilisez uneimplémentation propriétaire, ce champ peut accueillir votre numéro de versioninterne du module que vous avez développé par exemple.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..128
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 101 / 186
Code erreur 31
Catégorie Informations techniques.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 102 / 186
vads_ctx_mode
Description Paramètre obligatoire.
Définit le mode de sollicitation de la plateforme de paiement.
Influe sur le choix de la clé à utiliser (clé de test ou clé de production) pour le calculde la signature.
Le mode TEST est toujours disponible, même après la génération de la clé deproduction.
Si vous créez un nouveau site e-commerce (ou disposez d’un environnement derecette), vous pourrez effectuer vos tests sans impacter le site actuellement enproduction.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Code erreur 11
Erreurs fréquentes:
• Le mode n'a pas été envoyé à la plateforme de paiement.
• Ne pas coder PROD à la place de PRODUCTION
• Ne pas coder la valeur en minuscules (test ou production). Ce champ attendexclusivement des valeurs en majuscules et sans abréviation.
Valeurs possibles TEST, PRODUCTION
Catégorie Informations techniques.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 103 / 186
vads_currency
Description Code numérique de la monnaie à utiliser pour le paiement, selon la norme ISO 4217(code numérique).
Remarque : Les devises listées sont toutes disponibles mais elles ne sont pas toutesprésentées lors de la création des contrats. Si la devise souhaitée n'est pas proposéelors de la création de votre contrat, veuillez contacter l'administration des ventes .
Pour utiliser une devise dans un paiement, il est indispensable d'avoir un contratouvert dans cette devise. L’acquéreur fournit le contrat au marchand avec la ou lesdevises supportées et la plateforme prend en compte ces informations lors de lacréation de contrat.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n3
Code erreur 10
Valeurs possibles Devise Codification ISO 4217Nombre de chiffres aprèsle séparateur décimal
Dollar australien (AUD) 036 2
Riel Cambodgien (KHR) 116 0
Dollar canadien (CAD) 124 2
Renminbi yuan chinois (CNY) 156 1
Couronne tchèque (CZK) 203 2
Couronne danoise (DKK) 208 2
Dollar de Hong Kong (HKD) 344 2
Forint hongrois (HUF) 348 2
Roupie Indienne (INR) 356 2
Roupie indonésienne (IDR) 360 2
Yen (JPY) 392 0
Won Sud Coréen (KRW) 410 0
Dinar Koweïtien (KWD) 414 3
Ringgit malais (MYR) 458 2
Peso mexicain (MXN) 484 2
Dirham Marocain (MAD) 504 2
Dollar néo-zélandais (NZD) 554 2
Couronne norvégienne (NOK) 578 2
Peso philippin (PHP) 608 2
Rouble russe (RUB) 643 2
Dollar de Singapour (SGD) 702 2
Rand sud-africain (ZAR) 710 2
Couronne suédoise (SEK) 752 2
Franc suisse (CHF) 756 2
Baht thailandais (THB) 764 2
Dinar Tunisien (TND) 788 3
Livre Sterling (GBP) 826 2
Dollar des États-Unis (USD) 840 2
Nouveau dollar de Taïwan (TWD) 901 2
Lire turque (TRY) 949 2
Euro (EUR) 978 2
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 104 / 186
Devise Codification ISO 4217Nombre de chiffres aprèsle séparateur décimal
Zloty polonais (PLN) 985 2
Real du Brésil (BRL) 986 2
Catégorie Informations sur la transaction.
vads_cust_address
Description Adresse postale de l’acheteur.
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay et Oney pour lesquels le champest obligatoire et le format est ans..128. Seuls les caractères spéciaux suivants sontautorisés:
• l'espace,
• la barre oblique ( / )
• le tiret ( - )
• l'apostrophe ( ' )
• la virgule ( , )
• le point ( . )
Pour les paiements SEPA Direct Debit, le champ devient obligatoire si le clientpossède un compte bancaire dans les départements, territoires ou pays suivants :Suisse, Monaco, Saint-Marin, Mayotte, Saint-Pierre-et-Miquelon, Guernesey,Jersey, Île de Man.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Remarque : Les caractères > et < ne sont pas autorisés.
Code erreur 19
Catégorie Informations sur l'acheteur.
vads_cust_address2
Description Deuxième ligne d'adresse.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Code erreur 19
Catégorie Informations sur l'acheteur.
vads_cust_address_number
Description Numéro de rue de l’acheteur.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 105 / 186
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..64
Code erreur 112
Catégorie Informations sur l'acheteur.
vads_cust_cell_phone
Description Numéro de téléphone mobile de l’acheteur.
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay et Oney pour lesquels le champest obligatoire et le format est n10.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..32
Code erreur 77
Catégorie Informations sur l'acheteur.
vads_cust_city
Description Ville de l’acheteur.
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay et Oney pour lesquels le champest obligatoire et le format est ans..128. Seuls les caractères spéciaux suivants sontautorisés:
• l'espace,
• la barre oblique ( / ),
• le tiret ( - )
• l'apostrophe ( ' )
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..128
Code erreur 21
Catégorie Informations sur l'acheteur.
vads_cust_country
Description Permet de spécifier le code du pays de l’acheteur à la norme ISO 3166.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format a2
Code d'erreur 22
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 106 / 186
Exemples de valeurspossibles
Code Pays Code Pays
AT Autriche IN Inde
BR Brésil MQ Martinique
CI Côte d'Ivoire NC Nouvelle-Calédonie
FR Corse PF Polynesie Francaise
FR France PM St-Pierre-et-Miquelon
GP Guadeloupe US Etats-Unis d'Amérique
Catégorie Informations sur l'acheteur.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 107 / 186
vads_cust_district
Description Quartier de l’acheteur.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..127
Code erreur 113
Catégorie Informations sur l'acheteur.
vads_cust_email
Description Adresse e-mail de l’acheteur, nécessaire si vous souhaitez que la plateforme depaiement envoie un e-mail à l’acheteur.
Pour que l'acheteur reçoive un e-mail, n'oubliez pas de poster ce paramètre dansle formulaire lorsque vous générez une demande de paiement.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..150
Code erreur 15
Catégorie Informations sur l'acheteur.
vads_cust_first_name
Description Prénom de l’acheteur.
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay et Oney pour lesquels le champest obligatoire et le format est an..63.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..63
Code erreur 104
Catégorie Informations sur l'acheteur.
vads_cust_id
Description Identifiant de l’acheteur chez le marchand.
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay et Oney pour lesquels le champest obligatoire et le format est an..8.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..63
Code erreur 16
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 108 / 186
Catégorie Informations sur l'acheteur.
vads_cust_last_name
Description Nom de l’acheteur.
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay et Oney pour lesquels le champest obligatoire et le format est an..63.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..63
Code erreur 105
Catégorie Informations sur l'acheteur.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 109 / 186
vads_cust_legal_name
Description Raison sociale de l'acheteur.
Champ d'entrée.
Format an..100
Code d'erreur 121
Catégorie Informations sur l'acheteur.
vads_cust_name
Description Nom de l’acheteur.
Ce champ est déprécié. Il est remplacé par les champs vads_cust_first_name etvads_cust_last_name
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..127
Code erreur 18
Catégorie Informations sur l'acheteur.
vads_cust_national_id
Description Identifiant national.
Permet d'identifier de façon unique chaque citoyen au sein d'un pays.
Par exemple, au Brésil, ClearSale impose que ce champ soit valorisé avec le CPF/CNPJ (format numérique, de longueur comprise entre 11 et 20 digits).
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Code d'erreur 124
Catégorie Informations sur l'acheteur.
vads_cust_phone
Description Numéro de téléphone de l’acheteur.
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay et Oney pour lesquels le champest obligatoire et le format est n10.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..32
Code erreur 23
Catégorie Informations sur l'acheteur.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 110 / 186
vads_cust_state
Description Etat/ Région de l’acheteur
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..127
Code erreur 88
Catégorie Informations sur l'acheteur.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 111 / 186
vads_cust_status
Description Type d’acheteur.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Code erreur 92
Valeurs possibles PRIVATE, COMPANY
Catégorie Informations sur l'acheteur.
vads_cust_title
Description Civilité de l’acheteur (Exemple Mr, Mme, Melle).
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..63
Code erreur 17
Valeurs possibles M., Mme, Mlle
Catégorie Informations sur l'acheteur.
vads_cust_zip
Description Code postal de l’acheteur.
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay et Oney pour lesquels le champest obligatoire et le format est n5.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..64
Code erreur 20
Catégorie Informations sur l'acheteur.
vads_effective_amount
Description Montant du paiement dans la devise réellement utilisée pour effectuer la remiseen banque.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..12
Exemples EXEMPLE POUR UNE BOUTIQUE OU LA REMISE EST EFFECTUÉE EN EUR
Paiement de 10,00 EUR
Paramètres envoyés dans le formulaire de paiement
• vads_amount = 1000
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 112 / 186
Paramètres envoyés dans le formulaire de paiement• vads_currency = 978
Paramètres retournés
• vads_amount = 1000
• vads_currency = 978
• vads_effective_amount = 1000
Paiement de 10 dollars américains
Paramètres envoyés dans le formulaire de paiement
• vads_amount = 1000
• vads_currency = 840
Paramètres retournés
• vads_amount = 1000
• vads_currency = 840
• vads_change_rate= 1.3118 (taux utilisé)
• vads_effective_amount = 762 (vads_amount / vads_change_rate)
Paiement multiple 90,00 EUR en 3 fois
Paramètres envoyés dans le formulaire de paiement
• vads_amount = 9000
• vads_currency = 978
• vads_payment_config=MULTI_EXT:date1=3000;date2=2000;date3=4000
Remarque : valeur MULTI_EXT non disponible pour le paiement SEPA
Paramètres retournés pour la première échéance
• vads_amount = 9000
• vads_currency = 978
• vads_effective_amount = 3000
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 113 / 186
Paiement multiple 90 dollars américains en 3 fois
Paramètres envoyés dans le formulaire de paiement
• vads_amount = 9000
• vads_currency = 840
• vads_payment_config=MULTI_EXT:20121025=3000;20121026=2000;20121027=4000
Remarque : valeur MULTI_EXT non disponible pour le paiement SEPA
Paramètres retournés pour la première échéance
• vads_amount = 9000
• vads_currency = 840
• vads_change_rate= 1.3118 (taux utilisé)
• vads_effective_amount = 2287 (montant 1ere échéance 30$ / vads_change_rate)
Catégorie Informations sur la transaction.
vads_effective_creation_date
Description Date d'enregistrement de la transaction, dans le fuseau UTC (ou GMT+0) au formathoraire 24h (AAAAMMJJHHMMSS).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n14
Catégorie Informations sur la transaction.
vads_effective_currency
Description Devise dans laquelle la remise en banque va être effectuée.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n3
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 114 / 186
vads_expiry_month
Description Mois d’expiration de la carte utilisée pour le paiement.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..2
Catégorie Informations sur le moyen de paiement.
vads_expiry_year
Description Année d’expiration de la carte utilisée pour le paiement.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n4
Catégorie Informations sur le moyen de paiement.
vads_ext_info
Description Permet d’ajouter des données complémentaires pour le marchand dans leformulaire de paiement.
Ces informations seront présentes :
• dans le Back Office Marchand, dans le détail de la transaction (onglet Extras)
• dans les données transmises au site marchand lors du retour à la boutique
• dans les données transmises au site marchand lors de l'IPN
• par défaut dans l'e-mail de confirmation de paiement à destination dumarchand
• dans l'e-mail de confirmation de paiement à destination de l'acheteur si vous lespécifiez dans le paramétrage de la règle de notification.
Syntaxe à respecter :
vads_ext_info_lenomduchamp=valeur
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans
Code erreur 91
Catégorie Informations sur la commande.
vads_ext_info_bil_address_complement
Description Spécifique au Brésil et à l'analyseur de fraude ClearSale.
Permet de préciser un complément d'adresse pour la facturation.
Champ d'entrée.
Format ans..250
Catégorie Informations sur l'acheteur.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 115 / 186
vads_ext_info_bil_date_of_birth
Description Permet de transmettre à l'analyseur de risque la date de naissance indiquée surla facture.
Format : yyyymmdd
Champ d'entrée.
Format n8
Catégorie Informations sur l'acheteur.
vads_ext_info_bil_gender
Description Spécifique au Brésil et à l'analyseur de fraude ClearSale.
Permet de préciser sur la facture si l'acheteur est un homme ou une femme.
Champ d'entrée.
Format n1
Catégorie Informations sur l'acheteur.
vads_ext_info_deadline
Description Spécifique au Brésil et à l'analyseur de fraude ClearSale.
Permet de préciser le délai de livraison en jour (N jours).
Champ d'entrée.
Format n
Catégorie Informations sur la livraison.
vads_ext_info_fingerprint_id
Description Spécifique au Brésil et à l'analyseur de fraude ClearSale.
Identifiant unique de session.
• Soit cet identifiant de session est généré par la plateforme de paiement
Dans ce cas, ce paramètre ne doit pas être renseigné.
• Soit cet identifiant de session est généré par le site marchand
Dans ce cas, ce paramètre doit être renseigné avec la valeur de l’identifiantsouhaité. Attention, il incombe au site marchand de s’assurer de l’unicité desidentifiants. Toute demande d'enregistrement contenant un identifiant déjàexistant, sera rejetée, et provoquera l’affichage d’un message d’erreur
Champ d'entrée.
Format string
Codé sur 128 octets, peut être composé de majuscules ou de minuscules, chiffresou tiret ([A-Z] [a-z], 0-9, _, -).
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 116 / 186
Catégorie Informations sur l'acheteur.
vads_ext_info_ship_address_complement
Description Spécifique au Brésil et à l'analyseur de fraude ClearSale.
Permet de préciser un complément d'adresse pour la livraison.
Champ d'entrée.
Format ans..250
Catégorie Informations sur la livraison.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 117 / 186
vads_ext_info_ship_date_of_birth
Description Permet de préciser pour la livraison la date de naissance de l'acheteur.
Format : yyyymmdd
Champ d'entrée.
Format n8
Catégorie Informations sur livraison.
vads_ext_info_ship_gender
Description Spécifique au Brésil et à l'analyseur de fraude ClearSale.
Permet de préciser pour la livraison si l'acheteur est un homme ou une femme.
Champ d'entrée.
Format n1
Catégorie Informations sur la livraison.
vads_ext_info_soft_descriptor
Description Permet de personnaliser le nom de la marque.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Catégorie Informations sur la commande
vads_ext_trans_id
Description Référence externe de la transaction.
Exemple : numéro de transaction PayPal, numéro de réservation Klarna.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..20
Catégorie Informations sur la transaction
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 118 / 186
vads_extra_result
Description Code complémentaire de réponse. Sa signification dépend de la valeur renseignéedans vads_result.
• Lorsque vads_result vaut 30 (erreur de requête), alors vads_extra_resultcontient le code numérique du champ qui comporte une erreur de valorisationou de format. Cette valeur peut être renseignée à 99 dans le cas d’une erreurinconnue dans la requête.
Exemple : si vads_extra_result contient la valeur 09, cela signifie que lemontant spécifié dans vads_amount est incorrect (par exemple, si le montantcontient des décimales, car il n’aurait pas été converti préalablement encentimes).
• Lorsque vads_result vaut 05 (refusée) ou 00 (acceptée), alorsvads_extra_result contient le code numérique du résultat des contrôles derisques.
Code Description
Vide Pas de contrôle effectué.
00 Tous les contrôles se sont déroulés avec succès.
02 La carte a dépassé l’encours autorisé.
03 La carte appartient à la liste grise du marchand.
04 Le pays d’émission de la carte appartient à la liste grise du marchand.
05 L’adresse IP appartient à la liste grise du marchand.
06 Le code bin appartient à la liste grise du marchand.
07 Détection d’une e-carte bleue.
08 Détection d’une carte commerciale nationale.
09 Détection d’une carte commerciale étrangère.
14 Détection d’une carte à autorisation systématique.
20 Contrôle de cohérence : aucun pays ne correspond (pays IP, pays carte, pays del’acheteur ).
30 Le pays de l’adresse IP appartient à la liste grise.
99 Problème technique rencontré par le serveur lors du traitement d’un des contrôleslocaux.
Il est déconseillé d'activer le blocage des cartes à autorisation systématique si voussouhaitez accepter les paiements par Titres-Restaurant.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Catégorie Informations techniques.
vads_first_installment_delay
Description Ce champ permet de spécifier le nombre de mois de différé à appliquer sur lapremière échéance d'un paiement en plusieurs fois lorsque l'acquéreur le supporte(ex: Webpay Completa).
Le paiement sera refusé et le champ vads_payment_error sera valorisé à 171 dansles cas suivants :
• le marchand n'est pas autorisé à différer les paiements
• la valeur transmise dans la requête ne fait pas partie des options autorisées parl'acquéreur.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 119 / 186
Champ d'entrée.
Format n..2
Code erreur N/A
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 120 / 186
vads_hash
Description Clé unique renvoyée uniquement à l’URL de notification (IPN).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format an64
Catégorie Informations techniques.
vads_identifier
Description Identifiant unique (alias ou référence unique de mandat) associé à un moyen depaiement.
• Soit cet identifiant est généré par la plateforme.
Dans ce cas, ce paramètre ne doit pas être renseigné.
• Soit cet identifiant est généré par le site marchand.
Dans ce cas, ce paramètre doit être renseigné avec la valeur de l’identifiantsouhaité. Attention, il incombe au site marchand de s’assurer de l’unicité desidentifiants. Toute demande d'enregistrement contenant un identifiant déjàexistant, sera rejetée, et provoquera l’affichage d’un message d’erreur.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format Deux formats possibles :
• an32 : lorsque l'identifiant est généré par la plateforme. Ce format est réservépour la plateforme de paiement.
• ans..50 : lorsque l'identifiant est généré par le marchand. Ne peut pas être an32dans ce cas.
Code d'erreur 30
Catégorie Informations sur l'abonnement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 121 / 186
vads_identifier_status
Description Présent uniquement si l’action demandée correspond à la création ou à la mise àjour d'un:
• alias (abonnement)
• RUM ou référence unique de mandat (SEPA)
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format string
Valeurs possibles Valeur Description
CREATED La demande d’autorisation a été acceptée.L'alias (ou RUM pour un paiement SEPA) est créé avec succès.
NOT_CREATED La demande d’autorisation a été refusée.L'alias (ou RUM pour un paiement SEPA) n'est pas créé et n'apparaîtrapas dans le Back Office Marchand.
UPDATED L'alias (ou RUM pour un paiement SEPA) est mis à jour avec succès.
NOT_UPDATED L'alias (ou RUM pour un paiement SEPA) n'a pas été mis à jour.
ABANDONED Action abandonnée par l'acheteur (débiteur).L'alias (ou RUM pour un paiement SEPA) n'est pas créé et n'apparaîtrapas dans le Back Office Marchand.
Catégorie Informations sur l'abonnement.
vads_iframe_options
Description Permet de personnaliser certains élements de la page de paiement en modeiframe :
• fieldsBackgroundColor : couleur de fond des champs de saisie
• fieldsFontColor : couleur de la police dans les champs de saisie
Exemple de syntaxe:
vads_iframe_options = {"fieldsBackgroundColor":"#000000","fieldsFontColor":"#FFFFFF"}
Ce qui donne le rendu suivant:
Champ d'entrée.
Format json
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 122 / 186
Code erreur En cas d'erreur de format, le champ est ignoré et le formulaire de paiement n'estpas refusé.
Catégorie Personnalisation de la page de paiement.
vads_insurance_amount
Description Montant de l’assurance pour l’ensemble de la commande.
Spécifique au moyen de paiement PayPal.
Champ d'entrée.
Format n..12
Code erreur 110
Catégorie Informations sur la commande.
vads_language
Description Dans la demande de paiement :
Définit la langue dans laquelle est affichée la page de paiement (norme ISO 639-1).
Si le champ n’est pas envoyé ou s’il est valorisé à vide dans la demande depaiement, la page de paiement sera affichée dans la langue présentée par lenavigateur de l’acheteur.
Dans la réponse :
Retourne la valeur spécifiée dans le formulaire si l’acheteur n’a pas changé lalangue sur la page de paiement.
Retourne la langue sélectionnée par l’acheteur si celui-ci a changé de langue sur lapage de paiement en sélectionnant un autre drapeau.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format a2
Code erreur 12
Valeurs possibles Langue Codification ISO 639-1
Allemand de
Anglais en
Chinois zh
Espagnol es
Français fr
Italien it
Japonais ja
Néerlandais nl
Polonais pl
Portugais pt
Russe ru
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 123 / 186
Langue Codification ISO 639-1
Suédois sv
Turc tr
Catégorie Personnalisation de la page de paiement
vads_nb_products
Description Permet de définir le nombre de produits contenu dans le panier.
Remarque :
Ce champ devient obligatoire pour que le panier soit pris en compte.
En le renseignant, l'onglet Panier dans le détail d'une transaction depuis le BackOffice Marchand s'affichera.
Cependant, si les autres champs commençant par vads_product_ ne sont pasrenseignés, l'onglet ne comportera pas d'information. Pour cette raison, envalorisant le champ vads_nb_products, il devient obligatoire de valoriser les autreschamps commençant par vads_product_.
Champ d'entrée.
Format n..12
Catégorie Informations sur la commande.
vads_operation_type
Description Permet de d'identifier le type d'opération :débit, crédit (remboursement), ou devérification lors de la création ou mise à jour d'un alias sans transaction.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Remarque
Le champ vads_operation_type n'est pas retourné dans la réponse lorsqu'unpaiement est annulé ou abandonné.
Format enum
Valeurs possibles • DEBIT
• CREDIT
• VERIFICATION
Remarque
Le champ vads_operation_type est valorisé à VERIFICATION dans les cas suivantsoù il n'y pas de transaction :
• vads_page_action = REGISTER
Création de l'alias sans paiement
• vads_page_action = REGISTER_UPDATE
Modification des informations associées à l’alias
• vads_page_action = REGISTER_SUBSCRIBE
Création de l'alias lors de la souscription à un abonnement
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 124 / 186
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 125 / 186
vads_order_id
Description Numéro de commande. Il est également inclu dans l'e-mail de confirmation depaiement adressé à l’acheteur.
Champ au format alphanumérique. Seul le caractère spécial « - » est autorisé.
S'il contient un caractère spécial (&, ;, @, etc.), la plateforme de paiement retourneune erreur.
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay, Oney, Illicado pour lesquels lechamp est obligatoire et le format est an9.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..64
Code erreur 13
Catégorie Informations sur la commande.
vads_order_info
Description Descriptif de la commande.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..255
Code erreur 14
Catégorie Informations sur la commande.
vads_order_info2
Description Descriptif de la commande.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..255
Code erreur 14
Catégorie Informations sur la commande.
vads_order_info3
Description Descriptif de la commande.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..255
Code erreur 14
Catégorie Informations sur la commande.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 126 / 186
vads_override_payment_cinematic
Description Paramètre optionnel.
Utilisé par le marchand pour demander, sur des transactions individuelles,l’utilisation d’une cinématique de paiement différente de celle précisée dans soncontrat. (champ « Cinématique de paiement »)
Champ d'entrée.
Remarque
Tous les contrats n'exploitent pas ce paramètre. Si une valeur est sélectionnée dansun contrat qui n'exploite pas le paramètre, la donnée est ignorée et aucun messaged'erreur n'est remonté.
Format enum
Code erreur 131
Valeurs possibles • (vide)
La valeur du contrat est utilisée.
• IMMEDIATE_CAPTURE
Correspond à une cinématique de capture immédiate : la capture estdéclenchée par l'acquéreur, le jour du paiement.
• DELAYED_CAPTURE
Correspond à une cinématique de capture différée : la capture est déclenchéepar la plateforme de paiement, toujours avant l'expiration de la demanded'autorisation.
Catégorie Informations techniques.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 127 / 186
vads_page_action
Description Paramètre obligatoire.
Définit l'opération à réaliser.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Code erreur 46
Valeurs possibles • PAYMENT
Paiement (avec ou sans alias)
• REGISTER
Création de l'alias sans paiement
• REGISTER_UPDATE
Modification des informations associées à l’alias
• REGISTER_PAY
Création de l'alias lors d'un paiement
• REGISTER_SUBSCRIBE
Création de l'alias lors de la souscription à un abonnement
• REGISTER_PAY_SUBSCRIBE
Création de l'alias lors de la souscription d’un abonnement accompagné d’unpaiement
• SUBSCRIBE
Utilisation d'un alias pour souscrire à un abonnement
• REGISTER_UPDATE_PAY
Modification des informations associées à l’alias lors d'un paiement
• ASK_REGISTER_PAY
Paiement avec proposition au porteur de créer un alias
Catégorie Informations techniques.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 128 / 186
vads_payment_cards
Description Contient la liste des moyens de paiement à proposer à l’acheteur, séparés par des" ;".
Exemple : "VISA;MASTERCARD".
Si la liste ne contient qu'un moyen de paiement, la page de saisie des données dece moyen de paiement sera directement présentée. Sinon la page de sélection desmoyens de paiement sera présentée.
Si ce paramètre est vide (conseillé) alors les moyens de paiement éligibles (devises,contraintes techniques, etc) associés à la boutique seront proposés.
Champ d'entrée.
Format type 1;type 2;type 3
Code erreur 08
Le formulaire sera rejeté dans les cas suivants :
• la valeur transmise n'est pas présente dans la liste ci-dessous.
• TOUTES, ALL ne sont pas des valeurs acceptées. Pour proposer tous les moyensde paiement ce paramètre ne doit pas être posté ou être posté à vide.
• la valeur transmise ne correspond pas au moyen de paiement disponible pourvotre boutique.
• Votre contrat e-commerce a été clôturé par votre établissement bancaire.Contactez le service client de votre plateforme de paiement.
• la valeur transmise n'est pas éligible dans le réseau associé.
Valeurs possibles Moyen de paiementType de cartes(vads_payment_cards)
Carte enseigne Accord ACCORD_STORE
Carte enseigne Accord - Mode sandbox ACCORD_STORE_SB
Carte enseigne Alinéa ALINEA
Carte cadeau Alinéa ALINEA_CDX
Carte cadeau Alinéa - Mode sandbox ALINEA_CDX_SB
Carte enseigne Alinéa - Mode sandbox ALINEA_SB
Alipay ALIPAY
Carte cadeau AlloBébé ALLOBEBE_CDX
Carte cadeau AlloBébé - Mode sandbox ALLOBEBE_CDX_SB
American Express AMEX
Carte enseigne Auchan AUCHAN
Carte enseigne Auchan - Mode sandbox AUCHAN_SB
Carte Aurore AURORE_MULTI
Bancontact Mistercash BANCONTACT
Carte cadeau BizzBee BIZZBEE_CDX
Carte cadeau BizzBee - Mode sandbox BIZZBEE_CDX_SB
Carte enseigne Boulanger BOULANGER
Carte enseigne Boulanger - Mode sandbox BOULANGER_SB
Carte cadeau Brice BRICE_CDX
Carte cadeau Brice - Mode sandbox BRICE_CDX_SB
CB CB
Carte Cofinoga Be Smart COFINOGA
Titre-Restaurant Dématérialisé Conecs CONECS
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 129 / 186
Moyen de paiementType de cartes(vads_payment_cards)
Carte Aurore "CORA blanche" CORA_BLANCHE
Carte Aurore "CORA Premium" CORA_PREM
Carte Aurore "CORA VISA" CORA_VISA
Carte Diners Club DINERS
Diners DINERS
Carte Discover DISCOVER
Discover DISCOVER
e-Chèque-Vacances E_CV
e-carte bleue E-CARTEBLEUE
Euro-Cheque card ECCARD
Ticket Eco Chèque Edenred EDENRED_EC
Ticket Compliment Edenred EDENRED_TC
Ticket Restaurant Edenred EDENRED_TR
Prélèvement Bancaire Hobex ELV
Paiement en 3x sans frais par BNPP PF FULLCB_3X
Paiement en 4x sans frais par BNPP PF FULLCB_4X
Giropay GIROPAY
Paiement par Wallet Google Pay GOOGLEPAY
iDeal Internet Banking IDEAL
Carte Cadeau Illicado ILLICADO
Carte Cadeau Illicado - Mode sandbox ILLICADO_SB
JCB JCB
Carte cadeau JouéClub JOUECLUB_CDX
Carte cadeau JouéClub - Mode sandbox JOUECLUB_CDX_SB
Carte cadeau Jules JULES_CDX
Carte cadeau Jules - Mode sandbox JULES_CDX_SB
Klarna Internet Banking KLARNA
Carte enseigne Leroy-Merlin LEROY-MERLIN
Carte enseigne Leroy-Merlin - Mode sandbox LEROY-MERLIN_SB
Maestro MAESTRO
Mastercard MASTERCARD
MasterPass MASTERPASS
Multibanco MULTIBANCO
Carte enseigne Norauto NORAUTO
Carte enseigne Norauto - Mode sandbox NORAUTO_SB
FacilyPay Oney ONEY
FacilyPay Oney - Mode sandbox ONEY_SANDBOX
PayDirekt PAYDIREKT
Wallet Paylib PAYLIB
PayPal PAYPAL
PayPal - Mode sandbox PAYPAL_SB
Carte enseigne PicWic PICWIC
Carte enseigne PicWic - Mode sandbox PICWIC_SB
PostFinance POSTFINANCE
PostFinance E-finance POSTFINANCE_EFIN
Virement Bancaire SEPA CREDIT TRANSFER SCT
Prélèvement Bancaire SEPA DIRECT DEBIT SDD
SEPA DIRECT DEBIT SDD
Carte Soficarte SOFICARTE
Sofort Banking SOFORT_BANKING
Carte Cadeau Truffaut TRUFFAUT_CDX
Union Pay UNION_PAY
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 130 / 186
Moyen de paiementType de cartes(vads_payment_cards)
Carte enseigne Villaverde VILLAVERDE
Carte enseigne Villaverde - Mode sandbox VILLAVERDE_SB
Visa VISA
Visa Electron VISA_ELECTRON
Vpay VPAY
WeChat WECHAT
Catégorie Informations sur la transaction.
vads_payment_certificate
Description Ce champ est valorisé par la plateforme de paiement dans le cas où l’autorisationa été réalisée avec succès.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format an40
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 131 / 186
vads_payment_config
Description Désigne le type du paiement : comptant ou en plusieurs fois.
• Pour un paiement simple, la valeur doit être égale à SINGLE.
• Pour un paiement en plusieurs fois avec montants et dates fixes, la valeur doitêtre égale à MULTI: suivi par des paires clé=valeur séparées par des « ; ».
Les paramètres sont les suivants :
• « first » indique le montant du premier paiement (exprimé dans la plus petiteunité de la monnaie ou devise).
• « count » indique le nombre total d'échéances.
• « period » indique l’intervalle en nombre de jours entre 2 paiements.
L'ordre des champs associés à MULTI est imposé.
Remarque : valeur MULTI non disponible pour le paiement SEPA
• Pour un paiement en plusieurs fois, avec un échéancier personnalisé, la valeurdoit être égale à MULTI_EXT: suivi par des paires date=montant séparées pardes « ; ».
Les dates ne doivent pas être dans le passé.
Remarque : valeur MULTI_EXT non disponible pour le paiement SEPA
L’utilisation de la valeur MULTI_EXT nécessite la souscription de l’option Paiementen plusieurs fois avancé.
Remarque: La valeur de vads_capture_delay n'est pas prise en compte dans le casd'un paiement en plusieurs fois MULTI_EXT.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Code erreur 07
Valeurs possibles • SINGLE
• MULTI:first= montant_inital;count= nbre_echeances;period=intervalle_en_jours
Remarque : valeur MULTI non disponible pour le paiement SEPA
• MULTI_EXT:date1=montant1;date2=montant2;date3=montant3
Remarque : valeur MULTI_EXT non disponible pour le paiement SEPA
Exemple 1 MULTI permet de définir un paiement en plusieurs fois.
Le montant de chaque échéance correspond au montant total divisé par le nombred'échéances.
La valeur du premier montant peut être différente et spécifiée dans le paramètrefirst.
En cas de reste différent de zéro, il sera reporté sur le montant de la dernièreéchéance.
Requête de paiement :
• vads_capture_delay=2
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 132 / 186
• vads_currency=978
• vads_amount=20000
• vads_payment_config=MULTI:first=10000;count=4;period=30
Résultat :
Un premier paiement de 100 ,00 EUR sera remis en banque à J+2(vads_capture_delay).
Un deuxième paiement de 33,33 EUR sera effectué à J+32 (vads_capture_delay +period).
Un troisième paiement de 33,33 EUR sera effectué à J+62.
Un quatrième et dernier paiement de 33,34 EUR sera effectué à J+92.
Le total donne bien 200,00 EUR (vads_amount= 20000). Le reste a été ajouté aumontant de la dernière échéance.
Cette instruction permet de créer immédiatement 4 paiements avecle même numéro de transaction mais un numéro d'échéance différent(vads_sequence_number).
Exemple 2 MULTI_EXT permet de définir un échéancier personnalisé. Vous pourrez ainsidéfinir la date et le montant de chaque échéance.
Requête de paiement MULTI_EXT :
• vads_currency=978
• vads_amount=10000
• vads_payment_config= MULTI_EXT:20150601 =5000; 20150701 =2500;20150808 =2500
Résultat :
Le premier paiement aura lieu le 1er juin 2015 pour un montant de 50,00 EUR .
Le second paiement aura lieu le 1er juillet 2015 pour un montant de 25,00 EUR .
Le dernier paiement aura lieu le 8 août 2015 pour un montant de 25,00 EUR .
Remarque :
La somme totale des montants doit être égale à la valeur du champ vads_amount.La date de la dernière échéance ne peut être supérieure à 12 mois par rapport à ladate de soumission du formulaire. Si la date de la dernière échéance est supérieureà la date de validité de la carte, aucune échéance ne sera enregistrée et l’acheteursera notifié par un message de ce problème.
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 133 / 186
vads_payment_error
Description Codes d'erreurs pouvant apparaître lors d'un paiement refusé.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..3
Valeurs possibles
Code Message
1 La transaction n'a pas été trouvée.
2 La transaction n'a pas été trouvée.
3 Cette action n'est pas autorisée sur une transaction ayant ce statut {0}.
4 Cette transaction n'est pas autorisée dans ce contexte.
5 La transaction existe déjà.
6 Montant de transaction invalide.
7 Cette action n'est plus possible pour une transaction créée à cette date.
8 La date d'expiration de la carte ne permet pas cette action.
9 CVV obligatoire pour la carte.
10 Le montant de remboursement est supérieur au montant initial.
11 La somme des remboursements effectués est supérieure au montant initial.
12 La duplication d'un crédit (remboursement) n'est pas autorisée.
13 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
14 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
15 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
16 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
17 Le téléparamétrage du contrat Aurore a échoué.
18 L'analyse de la réponse Cetelem a échoué.
19 Devise inconnue.
20 Type de carte invalide.
21 Aucun contrat trouvé pour ce paiement. Veuillez modifier les données ou contacter votre gestionnaire en casd'échecs répétés.
22 Boutique non trouvée.
23 Contrat ambigüe.
24 Contrat invalide.
25 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
26 Numéro de carte invalide
27 Numéro de carte invalide.
28 Numéro de carte invalide.
29 Numéro de carte invalide.
30 Numéro de carte invalide (Luhn).
31 Numéro de carte invalide (longueur).
32 Numéro de carte invalide (non trouvé).
33 Numéro de carte invalide (non trouvé).
34 Contrôle carte à autorisation systématique en échec.
35 Contrôle e-Carte Bleue en échec.
36 Le contrôle des risques a provoqué le refus de la transaction.
37 Interruption non gérée lors du processus de paiement.
38 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
39 Refus 3D Secure pour la transaction.
40 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
41 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
42 Une erreur interne est survenue lors de la consultation du numéro de carte.
43 Une erreur interne est survenue lors de la consultation du numéro de carte.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 134 / 186
Code Message
44 Cette action n'est pas autorisée pour les transactions de proximité.
45 Devise invalide pour la modification.
46 Le montant est supérieur au montant autorisé.
47 La date de présentation souhaitée est postérieure à la date de validité de l'autorisation.
48 La modification requise est invalide.
49 Définition du paiement multiple invalide.
50 Boutique inconnue.
51 Cours inconnu.
52 Le contrat est clos depuis le {0}.
53 La boutique {0} est close depuis le {1}.
54 Paramètre rejeté pouvant contenir des données sensibles {0}.
55 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
57 Erreur lors de la récupération de l'alias.
58 Le statut de l'alias n'est pas compatible avec cette opération.
59 Erreur lors de la récupération de l'alias.
60 Alias existant.
61 Alias invalide
62 Création d'un alias refusée.
63 Abonnement déjà existant.
64 Cet abonnement est déjà résilié.
65 Cet abonnement est invalide.
66 La règle de récurrence n'est pas valide.
67 Création de l'abonnement refusée.
68 Annulation refusée.
69 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
70 Code pays invalide.
71 Paramètre du service web invalide.
72 Refus d'autorisation par Cofinoga.
73 Refus de l'autorisation à 1 EUR (ou demande de renseignement sur le réseau CB si l'acquéreur le supporte).
74 Configuration de paiement invalide.
75 L'opération a été refusée par PayPal.
76 Le nom du porteur est absent.
77 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
78 Identifiant de transaction non défini.
79 Identifiant de transaction déjà utilisé.
80 Identifiant de transaction expiré.
81 Contenu du thème config invalide.
82 Le remboursement n'est pas autorisé.
83 Montant de transaction en dehors des valeurs permises.
85 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
87 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
88 Remboursement impossible : le remboursement des transactions est interdit par PayPal au-delà de 60 jours.
89 La modification n'est pas autorisée.
90 Une erreur est apparue lors du remboursement de cette transaction.
91 Aucune option de paiement activée pour ce contrat.
92 Une erreur est survenue lors du calcul du canal de paiement.
93 Une erreur est survenue lors du retour de l'acheteur sur la page de finalisation de paiement.
94 Une erreur technique est survenue.
96 Une erreur est apparue lors de la remise de cette transaction.
97 Date de remise trop éloignée.
98 Date de transaction invalide.
99 Une erreur est survenue lors du calcul de l'origine du paiement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 135 / 186
Code Message
100 Contrôle carte commerciale en échec.
101 Refusé car première échéance refusée.
103 Le statut de la transaction n'a pas pu être synchronisé avec le système externe.
104 Une erreur est apparue lors de la remise de cette transaction.
105 Une erreur de sécurité est apparue lors du processus 3DS de cette transaction.
106 Devise non supportée pour ce contrat et/ou cette boutique.
107 La carte associée à l'alias n'est plus valide.
108 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
109 Délai d'attente dépassé lors de la redirection de l'acheteur.
110 Carte de paiement non supportée par le contrat.
111 Refus des transactions sans Transfert de responsabilité.
112 L'annulation n'est pas autorisée.
113 La duplication n'est pas autorisée.
115 Le remboursement n'est pas autorisé.
116 Paiement manuel non autorisé pour cette carte.
118 Paiement manuel en plusieurs fois non autorisé pour cette carte.
119 La date soumise est invalide.
120 L'option de paiement de la transaction initiale n'est pas applicable.
124 Carte inactive.
125 Paiement refusé par l'acquéreur.
126 Cette action n'est pas possible car la séquence de paiement n'est pas terminée.
128 Moyen de paiement invalide.
129 Code PIN invalide.
130 Solde épuisé
131 Solde insuffisant
136 Refus des transactions dérivées, sans Transfert de responsabilité sur la transaction primaire.
137 La transaction est un doublon.
138 Le remboursement partiel n'est pas possible sur cette transaction.
139 Remboursement refusé.
140 Un problème technique est survenu lors du paiement.
141 L'analyseur de risque a rejeté cette transaction.
142 Le type de carte utilisé n'est pas valide pour le mode de paiement demandé.
143 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
144 Une transaction en mode production a été marquée en mode test chez l'acquéreur.
145 Une transaction en mode test a été marquée en mode production chez l'acquéreur.
146 Code sms invalide.
147 Le module de gestion de fraudes a demandé le refus de cette transaction.
148 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande. La transaction n'a pasété créée.
149 La durée de la session de paiement a expiré (cas de l'acheteur qui est redirigé vers l'ACS et qui ne finalise pasl'authentification 3D Secure).
150 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande. La transaction n'a pasété créée.
151 Une transaction Facily Pay ne peut pas être annulée/modifiée/remboursée entre 23h30 et 5h30.
152 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
153 Une erreur technique est survenue lors de l'appel au service Banque Accord.
155 La transaction Facily Pay n'a pu être annulée/modifiée/remboursée : l'état de la transaction ne permet pas deréaliser l'action demandée. Rappel concernant une transaction Facily Pay : un remboursement doit respecterun délai de deux jours après la remise, le délai entre deux remboursements est d'un jour, un remboursementpartiel est limité à 20 jours, un remboursement total est limité à 6 mois.
156 Opération non supportée.
158 Suite à un incident technique, nous ne sommes pas en mesure de traiter votre demande.
159 Le montant est inférieur au montant minimum autorisé (minimum={0} {1}).
160 Il est impossible de rembourser une transaction impayée.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 136 / 186
Code Message
164 Option de paiement invalide.
165 Le type de document d'identité est présent, mais son numéro est absent.
166 Le numéro de document d'identité est présent, mais son type est absent.
167 Le type du document d'identité est inconnu.
168 Le numéro du document d'identité est invalide.
169 Les données spécifiques devant être transmises à l'acquéreur sont invalides.
170 Le paiement différé n'est pas autorisé.
171 Le nombre de mois pour le paiement différé n'est pas autorisé.
172 La cinématique de paiement sélectionnée est invalide.
173 Erreur sur le service Express Checkout de PayPal.
174 Emetteur de carte non disponible.
175 Annulation impossible, veuillez tenter un remboursement.
176 Remboursement impossible, veuillez tenter une annulation.
177 Aucune réponse à la demande d'autorisation n'a été reçue dans le délai imparti.
178 Annulation impossible, la transaction a déjà été annulée.
179 Le status de la transaction est inconnue.
182 L'identifiant national du client est absent.
183 Le format de l'identifiant national du client est incorrect.
Catégorie Informations techniques.
vads_payment_option_code
Description Code de l'option de paiement utilisée.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..5
Code d'erreur 103
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 137 / 186
vads_payment_seq
Description Détails des transactions réalisées.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format json
vads_payment_seq (format json) décrit la séquence de paiement fractionné. Ilcontient les éléments :
• "trans_id" : identifiant de la transaction global à la séquence de paiement.
• "transaction" : tableau des transactions de la séquence. Il contient leséléments :
Nom du paramètre Description
amount Montant de la séquence de paiement.
operation_type Opération de débit.
auth_number Numéro d'autorisation. Exemple : 949478
auth_result Code retour de la demande d'autorisation.
capture_delay Délai avant remise (en jours).
• Pour un paiement par carte bancaire, la valeur de ce paramètre tientcompte du délai en nombre de jours avant la remise en banque. Si ceparamètre n'est pas transmis dans le formulaire de paiement, la valeurpar défaut définie dans le Back Office Marchand sera utilisée.
card_brand Moyen de paiement utilisé.Pour un paiement par carte bancaire (exemple CB ou cartes CB cobadgéesVisa ou Mastercard), ce paramètre est valorisé à "CB".Se référer au guide d'intégration du formulaire de paiement disponible surnotre site documentaire pour visualiser la liste complète des types de carte.
card_number Numéro du moyen de paiement.
expiry_month Mois d'expiration du moyen de paiement.
expiry_year Année d'expiration du moyen de paiement.
payment_certificate Certificat de paiement.
contract_used Contrat utilisé pour le paiement.
identifier Identifiant unique (token/alias) associé à un moyen de paiement.
identifier_status Présent uniquement si l’action demandée correspond à la création ou à lamise à jour d'un alias.Valeurs possibles:
Valeur Description
CREATED La demande d’autorisation a été acceptée.L'alias (ou RUM pour un paiement SEPA) est créé avecsuccès.
NOT_CREATED La demande d’autorisation a été refusée.L'alias (ou RUM pour un paiement SEPA) n'est pas crééet n'apparaîtra pas dans le Back Office Marchand.
UPDATED L'alias (ou RUM pour un paiement SEPA) est mis à jouravec succès.
NOT_UPDATED L'alias (ou RUM pour un paiement SEPA) n'a pas étémis à jour.
ABANDONED Action abandonnée par l'acheteur (débiteur).L'alias (ou RUM pour un paiement SEPA) n'est pas crééet n'apparaîtra pas dans le Back Office Marchand.
presentation_date Pour un paiement par carte bancaire, ce paramètre correspond à la date deremise en banque souhaitée (au format ISO 8601).
trans_id Numéro de transaction.
ext_trans_id Paramètre absent pour le paiement par carte bancaire.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 138 / 186
Nom du paramètre Description
trans_uuid Référence unique générée par la plateforme de paiement suite à la créationd'une transaction de paiement.Offre une garantie d'unicité pour chaque transaction
extra_result Code numérique du résultat des contrôles de risques.
Code Description
Vide Pas de contrôle effectué.
00 Tous les contrôles se sont déroulés avec succès.
02 La carte a dépassé l’encours autorisé.
03 La carte appartient à la liste grise du marchand.
04 Le pays d’émission de la carte appartient à la liste grise dumarchand.
05 L’adresse IP appartient à la liste grise du marchand.
06 Le code bin appartient à la liste grise du marchand.
07 Détection d’une e-carte bleue.
08 Détection d’une carte commerciale nationale.
09 Détection d’une carte commerciale étrangère.
14 Détection d’une carte à autorisation systématique.
20 Contrôle de cohérence : aucun pays ne correspond (pays IP, payscarte, pays de l’acheteur ).
30 Le pays de l’adresse IP appartient à la liste grise.
99 Problème technique rencontré par le serveur lors du traitementd’un des contrôles locaux.
sequence_number Numéro de séquence.
trans_status Statut de la transaction.
Tableau 13 : Contenu de l'objet JSON
Remarque : les transactions annulées sont également présentes dans le tableau(information donnée dans le paramètre JSON trans_status).
Catégorie Informations sur la transaction.
vads_payment_src
Description Permet de définir le mode de saisie des informations du moyen de paiement.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Code erreur 60
Valeurs possibles Valeur Description
EC E-commerce : Saisie des données depuis la page de paiement par le porteur decarte.
MOTO MAIL OR TELEPHONE ORDER : Saisie réalisée par un opérateur suite à unecommande par téléphone ou e-mail.
CC Call center : Saisie réalisée par un opérateur de centre d’appel.
OTHER Autre : Saisie réalisé depuis une autre source comme le Back Office Marchand parexemple.
Seule la valeur EC permet de créer une transaction avec 3D Secure.
Les autres valeurs ne doivent être utilisées que pour de la vente à distance, pourlaquelle le 3D Secure n’est pas applicable.
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 139 / 186
vads_pays_ip
Description Code pays de l’adresse IP de l’acheteur à la norme ISO 3166.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format a2
Catégorie Informations sur l'acheteur.
vads_presentation_date
Description • Date et heure UTC de remise en banque demandée, au formatAAAAMMJJhhmmss.
ou
• Date et heure UTC de l'échéance demandée dans le cadre d'un prélèvementSEPA.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n14
Catégorie Informations sur la transaction.
vads_pretax_amount
Description Permet de définir le montant hors taxe de l’ensemble de la commande.
La valeur doit être exprimée dans la plus petite unité monétaire (le centime pourl'euro) .
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..12
Catégorie Informations sur la commande.
vads_product_amountN
Description Permet de définir le montant des différents articles contenus dans le panier.
N correspond à l'indice de l'article. (0 pour le premier, 1 pour le deuxième etc.)
Le montant sera exprimé dans l'unité la plus petite de la devise. Le centime pourl'euro.
Champ d'entrée.
Format n..12
Code d'erreur 102
Catégorie Informations sur la commande.
vads_product_ext_idN
Description Correspond au code barre de l'article dans le site web du marchand.
N correspond à l'indice de l'article. (0 pour le premier, 1 pour le deuxième, etc.)
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 140 / 186
Champ transmis à l'analyseur de fraude Konduto
Champ d'entrée.
Format an..100
Code d'erreur 120
Catégorie Informations sur la commande
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 141 / 186
vads_product_labelN
Description Permet de définir le libellé de chacun des articles contenus dans le panier.
N correspond à l'indice de l'article. (0 pour le premier, 1 pour le deuxième etc.)
Remarque:
En fonction du moyen de paiement, certaines restrictions peuvent modifier leformat. C'est le cas pour les paiements FacilyPay et Oney pour lesquels le champest obligatoire et le format est an..127.
Champ d'entrée.
Format ans..255
Code d'erreur 97
Catégorie Informations sur la commande.
vads_product_qtyN
Description Permet de définir la quantité de chacun des articles contenus dans le panier.
N est un nombre entier qui correspond à l'indice de l'article. (0 pour le premier, 1pour le deuxième etc.)
Champ d'entrée.
Format n..12
Code d'erreur 101
Catégorie Informations sur la commande.
vads_product_refN
Description Permet de définir une référence pour chacun des articles contenus dans le panier.
N correspond à l'indice de l'article. (0 pour le premier, 1 pour le deuxième etc.)
Champ d'entrée.
Format an..64
Code d'erreur 100
Catégorie Informations sur la commande.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 142 / 186
vads_product_typeN
Description Permet de définir le type de l'article contenu dans le panier.
N correspond à l'indice de l'article. (0 pour le premier, 1 pour le deuxième etc.)
Champ d'entrée.
Format enum
Code d'erreur 98
Valeurs possibles Valeur Description
FOOD_AND_GROCERY Produits alimentaires et d'épicerie
AUTOMOTIVE Automobile / Moto
ENTERTAINMENT Divertissement / Culture
HOME_AND_GARDEN Maison et jardin
HOME_APPLIANCE Equipement de la maison
AUCTION_AND_GROUP_BUYING Ventes aux enchères et achats groupés
FLOWERS_AND_GIFTS Fleurs et cadeaux
COMPUTER_AND_SOFTWARE Ordinateurs et logiciels
HEALTH_AND_BEAUTY Santé et beauté
SERVICE_FOR_INDIVIDUAL Services à la personne
SERVICE_FOR_BUSINESS Services aux entreprises
SPORTS Sports
CLOTHING_AND_ACCESSORIES Vêtements et accessoires
TRAVEL Voyage
HOME_AUDIO_PHOTO_VIDEO Son, image et vidéo
TELEPHONY Téléphonie
Tableau 14 : Valeurs associées à vads_product-type0
Catégorie Informations sur la transaction.
vads_product_vatN
Description Permet de définir le montant de la taxe pour chacun des articles contenu dans lepanier.
N correspond à l'indice de l'article. (0 pour le premier, 1 pour le deuxième etc.)
Champ d'entrée.
Format n..12
Code d'erreur 203
Valeurs possibles • Un entier sans décimal
Pour exprimer un montant en centime appliqué sur le produit concerné.
Exemple en euros : 14520 (pour un montant de 145 euros et 20 centimes)
• Un entier avec décimal inférieur à 100
Pour exprimer un pourcentage appliqué sur le montant du produit concernéavec maximum 4 chiffres après la virgule.
Exemples : 20.0 ou 19.6532
Remarques :
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 143 / 186
• La décimale est obligatoire pour exprimer un pourcentage.
• La décimale est marquée par le caractère ".".
Catégorie Informations sur la commande.
vads_proof_of_id_number
Description Champ réservé à la saisie du numéro de la pièce d'identité de l'acheteur sur la pagede paiement.
Le format dépend du type de pièce d'identité et est de 7 à 13 caractères, chiffres,lettres et/ou points.
En Amérique Latine, ce paramètre peut être obligatoire pour certains acquéreurs.
Champ d'entrée.
Format an..13
Code d'erreur 129
Catégorie Informations sur le moyen de paiement.
vads_proof_of_id_type
Description Ce champ correspond au type de pièce d'identité sélectionné par l'acheteur lorsde la saisie des données de la carte de paiement.
En Amérique Latine, ce paramètre est obligatoire pour DECIDIR.
Champ d'entrée.
Format enum
Code d'erreur 128
Catégorie Informations sur le moyen de paiement.
vads_recurrence_number
Description Numéro de l'échéance de l'abonnement.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..2
Catégorie Informations sur l'abonnement.
vads_recurrence_status
Description Statut de l'abonnement.
Présent uniquement si l’action demandée correspond à la création d'unabonnement (REGISTER_SUBSCRIBE, SUBSCRIBE, REGISTER_PAY_SUBSCRIBE,REGISTER_UPDATE_PAY).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format string
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 144 / 186
Valeurs possibles Valeur Description
CREATED L’abonnement a été créé avec succès.Le détail de l’abonnement est visible dans le Back Office Marchand.
NOT_CREATED L’abonnement n’a pas été créé et n’est pas visible dans le Back OfficeMarchand.
ABANDONED La demande de création de l’abonnement a été abandonnée parl’acheteur (débiteur).L’abonnement n’a pas été créé et n’est pas visible dans le Back OfficeMarchand.
Catégorie Informations sur l'abonnement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 145 / 186
vads_redirect_error_message
Description Permet de spécifier le message en cas de paiement refusé dans le cas d’uneredirection automatique vers le site marchand.
Champ d'entrée.
Format ans..255
Code erreur 37
Catégorie Redirection vers le site marchand.
vads_redirect_error_timeout
Description Permet de définir un délai en secondes avant redirection automatique vers le sitemarchand à la fin d’un paiement refusé.
Sa valeur est comprise entre 0 et 600s.
Passé ce délai, l'acheteur sera dirigé vers l'URL renseignée dans le champvads_url_refused. Si ce champ n'est pas renseigné, l'acheteur sera redirigé versl'URL de retour renseignée dans le champ vads_url_return ou vers l’URL de retourrenseignée dans le Back Office Marchand. Si l'URL de retour n'est pas définie, ilsera redirigé vers l’URL de la boutique.
Champ d'entrée.
Format n..3
Code erreur 36
Catégorie Redirection vers le site marchand.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 146 / 186
vads_redirect_success_message
Description Permet de spécifier le message à la fin d’un paiement accepté dans le cas d’uneredirection automatique vers le site marchand.
Champ d'entrée.
Format ans..255
Code erreur 35
Catégorie Redirection vers le site marchand.
vads_redirect_success_timeout
Description Permet de définir un délai en secondes avant redirection automatique vers le sitemarchand à la fin d’un paiement accepté.
Sa valeur est comprise entre 0 et 600s.
Passé ce délai, l'acheteur sera dirigé vers l'URL renseignée dans le champvads_url_success. Si ce champ n'est pas renseigné, l'acheteur sera redirigé versl'URL de retour renseignée dans le champ vads_url_return ou vers l’URL de retourrenseignée dans le Back Office Marchand. Si l'URL de retour n'est pas définie, ilsera redirigé vers l’URL de la boutique.
Champ d'entrée.
Format n..3
Code erreur 34
Catégorie Redirection vers le site marchand.
vads_requestor
Description Permet de modifier la valeur du champ "Aceite" sur un Boleto Bancario.
Le champ Aceite peut avoir deux valeurs :
• N (= Non)
Valeur par défaut
Le boleto a été généré sans l'autorisation officielle de l'acheteur via undocument signé.
• S (= oui)
L'autorisation de l'acheteur est indispensable car le document signé sera lareconnaissance de dette.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Valeurs possibles • BANK
Signifie que la valeur S (= oui) sera appliquée dans le champ Aceite
• MERCHANT
Signifie que la valeur N (= non) sera appliquée dans le champ Aceite
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 147 / 186
Catégorie Informations sur la transaction
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 148 / 186
vads_result
Description Code retour de l'action demandée.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n2
Valeurs possibles Valeur Description
00 Action réalisée avec succès.
02 Le marchand doit contacter la banque du porteur. Déprécié.
05 Action refusée.
17 Annulation de l'acheteur
30 Erreur de format de la requête. A mettre en rapport avec la valorisation du champvads_extra_result.
96 Erreur technique.
Catégorie Informations techniques.
vads_return_mode
Description Permet de spécifier la méthode de transmission des données utilisée lors du retourvers le site marchand.
Champ d'entrée.
Format enum
Code erreur 48
Valeurs possiblesNom du champ Valeur Description
absent, vide ouNONE
Aucun paramètre ne sera passé à l’URL de retourvers le site marchand.
GET Les champs de retour seront transmis à l’URL deretour sous la forme d’un formulaire HTTP GET(dans la « query string »).
vads_return_modePOST Les champs de retour seront transmis à l’URL de
retour sous la forme d’un formulaire HTTP POST.Si le retour boutique se fait sur un environnementnon https alors le navigateur affichera un pop-upde sécurité à l’acheteur.
Catégorie Redirection vers le site marchand.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 149 / 186
vads_risk_analysis_result
Description Retourne le résultat de l'analyse de fraude effectuée par un système externe(Konduto, ClearSale, CyberSource, NOTO ...).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans
Valeurs possibles
Valeurs communes à tous les analyseurs de risques
INVALID_CREDENCIAL Problème de paramétrage du contrat d’analyse de risques.
COMUNICATION_PROBLEM Impossible de communiquer avec l’analyseur de risques.
DATA_PROCESSING_PROBLEM Problème lors du traitement de l’envoi ou de la réponse d’analyse derisques.
MISSING_MANDATORY_ORDER_INFO Des données relatives à la commande sont manquantes.
MISSING_MANDATORY_SHIPPING_INFO Des données relatives à la livraison sont manquantes.
MISSING_MANDATORY_SHIPPING_ADDRESS_INFO Des données relatives à l’adresse de livraison sont manquantes.
MISSING_MANDATORY_BILLING_INFO Des données relatives à la facturation sont manquantes.
MISSING_MANDATORY_BILLING_ADDRESS_INFO Des données relatives à l’adresse de facturation sont manquantes
MISSING_MANDATORY_CARD_INFO Des données concernant le moyen de paiement sont manquantes.
MISSING_MANDATORY_CUSTOMER_INFO Des données concernant l’acheteur sont manquantes.
Valeurs retournées par ClearSale
APA La transaction est automatiquement approuvée selon les paramètres définis.
APM La transaction est manuellement approuvée par un analyste.
RPM La commande est refusée en raison du manque d'informations sur l'acheteur en accord avec la politiqueappliquée.
AMA En attente d'analyse manuelle. La commande est dans une file d'attente pour analyse.
ERR Erreur
NVO Nouvelle commande. En attente de traitement et de classification.
SUS Commande suspendue manuellement. La commande est suspendue pour suspicion de fraude.
CAN Commande annulée. La commande est annulée par l'acheteur.
FRD Fraude confirmée avec l'opérateur de la carte de crédit ou du titulaire de la carte.
RPA Commande refusée automatiquement. La commande est refusée en application des paramètres del'analyseur de fraude externe.
RPP Commande refusée automatiquement. La commande est refusée en application de la politique client ouClearSale.
Valeurs retournées par Cybersource
100 La transaction s'est effectuée avec succès.
101 La transaction est refusée. Un ou plusieurs champs sont manquants.
102 La transaction est refusée. Un ou plusieurs champs contient des données invalides.
150 Erreur.
151 Erreur. La requête a été reçue mais le délai a été dépassé. Cette erreur n'inclue pas les dépassements dedélais entre le client et le serveur.
152 Erreur. La requête a été reçue mais un service n'a pas terminé à temps.
202 Refusée. Carte expirée.
231 Refusée. Numéro de compte invalide.
234 Refusé. Un problème est survenu avec la configuration CyberSource du marchand.
400 Refusée. Le score de la fraude dépasse le seuil de tolérance.
480 La commande est marquée afin d'être examinée par le Decision Manager.
481 La commande a été rejetée par le Decision Manager.
Valeurs retournées par Konduto/NOTO
APPROVE Konduto recommande d'accepter la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 150 / 186
Valeurs retournées par Konduto/NOTOSi aucune règle ne contredit cette recommandation, le statut de la transactionsera AUTHORISED.
DECLINE Konduto recommande de refuser la transaction.Le statut de la transaction sera REFUSED.
REVIEW Konduto recommande de vérifier la transaction.En fonction du résultat de l'authentification 3D-Secure, le statut de la transactionsera :
• AUTHORISED_TO_VALIDATE si le porteur s'est authentifié avec succès.
• REFUSED en cas d'échec d'authentification du porteur.
THREE_DS NOTO a recommandé une authentification forte.
NONE Aucune recommandation particulière de la part de NOTO.
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 151 / 186
vads_risk_assessment_result
Description Retourne la liste des actions réalisées sur la transaction, suite au déclenchement desrègles de gestion de risques avancées activées dans le Back Office Marchand.
Lors du déclenchement de plusieurs règles, le champ vads_risk_assessment_resultssera composé de plusieurs mots-clés séparés par un ";".
Exemple :
vads_risk_assessment_results="ENABLE_3DS;MANUAL_VALIDATION"
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans
Valeurs possibles
Valeurs Description
ENABLE_3DS 3D Secure activé.
DISABLE_3DS 3D Secure désactivé.
MANUAL_VALIDATION La transaction est créée en validation manuelle.La remise du paiement est bloquée temporairement pour permettre au marchand deprocéder à toutes les vérifications souhaitées.
REFUSE La transaction est refusée.
RUN_RISK_ANALYSIS Appel à un analyseur de risques externes sous condition que le marchand possède uncontrat.Se référer à la description du champ vads_risk_analysis_result pour identifier la listedes valeurs possibles et leur description.
INFORM Une alerte est remontée.Le marchand est averti qu’un risque est identifié.Le marchand est informé via une ou plusieurs des règles du centre de notification(URL de notification, e-mail ou SMS).
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 152 / 186
vads_risk_control
Description Permet de définir le résultat du contrôle des risques.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format contrôle1=resultat1;contrôle2=resultat2
Valeurs possibles Valeur Description
CARD_FRAUD Contrôle la présence du numéro de carte de l'acheteurdans la liste grise de cartes.
SUSPECT_COUNTRY Contrôle la présence du pays émetteur de la carte del'acheteur dans la liste de pays interdits.
IP_FRAUD Contrôle la présence de l'adresse IP de l'acheteur dans laliste grise d'IP.
CREDIT_LIMIT Contrôle la fréquence et les montants d'achat d'unmême numéro de carte, ou le montant maximum d'unecommande.
BIN_FRAUD Contrôle la présence du code BIN de la carte de l'acheteurdans la liste grise de codes BIN.
ECB Contrôle si la carte de l'acheteur est de type e-carte bleue.
COMMERCIAL_CARD Contrôle si la carte de l'acheteur est une cartecommerciale.
SYSTEMATIC_AUTO Contrôle si la carte de l'acheteur est une carte àautorisation systématique.
INCONSISTENT_COUNTRIES Contrôle si le pays de l'adresse IP, le pays émétteur de lacarte de paiement, et le pays de l'adresse de l'acheteursont cohérents entre eux.
NON_WARRANTY_PAYMENT Contrôle le transfert de responsabilité de la transaction.
SUSPECT_IP_COUNTRY Contrôle la présence du pays de l'acheteur, identifié parson adresse IP, dans la liste de pays interdits.
Les différentes valeurs possibles pour ‘résultat’ sont :
Valeur Description
OK OK
WARNING Contrôle informatif échoué
ERROR Contrôle bloquant échoué
Catégorie Informations sur la transaction.
vads_sequence_number
Description Numéro de séquence de la transaction.
Cas du paiement unique (vads_payment_config=SINGLE)
vads_sequence_number est valorisé à 1 dans le cas d’un paiement unique.
Cependant, si le marchand a autorisé plusieurs tentatives de paiement après unpaiement refusé, le numéro de séquence sera incrémenté à chaque nouvelletentative.
Le nombre de tentatives supplémentaires après un paiement refusé estconfigurable depuis le Back Office Marchand (menu Paramétrage > Boutique >Configuration).
Si vads_payment_config = SINGLE :
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 153 / 186
vads_url_check_srcvads_sequence_numberDescription
1 Paiement réglé en 1 tentative
2 Paiement réglé en 2 tentativesPAY
3 Paiement réglé en 3 tentatives
1 Paiement différé réglé en 1 tentative
2 Paiement différé réglé en 2 tentativesBATCH_AUTO
3 Paiement différé réglé en 3 tentatives
Cas du paiement en plusieurs fois (vads_payment_config=MULTI)
Pour un paiement en plusieurs fois, ce champ prendra la valeur "1" pour lapremière échéance, "2" pour deuxième échéance, "3" pour la troisième échéanceetc.
Le paiement en plusieurs fois n'est pas compatible avec la fonctionnalité detentatives supplémentaires en cas de paiement refusé.
Remarque :
Le champ vads_sequence_number n'est pas retourné dans la réponse lorsqu'unpaiement est annulé ou abandonné.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Catégorie Informations sur la transaction.
vads_ship_to_city
Description Permet de définir la ville de l'acheteur.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..128
Code erreur 83
Catégorie Informations sur la livraison.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 154 / 186
vads_ship_to_country
Description Permet de définir le code pays de l’acheteur à la norme ISO 3166.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format a2
Code erreur 86
Exemples de valeurspossibles
Code Pays Code Pays
AT Autriche IN Inde
BR Brésil MQ Martinique
CI Côte d'Ivoire NC Nouvelle-Calédonie
FR Corse PF Polynesie Francaise
FR France PM St-Pierre-et-Miquelon
GP Guadeloupe US Etats-Unis d'Amérique
Catégorie Informations sur la livraison.
vads_ship_to_delay
Description Permet de définir la rapidité liée au mode de livraison lorsque vads_ship_to_speedest valorisé à PRIORITY.
Champ d'entrée.
Format enum
Code erreur 127
Valeurs possibles • INFERIOR_EQUALS pour un délai de livraison inférieur ou égal à 1 heure.
• SUPERIOR pour un délai de livraison supérieur à 1 heure.
• IMMEDIATE pour un délai de livraison immédiat.
• ALWAYS pour un délai de livraison 24h/24 et 7j/7.
Catégorie Informations sur la livraison.
vads_ship_to_delivery_company_name
Description Permet de définir le nom du transporteur.
Champ d'entrée.
Format ans..127
Code erreur 96
Catégorie Informations sur la livraison.
vads_ship_to_district
Description Permet de définir le quartier.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..127
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 155 / 186
Code erreur 115
Catégorie Informations sur la livraison.
vads_ship_to_first_name
Description Permet de définir le prénom de l'acheteur.
Champ d'entrée.
Format ans..63
Code erreur 106
Catégorie Informations sur la livraison.
vads_ship_to_last_name
Description Permet de définir le nom de l'acheteur.
Champ d'entrée.
Format ans..63
Code erreur 107
Catégorie Informations sur la livraison.
vads_ship_to_legal_name
Description Raison sociale de lieu de livraison.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..100
Code d'erreur 125
Catégorie Informations sur la livraison.
vads_ship_to_name
Description Permet de définir le nom de l'acheteur.
Déprécié. Nous vous invitons à utiliser vads_ship_to_first_name etvads_ship_to_last_name
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..63
Code erreur 80
Catégorie Informations sur la livraison.
vads_ship_to_phone_num
Description Permet de définir le numéro de téléphone de l'acheteur.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 156 / 186
Format ans..32
Code erreur 87
Catégorie Informations sur la livraison.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 157 / 186
vads_ship_to_speed
Description Permet de définir le mode de livraison.
Champ d'entrée.
Format enum
Code erreur 95
Valeurs possibles • STANDARD (Réservé FacilyPay)
• EXPRESS (Réservé FacilyPay)
• PRIORITY (Réservé FacilyPay)
• ELECTRONIC_DELIVERY
• SAME_DAY_SHIPPING
• OVERNIGHT_SHIPPING
• TWO_DAYS_OR_MORE_SHIPPING
Remarque :
L'utilisation de la valeur PRIORITY implique l'utilisation du champvads_ship_to_delay.
Catégorie Informations sur la livraison.
vads_ship_to_status
Description Permet de définir le type d'adresse de livraison.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Code erreur 93
Valeurs possibles PRIVATE, COMPANY
Catégorie Informations sur la livraison.
vads_ship_to_state
Description Permet de définir l'état de l'acheteur.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..127
Code erreur 84
Catégorie Informations sur la livraison.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 158 / 186
vads_ship_to_street
Description Permet de définir l'adresse de l'acheteur.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Remarque : Les caractères > et < ne sont pas autorisés.
Code erreur 81
Catégorie Informations sur la livraison.
vads_ship_to_street2
Description Permet de définir la deuxième ligne d'adresse de l'acheteur.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Remarque : Les caractères > et < ne sont pas autorisés.
Code erreur 82
Catégorie Informations sur la livraison.
vads_ship_to_street_number
Description Permet de définir le numéro de rue.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..64
Code erreur 114
Catégorie Informations sur la livraison.
vads_ship_to_type
Description Permet de définir le type de livraison.
Champ d'entrée.
Format enum
Code erreur 94
Valeurs possibles • RECLAIM_IN_SHOP pour le retrait de la marchandise en magasin.
• RELAY_POINT pour l'utilisation d'un réseau de points de retrait tiers (Kiala,Alveol, etc).
• RECLAIM_IN_STATION pour le retrait dans un aéroport, une garde ou uneagence de voyage.
• PACKAGE_DELIVERY_COMPANY pour la livraison par transporteur (Colissimo,UPS, etc).
• ETICKET pour l'émission d'un billet électronique, téléchargement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 159 / 186
• CARD_HOLDER_ADDRESS (3DS2)
• VERIFIED_ADDRESS (3DS2)
• NOT_VERIFIED_ADDRESS (3DS2)
• SHIP_TO_STORE (3DS2)
• DIGITAL_GOOD (3DS2)
• ETRAVEL_OR_ETICKET (3DS2)
• OTHER (3DS2)
• PICKUP_POINT (3DS2)
• AUTOMATED_PICKUP_POINT (3DS2)
Catégorie Informations sur la livraison.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 160 / 186
vads_ship_to_user_info
Description Information sur l’utilisateur à l’origine du paiement.
Ce paramètre sera renvoyé dans la réponse avec la valeur transmise dans larequête.
Remarque :
Pour des raisons de rétrocompatibilité, il est possible d'utiliser ce champ pourvaloriser le CPF/CNPJ (Identifiant légal, au format numérique, de longueur compriseentre 11 et 20 digits) imposé par le module de gestion de fraude ClearSale.Cependant, le CPF/CNPJ peut être valorisé dans le champ vads_cust_national_id.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Code erreur 116
Catégorie Informations sur la livraison.
vads_ship_to_zip
Description Permet de définir le code postal de l'acheteur.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..64
Code erreur 85
Catégorie Informations sur la livraison.
vads_shipping_amount
Description Permet de définir le montant des frais de livraison pour l’ensemble de lacommande.
Champ d'entrée.
Format n..12
Code d'erreur 109
Catégorie Informations sur la livraison.
vads_shop_name
Description Permet de définir le nom de la boutique qui apparait dans le récapitulatif à la findu paiement, le ticket et les e-mails de confirmation de paiement.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..127
Code erreur 72
Catégorie Personnalisation de la page de paiement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 161 / 186
vads_shop_url
Description URL de la boutique qui apparait sur la page de paiement et les e-mails deconfirmation de paiement.
Ce paramètre permet de surcharger la valeur par défaut de votre boutique.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..1024
Code erreur 73
Catégorie Personnalisation de la page de paiement.
vads_site_id
Description Paramètre obligatoire.
Valeur générée lors de l'inscription à la plateforme de paiement.
Sa valeur est consultable sur l’interface du Back Office Marchand dans le menuParamétrage > Boutique > Clés par toutes les personnes habilitées.
Dans le cas d'une valeur incorrecte, lors du paiement, l'acheteur obtient unmessage d'erreur sur son navigateur.
Le paiement est alors impossible et la transaction est définitivement interrompue.
Un e-mail d'alerte est alors envoyé au contact administratif de la boutique. Ilcontient le formulaire que la plateforme n'a pas pu traiter avec la valeur de lasignature.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n8
Code erreur 02
Catégorie Informations techniques.
vads_subscription
Description Paramètre facultatif utilisé dans le cas de la création d'un abonnement. Il désignel'identifiant de l'abonnement à créer.
Deux options sont possibles :
• Soit la gestion de ces identifiants est déléguée à la plateforme.
Dans ce cas, ce paramètre ne doit pas être renseigné.
En cas de succès de la création de l’abonnement, la réponse contiendra la valeurgénérée par la plateforme.
• Soit la gestion de ces identifiants est faite par le site marchand.
Dans ce cas, ce paramètre doit être renseigné avec la valeur de l’identifiantd’abonnement souhaité.
Il n'y a pas de contrôle d'unicité sur l' identifiant des abonnements.
Lors de la création d'un abonnement, le site marchand peut valoriservads_subscription avec une valeur déjà existante.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 162 / 186
Il est possible de créer plusieurs abonnements, associés à un même alias, avecle même identifiant d'abonnement.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format Deux formats possibles :
• an32 : lorsque l'identifiant est généré par la plateforme
• ans..50 : lorsque l'identifiant est généré par le marchand
Code erreur 63
Catégorie Informations sur l'abonnement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 163 / 186
vads_sub_amount
Description Paramètre obligatoire utilisé dans le cas de la création d'un abonnement.
Il fait référence au montant des échéances de l’abonnement pourtoutes les échéances, hormis celles éventuellement définies parvads_sub_init_amount_number.
La valeur ne peut être ni négative, ni vide, ni égale à 0.
La valeur doit être exprimée dans la plus petite unité monétaire (le centime pourl'Euro).
Exemple : pour une transaction de 10 EUR et 28 centimes, la valeur du paramètreest 1028.
Champ d'entrée.
Format n..12
Code erreur 65
Catégorie Informations sur l'abonnement.
vads_sub_currency
Description Paramètre obligatoire utilisé dans le cas de la création d'un abonnement.
Il indique la monnaie à utiliser pour l’abonnement, selon la norme ISO 4217.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n3
Exemples de valeurspossibles
Les devises possibles sont les suivantes :
Devise Codification ISO 4217Nombre de chiffres aprèsle séparateur décimal
Dollar australien (AUD) 036 2
Riel Cambodgien (KHR) 116 0
Dollar canadien (CAD) 124 2
Renminbi yuan chinois (CNY) 156 1
Couronne tchèque (CZK) 203 2
Couronne danoise (DKK) 208 2
Dollar de Hong Kong (HKD) 344 2
Forint hongrois (HUF) 348 2
Roupie Indienne (INR) 356 2
Roupie indonésienne (IDR) 360 2
Yen (JPY) 392 0
Won Sud Coréen (KRW) 410 0
Dinar Koweïtien (KWD) 414 3
Ringgit malais (MYR) 458 2
Peso mexicain (MXN) 484 2
Dirham Marocain (MAD) 504 2
Dollar néo-zélandais (NZD) 554 2
Couronne norvégienne (NOK) 578 2
Peso philippin (PHP) 608 2
Rouble russe (RUB) 643 2
Dollar de Singapour (SGD) 702 2
Rand sud-africain (ZAR) 710 2
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 164 / 186
Devise Codification ISO 4217Nombre de chiffres aprèsle séparateur décimal
Couronne suédoise (SEK) 752 2
Franc suisse (CHF) 756 2
Baht thailandais (THB) 764 2
Dinar Tunisien (TND) 788 3
Livre Sterling (GBP) 826 2
Dollar des États-Unis (USD) 840 2
Nouveau dollar de Taïwan (TWD) 901 2
Lire turque (TRY) 949 2
Euro (EUR) 978 2
Zloty polonais (PLN) 985 2
Real du Brésil (BRL) 986 2
Code erreur 67
Catégorie Informations sur l'abonnement.
vads_sub_desc
Description Paramètre obligatoire utilisé dans le cas de la création d'un abonnement.
Il définit la règle de l’abonnement à appliquer.
La valeur attendue dans ce paramètre est une chaîne de caractères suivant laspécification iCalendar, ou Internet Calendar, décrite dans la RFC5545 (voir http://tools.ietf.org/html/rfc5545).
Cette spécification permet entre autre de définir des règles complexesd’abonnement, via la propriété RRULE.
Pour des raisons techniques, il n’est pas possible de définir des périodesd’abonnement inférieures à une journée.
Les mots clés "SECONDLY" / "MINUTELY" / "HOURLY" ne sont donc pas pris encompte.
Exemples :
• Pour définir des échéances de paiement ayant lieu le dernier jour de chaquemois, pendant 12 mois, la règle s’écrit :
RRULE:FREQ=MONTHLY;BYMONTHDAY=28,29,30,31;BYSETPOS=-1;COUNT=12
Cette règle signifie que si le mois courant ne contient pas de 31, alors le moteurprendra en compte le 30. Si le 30 n’existe pas, alors il prendra en compte le 29et ainsi de suite jusqu’au 28.
Une autre version de cette règle :RRULE:FREQ=MONTHLY;COUNT=5;BYMONTHDAY=-1
• Pour définir des échéances de paiement ayant lieu le 10 de chaque mois,pendant 12 mois, alors la règle d’abonnement s’écrit de la manière suivante :RRULE:FREQ=MONTHLY;COUNT=12;BYMONTHDAY=10
• Pour définir des échéances de paiement ayant lieu chaque trimestre, jusqu’au31/12/2016 :RRULE:FREQ=YEARLY;BYMONTHDAY=-1;BYMONTH=1,4,7,10;UNTIL=20161231
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 165 / 186
Les échéances auront lieu chaque 1er de janvier, avril, juillet et octobre. Leurnombre total dépend de la date d’effet de l’abonnement (voir paramètrevads_sub_effect_date).
Pour plus de détails et d'exemples vous pouvez consulter le site http://recurrance.sourceforge.net/.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format string
Code erreur 64
Catégorie Informations sur l'abonnement.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 166 / 186
vads_sub_effect_date
Description Paramètre obligatoire utilisé dans la création d'un abonnement qui permet dedéfinir une date d'effet de l'abonnement.
Pour un prélèvement SEPA, la date d'effet doit être au minimum à + 14 jourscalendaires par rapport à la date de soumission du formulaire (vads_trans_date).
Ce paramètre ne coïncide pas systématiquement avec la date de la premièreéchéance, qui dépend uniquement du paramètre vads_sub_desc.
La date d’effet indique à partir de quand l’abonnement débute. Le format de cettedate est AAAAMMJJ.
Exemple : pour le 1er février 2015, utilisez la valeur 20150201.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n8
Code erreur 69
Catégorie Informations sur l'abonnement.
vads_sub_init_amount
Description Paramètre facultatif utilisé lors de la création d'un abonnement. Représente lemontant des échéances de l’abonnement pour les premières échéances.
Le nombre de ces premières échéances est défini par le paramètrevads_sub_init_amount_number.
Ce montant est exprimé dans la devise définie par le paramètrevads_sub_currency et est exprimé en son unité indivisible (le centime pour l'Euro).
Exemple : pour un montant de 10 euros et 28 centimes, la valeur du paramètreest 1028.
La valeur peut être vide mais ne peut être ni négative, ni égale à 0.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..12
Code erreur 66
Catégorie Informations sur l'abonnement.
vads_sub_init_amount_number
Description Paramètre facultatif utilisé dans le cas de la création d'un abonnement.Représente le nombre d’échéances auxquelles il faudra appliquer le montantvads_sub_init_amount.
Une fois ce nombre d’échéances dépassé, c’est le montant vads_sub_amount quisera utilisé.
Exemple : pour définir un abonnement dont les 3 premières échéances sont à 25,00EUR , et le reste des échéances à 30,00 EUR , les valeurs suivantes seront utilisées :
• vads_sub_currency = 978
• vads_sub_init_amount_number = 3
• vads_sub_init_amount = 2500
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 167 / 186
• vads_sub_amount = 3000
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..3
Code erreur 68
Catégorie Informations sur l'abonnement.
vads_tax_amount
Description Paramètre qui permet de définir le montant des taxes pour l’ensemble de lacommande.
La valeur doit être exprimée dans la plus petite unité monétaire (le centime pourl'euro) .
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..12
Code d'erreur 108
Catégorie Informations sur la commande.
vads_tax_rate
Description Permet de définir le taux de taxes (TVA) appliqué sur la commande.
La valeur doit être exprimée au format XX.X avec le point comme séparateur etsans le suffixe %.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format XX.X
Code d'erreur 153
Catégorie Informations sur la commande.
vads_theme_config
Description Permet de personnaliser certains éléments de la page de paiement commele modèle de personnalisation à appliquer, le libellés des boutons et certainsmessages.
Ce paramètre propose une liste de mots-clés (codes) associés à des éléments despages de paiement auxquels on associe une valeur.
Exemple:
vads_theme_config="SUBMIT_BUTTON_LABEL=PAYER;TICKET_LABEL=TICKET DE PAIEMENT"
Consultez le Manuel utilisateur du Back Office - Personnalisation avancée pour plusde détails sur la personnalisation des pages de paiement.
Champ d'entrée.
Format map
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 168 / 186
Code erreur 32
Valeurs possibles
Code Description
Fonctionnalités
RESPONSIVE_MODEL Permet de surcharger le modèle de personnalisation à appliquer auxpages de paiement.Exemple d'utilisation:
vads_theme_config="RESPONSIVE_MODEL=Model_1"
L'utilisation des modèles de personnalisation nécessite l'activation del'option "Personnalisation avancée".
RESPONSIVE_MAIL_MODEL Permet de surcharger le modèle de personnalisation à appliquer aux e-mails.Exemple d'utilisation:
vads_theme_config="RESPONSIVE_MAIL_MODEL=Model_1"
L'utilisation des modèles de personnalisation nécessite l'activation del'option "Personnalisation avancée".
HIGH_CONTRAST_MODE Permet d'activer le mode contraste élevé pour intensifier le contraste descouleurs et afficher la page de paiement en noir et blanc.Valeurs possibles: "true" ou "false".Exemple d'utilisation:
vads_theme_config="HIGH_CONTRAST_MODE=true"
SIMPLIFIED_DISPLAY Permet de réduire le volume de données à charger lors de l'affichage dela page de paiement.Supprime le sélecteur de langue et les logos présents dans le footer.Recommandé pour les intégrations iframe et In-app.Valeurs possibles: "true" ou "false".Exemple d'utilisation:
vads_theme_config="SIMPLIFIED_DISPLAY=true"
FORM_TARGET Permet de définir où afficher la page de retour à la fin du paiement.Valeurs possibles:
• _blank: dans une nouvelle fenêtre ou un nouvel onglet
• _self: dans la frame courante
• _parent: dans la frame parent
• _top: dans toute la page
• framename: dans la frame spécifiée.
Exemple d'utilisation:
vads_theme_config="FORM_TARGET=_top"
3DS_LOGOS Permet de masquer les logos "Verified By Visa" et "Mastercard SecureCode" sur la page de saisie des données carte.Valeurs possibles: "true" ou "false".Exemple d'utilisation:
vads_theme_config="3DS_LOGOS=false"
Libellés des boutons
SUBMIT_BUTTON_LABEL Permet de modifier le libellé du bouton "VALIDER".Exemple d'utilisation:
vads_theme_config="SUBMIT_BUTTON_LABEL=PAYER"
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 169 / 186
Code Description
CANCEL_FOOTER_MSG_RETURN Libellé du bouton "Annuler et retourner à la boutique" présent surla page de sélection du moyen de paiement, la page de saisie desinformations carte, et sur la page de résultat en cas d’échec du paiement.Exemple d'utilisation:
vads_theme_config="CANCEL_FOOTER_MSG_RETURN=ANNULER"
SUCCESS_FOOTER_MSG_RETURN Libellé du bouton "Retourner à la boutique" présent sur la page derésultat en cas de paiement réalisé avec succès.Exemple d'utilisation:
vads_theme_config="SUCCESS_FOOTER_MSG_RETURN=RETOUR"
TICKET_LABEL Libellé du bouton "TICKET" présent sur la page de résultat en cas depaiement réalisé avec succès.Exemple d'utilisation:
vads_theme_config="TICKET_LABEL=TICKET DE PAIEMENT"
Messages
MERCHANT_ MESSAGE Permet d'afficher un message au dessus du récapitulatif de la transaction.Nécessite l'activation de la case à cocher Afficher le messagepersonnalisé via le menu Paramétrage > Personnalisation > onglet Pagesde paiement > groupe Logo.Exemple d'utilisation:
vads_theme_config="MERCHANT_MESSAGE=Récapitulatif de la transaction"
SECURE_ MESSAGE Valeur par défaut: L'adresse de ce site de paiement préfixée par httpsindique que vous êtes sur un site sécurisé et que vous pouvez régler votreachat en toute tranquillité.Exemple d'utilisation:
vads_theme_config="SECURE_ MESSAGE=Vous êtes sur un site sécurisé par TLS1.2. Vous pouvez régler en toute sérénité."
SECURE_MESSAGE_REGISTER Valeur par défaut: L'adresse de ce site de paiement préfixée par httpsindique que vous êtes sur un site sécurisé et que vous pouvez renseignervos coordonnées bancaires en toute tranquillité.
REGISTER_ON_PAYMENT Permet de personnaliser le texte de la case à cocher lors d'unASK_REGISTER_PAY.Valeur par défaut: Je souhaite enregistrer les données de mon moyen depaiement pour un futur achat
Libellés présents dans le ticket et les pages de paiement
SITE_ID_LABEL Valeur par défaut: Identifiant du marchand
ORDER_ID_LABEL Valeur par défaut: Référence commande
TRANSACTION_ID_LABEL Valeur par défaut: Numéro de transaction
TRANSACTION_AMOUNT_LABEL Valeur par défaut: Montant
MULTI_DATE_LABEL Valeur par défaut: Date de venteInformation présente uniquement lors d'un paiement en plusieurs fois.
CUST_ID_LABEL Valeur par défaut: Référence acheteurInformation présente uniquement lors d'un paiement par alias.
CUST_ADRESS_NUMBER_LABEL Valeur par défaut: Numéro d'adresseInformation présente uniquement lors d'un paiement par alias.
CUST_ADRESS_LABEL Valeur par défaut: AdresseInformation présente uniquement lors d'un paiement par alias.
CUST_ADRESS2_LABEL Valeur par défaut: Complément d'adresseInformation présente uniquement lors d'un paiement par alias.
CUST_DISTRICT_LABEL Valeur par défaut: QuartierInformation présente uniquement lors d'un paiement par alias.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 170 / 186
Code Description
CUST_CITY_LABEL Valeur par défaut: VilleInformation présente uniquement lors d'un paiement par alias.
CUST_COUNTRY_LABEL Valeur par défaut: PaysInformation présente uniquement lors d'un paiement par alias.
CUST_PHONE_LABEL Valeur par défaut: TélInformation présente uniquement lors d'un paiement par alias.
CUST_NAME_LABEL Valeur par défaut: Nom de l'acheteurInformation présente uniquement lors d'un paiement par alias.
RECURRENCE_AMOUNT_LABEL Valeur par défaut: Montant par échéanceInformation présente uniquement lors d'un paiement par alias.
RECURRENCE_INIT_AMOUNT_NUMBER_LABEL
Valeur par défaut: Nombre d'échéances de montant initialInformation présente uniquement lors d'un paiement par alias.
RECURRENCE_INIT_AMOUNT_LABEL Valeur par défaut: Montant initial de l'abonnementInformation présente uniquement lors d'un paiement par alias.
SHOP_LABEL Valeur par défaut: BOUTIQUEInformation présente uniquement dans le ticket PDF.
SITE_URL_LABEL Valeur par défaut: Adresse URLInformation présente uniquement dans le ticket PDF.
CUST_LANGUAGE Valeur par défaut: LangueInformation présente uniquement dans le ticket PDF.
Catégorie Personnalisation de la page de paiement.
vads_threeds_auth_type
Description Désigne le type d’authentification du porteur.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Valeurs possibles • "Vide" si l'acheteur ne s'est pas authentifié correctement,
• FRICTIONLESS: authentification du porteur sans intéraction avec l'ACS. Valeurretournée uniquement en 3DS v2.
• CHALLENGE: authentification interactive du porteur (saisie OTP ou réponse àune série de questions). Valeur retournée en 3DS v1 et 3DS v2.
Catégorie Authentification 3DS.
vads_threeds_cavv
Description Désigne la vérification de l’authentification du porteur par l’ACS. Il est valorisépar le serveur d’authentification 3DS (ACS) lorsque l’acheteur s’est correctementauthentifié (vads_threeds_status vaut « Y » ou « A »).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..28
Catégorie Authentification 3DS.
vads_threeds_cavvAlgorithm
Description Algorithme utilisé par l’ACS pour générer la valeur du cavv.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 171 / 186
Il est valorisé par le serveur d’authentification 3DS (ACS) lorsque l’acheteur s’estcorrectement authentifié (vads_threeds_status vaut « Y » ou « A »).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n1
Valeurs possiblesValeur Description
0 HMAC
1 CVV
2 CVV_ATN
3 MasterCard SPA
Catégorie Authentification 3DS.
vads_threeds_eci
Description Désigne l’Indicateur de Commerce Electronique.
Il est valorisé par le serveur d’authentification 3DS (ACS) lorsque l’acheteur s’estcorrectement authentifié (vads_threeds_status vaut « Y » ou « A »).
status = Y status = A status = U status = N
VISA et AMEX 5 6 7 -
MasterCard 02 01 - -
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..2
Catégorie Authentification 3DS.
vads_threeds_enrolled
Description Désigne le statut de l’enrôlement du porteur. Il est valorisé par les serveurs VISAet MASTERCARD (DS) durant le processus 3D Secure.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format a1
Valeurs possiblesValeur Description
Y Porteur enrôlé, authentification 3DS possible.Remarque : Dans le Back Office Marchand, la valeur ENROLLED est affichée (onglet3D Secure du Détails d'une transaction).
N Porteur non enrôlé.Remarque : Dans le Back Office Marchand, la valeur NOT_ENROLLED est affichée(onglet 3D Secure du Détails d'une transaction).
U Impossible de vérifier le statut d’enrôlement.Remarque : Dans le Back Office Marchand, la valeur UNAVAILABLE est affichée(onglet 3D Secure du Détails d'une transaction).
Catégorie Authentification 3DS.
vads_threeds_error_code
Description Statut final du processus 3D Secure.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 172 / 186
Ce champ est déprécié. Il est remplacé par le champ vads_threeds_exit_status.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..2
Catégorie Authentification 3DS.
vads_threeds_exit_status
Description Statut final du processus 3D Secure.
Il est valorisé par la plateforme de paiement.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..2
Valeurs possiblesValeur Description
0 Statut initial
1 Statut non applicable (global, raison non détaillée)
2 Statut non applicable (integrator disabled)
3 Paiement non e-commerce
4 Paiement sans 3DS (paiement par alias, PayPal, Cetelem, etc.)
5 Marchand non enrôlé, pas de 3DS
6 Erreur technique lors du processus 3DS, pas de 3DS
7 Porteur non enrôlé, pas de 3DS
8 Signature invalide
9 Problème venant de l'ACS
10 Le processus 3DS s'est déroulé correctement
11 Le processus 3DS a été fait par l'intégrateur
12 Problème venant du DS
13 Délai dépassé (timeout) lors d'une connexion au DS
15 Canal de paiement pour lequel 3DS n'est pas disponible (paiements parfichier...)
16 Type carte et réseau elligible au 3DS, mais pas de "brand" associée à la carte(CB pure)
98 L'initialisation du processus 3DS est OK
99 Statut inconnu
* Ces statuts concernent les paiements pour lesquels 3DS a eu lieu mais sans saisiede carte (par alias).
Catégorie Authentification 3DS.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 173 / 186
vads_threeds_mpi
Description • 3DS1: Active / désactive le processus 3DS1 lors d’un paiement e-commerce.
IMPORTANTCette fonctionnalité ne sera plus disponible après la mise en place de 3DS2.
• 3DS2: Indique le souhait du marchand de challenger l'acheteur avec uneauthentification forte lors du paiement.
IMPORTANTLes valeurs 3, 4 et 5 ne seront disponibles qu'après l'activation du 3DS2 sur votre contrat.
Champ d'entrée.
Format n1
Code erreur 50
Valeurs possiblesValeur Description
absentouvideou 0
Gestion de l’authentification 3DS déléguée à la plateforme de paiement (configurationdu domaine, fournisseur, boutique)
1 Déprécié.
2 • 3DS1: Authentification 3DS désactivée pour la transaction.Nécessite l'option "3D Secure Sélectif".
• 3DS2: NO CHALLENGE REQUESTED. Permet de demander une authentification sansinteraction (frictionless).Le marchand perd la garantie de paiement si la demande est acceptée.
3 • 3DS2: CHALLENGE REQUESTED: 3DS Requestor Preference. Permet de demanderune authentification forte pour la transaction.
4 • 3DS2: CHALLENGE REQUESTED: mandate. Permet d'indiquer que pour des raisonsrèglementaires, une authentification forte est requise pour la transaction.
5 • 3DS2: NO PREFERENCE: Permet d'indiquer au DS que le marchand n'a pas depréférence. Si l'émetteur décide de réaliser une authentification sans interaction(frictionless), le paiement sera garanti.
Catégorie Authentification 3DS.
vads_threeds_sign_valid
Description Désigne la validité de la signature du message PARes. Il est valorisé par laplateforme de paiement.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format n1
Valeurs possiblesValeur Description
vide Pas de 3DS.
0 signature incorrecte.
1 signature correcte.
Catégorie Authentification 3DS.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 174 / 186
vads_threeds_status
Description Désigne le statut de l’authentification du porteur. Il est valorisé par le serveurd’authentification 3DS (ACS) durant le processus 3D Secure.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format a1
Valeurs possiblesValeur Description
Y Authentification réussie.Remarque : Dans le Back Office Marchand, la valeur SUCCESS est affichée (onglet 3DSecure du Détails d'une transaction).
N Erreur d’authentification.Remarque : Dans le Back Office Marchand, la valeur FAILED est affichée (onglet 3DSecure du Détails d'une transaction).
U Authentification impossible.Remarque : Dans le Back Office Marchand, la valeur UNAVAILABLE est affichée (onglet3D Secure du Détails d'une transaction).
A Essai d’authentification.Remarque : Dans le Back Office Marchand, la valeur ATTEMPT est affichée (onglet 3DSecure du Détails d'une transaction).
Catégorie Authentification 3DS.
vads_threeds_xid
Description Désigne la référence unique de la transaction 3DS.
Il est valorisé par le serveur d’authentification (ACS) durant le processus 3D Secure.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..28
Catégorie Authentification 3DS.
vads_token_id
Description Identifiant de l'ordre de paiement associé à la transaction.
Correspond au champ offerId de l'objet paymentOfferResponse > offerEntities (cf.Guide d'implémentation "API Webservices SOAP Ordre de paiement").
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Catégorie Informations sur la commande.
vads_totalamount_vat
Description Permet de définir le montant global des taxes appliquées sur l’ensemble de lacommande.
La valeur doit être exprimée dans la plus petite unité monétaire (le centime pourl'euro) .
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 175 / 186
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n..12
Code d'erreur 154
Catégorie Informations sur la commande.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 176 / 186
vads_trans_date
Description Paramètre obligatoire.
Correspond à l’horodatage au format AAAAMMJJHHMMSS.
L’horodatage doit nécessairement correspondre à la date et heure courants, dansle fuseau GMT+0 (ou UTC) au format horaire 24h.
Remarque :
Si vous utilisez les web services REST de paiement, l'équivalent du paramètrevads_trans_date esttransactions[0].transactionDetails.cardDetails.legacyTransDate.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n14
Code erreur 04
Erreurs fréquentes:
• La date n'est pas envoyée sous le format AAAAMMJJHHMMSS (année, mois,jour, heure, minute, seconde).
• La date n'est pas basée sur le fuseau horaire UTC (temps universel coordonné).
Pensez à utiliser des fonctions date dans votre langage de programmationgénérant une heure UTC (gmdate en PHP par exemple)
• L'heure doit être calculée sur 24h et non sur 12h.
• L'acheteur a attendu trop longtemps avant de cliquer sur le bouton Payer.
• L'acheteur a utilisé l'historique de son navigateur.
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 177 / 186
vads_trans_id
Description Paramètre obligatoire.
Il est constitué de 6 caractères numériques et doit être unique pour chaquetransaction pour une boutique donnée sur la journée.
Remarque : l’unicité de l’identifiant de transaction se base sur l’heure universelle(UTC).
Il est à la charge du site marchand de garantir cette unicité sur la journée. Il doitêtre compris entre 000000 et 899999.
La tranche 900000 et 999999 est reservée aux remboursements et aux opérationseffectuées depuis le Back Office Marchand.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format n6
Code erreur 03
Erreurs fréquentes:
Le formulaire est rejeté:
• si la valeur transmise est inférieure à 6 chiffres
• si la valeur est nulle
• si le champ est absent
• si un numéro de transaction identique a déjà été envoyé le même jour.
Si l'acheteur clique sur le bouton « Annuler et retourner à la boutique », lenuméro de transaction devra être différent pour la prochaine tentative carcelui-ci est considéré comme déjà utilisé.
Dans le cas contraire, le message « La transaction a été annulée » sera affiché.
Catégorie Informations sur la transaction.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 178 / 186
vads_trans_status
Description Permet de définir le statut de la transaction.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Valeurs possibles
Valeur Description
ABANDONED AbandonnéPaiement abandonné par l’acheteur.La transaction n’est pas créée et n’est donc pas visible dansle Back Office Marchand.
ACCEPTED Accepté.Statut d'une transaction de type VERIFICATION dontl'autorisation ou la demande de renseignement a étéacceptée.Ce statut ne peut évoluer.Les transactions dont le statut est "ACCEPTED" ne sontjamais remises en banque.
AUTHORISED En attente de remiseLa transaction est acceptée et sera remise en banqueautomatiquement à la date prévue.
AUTHORISED_TO_VALIDATE À validerLa transaction, créée en validation manuelle, est autorisée.Le marchand doit valider manuellement la transaction afinqu'elle soit remise en banque.La transaction peut être validée tant que la date d'expirationde la demande d'autorisation n’est pas dépassée. Si cettedate est dépassée alors le paiement prend le statut EXPIRED.Le statut Expiré est définitif.
CANCELLED AnnuléLa transaction est annulée par le marchand.
CAPTURED PrésentéLa transaction est remise en banque.
CAPTURE_FAILED La remise de la transaction a échoué.Contactez le Support.
EXPIRED ExpiréLa date d'expiration de la demande d'autorisation estatteinte et le marchand n’a pas validé la transaction. Leporteur ne sera donc pas débité.
INITIAL En attenteCe statut est spécifique à tous les moyens de paiementnécessitant une intégration par formulaire de paiement enredirection.Ce statut est retourné lorsque :
• aucune réponse n'est renvoyée par l'acquéreurou
• le délai de réponse de la part de l'acquéreur estsupérieur à la durée de session du paiement sur laplateforme de paiement.Ce statut est temporaire. Le statut définitif sera affichédans le Back Office Marchand aussitôt la synchronisationréalisée.
NOT_CREATED Transaction non crééeLa transaction n'est pas créée et n'est pas visible dans le BackOffice Marchand.
REFUSED RefuséLa transaction est refusée.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 179 / 186
Valeur Description
SUSPENDED SuspenduLa remise de la transaction est temporairement bloquée parl'acquéreur (AMEX GLOBAL ou SECURE TRADING). Une foisla remise traitée correctement, le statut de la transactiondeviendra CAPTURED.
UNDER_VERIFICATION Pour les transactions PayPal, cette valeur signifie que PayPalretient la transaction pour suspicion de fraude.Le paiement restera dans l’onglet Transactions encours jusqu'à ce que les vérifications soient achevées.La transaction prendra alors l'un des statuts suivants:AUTHORISED ou CANCELED.Une notification sera envoyée au marchand pour l'avertirdu changement de statut (Notification sur modification parbatch).
WAITING_AUTHORISATION En attente d'autorisationLe délai de remise en banque est supérieur à la durée devalidité de l'autorisation.
WAITING_AUTHORISATION_TO_VALIDATE A valider et autoriserLe délai de remise en banque est supérieur à la durée devalidité de l'autorisation.Une autorisation 1 EUR (ou demande de renseignement surle réseau CB si l'acquéreur le supporte) a été acceptée.Le marchand doit valider manuellement la transaction afinque la demande d’autorisation et la remise aient lieu.
Tableau 15 : Valeurs associées au champ vads_trans_status
Catégorie Informations sur la transaction.
vads_trans_uuid
Description Référence unique de la transaction générée par la plateforme de paiement suite àla création d'une transaction de paiement.
Offre une garantie d'unicité pour chaque transaction.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans32
Catégorie Informations sur la transaction.
vads_url_cancel
Description URL où sera redirigé l’acheteur si celui-ci appuie sur Annuler et retourner à laboutique avant d'avoir procédé au paiement.
Champ d'entrée.
Format ans..1024
Code erreur 27
Catégorie Redirection vers le site marchand.
vads_url_check
Description URL de la page à notifier à la fin du paiement. Surcharge la valeur saisie dans leparamétrage des règles de notification.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 180 / 186
Remarque
Ce champ doit être utilisé de manière exceptionnelle car :
• cette URL ne sera utilisée que dans l'appel de l'URL de notification de paiement(IPN) immédiat,
• la valeur surchargée ne sera pas utilisée s'il y a un re-jeu automatique.
Incompatible avec l'exécution, depuis le Back Office Marchand, de la requêteenvoyée à l’url de notification instantanée. L’URL appelée sera celle configuréedans la règle de notification (voir chapitre Paramétrer les notifications du guided'implémentation du formulaire de paiement).
Champ d'entrée.
Format ans..1024
Code erreur 33
Catégorie Redirection vers le site marchand.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 181 / 186
vads_url_check_src
Description Ce paramètre définit l’origine de la notification (également appelée IPN).
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Valeurs possiblesValeur Description
PAY Création d’un paiement par formulaire.
BO Exécution de l’URL de notification depuis le Back Office Marchand.
BATCH_AUTO Demande d’autorisation sur un paiement qui était en attented’autorisation.
BATCH Mise à jour du statut de la transaction après synchronisation auprès del'acquéreur (cas de la notification sur modification par batch).
REC Paiement résultant d'un abonnement.
MERCH_BO Opération réalisée depuis le Back Office Marchand.
RETRY Rejeu automatique de l’URL de notification.
Catégorie Redirection vers le site marchand.
vads_url_error
Description URL où sera redirigé l’acheteur en cas d'erreur de traitement interne.
Champ d'entrée.
Format ans..1024
Code erreur 29
Catégorie Redirection vers le site marchand.
vads_url_post_wallet
Description Ce champ permet au marchand de transmettre l'URL vers laquelle sera redirigél'acheteur lors d'un paiement via un wallet en deux étapes.
Cette url est utilisée pour transmettre des informations relatives au choix del’acheteur (e-mail, adresse de livraison, moyen de paiement, etc.).
A partir de ces éléments, le marchand peut décider de l'action à effectuer (ajusterdes frais de port, enregistrer le moyen de paiement, etc.) avant de permettre àl'acheteur de finaliser son paiement.
Les données seront transmises au site marchand via un formulaire html POST.
Exemple : vads_url_post_wallet = https://mydomain-name.com/return_url
Remarque
Si l 'URL n'est pas joignable, la transaction ne pourra pas aboutir. Après l'expirationde la session de paiement, une transaction refusée sera créée. Si le marchand aconfiguré la règle de notification sur abandon/annulation, le site marchand seranotifié de la raison du refus via le champ vads_payment_error. Ce champ seravalorisé à 149 indiquant que la durée de la session de paiement a expiré.
Il sera possible alors, dans le Back Office Marchand, de constater dans l'ongletHistorique
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 182 / 186
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..1024
Code erreur 138
Catégorie Redirection vers le site marchand.
vads_url_referral
Description Champ déprécié. Utilisez vads_url_refused.
URL où sera redirigé l’acheteur en cas de refus d’autorisation (code 02 Contacterl’émetteur de la carte) après appui sur Retourner à la boutique.
Champ d'entrée.
Format ans..127
Code erreur 26
Catégorie Redirection vers le site marchand.
vads_url_refused
Description URL où sera redirigé l’acheteur en cas de refus, après appui du bouton Retournerà la boutique.
Champ d'entrée.
Format ans..1024
Code erreur 25
Catégorie Redirection vers le site marchand.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 183 / 186
vads_url_return
Description URL où sera redirigé par défaut l’acheteur après un appui sur le bouton Retournerà la boutique, si les URL vads_url_error, vads_url_refused, vads_url_success ouvads_url_cancel ne sont pas renseignées.
Si ce champ n’est pas transmis, la configuration du Back Office Marchand sera priseen compte.
Il est possible de configurer des URL de retour, en mode TEST et en modePRODUCTION. Ces champs sont nommés URL de retour de la boutique en modetest et URL de retour de la boutique en mode production, et sont accessiblesdepuis le menu Paramétrage > Boutique > onglet Configuration.
Si aucune URL n’est définie dans le Back Office Marchand ou dans le formulaire,alors le bouton Retourner à la boutique redirigera l'acheteur vers l’URL du sitemarchand (champ URL dans la configuration de la boutique).
Champ d'entrée.
Format ans..1024
Code erreur 28
Catégorie Redirection vers le site marchand.
vads_url_success
Description URL où sera redirigé l’acheteur en cas de succès du paiement, après appui dubouton Retourner à la boutique.
Champ d'entrée.
Format ans..1024
Code erreur 24
Catégorie Redirection vers le site marchand.
vads_user_info
Description Information sur l’utilisateur à l’origine du paiement.
Dans le cas d’un paiement par formulaire, ce paramètre sera renvoyé dans laréponse avec la valeur transmise dans la requête.
Dans le cas d’un paiement manuel depuis le Back Office Marchand, ce champ seravalorisé avec le compte utilisateur (login) qui a réalisé le paiement.
Remarque :
Pour des raisons de rétrocompatibilité, il est possible d'utiliser ce champ pourvaloriser le CPF/CNPJ (Identifiant légal, au format numérique, de longueur compriseentre 11 et 20 digits) imposé par le module de gestion de fraude ClearSale.Cependant, le CPF/CNPJ peut être valorisé dans le champ vads_cust_national_id.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format ans..255
Code erreur 61
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 184 / 186
Catégorie Informations sur l'acheteur.
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 185 / 186
vads_validation_mode
Description Précise le mode de validation de la transaction.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Code erreur 05
Valeurs possiblesValeur Description
Absent ouvide
Configuration par défaut de la boutique retenue (paramétrable dans le BackOffice Marchand).
0 Validation automatique par la plateforme de paiement.
1 Validation manuelle par le marchand.
Catégorie Informations sur la transaction.
vads_version
Description Paramètre obligatoire.
Version du protocole d’échange avec la plateforme de paiement.
Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).
Format enum
Code erreur 01
Valeur possible V2
Catégorie Informations techniques.
vads_wallet
Description Ce champ permet au marchand d'identifier le type de wallet qui a servi pour lepaiement.
Présent uniquement lorsqu'un wallet est utilisé pour le paiement.
Liste des Wallets existant
Valeur du champ vads_wallet Type de wallet
MASTERPASS Masterpass de Mastercard
GOOGLEPAY Google pay
PAYLIB Paylib
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Format an..127
Catégorie Informations sur le moyen de paiement.
vads_warranty_result
Description Transfert de responsabilité dans le cas d’un paiement accepté.
Champ de sortie, retourné dans la réponse (IPN et URL de retour).
Ajouter le bouton de paiement SEPA Direct Debit - Prélèvement Ponctuel (One Off) - Version du document 2.17
Tous droits réservés - 186 / 186
Format enum
Valeurs possiblesValeur Description
YES Le paiement est garanti.
NO Le paiement n’est pas garanti.
UNKNOW Suite à une erreur technique, le paiement ne peut pas être garanti.
Non valorisé Transfert de responsabilité non applicable.
Catégorie Informations sur la transaction.