Skip to main content
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. Só amount é obrigatório — o resto tem padrão: currency = brl, payment_method_types = os três métodos, has_surcharge = false. O endpoint é só leitura/cálculo: nada é criado, reservado ou cobrado.
​
integer
obrigatório
Valor em centavos — inteiro positivo (> 0). Com has_surcharge: true, é o líquido desejado pela organização.
​
string
padrão:"brl"
Apenas brl é aceito. Padrão: brl.
​
boolean
padrão:"false"
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. O repasse vale só para cobrança avulsa — uma cobrança recorrente nunca carrega acréscimo, então a prévia com repasse descreve uma venda avulsa.
​
array
Métodos a calcular. Padrão: os três métodos (boleto, credit_card, pix). Quando enviado, deve ser um array não-vazio só com estes valores.
No cartão, os juros de parcelamento seguem o plano de parcelamento da organização e incidem sobre o valor já acrescido do repasse. Cada opção diz quem paga esse juro em interest_payer, conforme a configuração de checkout da organização: com buyer, vale payment_preview.amount + option.surcharge_amount + option.installment_interest_amount = option.amount; com organization, vale payment_preview.amount + option.surcharge_amount = option.amount e o juro é descontado do líquido da organização. Com has_surcharge: false, todo surcharge_amount é 0.
Quando a organização precifica o cartão por bandeira, um total de credit_card com has_surcharge não pode ser antecipado antes de o cartão existir — a prévia retorna 400 para esse método. Pix e boleto continuam retornando totais exatos, e a cobrança do cartão usa a taxa exata da bandeira real no momento do pagamento.

​
Atualidade da prévia

As opções usam a tabela de juros vigente para a organização no momento da consulta. A prévia não congela a taxa de uma cobrança futura. Se o preço mudar antes de confirmar, releia as opções e peça ao comprador que confirme o total atualizado.