Skip to main content
POST
Solicitar saque
Solicita um saque do saldo available para uma chave PIX.

Obrigatório

amount (mínimo 50 centavos), pixKey e pixKeyType. A taxa é calculada automaticamente conforme o contrato do merchant.
Exemplo:
Resposta:
A resposta é enxuta — não devolve pixKey/pixKeyType (você já os enviou). Para ver todos os detalhes depois, use GET /withdrawals/{id}.

Só um saque por vez

Você só pode ter um saque em andamento (PENDING ou PROCESSING) por merchant. Uma nova solicitação enquanto houver um em curso retorna 400 — aguarde a conclusão (ou falha) do saque atual antes de solicitar outro.

Erros possíveis

O saque retorna imediatamente com status PENDING. O processamento real é assíncrono — acompanhe o resultado via GET /withdrawals/{id} ou pelos webhooks WITHDRAWAL_COMPLETED / WITHDRAWAL_FAILED.

Authorizations

Authorization
string
header
required

Autentique suas requisições enviando o token no header Authorization: Bearer <token>.

O token pode ser:

Não há distinção de ambiente — toda chave vale para o único ambiente disponível (produção).

Body

application/json
amount
integer
required

Valor do saque em centavos (mínimo 50 = R$ 0,50, máximo 100.000.000 = R$ 1.000.000,00).

Required range: 50 <= x <= 100000000
Example:

5000

pixKey
string
required

Chave PIX que receberá o saque.

Required string length: 1 - 140
Example:

"pagamentos@minhaloja.com"

pixKeyType
enum<string>
required

Tipo da chave PIX:

  • CPF: CPF (apenas dígitos)
  • CNPJ: CNPJ (apenas dígitos)
  • EMAIL: e-mail válido
  • TELEFONE: celular no formato +5511999999999
  • CHAVE_ALEATORIA: chave aleatória (UUID/EVP)
Available options:
CPF,
CNPJ,
EMAIL,
TELEFONE,
CHAVE_ALEATORIA
Example:

"EMAIL"

description
string

Texto livre para sua referência.

Maximum string length: 140
Example:

"Repasse semanal"

taxId
string

CPF/CNPJ do destinatário da chave PIX (opcional).

Maximum string length: 18
Example:

"12345678900"

Response

Saque criado e enfileirado para processamento.

data
object
required

Shape retornado por POST /withdrawals. Não inclui pixKey/pixKeyType — consulte com GET /withdrawals/{id} os dados que você mesmo enviou, se precisar.

error
null
required
Example:

null

success
enum<boolean>
required
Available options:
true
Example:

true