Preloader
Desenvolvedor

Solicitar saque

Solicita saque via PIX para uma chave de destino, com callback de atualização.

Endpoint: POST /api/withdrawals/withdraw
ParâmetroTipoDescrição
amount *numberValor do saque.
external_id *stringID único no seu sistema.
pix_key *stringChave PIX do destinatário.
key_type *stringCPF, CNPJ, EMAIL, PHONE.
clientCallbackUrl *stringURL para notificação de status.
descriptionstringDescrição do saque.
gatewaystringGateway opcional.
curl -X POST 'https://api.vexuspay.com/api/withdrawals/withdraw' \
  --header 'Authorization: Bearer SEU_JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 25,
    "external_id": "saque-001",
    "pix_key": "cliente@email.com",
    "key_type": "EMAIL",
    "description": "Saque do usuário",
    "clientCallbackUrl": "https://seusistema.com/webhooks/withdraw"
  }'
{
  "message": "Withdrawal processed successfully.",
  "transactionId": "54345",
  "withdrawal": {
    "transaction_id": "54345",
    "external_id": "saque-001",
    "status": "PROCESSING",
    "amount": 25,
    "fee": 1.25,
    "total": 26.25,
    "type": "Withdrawal"
  }
}