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.

Requisição

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

CampoTipoObrigatórioDescrição
amount_centsintegersimValor do saque, em centavos. Precisa estar entre o mínimo e o máximo por saque da sua conta.

Resposta

A API responde 201 com o saque em requested.

CampoTipoDescrição
idstringId do saque.
statusstringStatus do saque. Veja os status.
amount_centsintegerValor do saque, em centavos.
fee_centsintegerTaxa do saque, em centavos. Sai do saldo junto com o saque.
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 saque e a taxa.Consulte o saldo.
422validation_failedValor fora do mínimo ou do máximo por saque.Veja o campo fields.