Skip to main content
GET
/
installments
Calcular Parcelas
curl --request GET \
  --url https://api.example.com/installments
{
  "200": {},
  "400": {},
  "401": {},
  "500": {},
  "number": 123,
  "installment_amount": 123,
  "total_amount": 123,
  "interest_rate": 123,
  "formatted": "<string>"
}

​
Visão Geral

Este endpoint retorna as opções de parcelamento disponíveis para um determinado valor, incluindo juros e valor de cada parcela.

​
Endpoint

GET https://api.klivopay.com.br/api/public/v1/installments

​
Parâmetros

​
api_token
string
required
Seu token de autenticação da API KlivoPay
​
amount
integer
required
Valor total em centavos para calcular o parcelamento. Exemplo: R$ 150,00 = 15000
​
interest_type
string
default:"simple"
Tipo de juros a aplicar:
  • simple - Juros simples (padrão)
  • compound - Juros compostos

​
Exemplo de Requisição

curl -X GET 'https://api.klivopay.com.br/api/public/v1/installments?api_token=seu_token_aqui&amount=15000&interest_type=simple'

​
Resposta de Sucesso

200 OK
{
  "success": true,
  "data": {
    "amount": 15000,
    "interest_type": "simple",
    "installments": [
      {
        "number": 1,
        "installment_amount": 15000,
        "total_amount": 15000,
        "interest_rate": 0,
        "formatted": "1x de R$ 150,00 sem juros"
      },
      {
        "number": 2,
        "installment_amount": 7500,
        "total_amount": 15000,
        "interest_rate": 0,
        "formatted": "2x de R$ 75,00 sem juros"
      },
      {
        "number": 3,
        "installment_amount": 5000,
        "total_amount": 15000,
        "interest_rate": 0,
        "formatted": "3x de R$ 50,00 sem juros"
      },
      {
        "number": 6,
        "installment_amount": 2650,
        "total_amount": 15900,
        "interest_rate": 2.5,
        "formatted": "6x de R$ 26,50 com juros"
      },
      {
        "number": 12,
        "installment_amount": 1425,
        "total_amount": 17100,
        "interest_rate": 4.5,
        "formatted": "12x de R$ 14,25 com juros"
      }
    ]
  }
}

​
Campos da Resposta

​
number
integer
Número de parcelas
​
installment_amount
integer
Valor de cada parcela em centavos
​
total_amount
integer
Valor total a ser pago (com juros) em centavos
​
interest_rate
number
Taxa de juros aplicada (%)
​
formatted
string
Texto formatado para exibição ao cliente

​
Códigos de Resposta

​
200
OK
Cálculo realizado com sucesso
​
400
Bad Request
Valor inválido para cálculo
​
401
Unauthorized
Token de API inválido ou ausente
​
500
Internal Server Error
Erro interno do servidor
Use este endpoint para exibir as opções de parcelamento ao cliente antes de criar a transação.
As taxas de juros e número máximo de parcelas podem variar de acordo com a configuração da sua conta.