Consultar histórico de notificação – Central de Atendimento

Essa rota retorna o histórico de notificações.

GET

Produção:

https://plugboleto.com.br/api/v1/notificacoes/historico

Headers

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-sh	CNPJ ou CPF da Software House	01001001000113
token-sh	Token da Software House	f22b97c0c9a3d41ac0a3875aba69e5aa
cnpj-cedente	CNPJ ou CPF do Cedente	01001001000113

Headers (Opcional)

Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-cedente	CNPJ do Cedente	01001001000113
token-cedente	Token do Cedente	f22b97c0c9a3d41ac0a3875aba69e5aa1

Query Params

Parâmetros permitidos na requisição:

Campo	Tipo	Descrição
dataInicial	string	Data inicial formato dd/mm/yyyy
dataFinal	string	Data final formato dd/mm/yyyy
tipo	string	Tipo da notificação (WEBHOOK, EMAIL, SMS)
evento	string	Evento da notificação (baixou, liquidou, alterou, registrou, rejeitou)
situacao	string	Situação da notificação (ENVIADO, FALHA , PROCESSANDO, PROCESSADO)
limit	number	Limite de arquivos retornados na página.
skip	number	Quantidade de ocorrências que serão puladas na consulta.

Exemplo de URL com os parâmetros preenchidos:

https://plugboleto.com.br/api/v1/notificacoes/historico?dataInicial=01/05/2021&dataFinal=19/05/2021&tipo=WEBHOOK

Retorno

Ao consultar sera retornado as informações dentro do array _dados, caso não retorne nenhuma informação, será retornado uma mensagem "Nenhum registro encontrado".

Dados da notificação que são retornados:

Campo	Tipo	Descrição
id	number	ID
protocolo	string	Protocolo do envio.
evento	string	Evento da notificação, ex: ENVIADO.
dados	json	Retorna o json, com o conteúdo utilizado no envio da notificação.
situacao	string	Situação da notificação, ex: PROCESSADO.
criado	Date	Data da criação da notificação.
atualizado	Date	Data da atualização do status da notificação.
tipo	string	Tipo da notificação, ex: EMAIL.
idintegracao	string	Id integração do boleto.

O campo _meta retorna um objeto com os dados necessário para se realizar uma paginação.

_itens_por_pagina: Quantidade de itens por página.
_pagina_atual: Página atual.
_total_paginas: Quantidade total de páginas considerante a quantidade de _itens_por_pagina.
_total: Quantidade total de registros.

Segue abaixo alguns exemplos de json que seu sistema irá receber para cada uma das notificações em WebHook:

Registro:

{
"tipoWH": "notifica_registrou",
"dataHoraEnvio": "30/06/2022 00:00:00",
"titulo": {
"situacao": "REGISTRADO",
"idintegracao": "xxxxxxxxx",
"PagamentoData": "30/06/2022",
"TituloNossoNumero": "0001"
}
}

Liquidação:

{
   "tipoWH":"notifica_liquidou",
   "dataHoraEnvio":"30/06/2022 00:00:00 ",
   "titulo":{
      "situacao":"LIQUIDADO",
      "idintegracao":"xxxxxxxxx",
      "PagamentoData":"30/06/2022",
      "TituloNossoNumero":"10",
      "PagamentoValorPago":"50.00",
      "PagamentoDataCredito":"30/06/2022",
      "TituloMovimentos":[
         {
            "codigo":"06",
            "mensagem":"Movimento: LIQUIDAÇÃO CONFIRMADA",
            "data":"17/09/2018 00:00:00",
            "ocorrencias":[]
         }
      ]
   }
}

Baixa:

{
"tipoWH": "notifica_baixou",
"dataHoraEnvio": "30/06/2022 00:00:00",
"titulo": {
"situacao": "BAIXADO",
"idintegracao": "xxxxxxxxx",
"TituloNossoNumero": "0001",
"TituloMovimentos": [
          {
             "codigo": "02",
             "mensagem": "Movimento: ENTRADA CONFIRMADA COM POSSIBILIDADE DE MENSAGEM",
             "data": "30/06/2022 00:00:00",
             "ocorrencias": []
          }
       ]
    }
}

