Skip to main content
GET
Buscar Saques por Metadata
Pesquisa seus saques filtrando pelo conteúdo do campo metadata. Retorna todos os saques cujo metadata contenha a chave e o valor informados. Quando a chave PIX for CPF ou CNPJ, o resultado inclui informações do cliente vinculado.
string
required
Sua API Key (sk_live_...). Veja Autenticacao.
string
required
Chave do campo dentro do objeto metadata a ser buscado.Exemplo: order_id
string
required
Valor a buscar no campo de metadata especificado.Exemplo: ORD-2024-001

Resposta

boolean
true quando a busca é executada com sucesso.
array
Array de saques que correspondem ao filtro de metadata.
string
Identificador único do saque.
integer
Valor do saque em centavos.
string
Status do saque.
object
Metadados do saque.

Exemplo de resposta