EBANX Payment Page

Sobre este guia

Esta página explica como processar pagamentos usando a integração com a Payment Page.

Se você ainda não está integrado à Payment Page, dê uma olhada na visão geral do produto para verificar os métodos de pagamento e recursos disponíveis. Não tem certeza se a Payment Page é a melhor opção para seu e-commerce? Por favor, fale com um de nossos especialistas.

O que você vai precisar

Antes de iniciar sua integração, certifique-se de ter:

1. Uma conta em nosso ambiente de testes. Ainda não possui sua conta? Fale com nossa equipe comercial;
2. Habilitado em sua conta os métodos de pagamento que deseja aceitar.

Como funciona

Para completar uma integração através da Payment page EBANX, siga os passos abaixo.

1. Habilite seus métodos de pagamento

   Você tem uma variedade de métodos de pagamento para escolher com o EBANX. Portanto, o primeiro passo é verificar quais você deseja ativar em seu Dashboard EBANX.

   Tudo pronto? Podemos avançar para a próxima etapa, caso contrário, entre em contato com nosso representante comercial.

2. Chame /ws/request via API para obter o link

   Com a Payment Page, seus clientes são redirecionados para uma página de checkout segura hospedada pelo EBANX. Para obter este link de redirecionamento, você só precisa chamar o end-point ws/request com os seguintes campos obrigatórios.

   Parâmetro	Descrição
   integration_key	Sua chave de integração única e secreta.
   name	Nome do cliente.
   email	Endereço de e-mail do cliente
   country	Código do país com duas letras.
   payment_type_code	_all, para ter todos os métodos de pagamento disponíveis ou você pode restringi-lo com os métodos de pagamento disponíveis
   currency_code	O código da moeda de sua transação.
   amount	Valor da transação, na moeda especificada. Por exemplo: 100.50
   merchant_payment_code	ID do pagamento gerado pelo merchant.

   API Reference

   A referência completa para o end-point ws/request pode ser encontrada aqui. Recomendamos fortemente que você dê uma olhada em todas as opções disponíveis, como parcelamentos por exemplo.

   Métodos de pagamento e moedas disponíveis

   Métodos de Pagamentos Disponíveis

   Você pode informar os valores abaixo no parâmetro payment_type_code para restringir a forma de pagamento, ou apenas usar _all para todas as formas de pagamento disponíveis na a conta do comerciante.

   • boleto: Boleto Bancário.
   • _creditcard: Cartões de Crédito
   • debitcard: Cartões de Débito

   Moedas Disponíveis

   • BRL: Real

   No exemplo abaixo, estamos chamando o end-point /ws/request usando country igual a br (Brasil) e currency_code igual a BRL (Real), inserindo todos os métodos de pagamento disponíveis.

   curl -X POST 'https://staging.ebanx.com.br/ws/request' \

   -d 'integration_key=your_test_integration_key_here' \

   -d 'name=José Silva' \

   -d 'email=josesilva@example.com' \

   -d 'country=br' \

   -d 'payment_type_code=_all' \

   -d 'merchant_payment_code=d59cb7166e7' \

   -d 'currency_code=BRL' \

   -d 'amount=100'

   Uma solicitação bem sucedida retornará uma resposta JSON como mostra o exemplo abaixo. O link de redirecionamento estará no parâmetro redirect_url.

   {

   "payment": {

   "hash": "5df021ff413e82f5573bf358a8955e9e40cf6587feed42c3",

   "pin": "737795033",

   "country": "br",

   "merchant_payment_code": "123121241243e8a",

   "order_number": null,

   "status": "OP",

   "status_date": null,

   "open_date": "2019-12-10 22:53:50",

   "confirm_date": null,

   "transfer_date": null,

   "amount_br": 100,

   "amount_ext": 100,

   "amount_iof": 0,

   "currency_rate": 1,

   "currency_ext": "BRL",

   "due_date": "2019-12-13",

   "instalments": 1,

   "payment_type_code": "_all",

   "pre_approved": false,

   "capture_available": null,

   "customer": null

   },

   "redirect_url": "https://checkout-sandbox.ebanxpay.com.br/5df021ff413e82f5573bf358a8955e9e40cf6587feed42c3",

   "status": "SUCCESS"

   }

   O parâmetro redirect_url contém a url para redirecionar seus clientes para a próxima etapa.

3. Redirecionar o cliente para a Payment Page usando a URL retornada

   Redirecione seu cliente para a URL retornada no parâmetro redirect_url. Seus clientes verão a página de pagamentos do EBANX:

   

4. Aguarde o pagamento

   Assim que o seu cliente tiver concluído a compra, será redirecionado para uma "página de agradecimento" como a imagem abaixo, com a possibilidade de regressar ao seu site.

   

   info

   A URL de retorno pode ser configurada em seu painel ou enviada como um parâmetro na solicitação para ws/request no parâmetro redirect_url. Saiba mais sobre notificações aqui

   Se seus clientes não concluírem o pagamento, ele será automaticamente cancelado.

Obtendo Ajuda

Nós esperamos que este artigo tenha sido esclarecedor, mas caso não tenhamos tirado suas dúvidas você tem as seguintes opções para continuar buscando respostas:

• Se você ainda não é nosso parceiro e deseja saber mais sobre nossos preços e condições, entre em contato com nossa equipe comercial.
• Caso você já seja nosso parceiro, entre em contato com nossa equipe de suporte em faleconosco@ebanxpay.com.