5.2. Detalhes do Contrato¶

🔗 Endpoint¶

Método	URL
	`/api/v1/cartao/contrato/{identificador}`

🧾 Descrição¶

Consulta os detalhes completos de um contrato previamente criado com base em uma simulação de agenda de recebíveis. O retorno inclui informações contratuais, totais financeiros e a lista de URs (títulos) vinculadas, com seus valores de constituição, garantia e liquidez.

📥 Response¶

✅ 200 OK¶

{
  "identificador": "5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6",
  "contrato": {
    "identificadorInteroperabilidade": ["5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6"],
    "dataAssinatura": "0000-00-00",
    "dataVencimento": "0000-00-00",
    "cnpj": "",
    "tipoContrato": 1,
    "status": 1,
    "parcela": {
      "numero": 1,
      "total": 10,
      "valor": 5000.00,
      "data": "0000-00-00"
    }
  },
  "totais": {
    "taxa": 0.00,
    "constituido": 0.00,
    "livre": 0.00,
    "desconto": 0.00,
    "garantido": 0.00
  },
  "titulos": [
    {
      "id": "7D121577-3C5A-494D-B052-291D9E100D0D",
      "credenciadora": {
        "cnpj": "",
        "nome": ""
      },
      "arranjo": {
        "sigla": "",
        "nome": ""
      },
      "dataPrevistaLiquidacao": "",
      "status": 1,
      "valorConstituido": 0.00,
      "valorLivre": 0.00,
      "valorGarantido": 0.00,
      "valorDesconto": 0.00,
      "valorAquisicao": 0.00
    }
  ]
}

🧾 Detalhamento dos Campos¶

🔹 contrato¶

Campo	Tipo	Descrição
identificadorInteroperabilidade	string[]	Identificador único compartilhado entre registradoras.
dataAssinatura	string	Data de assinatura do contrato (`YYYY-MM-DD`).
dataVencimento	string	Data de vencimento final do contrato.
cnpj	string	CNPJ do estabelecimento comercial.
tipoContrato	integer	Tipo de contrato: `1` = Troca de titularidade, `2` = Garantia, `3` = Fumaça.
status	integer	Código do status atual do contrato (ver tabela abaixo).
parcela.numero	integer	Número da parcela vinculada.
parcela.total	integer	Total de parcelas do contrato.
parcela.valor	number	Valor da parcela.
parcela.data	string	Data de vencimento da parcela (`YYYY-MM-DD`).

🔢 Status do Contrato¶

Código	Descrição
1	Aguardando registro
2	Registrando
3	Falha no registro
4	Aguardando liquidação
5	Cancelado
6	Em liquidação
7	Liquidado
8	Em cancelamento
9	Falha no cancelamento

🔹 totais¶

Campo	Tipo	Descrição
taxa	number	Taxa aplicada à operação.
constituido	number	Valor total constituído das URs vinculadas.
livre	number	Valor total livre (não comprometido).
desconto	number	Soma dos valores de deságio aplicados.
garantido	number	Valor total utilizado das URs como garantia.

🔹 titulos¶

Campo	Tipo	Descrição
id	string	GUID da UR.
credenciadora.cnpj	string	CNPJ da credenciadora.
credenciadora.nome	string	Nome da credenciadora.
arranjo.sigla	string	Sigla do arranjo de pagamento (ex.: MCC, VCC).
arranjo.nome	string	Nome completo do arranjo (ex.: Mastercard Crédito).
dataPrevistaLiquidacao	string	Data prevista de liquidação da UR (`YYYY-MM-DD`).
status	integer	Status da UR dentro do contrato.
valorConstituido	number	Valor constituído da UR na registradora.
valorLivre	number	Valor livre disponível da UR.
valorGarantido	number	Valor comprometido da UR dentro do contrato.
valorDesconto	number	Valor do deságio aplicado.
valorAquisicao	number	Valor líquido final da UR após desconto.

🧪 Exemplo de cURL¶

curl -X GET https://api.veflow.com/api/v1/cartao/contrato/5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json"

🕒 Observações¶

O campo status indica o estágio do contrato no ciclo de interoperabilidade com as registradoras.
Após liquidação total (status = 7), os títulos são considerados encerrados e não podem ser reatribuídos.
Os valores em totais refletem sempre o estado mais recente do contrato e podem ser atualizados conforme liquidações parciais.
URs canceladas ou liquidadas permanecem listadas apenas para fins de auditoria.
Autenticação obrigatória