Para usar a plataforma de pagamento EBANX no Mavibot, você precisa obter sua Integration Key da sua conta EBANX e inseri-la nas configurações de pagamento.

EBANX é um agregador de métodos de pagamento locais em toda a América Latina. Os pagamentos são processados em uma página de checkout segura hospedada pela EBANX, onde os clientes veem os métodos de pagamento disponíveis em seu país (como PIX e boleto no Brasil, OXXO e SPEI no México, PSE na Colômbia, cartões de crédito/débito e muito mais).

Obtendo a Integration Key

Assine um contrato com a EBANX e obtenha acesso ao EBANX Business Portal (seu painel do comerciante).

Durante o processo de integração, selecione os países onde deseja aceitar pagamentos. Os clientes só poderão pagar a partir dos países habilitados na sua conta EBANX.

Nas configurações de integração, copie sua Integration Key. Você precisará dela para conectar a EBANX ao Mavibot.

Para fins de teste, a EBANX fornece uma conta sandbox separada com sua própria Integration Key. Consulte Modo de Teste abaixo.

Conectando a EBANX

Nas configurações de Sistemas de Pagamento, selecione EBANX e insira o seguinte:

  • Integration Key — sua Integration Key EBANX copiada.
  • Country — o país de pagamento padrão (código de país de duas letras em minúsculas: br para Brasil, mx para México, co para Colômbia, cl para Chile, pe para Peru, ar para Argentina, etc.). Isso determina quais métodos de pagamento os clientes verão na página de checkout. O país selecionado deve estar habilitado na sua conta EBANX.
  • Test Mode — ative esta opção para testar a integração usando o ambiente sandbox da EBANX. Quando o Modo de Teste estiver ativado, use a Integration Key da sua conta sandbox. Para aceitar pagamentos reais, desative o Modo de Teste e use sua Integration Key ativa.

A configuração está concluída.

Função da calculadora:

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

Parâmetros

  • amount — valor do pagamento. Obrigatório.

  • customer_email — endereço de e-mail do cliente. Obrigatório. A EBANX não pode criar um pagamento sem ele. O cliente também receberá uma confirmação de pagamento neste e-mail.

  • full_name — nome completo do cliente. Obrigatório.

  • description — descrição do pagamento. Opcional.

  • currency — moeda do pagamento. Você pode usar:

    • a moeda local do país de pagamento (como BRL, MXN, COP, CLP, PEN, ARS, etc.), ou
    • a moeda da sua conta EBANX (geralmente USD), caso em que a EBANX converterá o valor usando sua taxa de câmbio.

    Opcional. O valor padrão é USD.

  • country — país de pagamento (código de país de duas letras em minúsculas). Opcional. Se omitido, o país padrão especificado nas configurações de pagamento será usado.

A função retorna uma URL de pagamento.

Nota: A moeda selecionada deve ser compatível com o país de pagamento. Deve ser a moeda local do país ou a moeda da sua conta EBANX. Por exemplo, para br (Brasil), BRL e USD são válidos, enquanto MXN não é.

Para enviar um botão de pagamento, selecione o tipo Payment Button e escolha EBANX como sistema de pagamento.

Insira:

  • nome do produto;
  • valor do pagamento;
  • moeda;
  • variáveis contendo o nome completo e o endereço de e-mail do cliente.

Opcionalmente, especifique o país de pagamento.

Exemplo 1: Configuração de Fluxo de Trabalho

Passo 1. Crie um bloco Start.

O bloco Start é normalmente usado para exibir a primeira mensagem de boas-vindas no fluxo de trabalho, juntamente com qualquer informação introdutória que o usuário precise.

Passo 2. Crie o bloco mostrado abaixo.

Passo 3. Vá para as configurações de Connection.

Você precisará da seguinte expressão regular para verificar se o cliente inseriu um endereço de e-mail válido:

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

Além disso, ative a opção User enters data e insira customer_email.

Passo 4. Insira a mensagem no segundo bloco.

Passo 5. Crie um terceiro bloco e abra as configurações de Connection entre o segundo e o terceiro blocos.

Ative o temporizador para prosseguir automaticamente para o próximo bloco.

Passo 6. No terceiro bloco, insira a função na Calculator.

Exemplo para copiar:

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

Se você quiser aceitar pagamentos em uma moeda diferente de USD, especifique a moeda conforme mostrado abaixo.

Exemplo 2. Botão de Cobrança

Este exemplo é quase idêntico ao Exemplo 1.

No entanto, em vez de criar um terceiro bloco com uma função para gerar o link de pagamento, você pode criar um botão no segundo bloco.

Na janela que se abre:

  • Insira o texto do botão.
  • Selecione a função Billing.
  • Selecione EBANX como provedor de pagamento.

Em seguida, insira o seguinte:

  • Product Name.
  • Payment Amount.
  • Currency (opcional).
  • Client Full Name (opcional). Você pode configurar isso da mesma forma que configurou a entrada de e-mail do cliente.
  • Customer Email — insira a variável #{customer_email}.

Em seguida, clique em Add.

Notificações Após o Pagamento

Após o cliente abrir o link de pagamento e concluir o pagamento, o seguinte callback é enviado para a conversa em caso de pagamento bem-sucedido:

SDJ91MTKTT_success 100

Onde:

  • SDJ91MTKTT são os primeiros 10 caracteres da sua Integration Key.
  • 100 é o valor do pagamento.

Se o pagamento for cancelado, o seguinte callback é enviado:

SDJ91MTKTT_fail 100

Para métodos de pagamento offline (como boleto, OXXO, etc.), a confirmação do pagamento não é imediata. A EBANX envia o callback somente após receber os fundos, o que pode levar de 1 a 3 dias úteis. O callback será entregue automaticamente assim que o pagamento for confirmado.

Como Enviar uma Resposta para um Pagamento Bem-sucedido ou Falho

Passo 1. Crie um bloco Trigger.

Passo 2. No campo de condição, insira o texto da notificação SDJ91MTKTT_success — sem o valor do pagamento — se você quiser reagir a cada pagamento.

Neste caso, o Match Type deve ser definido como By Keywords.

Alternativamente, insira todo o texto do callback no campo Trigger se você quiser reagir a um pagamento específico. Neste caso, o Match Type deve ser definido como Exact Match.

Se você quiser continuar o fluxo de trabalho após um pagamento bem-sucedido, pode criar um bloco Start em vez de um bloco Trigger e continuar construindo o fluxo do seu bot a partir daí.

Variáveis do Cliente Após um Pagamento Bem-sucedido

Variável Valor
ebanx_callback_data Informações do pagamento recebidas do sistema de pagamento
ebanx_payment_completed "True" — pagamento processado como bem-sucedido
ebanx_payment_hash Identificador do pagamento na EBANX (hash)