Skip to main content
Volta no pedido, na consulta e na listagem. Todo campo está sempre presente: os anuláveis vêm null, nunca ausentes. pix_key_type e pix_key vêm null no saque por TED, que é o do split. A chave vem mascarada.
Este objeto não é o que chega no webhook withdrawal.paid. Lá o líquido se chama net_amount e o pedido, requested_at; aqui são net e created_at. Leia cada um com o seu próprio esquema.

Um saque. amount, fee e net são centavos inteiros, e sempre net = amount - fee. A chave PIX vem mascarada.

object
string
required
Allowed value: "withdrawal"
id
string
required
Example:

"wd_01k1y8d4h1g2f3e4d5c6b7a8z9"

status
enum<string>
required

O que cada status significa está em Saques.

Available options:
pending,
processing,
awaiting_approval,
approved,
paid,
failed,
canceled,
rejected
method
enum<string>
required

pix no bolsão, ted no split.

Available options:
pix,
ted
amount
integer<int64>
required

O que saiu do saldo.

currency
string
required
Allowed value: "BRL"
fee
integer<int64>
required

A taxa do saque, de dentro de amount.

net
integer<int64>
required

O que chega ao destino.

pix_key_type
enum<string> | null
required

null no saque por TED.

Available options:
cpf,
cnpj,
email,
phone,
random
pix_key
string | null
required

A chave de destino, mascarada. null no saque por TED.

Example:

"fi********@fornecedor.com.br"

failed_reason
string | null
required
created_at
string<date-time>
required
processed_at
string<date-time> | null
required