Ir para o conteúdo

4.3. Detalhes da Simulação

🔗 Endpoint

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

🧾 Descrição

Recupera os detalhes completos de uma simulação previamente criada, incluindo os filtros utilizados, os títulos disponíveis, os títulos selecionados e os totais financeiros da operação simulada.


📥 Response

✅ 200 OK

{
  "identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
  "simulacao": {
    "cnpj": "",
    "tags": [""],
    "arranjos": [""],
    "credenciadoras": [""],
    "dataInicial": "0000-00-00",
    "dataFinal": "0000-00-00",
    "taxa": 0.00,
    "valorDesejado": {
      "valor": 0.00,
      "ordem": "ASC"
    },
    "statusAgenda": 1,
    "motivoFalha": ""
  },
  "totais": {
    "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": "",
      "valorNominal": 0.00,
      "valorGarantido": 0.00,
      "valorDesconto": 0.00,
      "valorAquisicao": 0.00,
      "selecionado": false
    }
  ]
}

🧾 Detalhamento dos Campos

🔹 simulacao

Campo Tipo Descrição
cnpj string CNPJ do estabelecimento comercial
tags string[] Lista de tags atribuídas na simulação para identificação
arranjos string[] Lista de arranjos utilizados na simulação
credenciadoras string[] Lista de CNPJs das credenciadoras utilizadas
dataInicial string Data inicial da consulta
dataFinal string Data final da consulta
taxa number Taxa (deságio) aplicada
valorDesejado objeto Informações sobre o valor solicitado
→ valor number Valor desejado para a operação
→ ordem string Ordem de priorização das URs (ASC ou DESC)
statusAgenda integer Status da agenda da simulação
motivoFalha string-null Motivo da falha da agenda

🔹 totais (baseados nas URs selecionadas)

Campo Tipo Descrição
nominal number Soma dos valores nominais das URs selecionadas
desconto number Soma dos valores de desconto aplicados (baseados na taxa)
aquisicao number Valor total a ser recebido após o deságio (nominal - desconto)
garantido number Valor total a ser utilizado das URs (podendo pegar valor parcial das URs)
CET number Custo Efetivo Total da simulaçã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 de recebimento da UR
valorNominal number Valor original da UR
valorGarantido number Valor utilizado da UR (podendo pegar valor parcial da UR)
valorDesconto number Valor de deságio aplicado conforme taxa
valorAquisicao number Valor líquido após deságio
selecionado boolean Indica se a UR foi usada na simulação (por valor ou seleção manual)

🔢 Status das agendas

Código Significado
1 Agenda disponível
2 Agenda vazia
3 Agenda com promessa de cessão
4 Agenda ultrapassou tempo de publicação
5 Agenda com falha
---

🧪 Exemplo de cURL

curl -X GET https://api.veflow.com/api/v1/cartao/simulacao/534D8AAE-61E4-4264-9D15-715B9E1F1D51 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json"

🕒 Observações

  • Os totais da simulação refletem apenas as URs selecionadas (manualmente ou por valor desejado).
  • URs não selecionadas continuam disponíveis para uso em outras simulações.