v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Checkout - Parcelamento

Simular parcelamento de um pagamento

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

get/{alias}/checkout/payments/{paymentId}/installments/simulate

Path parameters

aliasstring required

Alias da loja

paymentIdinteger required

ID da forma de pagamento

Query parameters

amountnumber float required

Valor total do pagamento

min_installment_valuenumber float required

Valor mínimo da parcela

max_installments_without_taxinteger required

Número máximo de parcelas sem juros

taxnumber float

Taxa aplicada na parcela

installmentinteger

Número da parcela

percent_discountnumber float

Desconto percentual aplicado na parcela

Taxa aplicada nas parcelas

currencystring

Moeda do pagamento

Response

Simulação de parcelamento realizada com sucesso

Example response

{
  "data": {
    "max_installment": 1,
    "max_installment_value": 500,
    "amount": 500,
    "text": "1x de R$ 500,00 sem juros",
    "text_with_tax": "1x de R$ 500,00",
    "installments": [
      {
        "amount": 500,
        "amount_formated": "R$ 500,00",
        "base_value": 500,
        "tax": "0",
        "discount_value_formated": "R$ 0,00",
        "installment": "1",
        "installment_value": 500,
        "installment_value_formated": "R$ 500,00",
        "text": "1x de R$ 500,00 sem juros",
        "text_with_tax": "1x de R$ 500,00"
      }
    ]
  }
}