Skip to main content
curl -X POST "https://api.chargefy.io/v1/payment-previews" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 2500,
    "has_surcharge": true
  }'

{
  "object": "payment_preview",
  "amount": 2500,
  "currency": "brl",
  "has_surcharge": true,
  "livemode": true,
  "payment_methods": {
    "boleto": {
      "amount_total": 2700,
      "surcharge_amount": 200
    },
    "credit_card": {
      "installments": {
        "max_count": 3,
        "options": [
          {
            "amount_total": 2775,
            "count": 1,
            "interest_amount": 0,
            "per_installment_amount": 2775,
            "surcharge_amount": 275
          },
          {
            "amount_total": 2889,
            "count": 2,
            "interest_amount": 105,
            "per_installment_amount": 1445,
            "surcharge_amount": 284
          },
          {
            "amount_total": 2924,
            "count": 3,
            "interest_amount": 140,
            "per_installment_amount": 975,
            "surcharge_amount": 284
          }
        ]
      }
    },
    "pix": {
      "amount_total": 2613,
      "surcharge_amount": 113
    }
  }
}
Serve para você exibir no seu checkout a quantidade de parcelas e o valor exato de cada uma, já com o acréscimo calculado — sem calcular juro na mão. PIX e boleto vêm no mesmo payload. Use a resposta para montar o seletor de parcelas; na hora de cobrar, envie a escolha ao Payment Intent, que recalcula tudo no servidor.
​
amount
integer
required
Valor em centavos. Com has_surcharge: true, é o líquido desejado pela organização.
​
has_surcharge
boolean
Quando true, o comprador cobre a taxa da organização: os totais são acrescidos de surcharge_amount para que a organização receba líquido o amount informado. Padrão: false.
​
payment_method_types
array
Métodos a calcular: credit_card, pix, boleto. Padrão: todos.
​
currency
string
Apenas brl. Padrão: brl.
No cartão, os juros de parcelamento seguem o plano de parcelamento da organização e incidem sobre o valor já acrescido do repasse. Em toda opção vale amount + surcharge_amount + interest_amount = amount_total. Com has_surcharge: false, todo surcharge_amount é 0 e os totais seguem o comportamento padrão (juros apenas, quando configurados). 
curl -X POST "https://api.chargefy.io/v1/payment-previews" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 2500,
    "has_surcharge": true
  }'

{
  "object": "payment_preview",
  "amount": 2500,
  "currency": "brl",
  "has_surcharge": true,
  "livemode": true,
  "payment_methods": {
    "boleto": {
      "amount_total": 2700,
      "surcharge_amount": 200
    },
    "credit_card": {
      "installments": {
        "max_count": 3,
        "options": [
          {
            "amount_total": 2775,
            "count": 1,
            "interest_amount": 0,
            "per_installment_amount": 2775,
            "surcharge_amount": 275
          },
          {
            "amount_total": 2889,
            "count": 2,
            "interest_amount": 105,
            "per_installment_amount": 1445,
            "surcharge_amount": 284
          },
          {
            "amount_total": 2924,
            "count": 3,
            "interest_amount": 140,
            "per_installment_amount": 975,
            "surcharge_amount": 284
          }
        ]
      }
    },
    "pix": {
      "amount_total": 2613,
      "surcharge_amount": 113
    }
  }
}