Saques
Solicitar Saque
POST
/v1/wallet/withdrawBase URL Produção:
https://api.validapay.com.brBase URL Sandbox:
https://sandbox.validapay.com.brAutenticação
bearerAuthorizationstring · header · obrigatório
Envie no header:
Authorization: Bearer {{token}}Solicita a transferência do saldo disponível para a conta bancária cadastrada.
Realizar saque via PIX
Transfere o valor solicitado do saldo disponível da sua carteira para uma chave PIX de destino. O saldo deve ser suficiente para cobrir o valor mais as taxas aplicáveis. O processamento é realizado em instantes durante o horário bancário.
| Campo | Obrig. | Tipo | Descrição |
|---|---|---|---|
amount | ✅ | number | Valor a sacar em reais (maior que zero) |
pixKey | ✅ | string | Chave PIX do destinatário |
pixKeyType | ✅ | string | Tipo da chave: CPF CNPJ EMAIL PHONE EVP |
documentNumber | ❌ | string | CPF ou CNPJ do titular da chave destino |
accountId | ❌ | string | M2M: número da subconta de origem |
Body
application/json
Content-Type:application/json
{
"amount": 500.0,
"pixKey": "joao@email.com",
"pixKeyType": "EMAIL",
"documentNumber": "12345678901",
"accountId": null
}Schema
| Field | Type | Required | Description |
|---|---|---|---|
amount | number | - | - |
pixKey | string | - | - |
pixKeyType | string | - | - |
documentNumber | string | - | - |
accountId | object | - | - |
Headers
| Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | - | application/json | Optional |
const url = 'https://sandbox.validapay.com.br/v1/wallet/withdraw';
const options = {
method: 'POST',
headers: {
'Authorization': 'Bearer {{token}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"amount": 500.0,
"pixKey": "joao@email.com",
"pixKeyType": "EMAIL",
"documentNumber": "12345678901",
"accountId": null
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Response Examples
201201
{
"withdrawalId": "wth_xxx",
"amount": 500.0,
"status": "PROCESSING",
"pixKey": "joao@email.com",
"createdAt": "2024-01-15T10:30:00Z"
}400400
{
"code": "INSUFFICIENT_BALANCE"
}