---
title: 4.1. Solicitar agenda
url: https://docs.vehub.com.br/API/VeFlow%20-%20Cart%C3%A3o%20de%20cr%C3%A9dito/4.%20Agenda%20de%20receb%C3%ADveis/v1.1/4.1.%20Solicitar%20agenda/
---
# 4.1. Solicitar agenda

## 🔗 Endpoint

| Método                                          | URL                                |
| ----------------------------------------------- | ---------------------------------- |
| ![POST](https://img.shields.io/badge/POST-blue) | `/api/v1.1/cartao/solicita-agenda` |

---

## 🧾 Descrição

Recebe uma solicitação para buscar/agendar agenda de recebíveis de cartão (consulta de URs/agendas) com base nos filtros informados.
Ao receber a requisição, VeFlow registrará o OPT-IN do EC (quando aplicável) e iniciará a consulta das agendas conforme os filtros.

---

## 📤 Requisição

### 📋 Payload (JSON)

```json
{
  "idOperacao": 0,
  "tags": [""],
  "cnpj": "",
  "arranjos": [""],
  "credenciadoras": [""],
  "dataInicial": "0000-00-00",
  "dataFinal": "0000-00-00"
}
```

### 🧾 Detalhamento dos Campos

| Campo          | Tipo     | Obrigatório | Descrição                                                                                                             |
| -------------- | -------- | ----------- | --------------------------------------------------------------------------------------------------------------------- |
| idOperacao     | number   | Sim         | ID da operação atrelada (valor definido pelo time de implantação).                                                    |
| tags           | string[] | Não         | Lista de tags/identificadores para facilitar rastreabilidade da simulação (p.ex. `["PA_01"]`).                        |
| cnpj           | string   | Sim         | CNPJ do estabelecimento comercial (somente números, sem formatação).                                                  |
| arranjos       | string[] | Não         | Lista de arranjos de pagamento (ex.: `"MCC"`, `"VCC"`). Se omitido, serão considerados todos os arranjos.             |
| credenciadoras | string[] | Não         | Lista de CNPJs das credenciadoras (somente números). Se omitido, busca em todas as credenciadoras disponíveis.        |
| dataInicial    | string   | Sim         | Data inicial para consulta no formato `YYYY-MM-DD`. Deve ser, preferencialmente, D+2 da data atual (recomendado D+5). |
| dataFinal      | string   | Sim         | Data final para consulta no formato `YYYY-MM-DD`. Deve ser maior ou igual a `dataInicial`.                            |

**Regras e formatos**

* Datas: `YYYY-MM-DD`
* `cnpj`: somente dígitos (ex.: `12345678000199`)
* `dataInicial` deve ser >= D+2 (ou conforme regra operacional do cliente)

---

## 🧪 Exemplo de cURL

```bash
curl -X POST https://api.veflow.com/api/v1.1/cartao/solicita-agenda \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "idOperacao": 1,
    "cnpj": "12345678000199",
    "tags": ["PA_01"],
    "arranjos": ["MCC","VCC"],
    "credenciadoras": ["10293847560102"],
    "dataInicial": "2025-08-09",
    "dataFinal": "2025-08-15"
  }'
```

---

## 📥 Responses

### ✅ 200 OK

```json
{
  "identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
  "mensagem": "Solicitação de agenda recebida com sucesso!"
}
```

Indica que a solicitação foi validada e será processada (início do fluxo de OPT-IN e consulta de agendas).

---

### ✅ 201 Fora da janela de operação

```json
{
  "identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
  "mensagem": "Solicitação recebida e agendada para processamento no próximo dia útil."
}
```

Retornado quando a requisição é feita fora da janela operacional definida (ver observações).

---

### ❌ 400 Bad Request (exemplo)

```json
{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Campo 'cnpj' é obrigatório.",
    "Campo 'dataInicial' inválido. Formato esperado: YYYY-MM-DD.",
    "dataInicial deve ser no mínimo D+2."
  ]
}
```

---

## 🕒 Observações

* Requisições são processadas **apenas entre 09:00 e 18:00 (horário comercial)** em dias úteis (janela de operação). Requisições fora dessa janela serão retornadas com `201` e agendadas para o próximo dia útil.
* `dataInicial` recomendada: D+5; mínimo permitido: D+2 (validação server-side).
* URs/agendas não vinculadas por este endpoint permanecem disponíveis para futuras simulações/vinculações.
* Authenticate via `Authorization: Bearer {token}` em todas as chamadas.
* Em caso de filtros que retornem grande volume, o processo pode ser assíncrono (o retorno inicial confirma recebimento e identifica o `identificador` para acompanhamento).