Ir para o conteúdo

4.2. Vincular URs ou Valor da Simulação

🔗 Endpoint

Método URL
POST /api/v1/cartao/simulacao/{identificador}/vinculo

🧾 Descrição

Permite ao usuário especificar a simulação por valor desejado ou selecionar manualmente as URs a serem vinculadas à simulação de antecipação.

Com base no tipoVinculo, a plataforma vinculará as URs automaticamente até atingir o valor informado ou usará os identificadores de títulos fornecidos.


📤 Requisição

📋 Payload (JSON)

✅ Vincular por valor

{
  "tipoVinculo": 1,
  "valor": 30000.00,
  "ordem": "ASC"
}

✅ Vincular por URs

{
  "tipoVinculo": 2,
  "idTitulos": ["29E8F0CE-3391-4A65-8091-2331802CEABE"]
}

🧾 Detalhamento dos Campos

Campo Tipo Obrigatório Descrição
tipoVinculo integer Sim Define a forma de vinculação: 1 para valor, 2 para UR específica
valor number Condicional Valor total a ser simulado (obrigatório se tipoVinculo = 1)
ordem string Opcional Ordem de seleção das URs: ASC (padrão) ou DESC (usado com tipoVinculo = 1)
idTitulos string[] Condicional Lista de GUIDs das URs a serem vinculadas (obrigatório se tipoVinculo = 2)

🧪 Exemplo de cURL

▶ Vincular por valor

curl -X POST https://api.veflow.com/api/v1/cartao/simulacao/534D8AAE-61E4-4264-9D15-715B9E1F1D51/vinculo \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "tipoVinculo": 1,
    "valor": 30000.00,
    "ordem": "ASC"
  }'

▶ Vincular por UR

curl -X POST https://api.veflow.com/api/v1/cartao/simulacao/534D8AAE-61E4-4264-9D15-715B9E1F1D51/vinculo \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "tipoVinculo": 2,
    "idTitulos": ["29E8F0CE-3391-4A65-8091-2331802CEABE"]
  }'

📥 Responses

✅ 200 OK

{
  "identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
  "mensagem": "URs vinculadas na simulação!"
}
Indica que as URs foram vinculadas com sucesso à simulação.


❌ 400 Bad Request (exemplo)

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Campo 'valor' é obrigatório quando tipoVinculo = 1.",
    "Campo 'idTitulos' é obrigatório quando tipoVinculo = 2."
  ]
}

🕒 Observações

  • URs não utilizadas na simulação continuam disponíveis para outras simulações ou vínculos.