Skip to main content
POST
/
api
/
v1
/
withdraw
/
create
curl -X POST 'https://api.visionwallet.com.br/api/v1/withdraw/create' \
  -H 'X-API-Key: sua_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 100.00,
    "pixKey": "usuario@example.com",
    "pixKeyType": "EMAIL",
    "description": "Saque para conta pessoal"
  }'

{
  "success": true,
  "message": "Saque processado com sucesso",
  "data": {
    "id": "withdraw_abc123",
    "value": 10000,
    "fee": 50,
    "sent": 9950,
    "status": "COMPLETED",
    "pixKey": "usuario@example.com",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

​
Criar Saque

Cria um novo saque para transferir dinheiro da sua conta Vision Wallet para uma conta bancária via PIX. O saque é processado instantaneamente. 
curl -X POST 'https://api.visionwallet.com.br/api/v1/withdraw/create' \
  -H 'X-API-Key: sua_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 100.00,
    "pixKey": "usuario@example.com",
    "pixKeyType": "EMAIL",
    "description": "Saque para conta pessoal"
  }'

{
  "success": true,
  "message": "Saque processado com sucesso",
  "data": {
    "id": "withdraw_abc123",
    "value": 10000,
    "fee": 50,
    "sent": 9950,
    "status": "COMPLETED",
    "pixKey": "usuario@example.com",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

​
Parâmetros

​
amount
number
required
Valor do saque em reais. Valor mínimo: R$ 5,00 (500 centavos).
​
pixKey
string
required
Chave PIX do destinatário (CPF, CNPJ, e-mail, telefone ou chave aleatória).
​
pixKeyType
string
required
Tipo da chave PIX: CPF, CNPJ, EMAIL, PHONE, ou RANDOM.
​
description
string
Descrição opcional do saque.
​
coverFee
boolean
default:"false"
Se true, o valor informado é o valor líquido que será enviado. A taxa será deduzida do saldo adicional.
​
verificationCode
string
Código de verificação necessário se a segurança de transferências estiver ativada na conta do usuário.
O saldo do usuário será debitado imediatamente ao criar o saque. Certifique-se de que há saldo suficiente antes de criar um saque.

​
Status do Saque

Os saques podem ter os seguintes status:
StatusDescrição
PENDINGSaque criado, aguardando processamento
COMPLETEDSaque processado com sucesso
FAILEDSaque falhou
A maioria dos saques é processada instantaneamente e ficam com status COMPLETED imediatamente após a criação.

​
Segurança de Transferências

Se a conta do usuário tiver segurança de transferências ativada, será necessário fornecer um código de verificação. O código deve ser solicitado através do endpoint de segurança antes de criar o saque.

​
Permissões Necessárias

Esta rota requer a permissão write:withdraw:create.

​
Rate Limiting

  • 10 req/s (600 req/min) por API Key

Authorizations

​
X-API-Key
string
header
required

API Key para autenticação. Use o header X-API-Key ou Authorization: Bearer {api_key}

Body

application/json
​
amount
number
required

Valor do saque em reais

Required range: x >= 5
Example:

100

​
pixKey
string
required

Chave PIX do destinatário

Example:

"usuario@example.com"

​
pixKeyType
enum<string>
required

Tipo da chave PIX

Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
RANDOM
​
description
string

Descrição opcional do saque

​
coverFee
boolean
default:false

Se true, o valor informado é o valor líquido enviado

Response

Saque criado com sucesso

​
success
boolean
​
message
string
​
data
object