ApexPy Docs · v1
Dashboard API Keys

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 Sim ID do método de saque cadastrado no dashboard. Consulte os métodos disponíveis no Seller Dashboard em "Cash Out" > "Métodos de Saque".
description string Não Descrição opcional do saque (máx: 255 caracteres)

Exemplo de Requisição

curl -X POST https://api.apexpy.com.br/api/v1/payouts \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100.5,
    "payout_method_id": 1,
    "description": "Saque para minha conta"
}'
const res = await fetch("https://api.apexpy.com.br/api/v1/payouts", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "amount": 100.5,
    "payout_method_id": 1,
    "description": "Saque para minha conta"
}),
});
const data = await res.json();
console.log(data);
<?php
$ch = curl_init("https://api.apexpy.com.br/api/v1/payouts");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_SECRET_KEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode({
    "amount": 100.5,
    "payout_method_id": 1,
    "description": "Saque para minha conta"
}),
]);
print_r(json_decode(curl_exec($ch), true));
import requests

resp = requests.request(
    "POST",
    "https://api.apexpy.com.br/api/v1/payouts",
    headers={
        "Authorization": "Bearer YOUR_SECRET_KEY",
        "Content-Type": "application/json",
    },
    json={
    "amount": 100.5,
    "payout_method_id": 1,
    "description": "Saque para minha conta"
},
)
print(resp.json())

Exemplo de Resposta

{
  "success": true,
  "data": {
    "id": "co_n4hpw7zqr2xs",
    "status": "pending",
    "amount": 10050,
    "fee_amount": 399,
    "fee_fixed": 0,
    "fee_variable": 3.99,
    "net_amount": 9651,
    "currency": "BRL",
    "payout_method": {
      "id": 1,
      "type": "pix"
    },
    "created_at": "2025-11-28T20:30:00-03:00",
    "updated_at": "2025-11-28T20:30:00-03:00"
  }
}

Validações

  • O valor deve ser maior que zero e não pode exceder o saldo disponível
  • É necessário ter um método de saque cadastrado no dashboard
  • Via API: só pessoa jurídica, com IP na whitelist. Os tetos do painel não se aplicam. Veja Cash Out via API.
  • Compliance: Apenas chaves PIX CPF/CNPJ do próprio seller são permitidas (Dashboard e API)
  • Chave PIX: Deve estar cadastrada previamente no dashboard
  • Titularidade: A chave PIX deve corresponder ao CPF/CNPJ cadastrado no perfil do seller

Segurança e Compliance

Importante - Política de Compliance:

Por questões de Compliance e segurança regulatória, todas as operações de Cash-out (saques e transferências) são realizadas exclusivamente para a chave PIX vinculada ao cadastro do seller/empresa.

Esta medida é fundamental para:

  • Prevenir lavagem de dinheiro e financiamento ilícito
  • Garantir a rastreabilidade das operações financeiras
  • Cumprir as exigências do Banco Central do Brasil e demais órgãos reguladores
  • Proteger tanto o seller quanto a plataforma de fraudes e operações irregulares
  • Assegurar que os recursos sejam transferidos apenas para o titular da conta verificado

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 - Apenas chaves PIX cadastradas do próprio seller (CPF/CNPJ)
  • 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
  • Bloqueio automático - Tentativas de saque para chaves de terceiros são bloqueadas

Saiba mais sobre segurança e compliance