5.2. Detalhes do Contrato¶

🔗 Endpoint¶

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

🧾 Descrição¶

Consulta os detalhes de um contrato previamente criado com base na simulação de agenda de recebíveis. Retorna os dados do contrato, títulos envolvidos, informações de garantia ou fumaça (quando aplicável) e os totais financeiros.

📥 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"
    },
    "fumaca": {
      "valor": 5000.00,
      "dataInicial": "0000-00-00",
      "dataFinal": "0000-00-00",
      "percentualRetencaoUr": 100.00
    }
  },
  "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": {
        "cnpj": "",
        "nome": ""
      },
      "arranjo": {
        "sigla": "",
        "nome": ""
      },
      "dataPrevistaLiquidacao": "",
      "status": 1,
      "valorNominal": 0.00,
      "valorGarantido": 0.00,
      "valorDesconto": 0.00,
      "valorAquisicao": 0.00
    }
  ]
}

🧾 Detalhamento dos Campos¶

🔹 contrato¶

Campo	Tipo	Descrição
identificadorInteroperabilidade	string[]	ID único compartilhado entre registradoras
dataAssinatura	string	Data de assinatura do contrato (YYYY-MM-DD)
dataVencimento	string	Data final do contrato ou última parcela
cnpj	string	CNPJ do estabelecimento comercial
status	string	Status do contrato
tipoContrato	integer	Tipo de contrato: 1 = Troca titularidade, 2 = Garantia, 3 = Fumaça

🔢 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

🔸 parcela (quando tipoContrato = 2)¶

Campo	Tipo	Descrição
numero	int	Número da parcela
total	int	Total de parcelas
valor	number	Valor da parcela
data	string	Data de vencimento (YYYY-MM-DD)

🔸 fumaca (quando tipoContrato = 3)¶

Campo	Tipo	Descrição
valor	number	Valor desejado na operação
dataInicial	string	Data inicial de URs (YYYY-MM-DD)
dataFinal	string	Data final de URs (YYYY-MM-DD)
percentualRetencaoUr	number	Percentual de retenção da UR (ex: 100.00)

🔹 totais¶

Campo	Tipo	Descrição
taxa	number	Valor individual da taxa utilizada na antecipação
nominal	number	Valor total nominal das URs do contrato
desconto	number	Soma dos deságios aplicados
aquisicao	number	Valor líquido a ser recebido
CET	number	Custo Efetivo Total da operação

🔹 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 (ex: MCC, VCC)
arranjo.nome	string	Nome do arranjo (ex: Mastercard Cartão Crédito)
dataPrevistaLiquidacao	string	Data prevista de recebimento
status	int	Status da UR no contrato
valorNominal	number	Valor bruto
valorDesconto	number	Valor do deságio
valorAquisicao	number	Valor líquido 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 dos títulos pode ser usado para identificar títulos liquidados, cancelados, ativos etc.
A estrutura dos campos parcela e fumaca depende do tipo de contrato.