2.3 Consulta de Agenda

Consulta

Após a confirmação de que o Opt-in foi registrado, o Participante Credor pode realizar a Consulta de Posição de Agenda por Titular de Ativos Financeiros conforme exemplo abaixo:

Além da consulta livre, caso queira filtrar melhor a consulta, basta habilitar os parâmetros que deseja selecionar, conforme o exemplo:

Para que haja o recebimento de Notificações de Eventos realizados nos Recebíveis sem ter a necessidade de fazer consultas, basta criar a URL de Webhook que vocês desejarem trabalhar. Será apresentado o passo a passo no capítulo 2.5 desta seção.

Consulta de Notificação

Além do recebimento das Notificações via Webhook, o Participante pode consultar a notificação que foi enviada pela TAG após um evento gatilho utilizando o EndPoint de Consulta de Notificação de Agenda. Segue um exemplo de notificação de Contrato, ou seja, onde o eventType é do tipo position:

[
  {
    "eventType": "position",
    "data": {
      "id": "dd5e5227-52a9-404a-83e1-1933b01ea0dc",
      "documentNumber": "99999999999999",
      "urls": [
        "https://api.receivable.staging.taginfraestrutura.com.br/reconciliation/file/56614efa-5026-4c6c-93ad-3b406729effb"
      ],
      "full": false,
      "processKey": "0ff40b0e-35ca-4d1f-bdeb-9d9f16",
      "createdAt": "2021-01-13T19:59:27.5994488Z"
    },
    "processKey": "0ff40b0e-35ca-4d1f-bdeb-9d9f16",
    "createdAt": "2021-01-13T19:59:27.675Z"
  }
]

O significado de cada um dos campos do Payload se encontra disponível na seção Dicionário de Campos do Payload.

❗️

Importante!

Notificação de Posição de Agenda possui em seu Payload uma URL contendo todas as URs em formato JsonLine. Essa URL possui um período de vigência de duas horas a partir de sua criação, portanto, deve ser consumida dentro deste prazo.

As demais notificações não possuem URL, elas já são encaminhadas contendo todas as informações no corpo do Payload, que pode ser consultada a qualquer momento, visto que não possui período de vigência.

🚧

To-dos de Desenvolvimento

1. Realizar a Consulta de Posição de Agenda cuja visualização foi concedida por Opt-in (Capítulo 2.2 desta seção);
2. Realizar a Consulta da Notificação de Posição de Agenda;
3. Identificar as diferenças nos dois tipos de Consulta.