Ir para o conteúdo

3.1. Criar Contrato

🔗 Endpoint

Método URL
POST /public/api/v1/duplicata-escritural/contratos

🧾 Descrição

Cria um novo contrato de duplicata escritural com base em uma simulação previamente realizada. O contrato pode ser processado de forma síncrona (200 OK) ou assíncrona (202 Accepted), dependendo do volume e das condições de processamento.


📤 Requisição

📋 Payload (JSON)

{
  "identificadorSimulacao": "534D8AAE-61E4-4264-9D15-715B9E1F1D51"
}

🧾 Detalhamento dos Campos

Campo Tipo Obrigatório Descrição
identificadorSimulacao string Sim GUID da simulação previamente criada

🧪 Exemplo de cURL

curl -X POST https://api.vehub.com.br/public/api/v1/duplicata-escritural/contratos \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{
    "identificadorSimulacao": "534D8AAE-61E4-4264-9D15-715B9E1F1D51"
  }'

📥 Responses

✅ 200 OK

{
  "mensagem": "Contrato criado com sucesso!",
  "identificador": "5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6",
  "identificadorProcessamento": null
}

✅ 202 Accepted

{
  "mensagem": "Contrato recebido e será processado em breve.",
  "identificadorProcessamento": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890"
}

❌ 400 Bad Request

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Simulação não encontrada ou já utilizada."
  ]
}

🧾 Detalhamento dos Campos da Resposta

🔹 200 OK / 202 Accepted

Campo Tipo Descrição
mensagem string Mensagem descritiva do resultado
identificador string GUID do contrato criado (apenas no 200)
identificadorProcessamento string GUID do processamento assíncrono (apenas no 202)

🕒 Observações

  • O campo identificadorSimulacao deve referenciar uma simulação válida e ainda não contratada.
  • Quando o retorno for 202 Accepted, o contrato será processado de forma assíncrona e o resultado será notificado via WebHook.
  • O identificador retornado no 200 OK é o identificador do contrato criado.