Skip to main content
No Brasil, o payment preview serve basicamente para uma coisa: montar, no seu checkout, a tabela de parcelas do cartão com o acréscimo já calculado — quantas parcelas, e o valor exato de cada uma. Pix e boleto vêm no mesmo payload, mas o motivo do objeto existir é resolver o parcelamento sem você calcular juro na mão. Use antes de criar o Payment Intent. Com has_surcharge: true, os totais incluem o repasse da taxa (surcharge_amount): o comprador cobre a taxa da organização e a organização recebe líquido exatamente o amount informado.
A preview é efêmera: não cria recurso, não tem id e nada é persistido. O Payment Intent recalcula tudo no servidor e é a fonte da verdade na cobrança.
​
string
Sempre payment_preview.
​
integer
Valor informado, em centavos. Com has_surcharge: true, é o que a organização recebe líquido.
​
string
Sempre brl.
​
boolean
Ecoa o valor enviado. Quando false, todo surcharge_amount é 0.
​
boolean
Ambiente da API key usada na chamada.
​
object
Um bloco por método solicitado.

​
Elegibilidade da cobrança

eligible indica se a cotação satisfaz os mínimos do plano e do método. minimum_amount é o mínimo em centavos para os componentes desta cotação. No cartão, ambos podem ser null quando a bandeira real ainda é necessária. Uma opção com eligible: false deve ficar fora das escolhas do comprador. Por exemplo, com Pix de 0,50% + R$ 1,00, uma prévia de 100 centavos retorna eligible: false e minimum_amount: 101. A confirmação recalcula e, se o valor continuar insuficiente, retorna amount_too_small.