PIX OUT – Solicitar Saque
Use este endpoint para enviar fundos via PIX da sua conta para o cliente ou parceiro.
Informe o valor, a chave de destino e, se quiser, um código seu para rastrear a operação.
⚠️ Importante: Valores em Centavos
Todos os valores monetários (amount) devem ser enviados em centavos como números inteiros.
Exemplos:
- R$ 10,00 =
1000 - R$ 99,99 =
9999 - R$ 100,50 =
10050
❌ NÃO use: 99.99, 10.00, valores negativos
✅ USE: 9999, 1000 (sempre inteiros)
Dados Obrigatórios
amount: Valor total do saque em centavos (ex: R$ 100,00 =10000)pixKey: Chave PIXpixKeyType: "Tipo da Chave PIX
Dados Opcionais
webhookUrl: URL HTTPS para notificaçõesexternalCode: Seu código de referênciaidempotencyKey: Chave para evitar duplicatas
Como Testar
Autenticação
- Abra o Swagger e clique em "Authorize"
- Insira suas credenciais:
- Authorization: Seu bearer token
Executar Teste
- Selecione o endpoint POST /withdraw
- Clique em "Try it out"
- Ajuste o corpo da requisição conforme necessário
- Clique em "Execute"
Verificar Resposta
- Verifique o status e corpo da resposta
- Em caso de sucesso, você receberá o status 201
✅ Exemplo de Resposta Bem-Sucedida
{
"id": "553e8400-e29b-41d4-a716-436251480000",
"externalCode": "SAQUE-123",
"amount": 1000,
"status": "PENDING"
}
❌ Possíveis Erros
- 401 Unauthorized: Credenciais inválidas
- 403 Forbidden: Sem permissão/autorização
- 422 Unprocessable Entity: Dados inválidos ou faltando e validações
- 429 Too Many Requests: Muitas requisições
- 500 Internal Server Error: Erro no processamento (Contate o Suporte)
📚 Recursos Relacionados
- Visão Geral - Introdução à API
- Webhooks PIX OUT - Notificações automáticas
- Lista de Erros - Códigos e mensagens de erro