Regras de parcelamento

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

CampoTipoObrigatórioDescrição
agreementTypeIdintegerObrigatórioTipo do acordo. Obtido em GET /installments/rules/tipos.
activebooleanObrigatórioIndica se a regra está ativa. Regras inativas não geram novas ofertas.
defaultRulebooleanObrigatórioIndica se esta é a regra padrão, usada na geração da fatura.
agreementRuleIdintegerRetornoIdentificador da regra, gerado na criação. Use-o em todos os vínculos e simulações.
validityStartdate-timeRetornoInício da vigência da regra, em UTC.

Faixas de parcelamento

CampoTipoObrigatórioDescrição
minimumInstallmentsintegerObrigatórioQuantidade mínima de parcelas aceita.
maximumInstallmentsintegerObrigatórioQuantidade máxima de parcelas aceita.
minimumInstallmentValuedecimalObrigatórioValor mínimo de cada parcela. Planos que gerariam parcela abaixo disso não são ofertados.
maximumInstallmentValuedecimalObrigatórioValor máximo de cada parcela.
limitContractedAgreementsintegerObrigatórioLimite de acordos contratados simultaneamente sob esta regra.

Custo

CampoTipoObrigatórioDescrição
interestRatePercentagedecimalObrigatórioTaxa de juros aplicada ao acordo, em fração decimal: 0.25 equivale a 25%.
iofdecimalObrigatórioAlíquota do IOF adicional, cobrado uma única vez sobre o valor financiado.
dailyIofdecimalObrigatórioAlíquota do IOF diário, aplicada sobre o prazo do financiamento.
daysAfterDueintegerObrigatórioQuantidade de dias após o vencimento da fatura considerada pela regra.

Entrada

CampoTipoObrigatórioDescrição
initialEntryPercentagedecimalObrigatórioPercentual de entrada do primeiro plano ofertado.
planEntryIncrementdecimalObrigatórioIncremento aplicado ao percentual de entrada a cada plano subsequente.
tiebreakerPercentagedecimalObrigatórioPercentual de desempate entre planos.
manualMinEntrydecimalObrigatórioValor mínimo aceito quando a entrada é informada manualmente em downPayment.
manualMaxEntrydecimalObrigatórioValor máximo aceito quando a entrada é informada manualmente em downPayment.
installmentPlanInvoicesarrayRetornoPlanos configurados para envio na fatura. Definidos em POST /installments/rules/{id}/plan.

Criando uma regra

POST
/installments/rules

Request

{
  "agreementTypeId": 1,
  "active": true,
  "defaultRule": true,
  "minimumInstallments": 3,
  "maximumInstallments": 12,
  "minimumInstallmentValue": 20,
  "maximumInstallmentValue": 1000,
  "limitContractedAgreements": 4,
  "interestRatePercentage": 0.25,
  "iof": 0.25,
  "dailyIof": 0.00082,
  "daysAfterDue": 5,
  "initialEntryPercentage": 0.1,
  "planEntryIncrement": 0.05,
  "tiebreakerPercentage": 0.02,
  "manualMinEntry": 50,
  "manualMaxEntry": 500
}

Response

👍

Sucesso 200

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "agreementRuleId": 1,
    "agreementTypeId": 1,
    "active": true,
    "defaultRule": true,
    "minimumInstallments": 2,
    "maximumInstallments": 12,
    "minimumInstallmentValue": 20,
    "maximumInstallmentValue": 200,
    "limitContractedAgreements": 4,
    "interestRatePercentage": 0.15,
    "iof": 0.042,
    "dailyIof": 0.00082,
    "daysAfterDue": 5,
    "initialEntryPercentage": 0.1,
    "planEntryIncrement": 0.05,
    "tiebreakerPercentage": 0.02,
    "manualMinEntry": 50,
    "manualMaxEntry": 500,
    "validityStart": "2024-07-05T21:05:47.000000Z",
    "installmentPlanInvoices": [1, 2]
  }
}

Did this page help you?