---
title: "Simulação de parcelamentos de uma fatura"
method: POST
path: "/cards/invoices/{statementId}/installments"
tags: ["Refinanciamento de fatura"]
---

# Simulação de parcelamentos de uma fatura

`POST /cards/invoices/{statementId}/installments`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/installments`
- Auth: HTTP bearer

<div class="bkly-ref-description">
  <p>Simule os possíveis parcelamentos de uma fatura e seus valores.</p> 
  <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-guide-small-simulacao-tag">simulação</span> <span class="bkly-ref-scope-tag">scope: invoice.read</span> 
</div>
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Simulação de parcelamentos de uma fatura](/docs/simulacao-de-parcelamentos-fatura)."
}
[/block]

## Path parameters

- `statementId` integer, required: Identificador único da fatura em aberto. Insira somente números, sem caracteres especiais.

## Parameters

- `#/paths/~1cards~1invoices~1adjustments/post/parameters/0` (unresolved $ref)
- `#/paths/~1cards~1invoices~1adjustments/post/parameters/1` (unresolved $ref)

## Request body

- object
  - `minTerm` integer, required: Número mínimo de parcelas a serem antecipadas. Mínimo de duas parcelas.
  - `maxTerm` integer, required: Número máximo de parcelas a serem antecipadas. Mínimo de duas parcelas.
  - `downPayment` number: Valor de entrada para simulação.

## Response `200`

Solicitação aceita com sucesso.

- PaymentOptionsInstallmentsDto[]
  - `paymentOptionId` integer: Identificador único da opção de pagamento.
  - `statementId` integer: Identificador único da fatura.
  - `paymentType` 'Cash' | 'Partial' | 'InstallmentWithEntry' | 'InstallmentWithoutEntry': Opção de pagamento.
  - `value` number, double: Valor a ser pago na entrada do parcelamento.
  - `creditOffer` CreditOfferDto: Objeto que contém informações sobre a proposta de parcelamento da fatura.
    - `creditOfferId` integer: Identificador único da proposta.
    - `externalOperationId` string, nullable: Identificador externo da operação.
    - `externalOfferId` string, nullable: Identificador externo da proposta.
    - `externalOfferType` 'Variable' | 'Fixed', nullable: Tipo da proposta externa retornada.
    - `amountCurrency` string, nullable: Código da moeda com base na ISO-4217. Exemplo: BRL.
    - `amountDue` number, double: Valor contratado da proposta mais o valor total de juros (pode ou não conter TAC).
    - `annualCet` number, double: CET (custo efetivo total) da contratação calculado ao ano.
    - `annualInterestRate` number, double: Taxa de juros anual da contratação.
    - `cet` number, double: CET (custo efetivo total) da contratação calculado na periodicidade definida das parcelas.
    - `disbursementDate` string, date-time: Data prevista para o desembolso da proposta.
    - `externalCreatedAt` string, date-time: Data do cálculo da proposta.
    - `externalExpiresAt` string, date-time: Data de expiração da proposta.
    - `firstPaymentDate` string, date-time: Data do 1º pagamento da proposta.
    - `graceDays` integer: Quantidade de dias para a carência do 1º pagamento.
    - `lastPaymentDate` string, date-time: Data do último pagamento da proposta.
    - `loanAmount` number, double: Valor do crédito solicitado para contratação.
    - `monthlyInterestRate` number, double: Taxa de juros mensal da contratação.
    - `operationCostAmount` number, double: Custo de processamento da operação.
    - `retentionRate` number, double: Indica o percentual de retenção da proposta.
    - `term` integer: Quantidade de parcelas da proposta.
    - `totalInterestAmount` number, double: Valor total de juros a ser pago na contratação.
    - `totalPaymentAmount` number, double: Valor total a ser pago no final do contrato (se aplicável ao produto).
    - `iofTotalAmount` number, double: Valor final do cálculo do IOF.
    - `iofTotalPercentage` number, double: Valor percentual do IOF, se aplicável.
    - `diaryIof` string: Percentual do IOF diário.
    - `fixedIof` string: Percentual do IOF fixo.
    - `confirmedOffer` boolean: Informa se a oferta está confirmada.
    - `installments` InstallmentDto[], nullable
      - `creditOfferId` integer: Identificador único da proposta.
      - `amortizationAmount` number, double, nullable: Valor da amortização no contrato.
      - `dueDate` string, date-time: Data de vencimento da parcela.
      - `interestAmount` number, double: Valor do juros da parcela.
      - `iofAmount` number, double: Valor do IOF da parcela.
      - `paymentAmount` number, double: Valor da parcela.
      - `installmentNumber` integer: Número da parcela.

## Other responses

- `400` (unresolved $ref)
- `406` (unresolved $ref)

---

[API](https://skmtc.dev/bankly/apis/gest-o-de-faturas.md) - [All operations](https://skmtc.dev/bankly/apis/gest-o-de-faturas/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/gest-o-de-faturas/revisions/59ad0e112fb8?raw)