v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
Boletos

Cancelar o Boleto

Cancela boletos nos status de Aberto(opened) ou Vencido(overdue)

put/v1/bank_billets/{id}/cancel

Path parameters

idstring required

ID do Boleto

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Request body

cancellation_reason1 | 2 | 3 | 4 | 5 nullable

Motivo do cancelamento:

  • 1 Outro
  • 2 Fraude
  • 3 Óbito
  • 4 Erro operacional
  • 5 Quitação paga

Response

Boleto cancelado