Skip to main content
POST
/
withdrawals
Solicitar Saque
curl --request POST \
  --url https://api.example.com/withdrawals \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "amount": 123,
  "pix_key": "<string>",
  "pix_key_type": "<string>",
  "description": "<string>"
}
'
{
  "id": "wd_flare_a1b2c3d4e5f6a7b8c9d0e1f2",
  "object": "withdrawal",
  "amount": 100.00,
  "fee": 1.90,
  "net_amount": 98.10,
  "currency": "BRL",
  "status": "processing",
  "destination": {
    "type": "pix",
    "pix_key_type": "cpf",
    "pix_key_masked": "123***00"
  },
  "created_at": "2026-03-05T18:14:48.552Z",
  "livemode": true
}

Descrição

Solicita um saque via PIX para a chave informada. O valor mínimo é R30,00</strong>eumataxade<strong>R 30,00</strong> e uma taxa de <strong>R 1,90 é descontada do valor sacado.
Diferente das cobranças, o campo amount em saques é em Reais (não em centavos). Por exemplo, 100.00 = R$ 100,00.
Rate Limit: 30 requisições/minuto

Headers

Authorization
string
required
Bearer token de autenticação. Formato: Bearer flare_xxx
Content-Type
string
required
Deve ser application/json
X-Idempotency-Key
string
Chave única para evitar saques duplicados

Body

amount
float
required
Valor em Reais (mínimo 30.00)
pix_key
string
required
Chave PIX de destino
pix_key_type
string
required
Tipo da chave: cpf, cnpj, email, phone, random
description
string
Descrição do saque

Exemplo de Requisição

curl -X POST https://api.flarepayments.com/v1/withdrawals \
  -H "Authorization: Bearer flare_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -H "X-Idempotency-Key: saque-mensal-marco-2026" \
  -d '{
    "amount": 100.00,
    "pix_key": "12345678900",
    "pix_key_type": "cpf",
    "description": "Saque mensal"
  }'

Resposta 201 Created

id
string
ID do saque no formato wd_flare_xxx
object
string
Sempre "withdrawal"
amount
float
Valor solicitado em Reais
fee
float
Taxa cobrada (R$ 1,90)
net_amount
float
Valor líquido após taxa
currency
string
Moeda (BRL)
status
string
Status: processing, paid, failed
destination
object
Dados do destino
created_at
string
Data de criação (ISO 8601)
livemode
boolean
true em produção
{
  "id": "wd_flare_a1b2c3d4e5f6a7b8c9d0e1f2",
  "object": "withdrawal",
  "amount": 100.00,
  "fee": 1.90,
  "net_amount": 98.10,
  "currency": "BRL",
  "status": "processing",
  "destination": {
    "type": "pix",
    "pix_key_type": "cpf",
    "pix_key_masked": "123***00"
  },
  "created_at": "2026-03-05T18:14:48.552Z",
  "livemode": true
}

Mascaramento da Chave PIX

Por segurança, a chave PIX é mascarada na resposta:
TipoFormato mascarado
emailjo***@email.com
cpf123***00
cnpj123***00
phone123***00
randomabcd***efgh

Erros

StatusCódigoDescrição
400invalid_amountValor deve ser positivo
400missing_pix_keypix_key e pix_key_type são obrigatórios
400invalid_pix_key_typeTipo inválido. Aceitos: cpf, cnpj, email, phone, random
400below_minimumValor abaixo do mínimo de R$ 30,00
400insufficient_balanceSaldo insuficiente (retorna available_balance)
400fee_exceeds_amountTaxa maior que o valor solicitado
429rate_limit_exceededLimite de 30 req/min excedido