Ir para o conteúdo

4.2. Detalhes da Agenda

🔗 Endpoint

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

🧾 Descrição

Retorna os detalhes completos de uma agenda solicitada, incluindo os filtros originais da simulação e a relação de títulos (URs) retornados pela registradora. Este endpoint é utilizado para acompanhar o resultado da consulta de agenda iniciada no endpoint Solicitar agenda.

📥 Response

✅ 200 OK

{
  "identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
  "simulacao": {
    "cnpj": "",
    "tags": [""],
    "arranjos": [""],
    "credenciadoras": [""],
    "dataInicial": "0000-00-00",
    "dataFinal": "0000-00-00",
    "statusAgenda": 1,
    "motivoFalha": ""
  },
  "titulos": [
    {
      "id": "7D121577-3C5A-494D-B052-291D9E100D0D",
      "credenciadora": {
        "cnpj": "",
        "nome": ""
      },
      "arranjo": {
        "sigla": "",
        "nome": ""
      },
      "dataPrevistaLiquidacao": "",
      "valorConstituido": 0.00,
      "valorLivre": 0.00,
      "valorGarantido": 0.00
    }
  ]
}

🧾 Detalhamento dos Campos

🔹 simulacao

Campo Tipo Descrição
cnpj string CNPJ do estabelecimento comercial utilizado na solicitação da agenda.
tags string[] Lista de tags associadas à solicitação original, para rastreabilidade.
arranjos string[] Lista de arranjos de pagamento filtrados na solicitação.
credenciadoras string[] Lista de credenciadoras consultadas.
dataInicial string Data inicial do intervalo da agenda consultada.
dataFinal string Data final do intervalo da agenda consultada.
statusAgenda integer Status atual do processamento da agenda.
motivoFalha string-null Descrição do motivo de falha (caso statusAgenda indique erro).

🔹 titulos

Campo Tipo Descrição
id string Identificador único (GUID) da Unidade Recebível (UR).
credenciadora.cnpj string CNPJ da credenciadora responsável pela UR.
credenciadora.nome string Nome da credenciadora.
arranjo.sigla string Sigla do arranjo de pagamento (ex.: MCC, VCC).
arranjo.nome string Nome do arranjo (ex.: Mastercard Crédito).
dataPrevistaLiquidacao string Data de liquidação prevista da UR.
valorConstituido number Valor constituído da UR, conforme registro da registradora.
valorLivre number Valor livre disponível da UR retornado pela registradora.
valorGarantido number Valor efetivamente comprometido/garantido dentro da plataforma.

🔢 Status da Agenda

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.1/cartao/agenda/534D8AAE-61E4-4264-9D15-715B9E1F1D51 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json"

🕒 Observações

  • As agendas podem ser consultadas apenas após a solicitação inicial via /api/v1.1/cartao/solicita-agenda.
  • Em caso de falha na consulta, o campo motivoFalha será preenchido com a descrição do erro retornado pela registradora.
  • Autenticação obrigatória via Authorization: Bearer {token}.