Criar Saque

Crie solicitações de saque via PIX para transferir seu saldo disponível para sua conta bancária.

Endpoint

POST /v1/payouts

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`amount`	number	Sim	Valor do saque em reais (ex: 100.50). O valor será convertido para centavos internamente.
`payout_method_id`	integer	Não	ID do método de saque cadastrado (usa o padrão se omitido)

Exemplo de Requisição (Método Cadastrado)

curl -X POST https://api.apexpy.com.br/v1/payouts \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100.50,
    "payout_method_id": 1,
    "description": "Saque para minha conta"
  }'

Exemplo de Requisição (Chave PIX Dinâmica)

Para fazer repasses/pagamentos para diferentes chaves PIX sem cadastrar antes:

curl -X POST https://api.apexpy.com.br/v1/payouts \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 150.00,
    "pix_key_type": "CPF",
    "pix_key_value": "12345678909",
    "description": "Repasse para vendedor #12345"
  }'

Saiba mais sobre chaves PIX dinâmicas

Exemplo de Resposta

{
  "success": true,
  "data": {
    "id": "co_123",
    "status": "pending",
    "amount": 10050,
    "currency": "BRL",
    "created_at": "2025-11-28T20:30:00Z"
  }
}

Validações

O valor deve ser maior que zero
O valor não pode exceder o saldo disponível (sistema de lastro)
É necessário ter um método de saque cadastrado
Via API: IP whitelist obrigatória (veja Segurança)
Via Dashboard: Apenas chaves PIX CPF/CNPJ do próprio seller são permitidas

Segurança

Para garantir segurança e compliance, implementamos várias camadas de proteção:

IP Whitelist obrigatória para saques via API
Validação de chave PIX - No dashboard, apenas CPF/CNPJ do seller
Sistema de lastro - Verificação automática de saldo antes de processar
Logs de compliance - Todos os saques são registrados com informações completas

Saiba mais sobre segurança e compliance