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âmetro | Descrição |
|---|---|
amount_cents | Quanto sairia do seu saldo, em centavos. Obrigatório. |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
amount_cents | integer | Quanto sairia do seu saldo, em centavos. |
fee_cents | integer | Taxa do saque, descontada de amount_cents. |
net_cents | integer | Quanto chegaria na sua chave Pix. |
fee_bps | integer | Percentual da taxa, em pontos-base (200 = 2%). |
fee_min_cents | integer | Taxa mínima por saque, em centavos. |
Erros
| HTTP | Código | Quando acontece | O que fazer |
|---|---|---|---|
| 400 | invalid_request | Parâmetro desconhecido ou valor que não é um número inteiro. | Envie só amount_cents, em centavos. |
| 422 | validation_failed | Valor fora do mínimo ou do máximo por saque, ou menor que a taxa (amount_below_fee). | Veja o campo fields. |
| 429 | too_many_attempts | Muitas simulações em pouco tempo. | Espere um minuto. |