Consultar status de transação

curl --request GET \
  --url https://api.public.firebanking.com.br/api/pix/transaction/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.public.firebanking.com.br/api/pix/transaction/{id}"

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/transaction/{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.public.firebanking.com.br/api/pix/transaction/{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 => [
    "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/transaction/{id}"

	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/transaction/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.public.firebanking.com.br/api/pix/transaction/{id}")

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

{
  "id": "123",
  "type": "PAYMENT",
  "status": "CONFIRMED",
  "originalAmount": "100.00",
  "feeAmount": "1.50",
  "finalAmount": "98.50",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:35:00.000Z",
  "externalId": "ext-001",
  "e2eId": "E00416968202512121343VX5Sx8fIpkY",
  "counterpartName": "John Marvin",
  "counterpartDocument": "12312312387",
  "counterpartAccountBankCode": "001",
  "counterpartAccountBranch": "0001",
  "counterpartAccountNumber": "123456-7",
  "counterpartAccountIspb": "00000000",
  "counterpartAccountBankName": "Banco do Brasil",
  "processedAt": "2024-01-15T10:35:00.000Z"
}

Transações PIX

Consultar status de transação

Requer token Bearer no header Authorization. Retorna o status atual de uma transação PIX com informações detalhadas sobre valores, contraparte e timestamps.

O identificador pode ser:

ID numérico: Identificador interno da transação retornado pela Fire Banking
externalId: Identificador externo que você forneceu na criação da transação

Campos retornados:

Informações básicas (id, externalId, type, status)
Valores (originalAmount, feeAmount, finalAmount)
End-to-end ID do PIX (e2eId)
Dados da contraparte (nome, documento, banco)
Timestamps (createdAt, updatedAt, processedAt)

GET

api

pix

transaction

{id}

Consultar status de transação

curl --request GET \
  --url https://api.public.firebanking.com.br/api/pix/transaction/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.public.firebanking.com.br/api/pix/transaction/{id}"

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/transaction/{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.public.firebanking.com.br/api/pix/transaction/{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 => [
    "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/transaction/{id}"

	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/transaction/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.public.firebanking.com.br/api/pix/transaction/{id}")

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

{
  "id": "123",
  "type": "PAYMENT",
  "status": "CONFIRMED",
  "originalAmount": "100.00",
  "feeAmount": "1.50",
  "finalAmount": "98.50",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:35:00.000Z",
  "externalId": "ext-001",
  "e2eId": "E00416968202512121343VX5Sx8fIpkY",
  "counterpartName": "John Marvin",
  "counterpartDocument": "12312312387",
  "counterpartAccountBankCode": "001",
  "counterpartAccountBranch": "0001",
  "counterpartAccountNumber": "123456-7",
  "counterpartAccountIspb": "00000000",
  "counterpartAccountBankName": "Banco do Brasil",
  "processedAt": "2024-01-15T10:35:00.000Z"
}

Autorizações

Authorization

string

header

obrigatório

Enter JWT token

Parâmetros de caminho

string

obrigatório

ID da transação (numérico) ou externalId (string)

Exemplo:

"123"

Resposta

Status da transação retornado com sucesso

string

obrigatório

ID da transação

Exemplo:

"123"

type

enum<string>

obrigatório

Tipo da transação

Opções disponíveis:

PAYMENT,

REFUND_IN,

REFUND_OUT,

WITHDRAW,

TRANSFER

Exemplo:

"PAYMENT"

status

enum<string>

obrigatório

Status da transação

Opções disponíveis:

PENDING,

CONFIRMED,

ERROR

Exemplo:

"CONFIRMED"

originalAmount

string

obrigatório

Valor original em reais

Exemplo:

"100.00"

feeAmount

string

obrigatório

Taxa em reais

Exemplo:

"1.50"

finalAmount

string

obrigatório

Valor final em reais

Exemplo:

"98.50"

createdAt

string

obrigatório

Data de criação (ISO 8601)

Exemplo:

"2024-01-15T10:30:00.000Z"

updatedAt

string

obrigatório

Data de atualização (ISO 8601)

Exemplo:

"2024-01-15T10:35:00.000Z"

externalId

string | null

External ID fornecido pelo cliente

Exemplo:

"ext-001"

e2eId

string | null

End-to-end ID do PIX

Exemplo:

"E00416968202512121343VX5Sx8fIpkY"

counterpartName

string | null

Nome da contraparte

Exemplo:

"John Marvin"

counterpartDocument

string | null

Documento da contraparte (CPF/CNPJ)

Exemplo:

"12312312387"

counterpartAccountBankCode

string | null

Código do banco da contraparte

Exemplo:

"001"

counterpartAccountBranch

string | null

Agência da contraparte

Exemplo:

"0001"

counterpartAccountNumber

string | null

Número da conta da contraparte

Exemplo:

"123456-7"

counterpartAccountIspb

string | null

ISPB do banco da contraparte

Exemplo:

"00000000"

counterpartAccountBankName

string | null

Nome do banco da contraparte

Exemplo:

"Banco do Brasil"

processedAt

string | null

Data de processamento (ISO 8601)

Exemplo:

"2024-01-15T10:35:00.000Z"

Solicitar estorno de pagamento recebido (Refund-In)Buscar transações da conta