Ir para o conteúdo

7.2. Atualização do Contrato

🔔 Tipo de Notificação

Campo Valor
tipoNotificacao 2

🧾 Descrição

Esta notificação será enviada via POST para o endpoint de WebHook configurado previamente quando houver alguma atualização no status do contrato de duplicata escritural. Ela permite acompanhar em tempo real as transições de status e identificar eventuais erros no processamento.


📤 Payload Enviado

{
  "tipoNotificacao": 2,
  "contrato": {
    "identificador": "19710560-04CD-4E48-881D-D38350B39079",
    "status": 1,
    "erros": ""
  }
}

🧾 Detalhamento dos Campos

Campo Tipo Descrição
tipoNotificacao integer Identifica o tipo da notificação (2 = Atualização do contrato)
contrato.identificador string GUID do contrato
contrato.status integer Status atual do contrato (ver StatusContrato)
contrato.erros string|null Mensagem de erro quando houver falha

🔢 StatusContrato

Código Significado
1 Ativo
2 Erro
3 Em Processamento
4 Baixa

📪 Exemplo de envio

O sistema enviará uma requisição POST para o endpoint informado pelo cliente com o seguinte corpo:

POST /webhook/duplicata-escritural HTTP/1.1
Content-Type: application/json
Authorization: Bearer {seu_token}

{
  "tipoNotificacao": 2,
  "contrato": {
    "identificador": "19710560-04CD-4E48-881D-D38350B39079",
    "status": 1,
    "erros": ""
  }
}

🕒 Observações

  • Esta notificação é assíncrona e pode ser enviada múltiplas vezes conforme o contrato evolui de status.
  • O campo contrato.identificador corresponde ao identificador retornado no momento da criação do contrato.
  • O campo contrato.erros será preenchido apenas quando status = 2 (Erro).