Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer

Headers

x-subaccount-id
string<uuid>

ID da subconta onde a operação será realizada. Quando fornecido, a operação será executada no contexto desta subconta específica.

Body

application/json

Payload para criação de um novo saque. O tipo de saque determina a estrutura específica dos dados necessários.

withdrawalMethod
enum<string>
required

Método de pagamento que terá o saldo debitado

Available options:
pix
amount
integer
required

Valor do saque em centavos. O valor mínimo para saque é 100 (R$ 1,00)

Required range: x >= 100
Example:

10000

bankAccountId
integer
required

ID da conta bancária que receberá o saque

Example:

1234567890

pixKeyType
enum<string>
required

Tipo da chave PIX

Available options:
DOCUMENT_CPF,
DOCUMENT_CNPJ,
EMAIL,
PHONE,
RANDOM
Example:

"CPF"

pixKey
string
required

Chave PIX

Example:

"1234567890"

postbackUrl
string

URL de callback para recebimento de notificações de saque

Example:

"https://example.com/callback"

Response

Saque solicitado com sucesso

data
object
message
string
Example:

"Saque solicitado com sucesso"