Skip to main content
POST

Authorizations

X-Public-Key
string
header
required

Sua chave pública de acesso à API. Ex: pk_live_abc123def456...

X-Secret-Key
string
header
required

Sua chave secreta de acesso à API. Ex: sk_live_xyz789ghi012...

Body

application/json
amount
integer
required

Valor do saque em centavos. Mínimo: 1000 (R$ 10,00).

Example:

50000

key_value
string
required

Valor da chave PIX de destino. O formato deve corresponder ao key_type informado.

Example:

"12345678909"

key_type
enum<string>
default:cpf

Tipo da chave PIX de destino. Se omitido, assume cpf como padrão.

Available options:
cpf,
cnpj,
email,
phone,
random
discount_fee
boolean
default:true

Define como a taxa de saque é aplicada. Com true (padrão), a taxa é descontada do valor transferido (liquid_amount = amount - taxas). Com false, a taxa é acrescentada ao total debitado da conta e o destinatário recebe exatamente o amount solicitado (liquid_amount = amount).

Response

Saque solicitado com sucesso

success
boolean

Indica se a operação foi bem-sucedida.

message
string

Mensagem descritiva do resultado.

data
object