Щоб використовувати платіжну платформу EBANX у Mavibot, вам потрібно отримати Integration Key з вашого облікового запису EBANX і ввести його в налаштуваннях платежів.

EBANX — це агрегатор локальних платіжних методів у Латинській Америці. Платежі обробляються на безпечній сторінці оформлення замовлення, розміщеній на EBANX, де клієнтам показуються доступні платіжні методи в їхній країні (наприклад, PIX і boleto в Бразилії, OXXO та SPEI в Мексиці, PSE в Колумбії, кредитні/дебетові картки тощо).

Отримання Integration Key

Підпишіть угоду з EBANX і отримайте доступ до EBANX Business Portal (вашої панелі мерчанта).

Під час процесу реєстрації виберіть країни, в яких ви хочете приймати платежі. Клієнти зможуть платити лише з країн, увімкнених у вашому обліковому записі EBANX.

У налаштуваннях інтеграції скопіюйте ваш Integration Key. Він знадобиться для підключення EBANX до Mavibot.

Для тестування EBANX надає окремий пісочний обліковий запис із власним Integration Key. Див. Test Mode нижче.

Підключення EBANX

У налаштуваннях платіжних систем виберіть EBANX і введіть наступне:

  • Integration Key — ваш скопійований Integration Key EBANX.
  • Country — країна платежу за замовчуванням (дволітерний код країни малими літерами: br для Бразилії, mx для Мексики, co для Колумбії, cl для Чилі, pe для Перу, ar для Аргентини тощо). Це визначає, які платіжні методи побачать клієнти на сторінці оформлення замовлення. Вибрана країна має бути увімкнена у вашому обліковому записі EBANX.
  • Test Mode — увімкніть цю опцію для тестування інтеграції за допомогою пісочного середовища EBANX. Коли Test Mode увімкнено, використовуйте Integration Key з вашого пісочного облікового запису. Щоб приймати реальні платежі, вимкніть Test Mode і використовуйте ваш живий Integration Key.

Налаштування завершено.

Генерація платіжного посилання

Функція калькулятора:

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

Параметри

  • amount — сума платежу. Обов'язково.

  • customer_email — електронна адреса клієнта. Обов'язково. EBANX не може створити платіж без неї. Клієнт також отримає підтвердження платежу на цю адресу.

  • full_name — повне ім'я клієнта. Обов'язково.

  • description — опис платежу. Необов'язково.

  • currency — валюта платежу. Ви можете використовувати:

    • місцеву валюту країни платежу (наприклад, BRL, MXN, COP, CLP, PEN, ARS тощо), або
    • валюту вашого облікового запису EBANX (зазвичай USD), у цьому випадку EBANX конвертує суму за своїм курсом.

    Необов'язково. Значення за замовчуванням — USD.

  • country — країна платежу (дволітерний код країни малими літерами). Необов'язково. Якщо пропущено, буде використано країну за замовчуванням, вказану в налаштуваннях платежів.

Функція повертає URL-адресу платежу.

Примітка: Вибрана валюта має бути сумісною з країною платежу. Вона має бути або місцевою валютою країни, або валютою вашого облікового запису EBANX. Наприклад, для br (Бразилія) дійсними є BRL та USD, тоді як MXN — ні.

Кнопка платіжного посилання

Щоб надіслати платіжну кнопку, виберіть тип Payment Button і оберіть EBANX як платіжну систему.

Введіть:

  • назву продукту;
  • суму платежу;
  • валюту;
  • змінні, що містять повне ім'я та електронну адресу клієнта.

За бажанням вкажіть країну платежу.

Приклад 1: Налаштування робочого процесу

Крок 1. Створіть блок Start.

Блок Start зазвичай використовується для відображення першого вітального повідомлення в робочому процесі, а також будь-якої вступної інформації, необхідної користувачеві.

Крок 2. Створіть блок, показаний нижче.

Крок 3. Перейдіть до налаштувань Connection.

Вам знадобиться наступний регулярний вираз, щоб перевірити, чи клієнт ввів дійсну електронну адресу:

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

Також увімкніть опцію User enters data і введіть customer_email.

Крок 4. Введіть повідомлення в другому блоці.

Крок 5. Створіть третій блок і відкрийте налаштування Connection між другим і третім блоками.

Увімкніть таймер, щоб автоматично перейти до наступного блоку.

Крок 6. У третьому блоці введіть функцію в Calculator.

Приклад для копіювання:

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

Якщо ви хочете приймати платежі у валюті, відмінній від USD, вкажіть валюту, як показано нижче.

Приклад 2. Кнопка виставлення рахунку

Цей приклад майже ідентичний Прикладу 1.

Однак замість створення третього блоку з функцією для генерації платіжного посилання ви можете створити кнопку в другому блоці.

У вікні, що відкриється:

  • Введіть текст кнопки.
  • Виберіть функцію Billing.
  • Виберіть EBANX як платіжного провайдера.

Потім введіть наступне:

  • Product Name.
  • Payment Amount.
  • Currency (необов'язково).
  • Client Full Name (необов'язково). Ви можете налаштувати це так само, як налаштували введення електронної адреси клієнта.
  • Customer Email — введіть змінну #{customer_email}.

Потім натисніть Add.

Сповіщення після оплати

Після того, як клієнт відкриє платіжне посилання та завершить оплату, у разі успішної оплати в розмову надсилається наступний зворотний виклик:

SDJ91MTKTT_success 100

Де:

  • SDJ91MTKTT — перші 10 символів вашого Integration Key.
  • 100 — сума платежу.

Якщо платіж скасовано, надсилається наступний зворотний виклик:

SDJ91MTKTT_fail 100

Для офлайн-методів оплати (наприклад, boleto, OXXO тощо) підтвердження платежу не є негайним. EBANX надсилає зворотний виклик лише після отримання коштів, що може зайняти 1–3 робочих дні. Зворотний виклик буде доставлено автоматично після підтвердження платежу.

Як надіслати відповідь на успішний або невдалий платіж

Крок 1. Створіть блок Trigger.

Крок 2. У полі умови введіть текст сповіщення SDJ91MTKTT_success — без суми платежу — якщо ви хочете реагувати на кожен платіж.

У цьому випадку Match Type має бути встановлено на By Keywords.

Або введіть весь текст зворотного виклику в поле Trigger, якщо ви хочете реагувати на конкретний платіж. У цьому випадку Match Type має бути встановлено на Exact Match.

Якщо ви хочете продовжити робочий процес після успішної оплати, ви можете створити блок Start замість блоку Trigger і продовжити створення потоку бота звідти.

Змінні клієнта після успішної оплати

Змінна Значення
ebanx_callback_data Інформація про платіж, отримана від платіжної системи
ebanx_payment_completed "True" — платіж оброблено як успішний
ebanx_payment_hash Ідентифікатор платежу в EBANX (hash)