Saldo e saques

Simular um saque

Mostra a taxa e o valor exato que chega na sua chave Pix para um saque, sem pedir o saque.

GET/v1/withdrawals/quote

Requer o escopo WITHDRAWAL:READ

Use antes de Pedir um saque para mostrar ao seu usuário quanto ele vai receber. O cálculo é o mesmo do pedido. Se as taxas mudarem entre a simulação e o pedido, vale a taxa do momento do pedido, e a resposta do pedido mostra os valores usados.

Parâmetros

ParâmetroDescrição
amount_centsQuanto sairia do seu saldo, em centavos. Obrigatório.

Resposta

CampoTipoDescrição
amount_centsintegerQuanto sairia do seu saldo, em centavos.
fee_centsintegerTaxa do saque, descontada de amount_cents.
net_centsintegerQuanto chegaria na sua chave Pix.
fee_bpsintegerPercentual da taxa, em pontos-base (200 = 2%).
fee_min_centsintegerTaxa mínima por saque, em centavos.

Erros

HTTPCódigoQuando aconteceO que fazer
400invalid_requestParâmetro desconhecido ou valor que não é um número inteiro.Envie só amount_cents, em centavos.
422validation_failedValor fora do mínimo ou do máximo por saque, ou menor que a taxa (amount_below_fee).Veja o campo fields.
429too_many_attemptsMuitas simulações em pouco tempo.Espere um minuto.