Skip to main content
POST
Solicitar Saque

Descrição

Solicita um saque do saldo disponível para a chave PIX informada. O valor sai do saldo disponível na hora e fica em processamento até a conclusão. O resultado chega pelos webhooks withdrawal.completed ou withdrawal.failed, e também pode ser consultado em GET /v1/payouts/.
O campo amount é o valor que sai do saldo, em centavos. A taxa do saque (platformFee) é descontada desse valor.
Rate Limit: 60 requisições/minuto

Headers

string
default:"Bearer YOUR_API_KEY"
required
Bearer token de autenticação. Formato: Bearer YOUR_API_KEY
string
required
Deve ser application/json

Body

integer
required
Valor do saque em centavos. Precisa respeitar o mínimo de saque da conta e ser maior que a taxa.
string
required
Chave PIX de destino.
string
required
Tipo da chave: cpf, cnpj, phone, email ou random.
string
Descrição do saque, até 140 caracteres. Se não for enviada, vale Saque solicitado.

Saque

Requisição

Resposta 201 Created

string
UUID do saque, gerado pela VisePag.
string
Status do saque: pending, processing, completed ou failed. Veja Status.
integer
Valor que saiu do saldo, em centavos.
integer
Taxa do saque, em centavos.
string
Tipo da chave de destino.
string
Chave de destino mascarada. A chave completa não é devolvida.

Erros