Skip to main content
GET
/
withdrawals
/
search
Buscar Saques por Metadata
curl --request GET \
  --url https://api.example.com/withdrawals/search \
  --header 'Authorization: <authorization>'
{
  "status": true,
  "data": [
    {}
  ],
  "data[].id": "<string>",
  "data[].amount": 123,
  "data[].status": "<string>",
  "data[].metadata": {}
}
Pesquisa saques do seller autenticado filtrando pelo conteudo 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.
​
Authorization
string
required
API Key no formato Bearer sk_live_... ou Bearer sk_test_...
​
metadataKey
string
required
Chave do campo dentro do objeto metadata a ser buscado.Exemplo: order_id
​
metadataValue
string
required
Valor a buscar no campo de metadata especificado.Exemplo: ORD-2024-001

​
Resposta

​
status
boolean
true quando a busca e executada com sucesso.
​
data
array
Array de saques que correspondem ao filtro de metadata.
​
data[].id
string
Identificador único do saque.
​
data[].amount
integer
Valor do saque em centavos.
​
data[].status
string
Status do saque.
​
data[].metadata
object
Metadados do saque.
curl -X GET "https://api.linka.com/withdrawals/search?metadataKey=order_id&metadataValue=ORD-2024-001" \
  -H "Authorization: Bearer <token>"

​
Exemplo de resposta

{
  "status": true,
  "data": [
    {
      "id": "clx1a2b3c4d5e6f7g8h9i0j",
      "amount": 50000,
      "status": "COMPLETED",
      "metadata": {"order_id": "ORD-2024-001"},
      "createdAt": "2026-03-06T10:00:00.000Z"
    }
  ]
}