Skip to main content
GET
Consultar Saque

Descrição

Retorna os dados completos de um saque, incluindo status, chave PIX mascarada e taxa. Use para acompanhar o saque quando o webhook não chegar.

Parâmetros de Path

string
required
UUID do saque, devolvido na criação

Headers

string
default:"Bearer YOUR_API_KEY"
required
Bearer token de autenticação. Formato: Bearer YOUR_API_KEY

Exemplo de Requisição


Resposta 200 OK

string
UUID do saque.
string
Status atual: pending, processing, completed ou failed.
integer
Valor do saque em centavos (o que saiu do saldo).
integer
Taxa do saque, em centavos.
string
Descrição do saque.
string
Tipo da chave PIX: cpf, cnpj, phone, email ou random.
string
Chave PIX de destino mascarada.
string | null
Motivo da falha, só quando status é failed.
string
Data de criação em ISO 8601.
string | null
Data de conclusão em ISO 8601, ou null.
string | null
Data da falha em ISO 8601, ou null.
string
Sempre "brl".

Erros