Ir para o conteúdo

4.10. Lista de URs da Simulação

🔗 Endpoint

Método URL
GET /api/v1.1/cartao/agenda/{identificador}/simulacoes/{idSimulacao}/titulos

🧾 Descrição

Retorna a lista de URs (Unidades Recebíveis) vinculadas a uma simulação específica dentro de uma agenda. Cada registro representa uma UR selecionada, utilizada ou vinculada durante o processo de composição da simulação.

📥 Response

✅ 200 OK

{
  "registros": [
    {
      "guid": "",
      "credenciadora": {
        "cnpj": "",
        "nome": ""
      },
      "arranjo": {
        "sigla": "",
        "nome": ""
      },
      "dataLiquidacao": "2025-04-15",
      "valorConstituido": 1.00,
      "valorLivre": 1.00,
      "valorGarantido": 1.00,
      "tipoValor": 1
    }
  ],
  "paginacao": {
    "paginaAtual": 1,
    "paginaTotal": 0,
    "paginaQuantidadeRegistro": 20,
    "quantidadeRegistros": 0,
    "temPaginaAnterior": false,
    "temProximaPagina": false
  },
  "mensagem": null
}

🧾 Detalhamento dos Campos

🔹 registros

Campo Tipo Descrição
guid string Identificador único (GUID) da UR vinculada à simulação.
credenciadora.cnpj string CNPJ da credenciadora responsável pela UR.
credenciadora.nome string Nome da credenciadora associada.
arranjo.sigla string Sigla do arranjo de pagamento associado à UR (ex.: MCC, VCC, ELO).
arranjo.nome string Nome completo do arranjo de pagamento (ex.: Mastercard Crédito).
dataLiquidacao string Data de liquidação prevista ou realizada da UR (YYYY-MM-DD).
valorConstituido number Valor total constituído da UR na registradora.
valorLivre number Valor livre disponível da UR (não comprometido).
valorGarantido number Valor efetivamente utilizado como garantia na simulação.
tipoValor integer Tipo do valor da UR (ex.: 1 = valor fixo, 2 = percentual).

🔹 paginacao

Campo Tipo Descrição
paginaAtual integer Página atual do retorno.
paginaTotal integer Total de páginas disponíveis.
paginaQuantidadeRegistro integer Quantidade máxima de registros por página.
quantidadeRegistros integer Total de registros encontrados.
temPaginaAnterior boolean Indica se há página anterior.
temProximaPagina boolean Indica se há próxima página.

🔹 mensagem

Campo Tipo Descrição
mensagem string/null Mensagem informativa opcional retornada pela API (geralmente null em casos de sucesso).

🧪 Exemplo de cURL

curl -X GET https://api.veflow.com/api/v1.1/cartao/agenda/534D8AAE-61E4-4264-9D15-715B9E1F1D51/simulacoes/AEB4EA8C-BEF4-4E4E-A009-0A94AF172EAB/titulos \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json"

🕒 Observações

  • O endpoint é paginado — utilize parâmetros de paginação padrão (?pagina=1&quantidade=20) se o volume de registros for grande.
  • URs retornadas incluem tanto as performadas quanto as futuras, conforme o escopo da simulação.
  • O campo tipoValor deve ser interpretado conforme enum interno definido pela aplicação.
  • Autenticação obrigatória via Authorization: Bearer {token}.
  • O campo mensagem pode conter alertas de consistência (ex.: UR sem valor garantido) dependendo da política de retorno da API.