5.2. Fluxo Regular e Irregular¶
Especificação — em construção
Os serviços descritos nesta área ainda não estão disponíveis.
Esta página explica como o espaçamento entre as parcelas é definido. Vale tanto para a simulação avulsa quanto para a simulação da proposta.
Os dois fluxos¶
| Fluxo | fluxoIrregular | Espaçamento entre parcelas |
|---|---|---|
| Regular | false (padrão) | Mensal |
| Irregular | true | Um intervalo uniforme em dias, definido por você em nroDiasIntervaloPrazo |
O que 'irregular' significa aqui
Em crédito, irregular quer dizer periodicidade diferente da mensal, e não parcelas de valores ou datas individuais. Você define um intervalo em dias e ele vale para todas as parcelas.
Não é possível, nesta API, definir data e valor parcela a parcela. Se a sua operação precisa disso, fale com o nosso time antes de desenhar a integração.
Fluxo regular¶
O caso comum. Basta omitir fluxoIrregular ou enviá-lo como false:
{
"tipoPessoa": 1,
"tipoSimulacao": 1,
"valor": 18000.00,
"taxa": 1.99,
"quantidadeParcelas": 24,
"dataPrimeiroVencimento": "2026-10-10"
}
As parcelas vencem mensalmente a partir da data informada.
Fluxo irregular¶
Informe fluxoIrregular: true e o intervalo em dias:
{
"tipoPessoa": 1,
"tipoSimulacao": 1,
"valor": 18000.00,
"taxa": 1.99,
"quantidadeParcelas": 12,
"dataPrimeiroVencimento": "2026-10-10",
"fluxoIrregular": true,
"nroDiasIntervaloPrazo": 45
}
Resultado: a 1ª parcela vence na data informada, e cada parcela seguinte 45 dias após a anterior.
| Parcela | Vencimento |
|---|---|
| 1 | 2026-10-13 |
| 2 | 2026-11-27 |
| 3 | 2027-01-11 |
| ... | ... |
🧾 Campos¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| fluxoIrregular | boolean | Não | true ativa o intervalo customizado |
| nroDiasIntervaloPrazo | integer | Sim, se fluxoIrregular = true | Intervalo em dias entre parcelas consecutivas. Maior que zero |
A data do primeiro vencimento¶
dataPrimeiroVencimento ancora a primeira parcela e funciona nos dois fluxos e nos dois modos de simulação:
| Situação | Efeito |
|---|---|
| Fluxo regular | 1ª parcela na data informada; as seguintes mensalmente |
| Fluxo irregular | 1ª parcela na data informada; as seguintes espaçadas por nroDiasIntervaloPrazo |
| Campo omitido | A plataforma aplica a regra padrão da operação |
Todas as datas são ajustadas para o próximo dia útil, considerando feriados nacionais. Por isso a dataVencimento devolvida pode ser posterior à que você informou — compare sempre pela resposta, não pela sua expectativa.
⚠️ Restrição: irregular não combina com simulação por valor de parcela¶
O modo tipoSimulacao = 2 (por valor da parcela) não suporta fluxo irregular. A combinação é recusada:
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"status": 400,
"errors": [
{ "campo": "fluxoIrregular", "mensagem": "O modo por valor da parcela não suporta fluxo irregular." }
]
}
Se precisar dos dois, o caminho é: simule por valor de parcela em fluxo regular para descobrir o valor financiável, e depois simule por valor financiado com o fluxo irregular desejado.
Resumo do que é e do que não é suportado¶
| Recurso | Situação |
|---|---|
| PRICE | ✅ |
| SAC | ❌ Não disponível em EP/CDC |
| Fluxo mensal | ✅ |
| Intervalo uniforme em dias | ✅ |
| Data do primeiro vencimento | ✅ nos dois modos e nos dois fluxos |
| Parcelas com valor individual | ❌ |
| Parcelas com data individual | ❌ |
| Carência do principal | ❌ |
| Irregular + por valor de parcela | ❌ |