Pour utiliser la plateforme de paiement EBANX dans Mavibot, vous devez obtenir votre clé d'intégration depuis votre compte EBANX et la saisir dans les paramètres de paiement.

EBANX est un agrégateur de moyens de paiement locaux en Amérique latine. Les paiements sont traités sur une page de paiement sécurisée hébergée par EBANX, où les clients voient les moyens de paiement disponibles dans leur pays (tels que PIX et boleto au Brésil, OXXO et SPEI au Mexique, PSE en Colombie, cartes de crédit/débit, etc.).

Obtention de la clé d'intégration

Signez un accord avec EBANX et obtenez l'accès au portail commercial EBANX (votre tableau de bord marchand).

Lors du processus d'intégration, sélectionnez les pays où vous souhaitez accepter les paiements. Les clients ne pourront payer qu'à partir des pays activés sur votre compte EBANX.

Dans les paramètres d'intégration, copiez votre clé d'intégration. Vous en aurez besoin pour connecter EBANX à Mavibot.

À des fins de test, EBANX fournit un compte sandbox séparé avec sa propre clé d'intégration. Voir le mode test ci-dessous.

Connexion d'EBANX

Dans les paramètres des systèmes de paiement, sélectionnez EBANX et saisissez les éléments suivants :

  • Clé d'intégration — votre clé d'intégration EBANX copiée.
  • Pays — le pays de paiement par défaut (code pays à deux lettres en minuscules : br pour le Brésil, mx pour le Mexique, co pour la Colombie, cl pour le Chili, pe pour le Pérou, ar pour l'Argentine, etc.). Cela détermine les moyens de paiement que les clients verront sur la page de paiement. Le pays sélectionné doit être activé sur votre compte EBANX.
  • Mode test — activez cette option pour tester l'intégration en utilisant l'environnement sandbox d'EBANX. Lorsque le mode test est activé, utilisez la clé d'intégration de votre compte sandbox. Pour accepter des paiements réels, désactivez le mode test et utilisez votre clé d'intégration en direct.

La configuration est maintenant terminée.

Génération d'un lien de paiement

Fonction de calculatrice :

get_ebanx_payment_url(amount, description, currency, customer_email, full_name, country)

Paramètres

  • amount — montant du paiement. Obligatoire.

  • customer_email — adresse e-mail du client. Obligatoire. EBANX ne peut pas créer de paiement sans cela. Le client recevra également une confirmation de paiement à cette adresse e-mail.

  • full_name — nom complet du client. Obligatoire.

  • description — description du paiement. Facultatif.

  • currency — devise du paiement. Vous pouvez utiliser soit :

    • la devise locale du pays de paiement (telle que BRL, MXN, COP, CLP, PEN, ARS, etc.), soit
    • la devise de votre compte EBANX (généralement USD), auquel cas EBANX convertira le montant en utilisant son taux de change.

    Facultatif. La valeur par défaut est USD.

  • country — pays de paiement (code pays à deux lettres en minuscules). Facultatif. S'il est omis, le pays par défaut spécifié dans les paramètres de paiement sera utilisé.

La fonction renvoie une URL de paiement.

Remarque : La devise sélectionnée doit être compatible avec le pays de paiement. Elle doit être soit la devise locale du pays, soit la devise de votre compte EBANX. Par exemple, pour br (Brésil), BRL et USD sont valides, tandis que MXN ne l'est pas.

Bouton de lien de paiement

Pour envoyer un bouton de paiement, sélectionnez le type Bouton de paiement et choisissez EBANX comme système de paiement.

Saisissez :

  • le nom du produit ;
  • le montant du paiement ;
  • la devise ;
  • les variables contenant le nom complet et l'adresse e-mail du client.

En option, spécifiez le pays de paiement.

Exemple 1 : Configuration du workflow

Étape 1. Créez un bloc Début.

Le bloc Début est généralement utilisé pour afficher le premier message de bienvenue dans le workflow, ainsi que toute information d'introduction dont l'utilisateur a besoin.

Étape 2. Créez le bloc illustré ci-dessous.

Étape 3. Accédez aux paramètres de Connexion.

Vous aurez besoin de l'expression régulière suivante pour vérifier que le client a saisi une adresse e-mail valide :

^[-\w.]+@([A-z0-9][-A-z0-9]+.)+[A-z]{2,4}$

Activez également l'option L'utilisateur saisit des données et saisissez customer_email.

Étape 4. Saisissez le message dans le deuxième bloc.

Étape 5. Créez un troisième bloc et ouvrez les paramètres de Connexion entre le deuxième et le troisième bloc.

Activez la minuterie pour passer automatiquement au bloc suivant.

Étape 6. Dans le troisième bloc, saisissez la fonction dans la Calculatrice.

Exemple à copier :

amount = 1000
description = "Product1 is product of great reliability!"
currency = "BRL"
link = get_ebanx_payment_url(amount, description, currency, customer_email, full_name, country)

Si vous souhaitez accepter des paiements dans une devise autre que USD, spécifiez la devise comme indiqué ci-dessous.

Exemple 2. Bouton de facturation

Cet exemple est presque identique à l'Exemple 1.

Cependant, au lieu de créer un troisième bloc avec une fonction pour générer le lien de paiement, vous pouvez créer un bouton dans le deuxième bloc.

Dans la fenêtre qui s'ouvre :

  • Saisissez le texte du bouton.
  • Sélectionnez la fonction Facturation.
  • Sélectionnez EBANX comme fournisseur de paiement.

Saisissez ensuite les éléments suivants :

  • Nom du produit.
  • Montant du paiement.
  • Devise (facultatif).
  • Nom complet du client (facultatif). Vous pouvez le configurer de la même manière que vous avez configuré la saisie de l'e-mail du client.
  • E-mail du client — saisissez la variable #{customer_email}.

Cliquez ensuite sur Ajouter.

Notifications après paiement

Une fois que le client a ouvert le lien de paiement et effectué le paiement, le callback suivant est envoyé à la conversation en cas de succès :

SDJ91MTKTT_success 100

Où :

  • SDJ91MTKTT correspond aux 10 premiers caractères de votre clé d'intégration.
  • 100 est le montant du paiement.

Si le paiement est annulé, le callback suivant est envoyé :

SDJ91MTKTT_fail 100

Pour les moyens de paiement hors ligne (tels que boleto, OXXO, etc.), la confirmation du paiement n'est pas immédiate. EBANX envoie le callback seulement après avoir reçu les fonds, ce qui peut prendre 1 à 3 jours ouvrables. Le callback sera livré automatiquement une fois le paiement confirmé.

Comment envoyer une réponse à un paiement réussi ou échoué

Étape 1. Créez un bloc Déclencheur.

Étape 2. Dans le champ de condition, saisissez le texte de notification SDJ91MTKTT_success — sans le montant du paiement — si vous souhaitez réagir à chaque paiement.

Dans ce cas, le Type de correspondance doit être défini sur Par mots-clés.

Alternativement, saisissez l'intégralité du texte du callback dans le champ Déclencheur si vous souhaitez réagir à un paiement spécifique. Dans ce cas, le Type de correspondance doit être défini sur Correspondance exacte.

Si vous souhaitez continuer le workflow après un paiement réussi, vous pouvez créer un bloc Début au lieu d'un bloc Déclencheur et continuer à construire le flux de votre bot à partir de là.

Variables client après un paiement réussi

Variable Valeur
ebanx_callback_data Informations sur le paiement reçues du système de paiement
ebanx_payment_completed "True" — le paiement a été traité comme réussi
ebanx_payment_hash Identifiant du paiement dans EBANX (hash)