Taxas
Simulação do valor bruto e líquido.
Simular valor bruto e líquido
POST/v1/fees/simulate
Mostra quanto o pagador paga e quanto a conta recebe, por meio e por parcela, com o plano de taxas da conta. Use antes de exibir as opções de parcelamento ao pagador.
Parâmetros
- McpfPay-Accountstring · cabeçalho
Obrigatório para chaves de parceiro. Id da conta conectada em nome da qual a operação é feita.
Corpo da requisição (JSON)
- amountobrigatóriointeger
Valor em centavos de real.
- methodobrigatóriocard | pix | boleto
- —
- card_brandmastercard | visa | elo | amex | hipercard | other
- —
- fee_payermerchant | payer
merchant: a taxa sai do valor recebido.payer: a taxa é somada ao que o pagador paga, e a conta recebe oamountintegral.
Resposta
- amountobrigatóriointeger
Valor em centavos de real.
- methodobrigatóriostring
- —
- fee_payermerchant | payer
merchant: a taxa sai do valor recebido.payer: a taxa é somada ao que o pagador paga, e a conta recebe oamountintegral.- optionsobrigatóriolista de object
Uma linha por número de parcelas (só uma para Pix e boleto).
- options[].installmentsobrigatóriointeger
- —
- options[].total_paidobrigatóriointeger
Quanto o pagador paga no total.
- options[].installment_amountobrigatóriointeger
- —
- options[].net_receivedobrigatóriointeger
Quanto a conta recebe.
- options[].feesobrigatóriointeger
- —
Códigos de resposta
- 200 Simulação.
- 400 Parâmetro ausente ou inválido.