Listar Transações
curl --request GET \
--url https://api.example.com/api/v1/cobranca/transactions \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/api/v1/cobranca/transactions"
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/transactions', 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/transactions",
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/transactions"
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/transactions")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cobranca/transactions")
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{
"items": [
{}
],
"total": 123,
"limit": 123,
"offset": 123
}Listar Transações
Listar suas transações com paginação e filtros
GET
/
api
/
v1
/
cobranca
/
transactions
Listar Transações
curl --request GET \
--url https://api.example.com/api/v1/cobranca/transactions \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/api/v1/cobranca/transactions"
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/transactions', 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/transactions",
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/transactions"
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/transactions")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cobranca/transactions")
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{
"items": [
{}
],
"total": 123,
"limit": 123,
"offset": 123
}Retorna uma lista paginada das suas transações.
A resposta vem no envelope
{status, data} — o objeto de listagem fica em data.string
required
Sua API Key (
sk_live_...). Veja Autenticacao.number
default:"50"
Número de transações por página. Intervalo: 1 a 500.
number
default:"0"
Número de transações a pular (offset).
string
Filtro por status. Valores:
PENDING, WAITING_PAYMENT, PROCESSING, AUTHORIZED, PAID, REFUSED, FAILED, EXPIRED, REFUNDED, PARTIALLY_REFUNDED, CHARGEDBACK, DISPUTE, BLOCKED, PENDING_REVIEW.string
Filtro por método de pagamento. Valor atual:
PIX.string
Data/hora inicial (ISO 8601, ex:
2026-05-01T00:00:00Z). Filtra transações criadas a partir deste momento (inclusivo).string
Data/hora final (ISO 8601, ex:
2026-05-05T23:59:59Z). Filtra transações criadas até este momento (inclusivo).Resposta
array
Array de transações. Cada item tem exatamente o mesmo formato do objeto retornado
por Buscar Transação — incluindo
description, merchantOrderId, postbackUrl, metadata, pix, end2endId,
feeAmount, netAmount, refundedAmount e refundType.Campos opcionais são omitidos quando não há valor — não vêm como null.integer
Total de transações que correspondem aos filtros.
integer
Tamanho de página aplicado.
integer
Offset aplicado.
curl -X GET "https://api.linkagateway.com/api/v1/cobranca/transactions?limit=20&status=PAID&paymentMethod=PIX" \
-H "x-api-key: <API_KEY>"
const params = new URLSearchParams({ limit: '20', status: 'PAID', paymentMethod: 'PIX' });
const response = await fetch(`https://api.linkagateway.com/api/v1/cobranca/transactions?${params}`, {
headers: { 'x-api-key': apiKey }
});
const { data } = await response.json();
type ListTransactionsResponse = {
status: boolean;
data: {
// cada item tem o mesmo formato de GET /transactions/:id
items: Array<{
id: string; amount: number; paymentMethod: string; status: string;
createdAt: string; updatedAt: string; providerReference: string;
paidAt?: string; customer?: object; metadata?: object;
description?: string; merchantOrderId?: string; postbackUrl?: string;
pix?: { copyPaste: string; qrCode: string; expiresAt: string };
end2endId?: string; feeAmount?: number; netAmount?: number;
refundedAmount?: number; refundType?: 'FULL' | 'PARTIAL'; refusedReason?: string;
}>;
total: number;
limit: number;
offset: number;
};
};
const params = new URLSearchParams({ limit: '20', status: 'PAID', paymentMethod: 'PIX' });
const response = await fetch(`https://api.linkagateway.com/api/v1/cobranca/transactions?${params}`, {
headers: { 'x-api-key': apiKey }
});
const { data }: ListTransactionsResponse = await response.json();
import requests
response = requests.get('https://api.linkagateway.com/api/v1/cobranca/transactions',
headers={'x-api-key': api_key},
params={'limit': 20, 'status': 'PAID', 'paymentMethod': 'PIX'})
data = response.json()['data']
import ("net/http"; "net/url")
func listTransactions(apiKey string) (*http.Response, error) {
u, _ := url.Parse("https://api.linkagateway.com/api/v1/cobranca/transactions")
q := u.Query()
q.Set("limit", "20")
q.Set("status", "PAID")
q.Set("paymentMethod", "PIX")
u.RawQuery = q.Encode()
req, _ := http.NewRequest("GET", u.String(), nil)
req.Header.Set("x-api-key", apiKey)
return http.DefaultClient.Do(req)
}
Exemplo de resposta
{
"status": true,
"data": {
"items": [
{
"id": "txn_uuid_aqui",
"amount": 15000,
"paymentMethod": "PIX",
"status": "PARTIALLY_REFUNDED",
"createdAt": "2026-03-06T10:00:00.000Z",
"updatedAt": "2026-03-07T09:12:44.000Z",
"paidAt": "2026-03-06T10:05:23.000Z",
"description": "Assinatura mensal",
"merchantOrderId": "ORD-2024-001",
"end2endId": "E1234567820260306100523abcdef123",
"providerReference": "txid_abc123",
"feeAmount": 199,
"netAmount": 14801,
"refundedAmount": 5000,
"refundType": "PARTIAL",
"metadata": {"pedidoId": "ORD-2024-001"}
}
],
"total": 1,
"limit": 20,
"offset": 0
}
}
Was this page helpful?