Cash Out via API

Cash Out via API é o caminho para a pessoa jurídica sacar pelo próprio sistema, com volume e IP conhecido. Não se mistura com as chaves de API e não herda os tetos do painel.

Só pessoa jurídica

Conta pessoa física não cria saque pela API. PF saca pelo painel, com teto diário e conferência da gestão a partir do valor configurado.

A API existe para quem realmente integra o gateway: ERP, plataforma própria, operação com tráfego contínuo e servidor com IP fixo.

Duas configurações diferentes

Onde	Para quê
Tokens da API	Autenticar a chamada (`Authorization: Bearer`). Não libera saque sozinho.
Cash Out → Cash Out via API	Whitelist de IP, `payout_method_id` e as regras deste caminho.

O que a API não herda do painel

Teto diário de pessoa física
Limite diário geral do painel
Conferência automática a partir de R$ 20 mil

Continua valendo: saldo disponível, tarifa do saque, chave PIX da empresa (CNPJ) e IP na whitelist.

Antes de chamar a API

Conta pessoa jurídica, com compliance aprovado.
Token criado em Tokens da API.
Chave PIX CNPJ da empresa cadastrada em Cash Out.
IP público do servidor na whitelist em Cash Out → Cash Out via API.

Sem whitelist, a API responde 403 com ip_not_allowed. Sem ser PJ, responde 403 com pf_api_payout_forbidden.

Criar o saque

POST /v1/payouts

curl -X POST https://api.apexpy.com.br/api/v1/payouts \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 15000.00,
    "payout_method_id": 12,
    "description": "Repasse operacional"
  }'

O payout_method_id aparece no painel, na seção Cash Out via API, depois que a chave PIX está cadastrada.

Veja o contrato completo em Criar Saques.

Erros deste caminho

Código	Quando
`pf_api_payout_forbidden`	A conta é pessoa física.
`ip_not_allowed`	O IP de origem não está na whitelist, ou a lista está vazia.
`invalid_pix_key_type` / `pix_key_ownership`	A chave não é CPF/CNPJ da própria empresa.

Painel versus API

	Painel	API
Quem usa	PF e PJ	Só PJ
Teto diário / conferência por valor	Sim	Não
Whitelist de IP	Não	Obrigatória
Saldo, tarifa e titularidade PIX	Sim	Sim