Solicitar saque
POST
/api/withdrawals
Autenticação
Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.withdrawals:write.Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
amount | number | sim | Valor em REAIS (mín R$ 1,00). |
pixKeyId | string | sim | ID de uma chave PIX já cadastrada (status: APPROVED). |
totpCode | string | só via cookie | Código TOTP de 6 dígitos. Não exigido quando autenticado via API Key — o uso da API Key já implica posse comprovada. |
Regras
vk_test_*) recebem 403: "Contas de teste não podem realizar saques".EVENT:WITHDRAWAL_COMPLETED ou EVENT:WITHDRAWAL_FAILED.Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/withdrawals' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 100.00,
"pixKeyId": "clpix0001"
}'Response Response Example
{
"withdrawal": {
"id": "clwdNew",
"amount": 10000,
"fee": 500,
"netAmount": 9500,
"status": "PROCESSING",
"pixKey": {
"type": "CNPJ",
"key": "12.***.***/****-90"
},
"createdAt": "2026-05-07T10:30:00.000Z"
}
}Modificado em 2026-07-02 06:57:27