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

EBANX

Para usar a plataforma de pagamento EBANX no Mavibot, você precisa obter sua Chave de Integração na sua conta EBANX e inseri-la nas configurações de pagamento.

A EBANX é uma agregadora 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 Chave de Integração

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

Durante o processo de onboarding, 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 Chave de Integração. Você precisará dela para conectar a EBANX ao Mavibot.

Para fins de teste, a EBANX oferece uma conta sandbox separada com sua própria Chave de Integração. Veja o Modo de Teste abaixo.

Conectando a EBANX

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

  • Chave de Integração — sua Chave de Integração EBANX copiada.

  • País — o país de pagamento padrão (código de país em minúsculas com duas letras: br para o Brasil, mx para o México, co para a Colômbia, cl para o Chile, pe para o Peru, ar para a 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.

  • Modo de Teste — habilite esta opção para testar a integração usando o ambiente sandbox da EBANX. Quando o Modo de Teste estiver habilitado, use a Chave de Integração da sua conta sandbox. Para aceitar pagamentos reais, desative o Modo de Teste e use sua Chave de Integração de produção.

A configuração está concluída.

Gerando um Link de Pagamento

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 endereço de 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 (normalmente USD), nesse caso 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 em minúsculas com duas letras). Opcional. Se omitido, será usado o país padrão especificado nas configurações de pagamento.

A função retorna uma URL de pagamento.

Observação: a moeda selecionada deve ser compatível com o país de pagamento. Ela 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álidas, enquanto MXN não é.

Botão de Link de Pagamento

Para enviar um botão de pagamento, selecione o tipo Botão de Pagamento 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 do fluxo

Etapa 1. Crie um Início bloco.

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

Etapa 2. Crie o bloco mostrado abaixo.

Etapa 3. Vá para as Conexão configurações.

Você precisará da seguinte expressão regular para verificar se o cliente digitou 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 Usuário insere dados e insira customer_email.

Etapa 4. Digite a mensagem no segundo bloco.

Etapa 5. Crie um terceiro bloco e abra as Conexão configurações entre o segundo e o terceiro bloco.

Ative o temporizador para avançar automaticamente para o próximo bloco.

Etapa 6. No terceiro bloco, insira a função na Calculadora.

Exemplo para copiar:

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:

  • Digite o texto do botão.

  • Selecione a Cobrança função.

  • Selecione EBANX como provedor de pagamento.

Em seguida, insira o seguinte:

  • Nome do produto.

  • Valor do pagamento.

  • Moeda (opcional).

  • Nome completo do cliente (opcional). Você pode configurar isso da mesma forma que configurou a entrada de e-mail do cliente.

  • E-mail do cliente — insira a variável #{customer_email}.

Em seguida, clique em Adicionar.

Notificações após o pagamento

Depois que o cliente abrir o link de pagamento e concluir o pagamento, o seguinte callback é enviado à conversa após o pagamento ser bem-sucedido:

Onde:

  • SDJ91MTKTT é os primeiros 10 caracteres da sua Chave de Integração.

  • 100 é o valor do pagamento.

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

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 com Falha

Etapa 1. Crie um Acionador bloco.

Etapa 2. No campo de condição, digite o texto da notificação SDJ91MTKTT_success — sem o valor do pagamento — se você quiser reagir a todos os pagamentos.

Nesse caso, o Tipo de correspondência deve ser definido como Por palavras-chave.

Como alternativa, digite o texto completo do callback no campo Acionador se quiser reagir a um pagamento específico. Nesse caso, o Tipo de correspondência deve ser definido como Correspondência exata.

Se você quiser continuar o fluxo de trabalho após um pagamento bem-sucedido, você pode criar um Início bloco em vez de um Acionador bloco 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 sobre o pagamento recebidas do sistema de pagamento

ebanx_payment_completed

"True" — o pagamento foi processado como bem-sucedido

ebanx_payment_hash

Identificador do pagamento na EBANX (hash)

AnteriorCoinpaymentsPróximoINXY Payments

Atualizado