get
https://api.stage.cora.com.br/v2/invoices//notifications
Consulta as notificações atreladas a um boleto através desta API
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: para que a resposta da API seja preenchida, é recomendável que um boleto tenha sido gerado anteriormente, o identificador desse boleto deve ser indicado no parâmetro da url.
Parâmetros da requisição
Parâmetro | Tipo | Descrição |
|---|---|---|
invoice_id obrigatório | String | Identificador do boleto que deve ser indicado no próprio endpoint |
Parâmetros da resposta
| Status | Status Code | Significado |
|---|---|---|
| Sucesso | 200 | O boleto tem ao menos uma notificação configurada. |
| Não encontrado | 404 | O boleto não tem nenhuma notificação configurada. Não significa que o boleto não exista. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name obrigatório | String | Nome do contato cadastrado para receber as notificações deste boleto. |
| channels\ obrigatório | Lista de NotificationChannelResponse | Um objeto por canal configurado no boleto. |
Objeto NotificationChannelResponse
| Parâmetro | Tipo | Descrição |
|---|---|---|
| channel obrigatório | String | Canal da notificação: "EMAIL", "SMS" ou "WHATSAPP". O canal WhatsApp não é configurável pela API de emissão, mas pode aparecer aqui se tiver sido configurado pelo aplicativo ou pelo Cora Web. |
| destination\ obrigatório | String | Destino para onde a notificação é enviada: o e-mail, ou o celular já normalizado com o código do país. |
| rules\ obrigatório | Lista de NotificationRuleResponse | Uma entrada por regra configurada neste canal, da mais antecipada para a mais tardia. |
Objeto NotificationRuleResponse
| Parâmetro | Tipo | Descrição |
|---|---|---|
| rule obrigatório | String | A regra configurada. Os valores possíveis estão no Enum de Tipos de Notificação. |
| status\ obrigatório | String | Situação atual da notificação. Os valores possíveis estão no Enum de Estados da Notificação. |
Atenção
A resposta traz apenas o que está configurado hoje. Ela não inclui a data de agendamento de cada notificação, nem o histórico de tentativas.
Enum de Estados da Notificação
| Parâmetro | Descrição |
|---|---|
| SCHEDULED | Agendada para uma data futura. |
| TRIGGERED | Sem data definida, aguardando o evento que a dispara. Hoje é o caso de NOTIFY_WHEN_PAID, que espera o pagamento. |
| CANCELED | Cancelada, seja por você, seja porque o boleto foi pago ou cancelado. |
| SENT | Enviada ao nosso disparador, aguardando confirmação de entrega. |
| SUCCESS | Entrega confirmada. |
| ERROR | Falha na entrega. |
Atenção
Os estados SENT, SUCCESS e ERROR são finais: uma notificação nesses estados não pode mais ser cancelada.
Use esta consulta para conferir o que foi efetivamente agendado em um boleto. Uma regra cuja data já passou no momento da emissão nasce cancelada, e a emissão não retorna erro por isso.
Agora é hora do Café!
Sim, aprendemos a consultar as notificações do boleto
404O boleto não tem nenhuma notificação configurada. Não significa que o boleto não exista. A resposta não tem corpo.