Solicitar Saque (Withdraw)
Solicita um saque do saldo disponível da empresa. Se a requisição incluir uma chave PIX (pixKey), ela será usada prioritariamente. Caso contrário, o sistema usará a chave PIX principal cadastrada no BankAccount da empresa.
💡 Valores monetários: Sempre informados em centavos (R$ 25,00 → 2500)
NOVOCampo metadata (opcional)
A requisição agora aceita o campo metadata:
"metadata": "qualquer texto"
ou
"metadata": { "origem": "n8n", "pedidoId": 123 }✔ Como funciona:
- Pode ser string ou JSON (objeto)
- Se enviar um objeto, ele será salvo como string JSON no banco
- É totalmente opcional
- Fica salvo no campo Withdraw.Metadata
- 📌 O metadata que você enviar será retornado no webhook
💡 Observação importante: Se pixKey for omitida, o sistema automaticamente usará a chave PIX cadastrada na conta bancária (BankAccount) da empresa. Se nenhuma chave estiver disponível, a API retornará erro.
Endpoint
/api/Withdraw/requestHeaders
Acceptapplication/json
Content-Typeapplication/json
X-Client-IdClient ID do aplicativo
X-API-KeySecret Key (Company)
Idempotency-KeyChave única para evitar duplicidade (ex.: wd_123456789)
Request Body
{
"amount": 2500,
"currency": "BRL",
"pixKey": "50651470862",
"pixKeyType": "CPF",
"description": "Saque teste via chave custom",
"metadata": { "origem": "n8n", "pedidoId": 123 }
}Campos do Body
amountValor do saque em centavos (2500 = R$ 25,00)
currencyMoeda padrão (BRL)
pixKeyChave PIX a ser usada (CPF, CNPJ, e-mail, telefone ou EVP)
pixKeyTypeTipo da chave PIX (ex: CPF, CNPJ, EMAIL, PHONE, EVP)
descriptionDescrição livre para o saque
metadataMetadados personalizados. Pode ser uma string ou um objeto JSON. Se for objeto, será convertido em string JSON. Retorna no webhook.
Exemplo de Requisição (cURL)
curl -X POST 'https://api.splitgames.com.br/api/Withdraw/request' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33' \
-H 'X-API-Key: y7M96h1M6aHI-pqKtE4a8cZGStRZ4hOLbt6UX_DyvPPdra8ettG8WM5Q3VEsXXyptSooRm042pCMlKpPDxMsig' \
-H 'Idempotency-Key: wd_test_pix_custom' \
-d '{
"amount": 1000,
"currency": "BRL",
"pixKey": "50651470862",
"pixKeyType": "CPF",
"description": "Saque R$10 via chave custom",
"metadata": { "origem": "n8n", "pedidoId": 123 }
}'Resposta de Sucesso (201 Created)
{
"id": 15,
"companyId": 1,
"idempotencyKey": "dc2b11dc8007409dbd421ed9014ac18c",
"value": 10.00,
"pixKey": "50651470862",
"pixKeyType": "CPF",
"creditorDocument": "11111111111111",
"description": "Saque teste via chave custom",
"currency": "BRL",
"enTransaction": "Awaiting",
"createdAt": "2025-11-17T14:05:07.825Z"
}Exemplo de Erro (sem chave PIX cadastrada)
{
"message": "Chave PIX não encontrada. Cadastre sua conta bancária ou envie a PixKey no request."
}Possíveis Erros
Erro de validação (ex.: amount ≤ 0, valor mínimo R$ 10,00)
Sem permissão para sacar (token sem escopo da empresa)
Colisão de idempotência (mesma Idempotency-Key já usada)
Erro interno do servidor
Exemplo em JavaScript/Node.js
const response = await fetch('https://api.splitgames.com.br/api/Withdraw/request', {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'X-Client-Id': 'e1c98954cc404cbcb2868af9b40c7a33',
'X-API-Key': 'y7M96h1M6aHI-pqKtE4a8cZGStRZ4hOLbt6UX_DyvPPdra8ettG8WM5Q3VEsXXyptSooRm042pCMlKpPDxMsig',
'Idempotency-Key': 'wd_test_' + Date.now()
},
body: JSON.stringify({
amount: 1000,
currency: 'BRL',
pixKey: '50651470862',
pixKeyType: 'CPF',
description: 'Saque R$10 via chave custom',
metadata: { origem: 'n8n', pedidoId: 123 }
})
});
const data = await response.json();
console.log(data);