GET /api/v1/checkouts/installment-options

Retorna as opções de parcelamento disponíveis para um valor específico

Endpoint público que calcula as opções de parcelamento disponíveis para um valor em centavos. Útil para exibir ao comprador as parcelas antes de confirmar o checkout.

Autenticação

Endpoint público — não requer autenticação.

Parâmetros de Query

amount · integer · required

Valor total em centavos (mínimo: 100 = R$ 1,00)

no_fees · boolean · default: "false"

Se true, calcula as parcelas sem acréscimo de juros

Resposta

max_installments · integer

Número máximo de parcelas disponível para o valor informado (limitado pela regra de parcela mínima de R$ 7,00 e máximo de 12x)

installment_options · array

Lista de opções de parcelamento disponíveis. Cada item contém:

Show Propriedades de cada opção

installments · integer

Número de parcelas

installment_amount · integer

Valor de cada parcela em centavos

total_amount · integer

Valor total com juros (se aplicável) em centavos

interest_rate · number

Taxa de juros aplicada (%)

Exemplo

cURL

curl -X GET "https://api.chargefy.io/api/v1/checkouts/installment-options?amount=9900&no_fees=false"

Resposta de Exemplo

{
  "max_installments": 12,
  "installment_options": [
    { "installments": 1, "installment_amount": 9900, "total_amount": 9900, "interest_rate": 0 },
    { "installments": 2, "installment_amount": 5048, "total_amount": 10096, "interest_rate": 1.99 },
    { "installments": 3, "installment_amount": 3399, "total_amount": 10197, "interest_rate": 1.99 },
    { "installments": 6, "installment_amount": 1732, "total_amount": 10392, "interest_rate": 1.99 },
    { "installments": 12, "installment_amount": 900, "total_amount": 10800, "interest_rate": 1.99 }
  ]
}