Listar Saques
curl --request GET \
--url https://api.example.com/api/v1/cobranca/withdrawals \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/api/v1/cobranca/withdrawals"
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/api/v1/cobranca/withdrawals', 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/api/v1/cobranca/withdrawals",
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/api/v1/cobranca/withdrawals"
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/api/v1/cobranca/withdrawals")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cobranca/withdrawals")
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": [
{}
],
"data.count": 123,
"data.take": 123,
"data.skip": 123
}Listar Saques
Listar seus saques com paginação e filtros
GET
/
api
/
v1
/
cobranca
/
withdrawals
Listar Saques
curl --request GET \
--url https://api.example.com/api/v1/cobranca/withdrawals \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/api/v1/cobranca/withdrawals"
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/api/v1/cobranca/withdrawals', 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/api/v1/cobranca/withdrawals",
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/api/v1/cobranca/withdrawals"
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/api/v1/cobranca/withdrawals")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cobranca/withdrawals")
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": [
{}
],
"data.count": 123,
"data.take": 123,
"data.skip": 123
}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-01string
Data final no formato
YYYY-MM-DD. Filtra saques criados até esta data (inclusivo).Exemplo: 2024-03-31number
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.
string
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.
curl -X GET "https://api.linkagateway.com/api/v1/cobranca/withdrawals?take=20&status=PAID&startDate=2024-01-01" \
-H "x-api-key: $API_KEY"
const apiKey = 'sk_live_...';
const params = new URLSearchParams({
take: '20',
status: 'PAID',
startDate: '2024-01-01'
});
const response = await fetch(`https://api.linkagateway.com/api/v1/cobranca/withdrawals?${params}`, {
headers: { 'x-api-key': apiKey }
});
const { data } = await response.json();
const apiKey = 'sk_live_...';
const params = new URLSearchParams({
take: '20',
status: 'PAID',
startDate: '2024-01-01'
});
const response = await fetch(`https://api.linkagateway.com/api/v1/cobranca/withdrawals?${params}`, {
headers: { 'x-api-key': apiKey }
});
const { data } = await response.json();
import requests
api_key = 'sk_live_...'
response = requests.get(
'https://api.linkagateway.com/api/v1/cobranca/withdrawals',
headers={
'x-api-key': api_key
},
params={
'take': 20,
'status': 'PAID',
'startDate': '2024-01-01'
}
)
data = response.json()['data']
package main
import (
"fmt"
"net/http"
)
func main() {
apiKey := "sk_live_..."
req, _ := http.NewRequest("GET", "https://api.linkagateway.com/api/v1/cobranca/withdrawals?take=20&status=PAID&startDate=2024-01-01", 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": {
"data": [
{
"id": "clx1a2b3c4d5e6f7g8h9i0j",
"amount": 50000,
"method": "PIX",
"status": "PAID",
"createdAt": "2026-03-06T10:00:00.000Z"
}
],
"count": 1,
"take": 20,
"skip": 0
}
}
Was this page helpful?