4.7. Refazer consulta¶
🔗 Endpoint¶
| Método | URL |
|---|---|
/public/api/v1.1/cartao/agendas/{idAgenda}/refazer |
🧾 Descrição¶
Refaz a consulta de uma agenda já existente junto às registradoras, reaproveitando os filtros da solicitação original (CNPJ do EC, arranjos, credenciadoras e intervalo de datas).
Use quando a agenda passou da dataValidade: os valores de UR — valorConstituido, valorComprometido, valorLivre — deixaram de refletir o que está registrado, e os itens de carrinho montados sobre ela foram invalidados. Refazer atualiza a mesma agenda com os dados novos, sem precisar criar outra.
O processamento é assíncrono: a resposta confirma o recebimento e devolve o identificadorProcessamento para acompanhamento.
📤 Requisição¶
🧭 Parâmetros de rota¶
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| idAgenda | string | Sim | GUID da agenda, devolvido em 4.1. Solicitar agenda. |
📋 Payload (JSON)¶
Não há corpo de requisição. Envie a chamada sem payload — os filtros vêm da solicitação original da agenda.
🧪 Exemplo de cURL¶
curl -X POST https://api.veflow.com/public/api/v1.1/cartao/agendas/534D8AAE-61E4-4264-9D15-715B9E1F1D51/refazer \
-H "Authorization: Bearer {seu_token}" \
-H "GrupoEconomico: {seu_grupo_economico}" \
-H "Idempotency-Key: 3b81f0c4-2a55-4e19-8d77-9c0ab2f6e514" \
-H "Content-Type: application/json"
📥 Responses¶
✅ 202 Accepted¶
{
"identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
"identificadorProcessamento": "B7E4D2A1-8888-4444-9999-1122334455AA",
"mensagem": "Nova consulta da agenda recebida com sucesso!"
}
| Campo | Tipo | Descrição |
|---|---|---|
| identificador | string | GUID da agenda — o mesmo da agenda refeita. A agenda não muda de identificador. |
| identificadorProcessamento | string | GUID do novo processamento assíncrono, para acompanhamento. |
| mensagem | string | Mensagem de confirmação. |
✅ 202 Accepted — fora da janela de operação¶
{
"identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
"identificadorProcessamento": "B7E4D2A1-8888-4444-9999-1122334455AA",
"dataAgendamento": "2025-09-08",
"mensagem": "Solicitação recebida e agendada para processamento no próximo dia útil."
}
Retornado quando a requisição chega fora da janela operacional. O campo dataAgendamento informa o dia útil em que a consulta será processada.
❌ 400 Bad Request¶
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"titulo": "Atenção",
"status": 400,
"erros": [
"O intervalo de datas da agenda original não atende à regra mínima de D+2. Solicite uma nova agenda."
]
}
Como os filtros são reaproveitados, uma agenda antiga pode ter dataInicial que já não respeita o mínimo de D+2 da data atual. Nesse caso a consulta não é refeita: solicite uma nova agenda em 4.1. Solicitar agenda, com novo intervalo de datas.
❌ 404 Not Found¶
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"titulo": "Não encontrado",
"status": 404,
"erros": [
"Agenda '534D8AAE-61E4-4264-9D15-715B9E1F1D51' não encontrada."
]
}
🕒 Observações¶
- Requisições são processadas apenas entre 09:00 e 18:00 em dias úteis (janela de operação). Fora dessa janela, a resposta é
202comdataAgendamentopara o próximo dia útil. - A agenda mantém o mesmo
identificador: todas as rotas da seção 4 continuam valendo, e a novadataValidadeaparece em 4.3. Detalhes da agenda. - Refazer a consulta substitui as URs da agenda pelos dados novos das registradoras. URs que deixaram de existir saem da listagem; valores comprometidos por terceiros podem ter mudado — confira em 4.5. Detalhes da UR.
- Itens de carrinho montados sobre a agenda vencida não são migrados: remonte o carrinho depois que a nova consulta terminar — ver 4.8. Consultar carrinho.
- A conclusão é notificada por webhook — ver 3.1. Listagem de URs.
- Envie sempre
Idempotency-Key: reenvios com a mesma chave não disparam consultas duplicadas na registradora. - Headers obrigatórios e convenções gerais: 1.2. Convenções da API.