Buscar Transação
curl --request GET \
--url https://api.example.com/api/v1/cobranca/transactions/:id \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/api/v1/cobranca/transactions/:id"
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/:id', 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/:id",
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/:id"
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/:id")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cobranca/transactions/:id")
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{
"id": "<string>",
"amount": 123,
"paymentMethod": "<string>",
"status": "<string>",
"createdAt": "<string>",
"paidAt": "<string>",
"updatedAt": "<string>",
"customer": {},
"metadata": {},
"description": "<string>",
"merchantOrderId": "<string>",
"postbackUrl": "<string>",
"pix": {},
"end2endId": "<string>",
"feeAmount": 123,
"netAmount": 123,
"providerReference": "<string>",
"refundedAmount": 123,
"refundType": "<string>",
"refusedReason": "<string>"
}Buscar Transação
Buscar uma transação pelo ID
GET
/
api
/
v1
/
cobranca
/
transactions
/
:id
Buscar Transação
curl --request GET \
--url https://api.example.com/api/v1/cobranca/transactions/:id \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/api/v1/cobranca/transactions/:id"
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/:id', 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/:id",
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/:id"
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/:id")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cobranca/transactions/:id")
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{
"id": "<string>",
"amount": 123,
"paymentMethod": "<string>",
"status": "<string>",
"createdAt": "<string>",
"paidAt": "<string>",
"updatedAt": "<string>",
"customer": {},
"metadata": {},
"description": "<string>",
"merchantOrderId": "<string>",
"postbackUrl": "<string>",
"pix": {},
"end2endId": "<string>",
"feeAmount": 123,
"netAmount": 123,
"providerReference": "<string>",
"refundedAmount": 123,
"refundType": "<string>",
"refusedReason": "<string>"
}Retorna os detalhes completos de uma transação específica da sua conta.
A resposta vem no envelope
{status, data} — o objeto da transação fica em data.string
required
Sua API Key (
sk_live_...). Veja Autenticacao.string
required
Identificador único da transação.Exemplo:
txn_uuid_aquiResposta
string
Identificador único da transação.
integer
Valor da transação em centavos.
string
Método de pagamento:
PIX.Novos valores podem ser adicionados a este campo. Trate valores
desconhecidos como fallback. Não faça switch exaustivo.
string
Status atual da transação. Valores:
PENDING, WAITING_PAYMENT, PROCESSING, AUTHORIZED, PAID, REFUSED, FAILED, EXPIRED, REFUNDED, PARTIALLY_REFUNDED, CHARGEDBACK, DISPUTE, BLOCKED, PENDING_REVIEW.Novos valores podem ser adicionados a este campo. Trate valores
desconhecidos como fallback. Não faça switch exaustivo.
string
Data/hora de criação (ISO 8601).
string
Data/hora em que a transação foi paga (ISO 8601). Presente apenas quando
status = PAID ou posterior.string
Data/hora da última alteração (ISO 8601).
object
Dados do comprador definidos na criação.
customer.document vem redigido (só primeiros e últimos 2 dígitos visíveis).object
Metadados da transação definidos por você na criação.
string
Descrição da cobrança informada por você na criação. Omitido quando não informado.
string
Seu identificador de pedido, informado na criação. Omitido quando não informado.
string
URL de notificação assíncrona informada por você na criação. Omitido quando não informado.
object
Dados do PIX da cobrança:
copyPaste, qrCode e expiresAt. Os mesmos valores
retornados na criação — permitem reexibir o QR sem guardar a resposta original.
Omitido em cobranças criadas antes desta versão.string
Identificador fim-a-fim (E2E) do PIX no SPI. Preenchido quando o pagamento é
confirmado; omitido enquanto a cobrança não foi paga.
integer
Taxa cobrada, em centavos. Omitido enquanto a transação não foi liquidada.
integer
Valor líquido após a taxa, em centavos. Omitido enquanto a transação não foi liquidada.
string
Referência interna para suporte e auditoria.
integer
Valor já estornado, em centavos. Omitido quando não houve estorno.
string
Tipo do estorno:
FULL quando status = REFUNDED, PARTIAL quando
status = PARTIALLY_REFUNDED. Omitido nos demais status.string
Motivo da recusa. Omitido quando a transação não foi recusada.
Campos opcionais são omitidos quando não há valor — não vêm como
null.
Novos campos podem ser adicionados à resposta a qualquer momento; ignore os que
não conhecer em vez de falhar na desserialização.curl -X GET https://api.linkagateway.com/api/v1/cobranca/transactions/<ID> \
-H "x-api-key: <API_KEY>"
const response = await fetch(`https://api.linkagateway.com/api/v1/cobranca/transactions/${id}`, {
headers: { 'x-api-key': apiKey }
});
const { data: transaction } = await response.json();
type TransactionResponse = {
status: boolean;
data: {
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;
};
};
const response = await fetch(`https://api.linkagateway.com/api/v1/cobranca/transactions/${id}`, {
headers: { 'x-api-key': apiKey }
});
const { data: transaction }: TransactionResponse = await response.json();
import requests
response = requests.get(f'https://api.linkagateway.com/api/v1/cobranca/transactions/{id}',
headers={'x-api-key': api_key})
transaction = response.json()['data']
import ("net/http")
func getTransaction(apiKey, id string) (*http.Response, error) {
req, _ := http.NewRequest("GET", "https://api.linkagateway.com/api/v1/cobranca/transactions/"+id, nil)
req.Header.Set("x-api-key", apiKey)
return http.DefaultClient.Do(req)
}
Exemplo de resposta
{
"status": true,
"data": {
"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",
"postbackUrl": "https://loja.exemplo.com.br/webhooks/linka",
"end2endId": "E1234567820260306100523abcdef123",
"providerReference": "txid_abc123",
"feeAmount": 199,
"netAmount": 14801,
"refundedAmount": 5000,
"refundType": "PARTIAL",
"metadata": {"pedidoId": "ORD-2024-001"},
"pix": {
"copyPaste": "00020126580014br.gov.bcb.pix...",
"qrCode": "data:image/png;base64,iVBORw0KGgo...",
"expiresAt": "2026-03-07T10:00:00Z"
},
"customer": {
"document": "123***00",
"name": "Maria Fernanda Costa",
"email": "[email protected]"
}
}
}
Was this page helpful?