Cancelamento

📘

Nota

A documentação da nova versão deste endpoint está disponível na aba v2 deste manual. Para acessá-la, basta selecionar a versão desejada (v2) no menu suspenso localizado no canto superior esquerdo da página.

Este endpoint permite que o parceiro realize o cancelamento de um boleto a qualquer momento após seu registro, desde que ele não tenha sido pago.

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

• Solicitação do emitente;
• Decurso do prazo de pagamento. Nesse caso, o próprio Bankly realiza o cancelamento 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).

Pré-requisitos

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

• O boleto tenha sido emitido;
• O boleto não tenha sido pago.

Requisição

Requisição HTTP

DELETE https://api-mtls.sandbox.bankly.com.br/bankslip/cancel

--location --request DELETE ' https://api-mtls.sandbox.bankly.com.br/bankslip/cancel' \  
--header 'Accept: application/json' \  
--header 'Content-Type: application/json' \  
--header 'api-version: 1.0' \  
--header 'Authorization: Bearer {{Token}} ' 
--data-raw '{ 
     “authenticationCode”: "5566165e-51fb-459b-a31c-1e996165280b", 
     "account": { 
        "number": "00001", 
        "branch": "15164" 
        }     
    }'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

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:

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

Resposta (Response)

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

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

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

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês 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 é: