Listar transações por chave PIX
curl --request GET \
--url https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}', 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.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"transactionId": "12345",
"externalId": "ext-123456",
"status": "Confirmado",
"operationType": "Pix in",
"movementType": "CREDIT",
"originalAmount": 100,
"feeAmount": 1,
"finalAmount": 99,
"endToEndId": "E12345678901234567890123456789012",
"createdAt": "2025-01-15T10:30:00.000Z",
"counterpart": {
"name": "João Silva",
"document": "***.456.789-**",
"bank": {
"bankISPB": "00000000",
"bankName": "Banco do Brasil",
"bankCode": "001",
"accountBranch": "0001",
"accountNumber": "123456-7"
}
},
"processedAt": "2025-01-15T10:30:05.000Z"
}
],
"metadata": {
"page": 1,
"size": 20,
"total": 150,
"totalPages": 8,
"hasNext": true,
"hasPrevious": false
}
}Transações PIX
Listar transações por chave PIX
Requer token Bearer no header Authorization.
Retorna transações associadas a uma chave PIX específica com paginação.
Características:
- Valores convertidos para reais (2 decimais)
- Status e tipos mapeados para português
- Documentos de contraparte mascarados
- Intervalo máximo de 31 dias entre startDate e endDate
- Default de
startDate: últimos 30 dias - Limite máximo de 1000 resultados totais
Tipos de chave PIX suportados: CPF, CNPJ, telefone, e-mail, chave aleatória EVP
Mapeamento de Status:
PENDING→PendenteCONFIRMED→ConfirmadoERROR→Error
Mapeamento de Tipos:
PAYMENT→Pix inWITHDRAW→Pix outREFUND_IN→Refund inREFUND_OUT→Refund out
GET
/
api
/
pix
/
transactions
/
pix-key
/
{pixKey}
Listar transações por chave PIX
curl --request GET \
--url https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}', 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.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"transactionId": "12345",
"externalId": "ext-123456",
"status": "Confirmado",
"operationType": "Pix in",
"movementType": "CREDIT",
"originalAmount": 100,
"feeAmount": 1,
"finalAmount": 99,
"endToEndId": "E12345678901234567890123456789012",
"createdAt": "2025-01-15T10:30:00.000Z",
"counterpart": {
"name": "João Silva",
"document": "***.456.789-**",
"bank": {
"bankISPB": "00000000",
"bankName": "Banco do Brasil",
"bankCode": "001",
"accountBranch": "0001",
"accountNumber": "123456-7"
}
},
"processedAt": "2025-01-15T10:30:05.000Z"
}
],
"metadata": {
"page": 1,
"size": 20,
"total": 150,
"totalPages": 8,
"hasNext": true,
"hasPrevious": false
}
}Autorizações
Enter JWT token
Parâmetros de caminho
Chave PIX (CPF, CNPJ, telefone, e-mail ou chave aleatória EVP)
Exemplo:
"joao@example.com"
Parâmetros de consulta
Número da página (1-indexed)
Intervalo obrigatório:
x >= 1Exemplo:
1
Quantidade de registros por página (máximo 1000)
Intervalo obrigatório:
1 <= x <= 1000Exemplo:
20
Filtro por status da transação
Opções disponíveis:
PENDING, CONFIRMED, ERROR Exemplo:
"CONFIRMED"
Filtro por tipo de transação
Opções disponíveis:
PAYMENT, WITHDRAW, REFUND_IN, REFUND_OUT Exemplo:
"PAYMENT"
Data inicial para filtro (ISO 8601). Se não informado, usa últimos 30 dias.
Exemplo:
"2025-01-01"
Data final para filtro (ISO 8601). Se não informado, usa data atual.
Exemplo:
"2025-01-31"