4.7. Remover UR da simulação¶
🔗 Endpoint¶
| Método | URL |
|---|---|
/api/v1.1/cartao/agenda/{identificador}/simulacoes/{idSimulacao}/remove-ur |
🧾 Descrição¶
Remove uma ou mais URs previamente vinculadas a uma simulação/contrato (carrinho) dentro do contexto da agenda especificada. Ao remover o(s) título(s), os valores correspondentes são liberados e disponibilizados novamente como valorLivre na UR, permitindo nova alocação.
Validações importantes:
- Cada
idTituloinformado deve estar vinculado àidSimulacaoinformada; caso contrário, a operação será recusada com erro. - Operação idempotente: tentar remover novamente um título já removido deve resultar em resposta indicando que o título não foi encontrado no contexto da simulação (400) ou simplesmente ignorado (dependendo da política).
📤 Requisição¶
📋 Payload (JSON)¶
{
"idTitulos": []
}
🧾 Detalhamento dos Campos¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| idTitulos | string[] | Sim | Lista de GUIDs das URs a serem removidas do carrinho/simulação. Cada GUID deve estar vinculado à simulação idSimulacao. |
Regras de validação
idTitulosnão pode ser vazio.- Todos os
idTitulosdevem pertencer à simulaçãoidSimulacaono contexto daagenda{identificador}. - Caso um ou mais títulos não pertençam à simulação, a API deverá retornar 400 Bad Request com detalhes dos IDs inválidos.
🧪 Exemplo de cURL¶
curl -X DELETE "https://api.veflow.com/api/v1.1/cartao/agenda/534D8AAE-61E4-4264-9D15-715B9E1F1D51/simulacoes/AEB4EA8C-BEF4-4E4E-A009-0A94AF172EAB/remove-ur" \
-H "Authorization: Bearer {seu_token}" \
-H "Content-Type: application/json" \
-d '{
"idTitulos": [
"7D121577-3C5A-494D-B052-291D9E100D0D"
]
}'
📥 Responses¶
✅ 200 OK¶
{
"mensagem": "Título(s) removido(s) do carrinho e valores liberados."
}
Indica que os títulos foram removidos do carrinho/simulação e os valores correspondentes foram liberados como valorLivre nas URs.
❌ 400 Bad Request (exemplo — títulos não vinculados)¶
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"titulo": "Atenção",
"status": 400,
"erros": [
"UR 'A1B2C3D4-5E6F-7890-1234-56789ABCDEF0' não está vinculada à simulação '987'."
]
}
❌ 404 Not Found (exemplo — simulação ou agenda não encontrada)¶
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"titulo": "Não encontrado",
"status": 404,
"erros": [
"Agenda '534D8AAE-61E4-4264-9D15-715B9E1F1D51' ou simulação '987' não encontrada."
]
}
🕒 Observações¶
- Após remoção, a plataforma atualiza os saldos (
valorLivreevalorGarantido) das URs afetadas. - Remoções podem desencadear reprocessamento de regras de composição da simulação (por exemplo: preencher lacunas com outras URs disponíveis). Esse processamento pode ser assíncrono.
- Autenticação obrigatória via
Authorization: Bearer {token}.