Skip to main content

​
Criar saque

POST /v1/payouts 
{
  "amount_cents": 3000,
  "external_id": "saque-99",
  "pix_key": "player@pix.io",
  "pix_key_type": "email",
  "recipient": { "name": "Player Um", "document": "11144477735" },
  "kind": "PLAYER_PAYOUT"
}
  • O saldo é debitado atomicamente na criação (valor + taxa). Sem saldo → 422 INSUFFICIENT_FUNDS.
  • kind: PLAYER_PAYOUT (saque de player) ou SETTLEMENT (saque do seu próprio saldo).
  • Idempotência por external_id.
Se a sua conta estiver com auto-aprovação ligada (padrão), o saque vai direto ao provedor e fica PROCESSING até liquidar. Senão, fica PENDING aguardando aprovação do operador.

​
Estados

PENDING → PROCESSING → PAID · ou → FAILED/REJECTED (o valor é estornado ao saldo).
Um 504 PROVIDER_TIMEOUT na criação não estorna automaticamente — o PIX pode ter saído. O saque fica PROCESSING e é resolvido pelo webhook do provedor. Nunca refaça um saque por timeout sem antes consultar o status.

​
Consultar

GET /v1/payouts/{id}
GET /v1/payouts?status=PROCESSING