Pré-visualizar opções de parcelamento

gethttps://sandbox-api.rebornpay.io/v1/payment-links/installment-options/previewAuth obrigatória

Calcula as opções de parcelamento para uma configuração de link ainda não criada, com a mesma regra usada no checkout. Requer API Key.

Headers

X-Api-Keystringrequired

API Key do seller (header)

Query Parameters

amountInCentsintegerrequired
maxInstallmentsintegeroptional
monthlyInterestPercentnumberoptional
interestFreeInstallmentsintegeroptional

Responses

200Opções de parcelamento
optionsarrayrequired

Lista de opções de parcelamento

installmentsinteger · int32required

Número de parcelas

Example: 3

amountPerInstallmentInCentsinteger · int64required

Valor por parcela em centavos

Example: 3330

totalAmountInCentsinteger · int64required

Valor total a pagar em centavos (com juros se houver)

Example: 9990

interestRatenumber · doubleoptional

Taxa de juros mensal aplicada (nulo = sem juros)

Example: 1.99

installmentAmountInCentsinteger · int64required

Alias de amountPerInstallmentInCents

principalAmountInCentsinteger · int64required

Valor da venda em centavos, sem os juros do comprador

Example: 9990

interestAmountInCentsinteger · int64required

Juros pagos pelo comprador em centavos. Zero quando o seller absorve o custo

Example: 0

interestFreebooleanrequired

Quando true, o comprador não paga juros nesta opção — só aí o checkout pode exibir "sem juros"

Example: true

interestModestring · enumrequired

Quem paga o custo do parcelamento nesta cobrança

Example: SELLER

SELLERBUYERMIXED
interestSourcestring · enumrequired

De onde veio a regra de juros aplicada

Example: NONE

NONEPAYMENT_LINKSELLER
400Configuração de parcelamento inválida
optionsarrayrequired

Lista de opções de parcelamento

installmentsinteger · int32required

Número de parcelas

Example: 3

amountPerInstallmentInCentsinteger · int64required

Valor por parcela em centavos

Example: 3330

totalAmountInCentsinteger · int64required

Valor total a pagar em centavos (com juros se houver)

Example: 9990

interestRatenumber · doubleoptional

Taxa de juros mensal aplicada (nulo = sem juros)

Example: 1.99

installmentAmountInCentsinteger · int64required

Alias de amountPerInstallmentInCents

principalAmountInCentsinteger · int64required

Valor da venda em centavos, sem os juros do comprador

Example: 9990

interestAmountInCentsinteger · int64required

Juros pagos pelo comprador em centavos. Zero quando o seller absorve o custo

Example: 0

interestFreebooleanrequired

Quando true, o comprador não paga juros nesta opção — só aí o checkout pode exibir "sem juros"

Example: true

interestModestring · enumrequired

Quem paga o custo do parcelamento nesta cobrança

Example: SELLER

SELLERBUYERMIXED
interestSourcestring · enumrequired

De onde veio a regra de juros aplicada

Example: NONE

NONEPAYMENT_LINKSELLER
curl -X GET 'https://sandbox-api.rebornpay.io/v1/payment-links/installment-options/preview' \  -H 'X-Api-Key: $API_KEY'
200Response example
{
  "options": [
    {
      "installments": 3,
      "amountPerInstallmentInCents": 3330,
      "totalAmountInCents": 9990,
      "interestRate": 1.99,
      "installmentAmountInCents": 1,
      "principalAmountInCents": 9990,
      "interestAmountInCents": 0,
      "interestFree": true
    }
  ],
  "interestMode": "SELLER",
  "interestSource": "NONE"
}