delete
https://api.stage.cora.com.br/v2/invoices//notifications
Cancele as notificações agendadas para um boleto
Importante para Integração Direta
Para você conseguir efetuar essa integração é obrigatória a leitura sobre "Utilização das APIs" e recomendada a leitura sobre "Instruções Iniciais" e "Client Credentials e Client ID"
Quais são os requisitos para a utilização desta API?
- Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
- Boleto: o boleto precisa ter sido emitido com notificações configuradas. O identificador dele deve ser indicado no próprio endpoint.
Parâmetros da requisição
| Parâmetro | Tipo | Descrição |
|---|---|---|
| invoice_id obrigatório | String | Identificador do boleto na Cora, criado quando o boleto é gerado. Exemplo: inv_rMS993vSMQJWqH290qO99Mccg. |
Parâmetros da resposta
| Status | Status Code | Corpo |
|---|---|---|
| Sucesso | 200 | vazio |
Atenção
O cancelamento é idempotente: se o boleto não tiver nenhuma notificação pendente, a chamada ainda assim responde 200.
São canceladas apenas as notificações que ainda não saíram, ou seja, as que estão em SCHEDULED ou TRIGGERED. As que já foram enviadas permanecem no histórico e continuam aparecendo na consulta de notificações.
Não há como cancelar uma notificação individual: a chamada cancela todas as pendentes do boleto.
200Notificações pendentes canceladas. A resposta não tem corpo. Idempotente: se o boleto não tiver nenhuma notificação pendente, a chamada ainda assim responde 200.