Cash Out

Iniciar Cashout PIX

POST/v1/cashout

Cria uma nova transação de cashout (saque) via PIX, transferindo fundos para uma chave PIX de destino.

Parâmetros

Campo	Tipo	Descrição
`external_id`	`string`	Sua referência interna para o cashout.
`pix_key`obrigatório	`string`	Chave PIX de destino. Deve estar no formato correto conforme pix_type.
`pix_type`obrigatório	`PixKeyType`	Tipo da chave PIX: CPF, CNPJ, EMAIL, PHONE ou RANDOM.
`amount`obrigatório	`number`	Valor do cashout em BRL. Mínimo: R$ 0,01.
`webhook_url`	`string`	URL para receber notificações de atualização de status.

Formatos de Chave PIX

Tipo	Formato	Exemplo
`CPF`	11 dígitos numéricos	`12345678901`
`CNPJ`	14 dígitos numéricos	`12345678000195`
`EMAIL`	Endereço de email válido	`usuario@exemplo.com`
`PHONE`	+55 seguido de 10-11 dígitos	`+5511999999999`
`RANDOM`	UUID (32-36 caracteres)	`123e4567-e12b-12d3-a456-426614174000`

A chave PIX deve corresponder exatamente ao tipo especificado em pix_type. Uma inconsistência resultará em erro 400.

Erros Possíveis

400Chave PIX inválida ou incompatível com o tipo informado

400Valor abaixo do mínimo permitido (R$ 0,01)

400Saldo insuficiente para o cashout

401API Secret ausente ou inválido

POSThttps://api.genesys.finance/v1/cashout

Headers

api-secret: seu_api_secret_aqui
Content-Type: application/json

Request Body (JSON)

{
  "external_id": "saque_12345",
  "pix_key": "joao.silva@exemplo.com",
  "pix_type": "EMAIL",
  "amount": 250.00,
  "webhook_url": "https://sua-api.com/webhooks/cashouts"
}

cURL

curl -X POST "https://api.genesys.finance/v1/cashout" \
  -H "api-secret: seu_api_secret_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "pix_key": "joao.silva@exemplo.com",
    "pix_type": "EMAIL",
    "amount": 250.00
  }'

Response 200

{
  "success": true,
  "message": "Cashout criado com sucesso",
  "data": {
    "withdraw_id": "bb0fb3cb-015f-4604-8532-133a78c0c3e1",
    "cashout_id": "bb0fb3cb-015f-4604-8532-133a78c0c3e1",
    "is_pending": true
  }
}