Skip to main content
GET
Buscar saque por ID
GET /withdrawals/:id Faz parte do recurso Saques — os estados e o fluxo de aprovação estão lá. Devolve o saque completo, incluindo o statusHistory — a trilha de cada mudança de estado, com quem a fez e quando.
O statusHistory é onde está o “por quê”. Cada entrada traz status, changedBy, changedAt e reason. Num saque rejected ou failed, é a reason da última entrada que explica — o objeto raiz não tem campo de motivo.
paidAt é o que confirma o dinheiro. Enquanto ele for nulo, o saque não chegou à conta, mesmo que o status já tenha avançado. É o campo a observar em conciliação.
Você não precisa ficar consultando. Três eventos cobrem o ciclo — withdrawal.requested, withdrawal.paid e withdrawal.rejected. Assine-os em Webhooks e use esta rota para o detalhe, não para descobrir que algo mudou.Repare que não há evento para approved, processing, cancelled nem failed: entre o pedido e o desfecho, o silêncio é esperado.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID do saque

Response

Dados do saque

id
string

Identificador único do registro.

amount
integer

Valor bruto em centavos

currency
string

Moeda no padrão ISO 4217 (ex.: BRL).

fee
integer

Taxa em centavos

netAmount
integer

Valor líquido (amount - fee) em centavos

status
string

Situação do saque. Valores: requested, approved, processing, paid, cancelled, rejected, failed.

bankAccountId
string | null

ID da conta bancária de destino do saque.

paidAt
string<date-time> | null

Data e hora em que o pagamento foi liquidado (ISO 8601).

statusHistory
object[] | null

Histórico de mudanças de status do saque.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).