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).
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
amount_cents | integer | sim | Valor 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.
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Id do saque. |
status | string | Status do saque. Veja os status. |
amount_cents | integer | Valor do saque, em centavos. |
fee_cents | integer | Taxa do saque, em centavos. Sai do saldo junto com o saque. |
reason | string | null | Por que o saque foi recusado. null nos outros casos. |
payout_key | string | A chave Pix que recebe o saque, mascarada. |
created_at | string (ISO 8601) | Quando o saque foi pedido. |
paid_at | string (ISO 8601) | null | Quando o saque foi pago. |
Erros
| HTTP | Código | Quando acontece | O que fazer |
|---|---|---|---|
| 409 | payout_key_required | Você ainda não tem chave Pix de saque ativa. | Cadastre a chave. |
| 409 | daily_limit_exceeded | O saque passa do limite do dia. | Peça um valor menor ou espere o próximo dia. |
| 409 | insufficient_balance | O saldo disponível não cobre o saque e a taxa. | Consulte o saldo. |
| 422 | validation_failed | Valor fora do mínimo ou do máximo por saque. | Veja o campo fields. |