4.1. Criar simulação¶

🔗 URL¶

Método	URL
	`/api/v1/cartao/simulacao`

🧾 Descrição¶

Recebe uma solicitação de simulação de agenda de recebíveis de cartão. Após o recebimento, o VeFlow registra o OPT-IN do EC e, após autorização, consulta as agendas conforme os filtros informados.

📤 Requisição¶

📋 Payload (JSON)¶

{
  "idOperacao": 0,
  "tags": [""],
  "cnpj": "",
  "nome": "",
  "arranjos": [""],
  "credenciadoras": [""],
  "dataInicial": "0000-00-00",
  "dataFinal": "0000-00-00",
  "taxa": 0.0
}

Campo	Tipo	Obrigatório	Descrição
idOperacao	number	Sim	ID da operação atrelada, valor fixo informado pelo time de implantação.
cnpj	string	Sim	CNPJ do estabelecimento comercial, sem formatação.
nome	string	Não	Nome do estabelecimento comercial
tags	string[]	Não	Lista de string para identificar a simulação
arranjos	string[]	Não	Lista de arranjos de pagamento (ex: MCC, VCC). Se não informado, serão considerados todos.
credenciadoras	string[]	Não	Lista de CNPJs (sem formatação) das credenciadoras. Se não informado, busca todas.
dataInicial	string	Sim	Data inicial da consulta. Deve ser D+2 da data atual. Recomendado: D+5.
dataFinal	string	Sim	Data final da consulta. Deve ser maior ou igual à dataInicial.
taxa	number	Não	Taxa (deságio) com até 4 casas decimais. Necessária apenas para operações de antecipação.

🧪 Exemplo de cURL¶

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

📥 Responses¶

✅ 200 OK¶

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

Significa que o VeFlow recebeu a simulação e irá iniciar o processo de OPT-IN e consulta da agenda.

❌ 400 Bad Request (exemplo)¶

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

✅ 201 Fora da janela de operação¶

{
  "identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
  "mensagem": "Solicitação de simulação recebida com sucesso e será processada no próximo dia útil!"
}

🕒 Observações¶

Requisições são processadas apenas entre 09h e 18h em dias úteis (janela de operação).
Requisições realizadas fora da janela de operação são agendadas para processamento no próximo dia útil.
O campo taxa deve ser informado apenas para antecipações, caso contrário o valor de aquisição será igual ao valor nominal da UR.
O nome do estabelecimento comercial será utilizado para efetuar a conciliação dos recebíveis quando o CNPJ do ponto de venda informado no arquivo do SLC não for o originário da UR