3.2. Atualizações 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 atualização no contrato — como mudanças no status das URs, valores totais atualizados ou cancelamentos.

Ela é útil para refletir o status final de URs processadas no contrato e atualizar os dados financeiros agregados.

📤 Payload Enviado¶

{
  "tipoNotificacao": 2,
  "contrato": {
    "identificador": "19710560-04CD-4E48-881D-D38350B39079",
    "identificadorInteroperabilidade": ["0DC43268-E05F-478E-931C-A43B8B3DD79B"],
    "status": 1
  },
  "totais": {
    "taxa": 0.00,
    "nominal": 0.00,
    "desconto": 0.00,
    "aquisicao": 0.00,
    "garantido": 0.00,
    "CET": 0.00
  },
  "titulos": [
    {
      "id": "7D121577-3C5A-494D-B052-291D9E100D0D",
      "credenciadora": "",
      "arranjo": "",
      "status": 1,
      "dataPrevistaLiquidacao": "",
      "valorNominal": 0.00,
      "valorGarantido": 0.00,
      "valorDesconto": 0.00,
      "valorAquisicao": 0.00
    }
  ]
}

🧾 Detalhamento dos Campos¶

🔹 contrato¶

Campo	Tipo	Descrição
identificador	string	GUID referente ao identificador do contrato
identificadorInteroperabilidade	string[]	GUID gerado no ambiente de interoperabilidade do contrato
status	number	Status do contrato

🔹 totais¶

Campo	Tipo	Descrição
taxa	number	Valor individual da taxa utilizada na antecipação
nominal	number	Soma dos valores nominais das URs vinculadas
desconto	number	Soma dos valores de deságio aplicados
aquisicao	number	Soma dos valores líquidos (valorNominal - valorDesconto)
CET	number	Custo Efetivo Total da operação

🔹 titulos¶

Campo	Tipo	Descrição
id	string	GUID da UR
credenciadora	string	CNPJ da credenciadora
arranjo	string	Sigla do arranjo (ex: MCC, VCC)
status	integer	Status atual da UR no contrato
dataPrevistaLiquidacao	string	Data prevista de liquidação
valorNominal	number	Valor bruto da UR
valorDesconto	number	Valor do deságio aplicado
valorAquisicao	number	Valor líquido resultante após o desconto

🔢 Status da UR¶

Código	Significado
0	Sucesso (UR vinculada corretamente ao contrato)
1	Falha no vínculo
2	Em processamento (status inicial)
3	Pendente extensão (EC sem vínculo com credenciadora)
999	UR cancelada

🔢 Status do contrato¶

Código	Significado	Aplicação
1	Aguardando registro	Contrato foi recebido na plataforma e estaremos encaminhando para registradora
2	Registrando	Contrato oficializado na registradora e aguardando retorno do registro
3	Falha no registro	Contrato obteve erro na formalização no regime de interoperabilidade
4	Aguardando liquidação	Contrato registrado e entrou para o fluxo de apenas aguardar liquidações
5	Cancelado	Contrato oficialmente cancelado no regime de interoperabilidade
6	Em liquidação	Contrato obteve sua primeira liquidação de uma UR vinculada
7	Liquidado	Contrato obteve liquidações de todas as suas URs vinculadas
8	Em cancelamento	Solicitação de cancelamento recebida na plataforma e será encaminhado para registradora
9	Falha no cancelamento	Não foi possível cancelar o contrato no regime de interoperabilidade

📪 Exemplo de envio¶

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

{
  "tipoNotificacao": 2,
  "contrato": {
    "identificador": "19710560-04CD-4E48-881D-D38350B39079",
    "identificadorInteroperabilidade": ["0DC43268-E05F-478E-931C-A43B8B3DD79B"],
    "status": 4
  },
  "totais": {
    "taxa": 2.50,
    "nominal": 50000.00,
    "desconto": 1500.00,
    "aquisicao": 48500.00,
    "garantido": 50000.00,
    "CET": 1.25
  },
  "titulos": [
    {
      "id": "7D121577-3C5A-494D-B052-291D9E100D0D",
      "credenciadora": "11223344000155",
      "arranjo": "MCC",
      "status": 0,
      "dataPrevistaLiquidacao": "2025-08-10",
      "valorNominal": 1000.00,
      "valorGarantido": 1000.00,
      "valorDesconto": 50.00,
      "valorAquisicao": 950.00
    }
  ]
}

🕒 Observações¶

Essa notificação pode ser enviada várias vezes durante a evolução do contrato.
Os status ajudam o cliente a identificar falhas ou pendências operacionais por UR.