---
title: "Simular parcelamento de um pagamento"
method: GET
path: "/{alias}/checkout/payments/{paymentId}/installments/simulate"
tags: ["Checkout - Parcelamento"]
---

# Simular parcelamento de um pagamento

`GET /{alias}/checkout/payments/{paymentId}/installments/simulate`

Simula o parcelamento de um pagamento, considerando valor total, valor mínimo da parcela, número máximo de parcelas sem juros e taxas associadas

## Path parameters

- `alias` string, required
- `paymentId` integer, required

## Query parameters

- `amount` number, float, required
- `min_installment_value` number, float, required
- `max_installments_without_tax` integer, required
- `taxes` object[], required
  - `tax` number, float — Taxa aplicada na parcela
  - `installment` integer — Número da parcela
  - `percent_discount` number, float — Desconto percentual aplicado na parcela
- `currency` string

## Response `200`

Simulação de parcelamento realizada com sucesso

- object
  - `data` InstallmentSimulationResponse — Resposta detalhada da simulação de parcelamento, incluindo o número máximo de parcelas, valor máximo da parcela, valor total, textos formatados e detalhes das parcelas
    - `max_installment` integer — Número máximo de parcelas
    - `max_installment_value` number, float — Valor máximo da parcela
    - `amount` number, float — Valor total do pagamento
    - `text` string — Texto formatado da parcela sem juros
    - `text_with_tax` string — Texto formatado da parcela com juros
    - `text_discount_percent` string, nullable — Texto do desconto percentual
    - `text_discount` string, nullable — Texto do desconto
    - `installments` object[]
      - `amount` number, float — Valor total da parcela
      - `amount_formated` string — Valor total da parcela formatado
      - `base_value` number, float — Valor base da parcela
      - `tax` string — Taxa aplicada na parcela
      - `tax_value` number, float — Valor da taxa aplicada
      - `discount_percent` number, float — Percentual de desconto aplicado na parcela
      - `discount_value` number, float — Valor do desconto aplicado
      - `discount_value_formated` string — Valor do desconto aplicado formatado
      - `installment` string — Número da parcela
      - `installment_value` number, float — Valor da parcela
      - `installment_value_formated` string — Valor da parcela formatado
      - `text` string — Texto da parcela sem juros
      - `text_with_tax` string — Texto da parcela com juros
      - `text_discount_percent` string, nullable — Texto do desconto percentual
      - `text_discount` string, nullable — Texto do desconto

## Other responses

- `400` — Requisição inválida
- `404` — Forma de pagamento não encontrada

---

[API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/revisions/fa16c50bef09/schema)