Skip to main content

​
Criar Solicitação de Saque

Este endpoint permite que você solicite a transferência do seu saldo disponível para uma conta externa. POST /api/withdraws

​
Corpo da Requisição

{
  "amountCents": 50000,
  "pixKey": "123.456.789-00",
  "pixKeyType": "cpf",
  "description": "Retirada de lucros Janeiro",
  "providerId": "provider-uuid",
  "methodId": "method-uuid"
}

​
Definição dos Campos

CampoTipoDescriçãoObrigatório
amountCentsnumberValor em centavos. Mínimo 100 (R$ 1,00).Sim
pixKeystringChave PIX de destino.Sim
pixKeyTypestringTipo da chave: cpf, cnpj, email, phone, random.Sim
descriptionstringDescrição opcional para controle interno.Não
providerIdstringID do provedor BaaS (opcional).Não
methodIdstringID do método de saque (opcional).Não

​
Resposta de Sucesso (201 Created)

{
  "id": "withdraw-uuid-123",
  "amount": 500.00,
  "amountCents": 50000,
  "status": "PENDING",
  "pixKey": "123.456.789-00",
  "pixKeyType": "cpf",
  "expectedArrival": "2024-01-16T15:00:00Z",
  "createdAt": "2024-01-15T10:30:00Z"
}

​
Limites e Segurança

  • KYC: O usuário deve ter o processo de KYC (Know Your Customer) aprovado.
  • Saldo: O valor solicitado deve ser menor ou igual ao saldo disponível.
  • Rate Limit: Este endpoint possui limites estritos para evitar abusos.
  • Segurança: Saques de alto valor podem entrar em análise manual pela equipe de risco.