Saldo e saques

Pedir um saque

Pede um saque do saldo disponível para a sua chave Pix ativa. O valor fica reservado até a análise.

POST/v1/withdrawals

Requer o escopo WITHDRAWAL:CREATE

O saque vai para a sua chave Pix ativa. Cadastre a chave antes em Cadastrar a chave Pix de saque. Veja como funciona em Saldo e saques.

O valor que você pede é o que sai do seu saldo. A taxa de saque é descontada dele e você recebe o restante. Para saber o valor exato antes de pedir, use Simular um saque.

Requisição

Cabeçalhos: Authorization, Content-Type: application/json e Idempotency-Key (obrigatório).

CampoTipoObrigatórioDescrição
amount_centsintegersimQuanto sai do seu saldo, em centavos. A taxa é descontada deste valor. Precisa estar entre o mínimo e o máximo por saque da sua conta.
expected_net_centsinteger | nullnãoO valor líquido que você conferiu (o net_cents de Simular um saque). Se a taxa mudou nesse meio tempo, o saque não é feito e a API responde 409 fee_changed com a simulação nova.

Resposta

A API responde 201 com o saque em requested.

CampoTipoDescrição
idstringId do saque.
statusstringStatus do saque. Veja os status.
amount_centsintegerQuanto saiu do seu saldo, em centavos.
fee_centsintegerTaxa do saque, em centavos. Já está dentro de amount_cents.
net_centsintegerQuanto chega na sua chave Pix: amount_cents menos fee_cents.
reasonstring | nullPor que o saque foi recusado. null nos outros casos.
payout_keystringA chave Pix que recebe o saque, mascarada.
created_atstring (ISO 8601)Quando o saque foi pedido.
paid_atstring (ISO 8601) | nullQuando o saque foi pago.

Erros

HTTPCódigoQuando aconteceO que fazer
409payout_key_requiredVocê ainda não tem chave Pix de saque ativa.Cadastre a chave.
409daily_limit_exceededO saque passa do limite do dia.Peça um valor menor ou espere o próximo dia.
409insufficient_balanceO saldo disponível não cobre o valor pedido.Consulte o saldo.
409fee_changedA taxa mudou e o líquido não é mais o expected_net_cents enviado. Nada foi reservado.Confira a simulação nova em detail e peça de novo com o líquido novo e uma nova Idempotency-Key.
503withdrawals_unavailableSaques estão indisponíveis no momento. Nada foi reservado.Tente mais tarde.
422validation_failedValor fora do mínimo ou do máximo por saque, ou menor que a taxa (amount_below_fee).Veja o campo fields.