5.1. Criar Contrato¶
🔗 Endpoint¶
| Método | URL |
|---|---|
/api/v1/cartao/contrato |
🧾 Descrição¶
Cria um novo contrato de operação com base em uma simulação previamente realizada.
O contrato pode ser do tipo:
- 1: Troca de titularidade (antecipação ou mudança de beneficiário)
- 2: Garantia com parcela (ônus/cessão fiduciária)
- 3: Fumaça (retenção de URs futuras por valor)
📤 Requisição¶
📋 Payloads (JSON)¶
🔹 Tipo 1 – Troca de Titularidade / Antecipação¶
{
"identificadorSimulacao": "GUID",
"tipoContrato": 1
}
🔹 Tipo 2 – Garantia (Em implantação)¶
{
"identificadorSimulacao": "GUID",
"tipoContrato": 2
}
🔹 Tipo 3 – Fumaça (Em implantação)¶
{
"identificadorSimulacao": "GUID",
"tipoContrato": 3
}
🧾 Detalhamento dos Campos¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| identificadorSimulacao | string | Sim | GUID da simulação já realizada |
| tipoContrato | integer | Sim | Tipo do contrato (1 = Troca titularidade, 2 = Garantia, 3 = Fumaça) |
🧪 Exemplo de cURL¶
curl -X POST https://api.veflow.com/api/v1/cartao/contrato \
-H "Authorization: Bearer {seu_token}" \
-H "Content-Type: application/json" \
-d '{
"identificadorSimulacao": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
"tipoContrato": 1
}'
📥 Response¶
✅ 200 OK¶
{
"identificador": "5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6",
"mensagem": "Contrato enviado e aguardando retorno da registradora!"
}
🕒 Observações¶
- Após a criação do contrato, o identificador retornado é do contrato.
- O campo
tipoContratodefine a estrutura esperada do payload. - A plataforma valida os horários de operação. Requisições fora da janela operacional (9h às 18h) serão recusadas.