Clickfin

Referência da API
Portal oficial
POST/bank-slips/{id}/cancel

Cancelar boleto emitido

Cancela um boleto já emitido. A operação só é permitida quando o status atual do boleto é issued.

O cancelamento é reservado antes da chamada ao Banco Inter. Uma rejeição definitiva do Inter libera a reserva e a operação pode ser repetida. Um resultado incerto (timeout, falha de rede, 5xx) conserva a reserva: novas chamadas retornam 503 BANK_SLIP.CANCEL_FAILED ("Bank slip cancellation is pending reconciliation.") sem reenviar o cancelamento até a conciliação com o provedor (fail-closed intencional). Erros do provedor são devolvidos com o status e a categoria do adaptador do Inter. Se o Banco Inter não puder atender a chamada (HTTP 5xx ou 429, ou falha de rede sem resposta), retorna 502 com a categoria BANK_SLIP.PROVIDER.UNAVAILABLE; as recusas 4xx do Inter respondem BANK_SLIP.PROVIDER.VALIDATION_ERROR. Requer perfil de Administrador.

AcessoChave de API · bank_slips:write
Parâmetros1
Respostas9

Parâmetros

  • idpath

    Sem descrição disponível.

Respostas

200Sucesso

Boleto cancelado com sucesso.

400Erro

Erro de validação nos parâmetros da consulta.

401Erro

Token ausente, inválido ou sem empresa selecionada.

403Erro

Falha de autorização.

404Erro

Erro de regra de negócio ou integração.

409Erro

Erro de regra de negócio ou integração.

429Erro

Limite de requisições excedido (RATE_LIMIT.EXCEEDED). Por chave: 120 requisições por minuto (janela fixa de 60 s); o 429 da chave traz X-RateLimit-* da chave. Por IP, para tráfego com chave: 600 requisições em 10 minutos; esse 429 traz só Retry-After, sem X-RateLimit-* (os cabeçalhos descrevem apenas o limite da chave). Aguarde Retry-After segundos antes de tentar de novo.

502Erro

Erro de regra de negócio ou integração.

503Erro

Erro de regra de negócio ou integração.