Skip to main content
GET
Consultar saque
Para saber que o saque caiu, o webhook withdrawal.paid dispensa consultar em laço. A consulta é o caminho para os desfechos sem evento: failed, canceled e rejected. Ver Saques.

Authorizations

Authorization
string
header
required

Chave secreta do vendedor, criada no painel em Desenvolvedores.

O valor em claro existe uma única vez, na criação. Guardamos só o hash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto: um dump do nosso banco não permite cobrar em nome de ninguém.

A chave vai no servidor. Colocá-la no navegador do comprador a entrega a qualquer pessoa que abra a página.

Path Parameters

code
string
required

Código público do saque, no formato wd_….

Pattern: ^wd_[0-9a-z]{26}$

Response

O saque.

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