Skip to main content
POST
Criar um saque via PIX

Autorizações

Authorization
string
header
obrigatório

Access token obtido no POST /auth (client_id + client_secret). Válido por 300 segundos.

Cabeçalhos

Idempotency-Key
string

Chave única do cliente (8-255 chars) que torna a requisição idempotente. Retentativas com a mesma chave retornam a resposta cacheada (TTL 24h). Mesma chave com body diferente retorna 422.

Required string length: 8 - 255

Corpo

application/json

Dados para criar um saque via PIX. Informe exatamente um entre amount (valor bruto debitado do saldo) ou netAmount (valor líquido que o destinatário deve receber).

pixKey
string
obrigatório

Chave PIX do destinatário.

Exemplo:

"12345678901"

pixKeyType
enum<string>
obrigatório

Tipo da chave PIX.

Opções disponíveis:
cpf,
cnpj,
email,
phone,
random
Exemplo:

"cpf"

holderName
string
obrigatório

Nome do titular da conta PIX.

Exemplo:

"João da Silva"

holderDocument
string
obrigatório

CPF ou CNPJ do titular.

Exemplo:

"12345678901"

holderDocumentType
enum<string>
obrigatório

Tipo do documento do titular.

Opções disponíveis:
cpf,
cnpj
Exemplo:

"cpf"

amount
number

Valor bruto em BRL debitado do saldo. O destinatário recebe amount - feeAmount. Mínimo R$ 1,00. Informe amount OU netAmount — nunca os dois.

Intervalo obrigatório: x >= 1
Exemplo:

150.75

netAmount
number

Valor líquido em BRL que o destinatário deve receber. A API calcula o gross necessário (gross = netAmount + feeAmount) e debita esse total do saldo. Mínimo R$ 1,00. Informe amount OU netAmount — nunca os dois.

Intervalo obrigatório: x >= 1
Exemplo:

150

externalReference
string

Seu ID de referência externa (opcional). É devolvido no response e nos webhooks withdrawal_completed e withdrawal_failed para facilitar a reconciliação com seus sistemas internos.

Maximum string length: 255
Exemplo:

"saque-empresa-001"

Resposta

Saque criado com sucesso

Dados do saque criado.

id
string<uuid>
obrigatório

ID do saque

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

amount
number
obrigatório

Valor do saque em BRL

Exemplo:

150.75

feeAmount
number
obrigatório

Valor da taxa em BRL

Exemplo:

2.5

netAmount
number
obrigatório

Valor líquido em BRL

Exemplo:

148.25

status
enum<string>
obrigatório

Status do saque

Opções disponíveis:
pending,
processing,
completed,
failed
Exemplo:

"completed"

snapshotHolderName
string
obrigatório

Nome do titular no momento do saque

Exemplo:

"João da Silva"

snapshotHolderDocument
string
obrigatório

Documento do titular no momento do saque

Exemplo:

"12345678901"

createdAt
string<date-time>
obrigatório

Data de criação

Exemplo:

"2026-02-10T14:30:00.000Z"

snapshotPixKey
string | null

Chave PIX usada no momento do saque

Exemplo:

"12345678901"

snapshotPixKeyType
enum<string> | null

Tipo da chave PIX usada no momento do saque

Opções disponíveis:
cpf,
cnpj,
email,
phone,
random
Exemplo:

"cpf"

failureReason
string | null

Motivo da falha (quando status = failed)

Exemplo:

null

pspReference
string | null

Referência do PSP (provedor de pagamento)

Exemplo:

null

processedAt
string<date-time> | null

Data de processamento

Exemplo:

"2026-02-10T14:30:01.000Z"

externalReference
string | null

Sua referência externa enviada na criação do saque (opcional)

Exemplo:

"saque-empresa-001"