Cancelamento Garantido

Funcionalidade Gateway que cancela automaticamente transações em erro, dando resposta definitiva ao consumidor.

Documentação legada do Pagar.me v5

Esta página descreve um conceito da Pagar.me v5 (versão clássica). Para projetos novos, explore o API Catalog.

Cancelamento Garantido

O cancelamento garantido é uma funcionalidade desenvolvida pensando na melhor experiência entre lojista e consumidor final. Para alguns modelos de negócio pode não ser viável esperar a resposta de uma transação com erro (em que não se sabe o status real: pago ou não autorizado). Muitas vezes, o lojista precisa mostrar uma resposta ao consumidor final na hora em que ele faz o pedido, já que o consumidor precisa da confirmação ou não do pedido de forma síncrona.

Com o cancelamento garantido, todas transações que sofreram algum tipo de erro no fluxo normal são automaticamente canceladas, e assim o consumidor terá uma resposta final (transação aprovada ou transação falha) no momento do pedido, em tempo real.

Para entender melhor o que pode causar um erro na transação, precisamos falar sobre alguns pontos:

Status de cobrança

A API Pagar.me tem os seguintes status mapeados para uma cobrança:

  • Paid — quando uma cobrança está paga;
  • Pending — quando uma cobrança ainda está pendente de alteração (como um boleto gerado e ainda não pago, uma transação de cartão de crédito autorizada e não capturada ou uma transferência bancária não realizada);
  • Failed — quando a transação falhou, foi não autorizada ou não confirmada;
  • Canceled — quando há o cancelamento ou estorno de uma cobrança;
  • Processing — quando ocorreu algum fluxo inesperado, ou seja, quando a cobrança não seguiu o fluxo correto de processamento e retornou com erro do gateway ou quando a cobrança está pendente de retentativa offline.

Quando o status vira "processing"

Uma transação adquire o status processing em alguns casos, como os citados abaixo:

ProblemaExplicação
Timeout com a adquirenteQuando a adquirente não responde a tempo
Operações com erro no retorno do gatewayLoja com problemas ou bloqueio na adquirente; erro 500 no gateway; erro no cancelamento; erro no estorno

Transações que entram no fluxo de retentativa offline também recebem o status "processing". Para diferenciar as duas situações, enviamos uma flag de pending_cancelation, mostrando que a transação está na fila de cancelamento.

Nos casos em que houve algum erro, o Pagar.me sonda a adquirente de tempos em tempos para entender qual o real status da transação (se existe e está paga, se existe e falhou ou se não existe na adquirente) e, ao concluir sobre esse status, notifica o lojista.

Comportamento esperado pelo lojista

Essa funcionalidade garante que todas as transações que entrem no fluxo de status processing sejam canceladas automaticamente. Retornamos o status processing, mas o lojista pode tratar como falha, permitindo que o consumidor tente de novo sem correr o risco de duplicar a compra.


Jornada: Cobrar um cliente
Etapa 9 de 22