Estornando transações (cancelamento)

Cancelando a reserva de saldo de uma pré-autorização ou retornando um valor total ou parcial de uma cobrança para o saldo do cartão.

Conceito

O estorno de transações (pré autorizadas ou bem sucedidas) é o processo de devolução de saldo (total ou parcial) de uma transação na fatura do pagador.

Esse estorno pode ser um cancelamento caso a fatura do cliente onde será lançada a primeira (ou única) parcela ainda não foi fechada ou um reembolso caso tenha sido fechada. Cancelamentos devem surtir efeito no mesmo dia, reembolsos podem levar uma ou mais faturas para serem refletidos, dependendo do banco emissor do cartão em questão.

📘

Caso uma transação já tenha algum recebível liquidado, a Zoop permite estornos caso o cliente ainda tenha saldo disponível em conta gráfica.
Para realizar o estorno de vendas já liquidadas deve ser feita uma solicitação especial de liberação em nome do marketplace/estabelecimento comercial, não sendo possível realizar este tipo de estorno sem uma liberação prévia.

📘

Não será possível estornar uma transação se ela estiver falhada, com uma captura pendente ou com um estorno pendente.

Tipos de Estorno

Cancelamento Total

É quando você devolve o valor total da transação que será devolvida ao cartão de crédito.

Cancelamento Parcial

O cancelamento parcial é o ato de cancelar um valor menor que o valor total autorizado/capturado. Esse modelo de cancelamento pode ocorrer inúmeras vezes, até que o valor total da transação seja cancelado.

Cancelamento parcial disponível apenas para transações de crédito capturadas.

Ao cancelar parcialmente uma transação, o amount estornado é reduzido do valor atual da venda, ficando o valor original_amount preservado com o valor original da venda, sendo regerado os recebíveis associados a esta venda, retornando erro caso uma regra de split ultrapasse o valor restante da venda após cancelamento.

No cancelamento parcial, o estado da venda permanece como succeeded enquanto restar valor amount a ser creditado ao EC. A venda passa para o estado de canceled quando o valor amount for zero.

No cancelamento parcial é também disparado o evento de transaction.canceled , porém mantendo o objeto da venda no estado de succeeded.

Para cada operação de cancelamento é registrado um histórico que pode ser visualizado nas APIs de transactions.

Requisição

POST /v1/marketplaces/marketplace_id/transactions/transaction_id/void

{    
   "amount": 7, // Valor para estornar e devolver ao cartão
   "on_behalf_of": "1e4c8c9b9886419098c60c53f2e7a57e" // ID do Vendedor
}
curl --request POST \
    --header "Content-Type: application/json" \
    --user zpk_test_EzCkzFFKibGQU6HFq7EYVuxI: \
    --url https://api.zoop.ws/v1/marketplaces/3249465a7753536b62545a6a684b0000/transactions/c937b6711e1144e89343b53000432772/void \
    --data '{    
        "amount": 7,
        "on_behalf_of": "1e4c8c9b9886419098c60c53f2e7a57e"
    }'

Comportamentos Excepcionais API V2

1. Timeout entre a Zoop e a rede de adquirência:

No processo de estorno de transações a Zoop espera um tempo máximo de 20 segundos pela resposta da adquirente. Caso esse tempo seja excedido, a Zoop corta a comunicação, mantém a transação no status anterior (seja bem sucedida ou pré autorizada) e armazena um histórico de operação de estorno pendente.

Assincronamente, a Zoop recupera o estado desse estorno e emite um evento informando o sucesso ou falha do estorno dessa transação.

2. Timeout entre a adquirência e os bancos emissores ou bandeiras

Nesse caso, a Zoop recebe uma resposta do adquirente com um código referente a uma falha inconclusiva ocasionada por timeout. O comportamento nesse caso é o mesmo descrito na situação 1.

3. Adquirentes que operam com estornos assíncronos por padrão

Alguns adquirentes operam com o resultado do estorno sendo retornado apenas em modo assíncrono, impossibilitando que a Zoop tenha uma resposta instantânea para devolver aos consumidores das nossas APIs. O comportamento nesse caso é o mesmo descrito na situação 1.

🚧

Modo Assíncrono

Não é possível desligar o modo assíncrono da operação de estorno, então é necessário que você tenha um webhook cadastrado para receber os eventos de operações de estorno. Para selecionar os eventos que você deseja receber, consulte nossa documentação de Eventos e Webhooks.

Updated 6 months ago


Estornando transações (cancelamento)


Cancelando a reserva de saldo de uma pré-autorização ou retornando um valor total ou parcial de uma cobrança para o saldo do cartão.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.