Skip to main content
GET
/
{alias}
/
checkout
/
payments
/
{paymentId}
/
installments
/
simulate
Simular parcelamento de um pagamento
curl --request GET \
  --url https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/installments/simulate \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>'
{
  "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",
    "text_discount_percent": null,
    "text_discount": null,
    "installments": [
      {
        "amount": 500,
        "amount_formated": "R$ 500,00",
        "base_value": 500,
        "tax": "0",
        "tax_value": 0,
        "discount_percent": 0,
        "discount_value": 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",
        "text_discount_percent": null,
        "text_discount": null
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
User-Token
string
header
required
​
User-Secret-Key
string
header
required

Path Parameters

​
alias
string
required

Alias da loja

​
paymentId
integer
required

ID da forma de pagamento

Query Parameters

​
amount
number<float>
required

Valor total do pagamento

​
min_installment_value
number<float>
required

Valor mínimo da parcela

​
max_installments_without_tax
integer
required

Número máximo de parcelas sem juros

​
taxes
object[]
required

Taxa aplicada nas parcelas

​
currency
string

Moeda do pagamento

Response

Simulação de parcelamento realizada com sucesso

​
data
Resposta de Simulação de Parcelamento · object

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