Rejeição:

{
    "tipoWH": "notifica_rejeitou",
    "datahoraenvio": "30/06/2022 00:00:00",
    "titulo": {

      "situacao": "REJEITADO",
      "idintegracao": "xxxxxxxxx",
      "TituloNossoNumero": "0001",
      "TituloMovimentos": []
      }
}

Alteração:

{
    "tipoWH": "notifica_alterou",
    "dataHoraEnvio": "30/06/2022 00:00:00",
    "titulo": {
       "situacao": "REGISTRADO",
       "TituloValor": "50.00",
       "idintegracao": "xxxxxxxxx",
       "TituloNossoNumero": "0001",
       "TituloDataVencimento": "30/06/2022 00:00:00",
       "TituloMovimentos": [
          {
             "codigo": "21",
             "mensagem": "Movimento: CONFIRMA RECEBIMENTO DE INSTRUÇÃO DE NÃO PROTESTAR",
             "data": "30/06/2022",
             "ocorrencias": []
          }
       ]
    }
}

Protesto:

{
    "tipoWH": "notifica_protestou",
    "dataHoraEnvio": "30/06/2022 00:00:00",
    "titulo": {
       "situacao": "INCLUIDO_CARTORIO",
       "idintegracao": "xxxxxxxxx",
       "TituloNossoNumero": "0001",
       "TituloMovimentos": [
          {
             "codigo": "19",
             "mensagem": "Movimento: Confirmação Recebimento Instrução de Protesto",
             "data": "30/06/2022 00:00:00",
             "ocorrencias": []
          }
       ]
    }
}

Exemplo de notificação de WebHook com falha:

"codigo":"06",
            "mensagem":"Movimento: LIQUIDAÇÃO CONFIRMADA",
            "data":"17/09/2018 00:00:00",
            "ocorrencias":[]
         }

"erro":
{
"codigo": 99, "mensagem": "Request failed with status code 400", "aptoRetentativa": true

}
]
}
}

Segue abaixo alguns exemplos de json que seu sistema irá receber para cada uma das notificações

em E-mail:

Registro:

{
"kind": "email",
"to": [
"emaildeteste@gmail.com"
],
"subject": "Assunto do e-mail, exemplo: BOLETO(s) - RAZAO SOCIAL",
"text": "Corpor do e-mail, exemplo: Prezado 'RAZAO SOCIAL'.\r\nAbaixo, segue o boleto com o valor de R$ 200.00, cujo vencimento está previsto para 10/08/2022.\r\nDúvidas, ficamos à disposição."
}

Liquidação:

{
"kind": "email",
"to": [
"emaildeteste@gmail.com"
],
"subject": "Assunto do e-mail, exemplo: Obrigado - Identificamos seu pagamento",
"text": "text": "Corpor do e-mail, exemplo: Prezado(s) RAZAO SOCIAL,\r\n\r\nIdentificamos o pagamento no valor de 200.00 com vencimento em 11/07/2022.\r\n\r\nObrigado pelo pagamento\r\n"
}

Baixa:

{
"kind": "email",
"to": [
"emaildeteste@gmail.com"
],
"subject": "Assunto do e-mail, exemplo: RAZÃO SOCIAL - Aviso de Baixa de boleto",
"text": "Corpor do e-mail, exemplo: Ola RAZAO SOCIAL!\r\nSeu boleto no valor de R$ 200.00, Nota Fiscal xxxxxx, Parcela x foi Baixado!\r\nObrigado e conte conosco!\r\n\r\n"
}

Exemplo de notificação de E-mail com falha::

"codigo": 99, "mensagem": "Message failed: Unusual sending activity detected.", "aptoRetentativa": true}

}

GET

Headers

Headers (Opcional)

Query Params

Exemplo de URL com os parâmetros preenchidos:

Retorno

Artigos relacionados