For the complete documentation index, see llms.txt. This page is also available as Markdown.

EBANX

Чтобы использовать платёжную платформу EBANX в Mavibot, вам нужно получить свой ключ интеграции в учётной записи EBANX и ввести его в настройках оплаты.

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

Получение ключа интеграции

Подпишите соглашение с EBANX и получите доступ к EBANX Business Portal (ваша панель управления продавца).

Во время процесса подключения выберите страны, в которых вы хотите принимать платежи. Клиенты смогут оплачивать только из стран, включённых в вашей учётной записи EBANX.

В настройках интеграции скопируйте свой ключ интеграции. Он понадобится вам для подключения EBANX к Mavibot.

Для тестирования EBANX предоставляет отдельную учётную запись в песочнице с собственным ключом интеграции. См. ниже тестовый режим.

Подключение EBANX

В настройках платёжных систем выберите EBANX и введите следующее:

  • Integration Key — скопированный вами ключ интеграции EBANX.

  • Страна — страна платежа по умолчанию (двухбуквенный код страны в нижнем регистре: br для Бразилии, mx для Мексики, co для Колумбии, cl для Чили, pe для Перу, ar для Аргентины и т. д.). Это определяет, какие способы оплаты увидят клиенты на странице оформления заказа. Выбранная страна должна быть включена в вашей учётной записи EBANX.

  • Тестовый режим — включите эту опцию, чтобы протестировать интеграцию в среде-песочнице EBANX. Когда тестовый режим включён, используйте ключ интеграции из вашей учётной записи sandbox. Чтобы принимать реальные платежи, отключите тестовый режим и используйте боевой ключ интеграции.

Настройка завершена.

Создание платёжной ссылки

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

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 в качестве платёжной системы.

Введите:

  • название продукта;

  • сумму платежа;

  • валюту;

  • переменные, содержащие полное имя клиента и адрес электронной почты.

При необходимости укажите страну платежа.

Пример 1: настройка сценария

Шаг 1. Создайте Start блок.

Блок Start обычно используется для отображения первого приветственного сообщения в сценарии, а также любой вводной информации, которая может понадобиться пользователю.

Шаг 2. Создайте блок, показанный ниже.

Шаг 3. Перейдите к Connection настройкам.

Вам понадобится следующее регулярное выражение, чтобы проверить, что клиент ввёл действительный адрес электронной почты:

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

Также включите Пользователь вводит данные опцию и введите customer_email.

Шаг 4. Введите сообщение во втором блоке.

Шаг 5. Создайте третий блок и откройте Connection настройки между вторым и третьим блоками.

Включите таймер, чтобы автоматически перейти к следующему блоку.

Шаг 6. В третьем блоке введите функцию в калькуляторе.

Пример для копирования:

Если вы хотите принимать платежи в валюте, отличной от USD , укажите валюту, как показано ниже.

Пример 2. Кнопка оплаты

Этот пример почти идентичен Примеру 1.

Однако вместо создания третьего блока с функцией для генерации платёжной ссылки вы можете создать кнопку во втором блоке.

В открывшемся окне:

  • Введите текст кнопки.

  • Выберите Оплата функцию.

  • Выберите EBANX в качестве платёжного провайдера.

Затем введите следующее:

  • Название продукта.

  • Сумма платежа.

  • Валюта (необязательно).

  • Полное имя клиента (необязательно). Вы можете настроить это так же, как настроили ввод электронной почты клиента.

  • Электронная почта клиента — введите переменную #{customer_email}.

Затем нажмите Добавить.

Уведомления после оплаты

После того как клиент откроет платёжную ссылку и завершит оплату, при успешном платеже в диалог будет отправлен следующий callback:

Где:

  • SDJ91MTKTT — это первые 10 символов вашего ключа интеграции.

  • 100 — это сумма платежа.

Если платёж отменён, отправляется следующий callback:

Для офлайн-способов оплаты (таких как boleto, OXXO и т. д.) подтверждение оплаты происходит не сразу. EBANX отправляет callback только после получения средств, что может занять 1–3 рабочих дня. Callback будет доставлен автоматически после подтверждения платежа.

Как отправить ответ при успешном или неуспешном платеже

Шаг 1. Создайте Триггер блок.

Шаг 2. В поле условия введите текст уведомления SDJ91MTKTT_success — без суммы платежа — если хотите реагировать на каждый платёж.

В этом случае тип совпадения должен быть установлен на По ключевым словам.

В качестве альтернативы введите весь текст callback в поле Trigger, если хотите реагировать на конкретный платёж. В этом случае тип совпадения должен быть установлен на точное совпадение.

Если вы хотите продолжить сценарий после успешного платежа, вы можете создать Start блок вместо Триггер блока и продолжить построение сценария бота оттуда.

Переменные клиента после успешного платежа

Переменная

Значение

ebanx_callback_data

Информация о платеже, полученная от платёжной системы

ebanx_payment_completed

"True" — платёж обработан как успешный

ebanx_payment_hash

Идентификатор платежа в EBANX (hash)

Последнее обновление