Skip to main content
GET
Listar Saques
Retorna uma lista paginada dos seus saques com suporte a múltiplos filtros.
string
required
Sua API Key (sk_live_...). Veja Autenticacao.
number
default:"10"
Quantidade de registros por página. Max recomendado: 100.
number
default:"0"
Número de registros a pular. Deve ser maior ou igual a 0.
string
Filtrar por status. Valores: PENDING, APPROVED, REJECTED, PROCESSING, PAID, FAILED, REFUNDED, CANCELED, BLOCKED.
string
Filtrar por método. Valor atual: PIX.
string
ID interno do saque para filtrar um registro específico.
string
Data inicial no formato YYYY-MM-DD. Filtra saques criados a partir desta data (inclusivo).Exemplo: 2024-01-01
string
Data final no formato YYYY-MM-DD. Filtra saques criados até esta data (inclusivo).Exemplo: 2024-03-31
number
Valor mínimo do saque em centavos.Exemplo: 5000 (R$ 50,00)
number
Valor máximo do saque em centavos.Exemplo: 500000 (R$ 5.000,00)
string
Chave do campo de metadata para busca. Use com metadataValue.
string
Valor do metadata a buscar. Suporta busca por substring.
Termo de busca geral. Pesquisa por ID, referência externa, end-to-end ID ou chave PIX.
boolean
default:"false"
Quando true, retorna o resultado como arquivo CSV para download.

Resposta

boolean
true quando a lista é retornada com sucesso.
array
Array de saques (cada item com id, amount, method, status, datas e valores de tarifa, quando aplicável).
integer
Total de saques que correspondem aos filtros.
integer
Tamanho de página aplicado.
integer
Offset aplicado.

Exemplo de resposta