Guias

Cancelamento de Protesto

Informações gerais

O cancelamento do protesto é necessário quando o devedor pagou a dívida, ou quando o envio do título a protesto foi feito de forma indevida. Existem 3 fluxos para cancelamento do protesto, que serão explicados nas seções a seguir.

Tipo de Cancelamento

Definição

Status para Solicitação

Cancelamento de envio

Esse fluxo pode ser realizado de forma emergencial SOMENTE quando o titulo está com a situação AGUARDANDO_COLETA. Nesse caso, é possível que o título não tenha sido enviado ao cartório ainda, por isso o cancelamento do protesto pode ser feito de forma instantânea e sem custos.

AGUARDANDO_COLETA

Autorização

Esse é fluxo de cancelamento mais recomendado pela sua facilidade de integração e simplicidade para o credor, já que tudo é resolvido com apenas um "clique", ou seja, uma chamada na API.

Após o acionamento da requisição, não é necessário fazer mais nada em termos de implementação, o Protesto24h enviará a autorização de cancelamento de forma automática ao cartório, em até 1 dia útil.
Do ponto de vistar do credor, a autorização pode ser o fluxo mais fácil e rápido, já que ele precisa apenas realizar um clique e avisar o devedor que ele precisa se dirigir ao cartório.

O protesto só é efetivamente removido do nome do devedor quando ele for ao cartório pagar as custas de cancelamento, ou seja, apesar de ser simples e rápido para o credor, para o devedor é extremamente manual.

PROTESTADO ou PROTESTO_POR_EDITAL.

Pedido de Cancelamento

Neste fluxo, o credor deve pagar as custas de cancelamento ao cartório.

Por esse motivo, pode ser um fluxo oneroso para o credor, já que ele precisa assumir o pagamento das custas de cancelamento, e possivelmente realizar ações manuais. Existem duas formas de realizar o pedido: Pagamento antecipado e Pagamento postecipado
Não é a forma padrão de realizar o pedido de cancelamento, é necessário entrar em contato com o suporte do Protesto24h para ativar. Neste modelo, não é necessário pagar as custas de cancelamento antes de enviar o cancelamento ao cartório. Funciona da seguinte forma:

A efetivação do cancelamento independe do pagamento do boleto, quando chegar a notificação webhook com a situação RETIRADO ou PROTESTO_CANCELADO o processo de cancelamento estará finalizado.

COLETADO, NO_CARTORIO, PROTESTADO ou PROTESTO_POR_EDITAL


Possíveis erros no cancelamento

Ao acionar as requisições "Solicitar custas" e "Solicitar cancelamento", os seguintes códigos de erro podem ser retornados:

IdentificadorDescrição
PEDIDO_CANCELAMENTO_INVALIDOO pedido de cancelamento não pode ser realizado pois a situação do título é inválida ou porque já existe um pedido ou autorização criado.
PEDIDO_CUSTAS_INVALIDOO pedido de custas não pode ser realizado pois a situação do título é inválida.
PEDIDO_CUSTAS_PENDENTERetornado apenas para pedidos de cancelamento postecipados, caso a ação "Solicitar custas" não tenha sido realizada ainda. Para corrigir o erro, faça a solicitação das custas antes de realizar o pedido de cancelamento.
AUTORIZACAO_INVALIDAA autorização não pode ser realizada pois a situação do título é inválida ou porque já existe um pedido ou autorização criado.
CANCELAMENTO_ENVIO_INVALIDOO envio do cancelamento não pode ser realizado.

Fluxos de Cancelamento

  1. CANCELAMENTO_ENVIO (Tipo = 1)
    • Quando usar: Apenas quando situação = AGUARDANDO_COLETA (título ainda não foi enviado ao cartório)
    • **Sucesso (HTTP 2xx): **Cancelamento instantâneo. Estado muda para INSERIDO imediatamente. Não aguarda webhook.
    • **Erro HTTP 422 CANCELAMENTO_ENVIO_INVALIDO: **Título já foi enviado ao cartório. Não é erro técnico, é fluxo inválido. Retorna erro sem alterar estado. Aguarde título chegar em COLETADO ou NO_CARTORIO e use outro fluxo.
  2. AUTORIZACAO (Tipo = 0)
    • **Quando usar: **Apenas quando situação = PROTESTADO ou PROTESTO_POR_EDITAL
    • Sucesso (HTTP 2xx): Estado muda para CANCELAMENTO_SOLICITADO. Email/SMS é enviado ao devedor informando que deve pagar custas no cartório.
    • **Próximos passos: **Aguarda webhook SITUACAO_TITULO com situacao = RETIRADO ou PROTESTO_CANCELADO para finalizar como CANCELADO.
    • Observação: Job de sincronização não marca erro se situação continuar PROTESTADO/NO_CARTORIO/COLETADO após solicitar autorização.
  3. PEDIDO_CANCELAMENTO (Tipo = 2) - Pagamento Antecipado
    • Quando usar: Quando o credor quer pagar as custas antecipadamente via Pix. Pode ser feito em qualquer situação após protesto efetivado.
    • **Sucesso (HTTP 2xx): **Estado muda para CANCELAMENTO_SOLICITADO.
    • Próximos passos:
    1. Aguarda webhook VALOR_CANCELAMENTO (com valor, QR Code PIX e prazo). Estado muda para VALOR_CANCELAMENTO.
    2. Cliente paga via PIX.
    3. Aguarda webhook SITUACAO_TITULO com situacao = RETIRADO ou PROTESTO_CANCELADO. Estado final muda para CANCELADO.
    • Observação: Job de sincronização não marca erro quando cancelamento_solicitado = true e situação é COLETADO, NO_CARTORIO, etc. Esses são estados normais do fluxo durante cancelamento.

Webhooks Recebidos

Webhook VALOR_CANCELAMENTO (apenas para PEDIDO_CANCELAMENTO)

{
  "titulo_id": 17509,
  "tipo": "VALOR_CANCELAMENTO",
  "prazo_cancelamento": "19/07/2021 15:00:00",
  "valor": "100.00",
  "codigo_pix": "00020126360014BR.GOV.BCB.PIX2567..."
}
  • Estado muda para VALOR_CANCELAMENTO
  • Cliente recebe notificação com valor, QR Code PIX e prazo

Webhook SITUACAO_TITULO (finalização)

{
  "titulo_id": 17509,
  "tipo": "SITUACAO_TITULO",
  "situacao": "RETIRADO" // ou "PROTESTO_CANCELADO"
}
  • Estado final muda para CANCELADO (não RETIRADO ou PROTESTO_CANCELADO)
  • Aplica-se tanto para AUTORIZACAO quanto para PEDIDO_CANCELAMENTO

Updated 8 days ago