Cancelamento

O cancelamento de um boleto pode ocorrer por duas razões:

Solicitação do beneficiário final;
Decurso do prazo de pagamento. Nesse caso o boleto será cancelado automaticamente para garantir que não haverá pagamento.

O cancelamento por decurso de prazo de pagamento considerará, por padrão, a data de vencimento do boleto (dueDate).

Porém, caso o título sofra a incidência de juros e/ou multa, o cancelamento ocorrerá somente após a nova data de vencimento do documento (informada no campo closePayment).

⚠️
Importante
O cancelamento do boleto por decurso de prazo ocorre em até 2 dias úteis.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O boleto tenha sido registrado;
O boleto não tenha sido pago.

Requisição (Request)

Requisição HTTP

DELETE https://sandbox.hiperbanco.com.br/boletos

--request DELETE 'https://sandbox.hiperbanco.com.br/boletos' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "authenticationCode": "5566165e-51fb-459b-a31c-1e996165280b",
  "account": {
    "number": "1156985214",
    "branch": "0001"
  }
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
version	cutting-edge	Essa propriedade garante que o response da API seja retornado no formato JSON
Authorization	Bearer token	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
authenticationCode	string	Obrigatório. Identificador único do boleto.
account	object	Obrigatório. Objeto que deverá conter informações sobre a conta do beneficiário final do boleto.
account.branch	string	Obrigatório. Número da agência.
account.number	string	Obrigatório. Número da conta.

{
  "authenticationCode": "5566165e-51fb-459b-a31c-1e996165280b",
  "account": {
    "number": "1105427896",
    "branch": "0001"
  }
}

⚠️
Importante
Os campos do objeto accounts (account.branch e account.number) devem ser preenchidos com as informações da conta logada.

Resposta (Response)

O status code 200 indicará que o boleto foi cancelado com sucesso.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status code	Código	Mensagem	Descrição
400	BANKSLIP_INVALID_STATUS_OPERATION	Invalid bankslip status to perform this operation	O boleto está com status diferente de “Registered”.
400	BANKSLIP_INVALID_EXPIRATION_DATE	It is not possible to cancel bankslip after the DueDate or ClosePayment	O boleto não pode ser cancelado após a data de vencimento (dueDate) ou após a data limite de pagamento (closePayment).

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. O evento é:

Evento	Descrição
BOLETO_WAS_CANCELLED	O boleto foi cancelado.