Buscar Saques por Metadata
curl --request GET \
--url https://api.example.com/v1/withdrawals/search \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/v1/withdrawals/search"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://api.example.com/v1/withdrawals/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/withdrawals/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/withdrawals/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/withdrawals/search")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/withdrawals/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"status": true,
"data": [
{}
],
"data[].id": "<string>",
"data[].amount": 123,
"data[].status": "<string>",
"data[].metadata": {}
}Buscar Saques por Metadata
Pesquisar saques pelo conteúdo do campo metadata
GET
/
v1
/
withdrawals
/
search
Buscar Saques por Metadata
curl --request GET \
--url https://api.example.com/v1/withdrawals/search \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/v1/withdrawals/search"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://api.example.com/v1/withdrawals/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/withdrawals/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/withdrawals/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/withdrawals/search")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/withdrawals/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"status": true,
"data": [
{}
],
"data[].id": "<string>",
"data[].amount": 123,
"data[].status": "<string>",
"data[].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_idstring
required
Valor a buscar no campo de metadata especificado.Exemplo:
ORD-2024-001Resposta
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.
curl -X GET "https://api.linkagateway.com/v1/withdrawals/search?metadataKey=order_id&metadataValue=ORD-2024-001" \
-H "x-api-key: $API_KEY"
const apiKey = 'sk_live_...';
const params = new URLSearchParams({
metadataKey: 'order_id',
metadataValue: 'ORD-2024-001'
});
const response = await fetch(`https://api.linkagateway.com/v1/withdrawals/search?${params}`, {
headers: { 'x-api-key': apiKey }
});
const { data } = await response.json();
const apiKey = 'sk_live_...';
const params = new URLSearchParams({
metadataKey: 'order_id',
metadataValue: 'ORD-2024-001'
});
const response = await fetch(`https://api.linkagateway.com/v1/withdrawals/search?${params}`, {
headers: { 'x-api-key': apiKey }
});
const { data } = await response.json();
import requests
api_key = 'sk_live_...'
response = requests.get(
'https://api.linkagateway.com/v1/withdrawals/search',
headers={
'x-api-key': api_key
},
params={
'metadataKey': 'order_id',
'metadataValue': 'ORD-2024-001'
}
)
data = response.json()['data']
package main
import (
"fmt"
"net/http"
)
func main() {
apiKey := "sk_live_..."
req, _ := http.NewRequest("GET", "https://api.linkagateway.com/v1/withdrawals/search?metadataKey=order_id&metadataValue=ORD-2024-001", nil)
req.Header.Set("x-api-key", apiKey)
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
fmt.Println(resp.Status)
}
Exemplo de resposta
{
"status": true,
"data": [
{
"id": "clx1a2b3c4d5e6f7g8h9i0j",
"amount": 50000,
"status": "PAID",
"metadata": {"order_id": "ORD-2024-001"},
"createdAt": "2026-03-06T10:00:00.000Z"
}
]
}
Was this page helpful?