Cancelamento de notificações do boleto

Cancele as notificações agendadas para um boleto

154
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.

Bora pro código?

383

Parâmetros da requisição

ParâmetroTipoDescrição
invoice_id obrigatórioStringIdentificador do boleto na Cora, criado quando o boleto é gerado. Exemplo: inv_rMS993vSMQJWqH290qO99Mccg.

Parâmetros da resposta

StatusStatus CodeCorpo
Sucesso200vazio
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.


Path Params
string
required
Defaults to inv_IU6nswNwQjO2JX8eHIzEfw

Identificador do boleto na Cora, devolvido na emissão.

Responses
200

Notificaçõ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.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json