Skip to main content
POST
Criar saque

Authorizations

Authorization
string
header
required

Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.

Body

application/json
type
enum<string>
required
Available options:
pix
wallet_id
string<uuid>
required

ID da carteira

amount
integer
required

Valor em centavos

Required range: x >= 1
idempotency_key
string
required

Chave de idempotência

Maximum string length: 255
pix_key
string
required

Chave PIX

Maximum string length: 255
pix_key_type
enum<string>
required

Tipo da chave PIX

Available options:
cpf,
cnpj,
email,
phone,
random
submerchant_id
string<uuid>

ID do submerchant (opcional, para saques em nome de um submerchant)

transaction_pin
string

PIN de transação (4 dígitos). Obrigatório quando o merchant tem PIN habilitado

Pattern: ^\d{4}$
holder_document_type
enum<string>

Tipo do documento do titular da chave PIX. Obrigatório via API quando a chave PIX é do tipo email, phone ou random

Available options:
cpf,
cnpj
holder_document_number
string

Número do documento do titular (CPF ou CNPJ, apenas dígitos). Obrigatório via API quando a chave PIX é do tipo email, phone ou random

Required string length: 11 - 14

Response

Saque solicitado com sucesso

success
boolean
Example:

true

message
string
data
object