Cancelar um pagamento

Sobre este guia

Este guia demonstra rapidamente como cancelar um pagamento pendente ou em aberto no EBANX. Iremos guiá-lo pelas etapas básicas para atingir esse objetivo usando sua integração com API direta.

Se você ainda não está integrado com EBANX Direct API, dê uma olhada neste guia básico. Não tem certeza se EBANX Direct API é a melhor opção para seu e-commerce? Por favor, fale com um de nossos especialistas.

Como funciona

Para cancelar um pagamento, você deve chamar o método cancelar da API. Veja os passos seguintes:

1. Certifique-se de que o status do pagamento é igual a pendente ou aberto

   Você pode cancelar um pagamento apenas se seu status for aberto (OP) ou pendente (PE). Você pode verificar o status do seu pagamento usando o end-point ws/query. Você pode aprender mais neste guia rápido.

   Pagamentos Confirmados

   É importante lembrar que não é possível cancelar pagamentos confirmados (CO), apenas reembolsados.

2. Cancele o pagamento usando o end-point /ws/cancel

   Para cancelar um pagamento você só precisa chamar o end-point /ws/cancel (do seu servidor) com os seguintes campos obrigatórios:

   Campo	Descrição
   integration_key	Sua chave secreta de integração
   hash	O hash de pagamento (identificador único EBANX)

   Por favor, verifique o exemplo abaixo:

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

   -d 'integration_key=sua_chave_teste_de_integração' \

   -d 'hash=5476099e890c06ca6f02cae9da1b1faaf3c5929439076cb9'

   Uma solicitação bem sucedida retornará uma expressão JSON semelhante a seguinte:

   {

   "payment": {

   "hash": "5476099e890c06ca6f02cae9da1b1faaf3c5929439076cb9",

   "merchant_payment_code": "1461416920319",

   "order_number": "146",

   "status": "CA",

   "status_date": "2014-11-26 17:34:11",

   "open_date": "2014-11-25 10:45:56",

   "confirm_date": null,

   "transfer_date": null,

   "amount_br": "204.45",

   "amount_ext": "204.45",

   "amount_iof": "0.00",

   "currency_rate": "1.0000",

   "currency_ext": "BRL",

   "due_date": "2014-12-2",

   "instalments": "1",

   "payment_type_code": "boleto",

   "pre_approved": false,

   "capture_available": null

   },

   "operation": "cancel",

   "status": "SUCCESS"

   }

   API Reference

   A referência completa da API para o end-point ws/cancel pode ser encontrada aqui. Recomendamos fortemente que você dê uma olhada em todas as opções e exemplos disponíveis.

Cancelando um Pagamento via Dashboard

Como alternativa, você também pode cancelar um pagamento em aberto usando seu Dashboard EBANX.

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.