Ir para o conteúdo

3.3. Atualizações das URs

🔔 Tipo de Notificação

Campo Valor
tipoNotificacao 3

🧾 Descrição

Esta notificação será enviada via POST sempre que a plataforma concluir o processo de conciliação bancária das URs de um contrato. A notificação traz a posição atualizada das URs, baseada no que foi creditado em conta comparado ao que estava registrado no contrato.

É especialmente útil para contratos do tipo fumaça ou em situações de chargeback, liquidação parcial ou ajustes automáticos.


📤 Payload Enviado

{
  "tipoNotificacao": 3,
  "contrato": {
    "identificador": "19710560-04CD-4E48-881D-D38350B39079",
    "identificadorInteroperabilidade": ["0DC43268-E05F-478E-931C-A43B8B3DD79B"],
    "status": 4
  },
  "titulos": [
    {
      "id": "7D121577-3C5A-494D-B052-291D9E100D0D",
      "credenciadora": "",
      "arranjo": "",
      "evento": 1,
      "dataPrevistaLiquidacao": "",
      "valor": 0.00,
      "valorChargeback": 0.00,
      "valorLiquidado": 0.00
    }
  ]
}

🧾 Detalhamento dos Campos

Campo Tipo Descrição
tipoNotificacao integer Tipo 3 = Atualização por conciliação
contrato.identificador string GUID referente ao identificador do contrato
contrato.identificadorInteroperabilidade string[] GUID gerado no ambiente de interoperabilidade do contrato
contrato.status number Status do contrato
titulos[].id string GUID da UR
titulos[].credenciadora string CNPJ da credenciadora
titulos[].arranjo string Sigla do arranjo (ex: MCC, VCC)
titulos[].evento integer Último evento detectado na conciliação (ver tabela abaixo)
titulos[].dataPrevistaLiquidacao string Data da UR
titulos[].valor number Valor atual da UR após conciliação
titulos[].valorChargeback number Valor de diferença detectado na conciliação
titulos[].valorLiquidado number Valor efetivamente creditado, preenchido nos eventos 3 e 4

🔢 Eventos de Conciliação

Código Significado
1 Valor da UR aumentou
2 Valor da UR reduziu (chargeback ou ajuste)
3 UR liquidada parcialmente ou não liquidada
4 UR liquidada completamente
5 Prioridade na liquidação da UR reduziu
6 Prioridade na liquidação da UR aumentou

Os eventos 3 e 4 somente são disparados quando a plataforma possui os dados de crédito bancário (liquidação).

🔢 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": 3,
  "contrato": {
    "identificador": "19710560-04CD-4E48-881D-D38350B39079",
    "identificadorInteroperabilidade": ["0DC43268-E05F-478E-931C-A43B8B3DD79B"],
    "status": 4
  },
  "titulos": [
    {
      "id": "7D121577-3C5A-494D-B052-291D9E100D0D",
      "credenciadora": "11223344000155",
      "arranjo": "MCC",
      "evento": 4,
      "dataPrevistaLiquidacao": "2025-08-10",
      "valor": 1000.00,
      "valorChargeback": 0.00,
      "valorLiquidado": 1000.00
    }
  ]
}

🕒 Observações

  • Esta notificação representa o status final conciliado da UR.
  • Pode ser enviada mais de uma vez, sempre refletindo a última posição da UR.
  • Os campos valorChargeback e valorLiquidado são essenciais para auditoria e controle.