A regra é a política comercial do parcelamento: quantas parcelas, com que juros, com que IOF, com ou sem entrada, e para quem vale. Tudo o que o portador enxerga como oferta nasce de uma regra.
O que uma regra define
Ordem recomendada
Campos da regra
Identificação
Campo
Tipo
Obrigatório
Descrição
agreementTypeId
integer
Obrigatório
Tipo do acordo. Obtido em GET /installments/rules/tipos.
active
boolean
Obrigatório
Indica se a regra está ativa. Regras inativas não geram novas ofertas.
defaultRule
boolean
Obrigatório
Indica se esta é a regra padrão, usada na geração da fatura.
agreementRuleId
integer
Retorno
Identificador da regra, gerado na criação. Use-o em todos os vínculos e simulações.
validityStart
date-time
Retorno
Início da vigência da regra, em UTC.
Faixas de parcelamento
Campo
Tipo
Obrigatório
Descrição
minimumInstallments
integer
Obrigatório
Quantidade mínima de parcelas aceita.
maximumInstallments
integer
Obrigatório
Quantidade máxima de parcelas aceita.
minimumInstallmentValue
decimal
Obrigatório
Valor mínimo de cada parcela. Planos que gerariam parcela abaixo disso não são ofertados.
maximumInstallmentValue
decimal
Obrigatório
Valor máximo de cada parcela.
limitContractedAgreements
integer
Obrigatório
Limite de acordos contratados simultaneamente sob esta regra.
Custo
Campo
Tipo
Obrigatório
Descrição
interestRatePercentage
decimal
Obrigatório
Taxa de juros aplicada ao acordo, em fração decimal: 0.25 equivale a 25%.
iof
decimal
Obrigatório
Alíquota do IOF adicional, cobrado uma única vez sobre o valor financiado.
dailyIof
decimal
Obrigatório
Alíquota do IOF diário, aplicada sobre o prazo do financiamento.
daysAfterDue
integer
Obrigatório
Quantidade de dias após o vencimento da fatura considerada pela regra.
Entrada
Campo
Tipo
Obrigatório
Descrição
initialEntryPercentage
decimal
Obrigatório
Percentual de entrada do primeiro plano ofertado.
planEntryIncrement
decimal
Obrigatório
Incremento aplicado ao percentual de entrada a cada plano subsequente.
tiebreakerPercentage
decimal
Obrigatório
Percentual de desempate entre planos.
manualMinEntry
decimal
Obrigatório
Valor mínimo aceito quando a entrada é informada manualmente em downPayment.
manualMaxEntry
decimal
Obrigatório
Valor máximo aceito quando a entrada é informada manualmente em downPayment.
installmentPlanInvoices
array
Retorno
Planos configurados para envio na fatura. Definidos em POST /installments/rules/{id}/plan.