Reembolsar um pagamento

Sobre este guia

Este guia demonstra rapidamente como reembolsar um pagamento confirmado no EBANX. Iremos guiá-lo pelas etapas básicas para atingir esse objetivo usando sua integração com a 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

Basicamente, o processo de reembolso só pode ser acionado para pagamentos já confirmados gerados com sua conta. Pagamentos com status aberto (OP) ou pendente (PE) não podem ser reembolsados. Para entender um pouco mais como isso funciona, dê uma olhada no fluxo de reembolso no diagrama a seguir:

1. O merchant solicita o reembolso por meio do Dashboard ou EBANX Direct API.
2. Esta solicitação de reembolso chega diretamente na fila de reembolso EBANX, marcada como Solicitada.
3. O EBANX então reconhece o reembolso e o reembolso é marcado como Pendente.
4. Quando o cliente recebe o dinheiro de volta (em sua conta bancária ou por meio de seu cartão de crédito), o estado de reembolso muda para Confirmado.

note

Enquanto o reembolso estiver como Solicitado ou Pendente, ele pode ser cancelado pelo merchant

Veja estas observações sobre reembolsos no EBANX:

• Cada pagamento pode ter vários reembolsos, desde que a soma de seus valores não exceda o valor do pagamento original. Reembolsos cancelados não contam para esta soma;
• Apenas pagamentos confirmados (CO) podem ser reembolsados;
• A moeda do reembolso é a mesma do pagamento original;
• Reembolsos são notificados quando o reembolso está pendente e um e-mail é enviado ao cliente solicitando informações bancárias e quando o reembolso é confirmado;

Para Reembolsar um pagamento por meio da API Direta do EBANX, siga as etapas abaixo.

1. Certifique-se de que o status do pagamento seja igual a confirmado

   Você só pode reembolsar um pagamento se o status for igual a (CO) confirmado. Você pode verificar o status do seu pagamento usando o end-point ws/query. Veja mais neste guia rápido.

   Pagamentos Confirmados

   Observe que os pagamentos com status igual a (OP) aberto ou (PE) pendente só podem ser cancelados, nunca reembolsados.

2. Reembolsar o pagamento usando o end-point /ws/refund

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

   Parametro	Descrição
   integration_key	Sua chave secreta de integração.
   operation	As operações disponíveis são: request para solicitar um novo reembolso ou cancel para cancelar um reembolso.
   hash	O hash de pagamento (identificador único EBANX).
   amount	O valor a ser reembolsado; expresso na moeda de pagamento original.
   description	Descrição do motivo do reembolso.
   merchant_refund_code	ID do reembolso gerado pelo merchant.
   refund_id	O ID do reembolso a ser cancelado.

   Por favor, verifique o exemplo abaixo:

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

   -d 'integration_key=your_test_integration_key' \

   -d 'operation=request' \

   -d 'merchant_refund_code=787653' \

   -d 'hash=5ad9028b30eb8de099f9fe72b9763283c7cf4d35b6430221' \

   -d 'amount=100.00' \

   -d 'description=Order did not arrive'

   Uma solicitação bem-sucedida retornará uma expressão JSON semelhante à seguinte.

   {

   "payment": {

   "hash": "5ad9028b30eb8de099f9fe72b9763283c7cf4d35b6430221",

   "pin": "253639240",

   "country": "br",

   "merchant_payment_code": "9dwdwdw1e31c4c234",

   "order_number": null,

   "status": "CO",

   "status_date": "2018-04-19 20:57:07",

   "open_date": "2018-04-19 20:56:42",

   "confirm_date": "2018-04-19 20:57:07",

   "transfer_date": null,

   "amount_br": "100.00",

   "amount_ext": "100.00",

   "amount_iof": "0.00",

   "currency_rate": "1.0000",

   "currency_ext": "BRL",

   "due_date": "2018-04-22",

   "instalments": "1",

   "payment_type_code": "visa",

   "pre_approved": false,

   "capture_available": null,

   "refunds": [

   {

   "id": "68682",

   "merchant_refund_code": null,

   "status": "RE",

   "request_date": "2018-04-19 21:00:06",

   "pending_date": null,

   "confirm_date": null,

   "cancel_date": null,

   "amount_ext": "100.00",

   "description": "Testing notifications"

   }

   ]

   },

   "status": "SUCCESS"

   }

   API Reference

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

Cancelando uma solicitação de reembolso

Se o reembolso não for mais necessário, você também pode cancelar sua solicitação usando nossas APIs. Um reembolso só pode ser cancelado se seu status for igual a solicitado (RE) ou pendente ( PE).

Se tudo correr bem, o reembolso será imediatamente cancelado.

note

Se o reembolso for cancelado, o cliente não receberá o dinheiro e o merchant não será cobrado. Os clientes NÃO são notificados sobre o cancelamento do reembolso.

Para cancelar um reembolso via EBANX Direct API, você só precisa chamar o mesmo end-point /ws/refund com o parâmetro operation igual a cancel assim como seu merchant_refund_code.

Por favor, verifique o exemplo abaixo:

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

-d 'integration_key=your_test_integration_key' \

-d 'operation=cancel' \

-d 'merchant_refund_code=3784756'

{

"payment": {

"hash": "5ad9028b30eb8de099f9fe72b9763283c7cf4d35b6430221",

"pin": "253639240",

"country": "br",

"merchant_payment_code": "9dwdwdw1e31c4c234",

"order_number": null,

"status": "CO",

"status_date": "2018-04-19 20:57:07",

"open_date": "2018-04-19 20:56:42",

"confirm_date": "2018-04-19 20:57:07",

"transfer_date": null,

"amount_br": "100.38",

"amount_ext": "100.00",

"amount_iof": "0.38",

"currency_rate": "1.0000",

"currency_ext": "BRL",

"due_date": "2018-04-22",

"instalments": "1",

"payment_type_code": "itau",

"pre_approved": false,

"capture_available": null,

"refunds": [

{

"id": "68682",

"merchant_refund_code": "3784756",

"status": "CA",

"request_date": "2018-04-19 21:00:06",

"pending_date": null,

"confirm_date": null,

"cancel_date": "2018-04-20 21:00:06",

"amount_ext": "100.00",

"description": "Test transaction"

}

]

},

"status": "SUCCESS"

}

Reembolsos usando o Dashboard

Alternativamente, você também pode reembolsar um pagamento confirmado ou cancelar um reembolso 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.