Sommaire
| Table of Contents |
|---|
Introduction
Bienvenue dans la documentation du module AXEPTA BNP Paribas pour Magento 2.
Ce module gratuit vous permet d’intégrer facilement notre solution de paiement en ligne au sein de votre boutique e-commerce.
Cette documentation vous guidera dans l’installation, la configuration et l’utilisation du module afin de vous garantir une intégration simple, fiable et adaptée à vos besoins.
| Info |
|---|
Prérequis nécessaires
Vous devez disposer d'un module Magento pleinement fonctionnel.
| Tip |
|---|
Assurez- vous de votre compatibilité de version Magento 2 & PHP avec le module AXEPTA BNP Paribas Vous trouverez les versions compatible ici : GitHub - AxeptaBNPParibas/AxeptaOnline-Magento2-plugin: Axepta Online plugin for Magento2 · GitHub |
Installation du module
L'installation du module se déroule de la manière suivante :
- Télécharger le zip du module ensuite le dézipper
- Aller dans le dossier racine de votre site
- Créer les dossiers suivants :
- app/code/Bnpparibas
- app/code/AxeptaBnpparibas/Online
- Copier tout le contenu du module dézippé dans le répertoire “app/code/Bnpparibas/Axepta”
- Retourner à la racine de votre site et lancer les commandes suivantes :
- php bin/magento setup:upgrade
- php bin/magento cache:clean
- php bin/magento cache:flush
Mise à jour de version
Avant toute installation, nous vous invitons à bien désinstaller l’extension actuelle, à vider le cache de votre CMS et vérifier la suppression de l’extension en veillant à supprimer le répertoire d’installation du module sur votre serveur FTP.
Une fois fait, vous pouvez Installer la dernière mise à jour.
| Info |
|---|
La version la plus récente du module est disponible dans notre GitHub: GitHub - AxeptaBNPParibas/AxeptaOnline-Magento2-plugin: Axepta Online plugin for Magento2 · GitHub Celui-ci est mis à jours régulièrement. Pensez par la suite à compléter les paramètres de configuration Axepta Online dans chaque onglet du module. Il vous faudra configurer à nouveau votre MID de production, votre clé d’activation de production disponible sur votre portail marchand BNP Paribas. |
Back Office
Configuration globale du module
Les fonctionnalités du module sont accessibles via le menu de gauche dans l'interface d'administration ''Axepta BNP Paribas''. Pour débuter la configuration, cliquez simplement sur l'option ''Paramètre des modes de paiement''.
- Documentation Axepta BNP Paribas : Renvois vers notre documentation officielle du module.
- Contacter l’assistance : Permet l'ouverture d’un formulaire d'envoi d'e-mail vers notre assistance. Dans cet e-mail, les versions serveur, CMS et module sont envoyées automatiquement.
- Vérifier ma configuration : Permet d’afficher et de vérifier dans une fenêtre que la configuration du serveur est compatible avec le module installé.
- Télécharger les logs: Permet le téléchargement des logs au format souhaité.
Configuration du compte
La configuration du mode production et du mode test sont à faire pour activer le paiement en ligne.
Mode Démonstration
Le mode démonstration ("DEMO") permet de tester le module sans paramétrage d’un MID
En mode Production, il est nécessaire de renseigner le MID et la clé privée.
En mode test , il est nécessaire de renseigner uniquement la clé privée. On utilise le MID de production auquel il a été ajouté un paramètre (_t)
Sélectionnez le mode que vous souhaitez paramétrer pour voir apparaître les champs adéquats
Pour pouvoir utiliser le module il est nécessaire de renseigner les paramètres suivants dans le formulaire
- Mode production :
- MID (envoyé par BNP Paribas)
- Clé privée (envoyée par BNP Paribas)
- Mode test :
Le MID de production est utilisé par défaut avec l’ajout d’une chaine de caractère- Clé privée (envoyée par BNP Paribas)
- Mode Démonstration
Ce mode permet l’affichage de bandeau sur le site pour informer
Un MID spécifique est pré paramétré - Activation en front
Nécessaire pour afficher le module sur la page de checkout quelque soit le mode activé
Afficher le logo ApplePay
ApplePay est actuellement embarqué par la page de paiement. Cette option ne fait qu’apparaître le logo avec les moyens de paiement
Les éléments ne sont sauvegardé que lorsque l’utilisateur clique sur le bouton de sauvegarde
Configuration des moyens de paiement
et ses fonctionnalités sans avoir de compte Axepta BNP Paribas.
Mode Test
- MID de test (disponible dans la rubrique " Voir les identifiants de l'API" de votre portail Marchand Axepta BNP Paribas)
- Clé API REST de test (disponible dans la rubrique " Voir les identifiants de l'API" de votre portail Marchand Axepta BNP Paribas)
Permet de configurer votre MID de test dédié, il est reconnaissable par le format (BNP_MID_t) disponible depuis votre portail marchand BNP Paribas.
Accès aux identifiants de l’API & HMAC - Documentation Axepta BNP Paribas - Axepta
Mode Production
- MID (disponible dans la rubrique "Voir les identifiants de l'API" de votre portail Marchand Axepta BNP Paribas)
- Clé API REST (disponible dans la rubrique "Voir les identifiants de l'API" de votre portail Marchand Axepta BNP Paribas)
Permet de configurer votre MID de production dédié, il est reconnaissable par le format (BNP_MID_XXX) disponible depuis votre portail marchand BNP Paribas.
Accès aux identifiants de l’API & HMAC - Documentation Axepta BNP Paribas - Axepta
Activation en front :
l'activation de cette fonctionnalité est nécessaire pour afficher les méthodes de paiement sur la page de checkout.
| Warning |
|---|
Les éléments ne sont sauvegardés que lorsque l’utilisateur clique sur |
Configuration du paiement
L'onglet configuration du paiement vous permet de configurer plusieurs fonctionnalités.
Organisation des moyens de paiement
Il s'agit de la méthode d'affichage des paiement sur la page de checkout.
deux options sont disponible:
Vous pouvez maintenant choisir les différents moyens de paiement à activer sur votre boutique.
Un onglet “Configuration des moyens de paiement” apparait sur la gauche de l’écran au dessous de "Configuration du compte" :
Tous les moyens de paiement intégrés à la librairie sont présentés ici. Il appartient au marchand de sélectionner les moyens de paiement qui l’a souscrit.
La clé d’activation ne permet plus de définir les moyens de paiement.
- Choix du moyen de paiement sur la page
- BNP Paribas
Correspond au formulaire de paiement hébergé par BNP Paribas vous y retrouverez les méthodes de paiement disponible sur votre compte.
- Choix des moyens de paiement sur le site du marchand
Libellé front: texte personnalisable apparaissant sur la page de paiement
Mode d'affichage
Le mode redirection : redirige le client vers le formulaire de paiement sécurisée par Axepta BNP Paribas.
Le mode iframe : intègre directement la page de paiement sur votre site.
Mode capture
- Redirection : lors de la phase de paiement, l’utilisateur est renvoyé vers une page en fonction du moyen de paiement sélectionné
- Iframe: lors de la phase de paiement, le formulaire est affiché en bas de la page de checkout en fonction du moyen de paiement sélectionné
Sélectionner les moyens de paiement à afficher en checkout :
- Si CB- Visa-MasterCard est activé, le logo CB apparaîtra seulement si le pays de livraison de la commande est la France
- Les paramètres Apple Pay et Google Pay permettent d’afficher les logos sur la page de checkout mais nécessitent d’avoir souscrit l’option sur le contrat pour voir l’affichage en page de paiement.
- Paypal est un Wallet qui doit être paramétré en amont sur votre compte Axepta. Il est nécessaire de communiquer le PayerID de Paypal à Axepta en amont.
Cette option vous permet de choisir la méthode de capture du paiement :
Activation de la capture Automatique :
Automatique (J)
=>: La capture se fera automatiquement à minuit.
Activation de la capture Différée :
Différée (J+x)
=>: Vous pouvez choisir le délai avant la capture (délai en heures : nombre entier compris en 1 et 696.
Exemple
pour:
Pour 2 jours: saisissez 48).
Les captures différées sont indiquées Capture "timed" dans la page ''Sales''>''Orders'' suivi de la date et heure à laquelle la capture a été effectuée.
Activation de la capture Manuelle :
Capture Manuelle
=>: La capture manuelle est effectuée manuellement par le marchand grâce à une configuration au niveau du back-office.
Activation de la capture Automatique :
Lors de la sélection capture automatique, les flux de paiement sont automatiquement
Aucune action n’est nécessaire par le marchand pour réalisée la capture. Elle est confirmée par un flux retour (IPN).
Activation de la capture Manuelle :
Dans le menu de configuration du marchand, descendre jusqu’au champ « Capture » et sélectionner « Manual Capture ».
Pour capturer manuellement un paiement, il vous faudra facturer la commande.
Pour cela, aller sur la page d’une commande à facturer, puis cliquer sur "Invoice".
Sélectionner ensuite "Capture online" pour capturer manuellement la commande à l’émission de la facture.
- Capture online : La capture online effectuée depuis le back-office Magento 2 se connectera au back-office axepta. Le statut de la transaction est synchronisé automatiquement entre les deux back-office.
- Capture offline : La capture Offline va simplement générer la facture et marquer la commande en cours de traitement, ce qui signifie que le montant a été reçu manuellement.
| Tip |
|---|
Capture Partielle : Il est possible de capturer une partie seulement de la commande si cette dernière comporte plusieurs articles en modifiant les quantités dans la colonne. Dans ce cas, les frais de livraison seront toujours capturés à la première facture. Pour les prochaines captures de paiement de cette même commande, les frais de livraisons ne seront pas comptabilisés. |
| Warning |
|---|
Attention : Sans action du commerçant, la transaction ne sera pas remise en banque. La capture d’une transaction au-delà du 7ème jour entraîne la perte de garantie associée au 3DSecure. Au-delà du 29ème jour l’autorisation accordée par l’émetteur ne sera plus valide. Il est donc préférable de capturer les opérations avant ces échéances. |
| Info |
|---|
Si vous tentez de facturer une commande dont le paiement a déjà été capturé, Un message d’alerte « La commande a déjà été capturée » s’affichera en haut de la page.
Des notifications spécifiques vous sont également envoyées quand la capture d'une commande a déjà été effectuée, ou bien dans le cas ou un paiement n’a pas été capturé depuis plus de 7 jours. l'onglet notification est visible en haut a droite de votre écran, les informations notifiées sont actualisées quotidiennement.
|
Exemption 3DS
Correspond au paramétrage du 3DS (méthode d'authentification du paiement) et de son exemption en fonction du montant total du panier du client.
| Warning |
|---|
En activant la demande d'exemption 3D Secure, vous acceptez la responsabilité en cas de fraude ou de litige sur les transactions concernées. Cette fonctionnalité doit être utilisée avec précaution. Vous retrouverez les différentes responsabilités en cas d'impayé sur notre page dédié: Liability Shift and 3D-Secure Matrices - Documentation Axepta BNP Paribas - Axepta |
Activation du One click
L'activation de cette fonctionnalité permet aux clients connectés d'enregistrer leur carte pour les prochains paiements.
Pour cela le client devra au préalable cocher l'enregistrement de sa carte sur la page de paiement.
Méthodes de paiement
Vous pouvez activer ou désactiver (''yes''/''No'') les méthodes de paiement souscrites, pour cela dirigez vous dans l'encart ''liste des moyens de paiement'' disponible depuis l'onglet ''Configuration des moyens de paiement''.
Personnalisation
Permet le paramétrage des champs envoyés dans le formulaire de paiement lors de la redirection.
Configuration de la fonctionnalité
Paiement parabonnement
Permet d’activer ou de désactiver le moyen de paiement par abonnement sur la boutique. Lorsque cette option est activée, les clients pourront choisir ce mode de paiement si leur panier contient un produit configuré en abonnement.
Personnalisation des moyens de paiement
Permet le paramétrage des champs envoyés dans le formulaire de paiement lors de la redirection.
Creation des produits en abonnement
Création d'une fiche produit abonnement
Dans ''Catalog'' > ''Produits''Dans Magento > Catalogue > Produits, ouvrez le produit à vendre en abonnement (ou créez - en un nouveau).Dans l’onglet Option de paramétrage des abonnements par Axepta BNP Paribas, vous pouvez activer un abonnement sur le produit en sélectionnant Oui
L'encart ''Active'' vous permet d'activer ou bien de désactiver la fiche produit abonnement(''yes''/''no'').
Périodicité de facturation
- Tous les
- :
- détermine le nombre sur l’intervalle (
- ex : 1,2,3 …)
- Périodicité
- : détermine la fréquence en Jour(s) / Semaine(s) / Mois / Année(s)
Exemple :
1 + Mois → facturation tous les mois
15 + Jours → facturation tous les 15 jours
- Expiré
- après :
- Nombre d’occurrences = nombred’occurrences déterminant la fin de l'abonnement, c'est à dire le nombre de fois où le client sera facturé.
Exemple :
3 → 3 paiements au total (selon la périodicité choisie)
Montant
- Montant récurrent : montant facturé à chaque période
| Tip |
|---|
Enregistrez / mettez à jour le produit. |
Tableau des commandes
Deux colonnes ont été ajoutées dans le tableau de commandes : une pour savoir quel type de capture a été employé pour la commande (automatique, manuelle ou différée), et une autre pour savoir si le paiement a été capturé depuis le back-office de Magento. Une capture réalisée sur le back-office Axepta n’entraîne pas l’actualisation de ce tableau de commande mais une alerte est proposée en cas de tentative sur une transaction déjà capturée (voir notification des alertes).
Les captures différées sont indiquées « Capture : timed » suivi de la date et heure à laquelle la capture a été effectuée
Gérer ses abonnements en cours
Dans l’onglet "Axepta BNP Paribas" > "Gestion Liste des Abonnements" : retrouver la liste des abonnements.
Vous y retrouverez les informations suivantes:
| Identifiant d’Abonnement | Identifiant unique de l’abonnement. |
| Identifiant de Commande | Identifiant de la commande associée. |
| Client | Nom / e‑mail du client. |
| Produit d’Abonnement | Nom du produit souscrit. |
| Identifiant de Transaction | Identifiant de la transaction de paiement. |
| Périodicité | Fréquence de facturation (ex. : tous les 1 mois). |
| Date de Début | Date de début de l’abonnement. |
| Date de Prochaine Exécution | Date de la prochaine facturation. |
| Montant | Montant facturé |
| Statut de l'abonnement | Statut actuel (Actif, En pause, Annulé, etc.). |
Arrêter un abonnement
Vous avez la possibilité de modifier le statut de l’abonnement pour l’activer ou l’arrêter.
Action : Désactiver un abonnement
Effet :
- L’abonnement passe en arrêté (il n’y aura plus de renouvellement automatique).
- Le client ne sera plus facturé à partir de ce moment vous pouvez réactiver a tout moment la fonctionnalité en cliquant sur "activer"
Action : Supprimer un abonnement
Effet :
- Supprime définitivement toute facturation
- Le client ne sera plus facturé à partir de ce moment
Configuration du paiement en plusieurs fois
Libéllé de paiement: texte personnalisable apparaissant sur la page de paiement
Montant minimum: désigne le montant minimum du total du panier du client ou la modalité de paiement en plusieurs fois sera proposé,
Montant maximum: désigne le montant maximum du total du panier du client ou la modalité de paiement en plusieurs fois sera proposé,
Paiement en 2X - 3X- 4X: Activez le nombre d'échéances souhaité (''yes''/''no'')
| Warning |
|---|
Veillez a désactiver le nombre d'échéances non souhaité. |
Nb échéance: désigne le pourcentage de répartition par rapport au montant total du panier sur chacune des échéances.
Exemple d'un paiement en 3X d'un montant total de 100€:
- 1er 50% => donc 50€
- 2e 25% => donc 25€
- 3e 25%=> donc 25€
| Warning |
|---|
La répartition est paramétrable en pourcentage et non en montant. |
Remboursement / Annulation
Pour Effectuer un remboursement ou une annulation,
Dirigez vous vers l'onglet "Ventes" > ''Commandes'' afin de
Capture manuelle
Capturer Manuellement la transaction
Pour capturer manuellement un paiement, il faut facturer la commande. Aller sur la page d’une commande à facturer, puis cliquer sur « Invoice ».
Sélectionner ensuite « Capture online » pour capturer manuellement la commande à l’émission de la facture.
Capture online : La capture online effectuée depuis le back-office Magento 2 se connectera au back-office axepta. Le statut de la transaction est synchronisé automatiquement entre les deux back-office.
Capture offline : La capture Offline va simplement générer la facture et marquer la commande en cours de traitement, ce qui signifie que le montant a été reçu manuellement.
Capture Partielle :
Il est possible de capturer une partie seulement de la commande si cette dernière comporte plusieurs articles en modifiant les quantités dans la colonne. Dans ce cas, les frais de livraison seront toujours capturés à la première facture. Pour les prochaines captures de paiement de cette même commande, les frais de livraisons ne seront pas comptabilisés.
Messages d'alertes :
Si l’on tente de facturer une commande dont le paiement a déjà été capturé, un message d’alerte « La commande a déjà été capturée » s’affichera en haut de la page comme ceci :
Des notifications ont également été ajoutées quand la capture a déjà été effectuée, ainsi que lorsqu’un paiement n’a pas été capturé depuis plus de 7 jours. L’actualisation se fait une fois par jour.
Ces notifications sont visibles en cliquant sur l’icône en haut à droite de l’écran :
Logs
Les logs sont constamment activés. Il est possible de les télécharger par le bouton en haut de l’écran de paramétrage
Remboursement / Annulation
Pour effectuer un remboursement ou une annulation (dans la mesure du possible), il faut se diriger vers l'onglet Ventes > Commandes pour visualiser les détails d'une commande.
1) Sélectionnez une la commande parmi en question depuis la liste, puis cliquez sur “voir” sur ''view'' pour visualiser les le détails d’une de la commande.
Dirigiez vous dans "Invoices" puis sélectionnez 2) Allez dans “Invoices” puis sélectionner la facture qui a été créée automatiquement pour la commande.
3) Sélectionner « Sélectionner "Crédit Memo »". Vous aurez alors toutes les informations concernant la commande et tout en bas de la page , plus bas vous trouverez les champs à remplir en cas de dans le cadre d'un remboursement.
Remboursement
Remboursement total
Pour un remboursement total, le montant ("subtotal) est affiché et il suffit de laisser les valeurs prédéfinies vides et de valider (Refund Offline)" est prés rempli, il vous suffit de cliquez sur 
.
Remboursement partiel
Pour un remboursement partiel, il faut ajuster les valeurs des champs. Le champ "Ajustement Fee" permet de modifier la somme à retirer du remboursement.
Exemple : Je souhaites rembourser 30€ mon client à la suite d'un retard de livraison.
Par exemple : Subtotal = 45,
Ajustement Fee = 15, en cliquant sur “Update Totals” on obtient 30 comme remboursement pour l’acheteur.
Cliquez sur "update total" pour déclencher le remboursement de la différence.
Annulation
Annulation
Si la transaction est en statut ''processing'' cela signifie que celle-ci n'a pas encore été remise en banque (status "processing" en cliquant sur l'orderID), une annulation est donc encore possible.
Pour savoir si la transaction a été annulée ou remboursée totalement, il faut se rendre dans vous faudra vous rendre sur "Axepta" >"Transaction" pour voir la liste des transactions :
Dans la colonne "Type", il sera indiqué « Cancellation » "Cancellation" pour une annulation ou « refund » "refund" pour un remboursement.
Tableau des abonnements
Dans l’onglet Axepta BNP Paribas > Gestion Liste des Abonnements : retrouver la liste des abonnements.
- ID de l’abonnement
- ID de la commande
- Le client
- Le produit Abonnement
- ID de la transaction
- La périodicité
- La date de début
- La date de la prochaine exécution.
- Le montant
- Le statut de l’abonnement
Vous avez la possibilité de modifier le statut de l’abonnement pour l’activer ou l’arrêter.
Désactiver un abonnement
Action : Désactiver un abonnement
Effet :
- L’abonnement passe en arrêté (il n’y aura plus de renouvellement automatique).
- Le client ne sera plus facturé à partir de ce moment.
Front Office
Rendu sur la page de checkout
Les moyens de paiement sont affichés sur un cadre prévu par bloc.
Les moyens de paiement supplémentaires sont accessibles en sélectionnant "Plus d'options de paiement", qui n’apparaît que le cas échéant.
Rendu de la page de paiement en redirection
Rendu de la page de Confirmation de Paiement
Espace client
Les commandes et les abonnements affichent un bloc Axepta sur l’espace client.