Prévias de pagamento
Criar uma prévia de pagamento
Monta a tabela de parcelas do cartão, com o acréscimo já calculado, para um valor.
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ó
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 é 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.payment_preview.amount + option.surcharge_amount + option.installment_interest_amount = option.amount. Com
has_surcharge: false, todo surcharge_amount é 0 e os totais seguem o
comportamento padrão (juros apenas, quando configurados).

