Pular para o conteúdo principal
GET
/
api
/
pix
/
transactions
/
pix-key
/
{pixKey}
/
{identifier}
Consultar transação por chave PIX e identificador
curl --request GET \
  --url https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey}/{identifier} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

Autorizações

​
Authorization
string
header
obrigatório

Enter JWT token

Parâmetros de caminho

​
pixKey
string
obrigatório

Chave PIX (CPF, CNPJ, telefone, e-mail ou chave aleatória EVP)

Exemplo:

"joao@example.com"

​
identifier
string
obrigatório

Identificador da transação: comparado contra endToEndId (e2eId), externalId ou id numérico simultaneamente

Exemplo:

"E00416968202512121343VX5Sx8fIpkY"

Resposta

Transação encontrada com sucesso

​
transactionId
string
obrigatório

ID único da transação

Exemplo:

"12345"

​
externalId
string
obrigatório

ID externo da transação

Exemplo:

"ext-123456"

​
status
enum<string>
obrigatório

Status da transação (em português)

Opções disponíveis:
Confirmado,
Pendente,
Error
Exemplo:

"Confirmado"

​
operationType
enum<string>
obrigatório

Tipo de operação (em português)

Opções disponíveis:
Pix in,
Pix out,
Refund in,
Refund out
Exemplo:

"Pix in"

​
movementType
enum<string>
obrigatório

Tipo de movimento (DEBIT para saída, CREDIT para entrada)

Opções disponíveis:
DEBIT,
CREDIT
Exemplo:

"CREDIT"

​
originalAmount
number
obrigatório

Valor original em reais

Exemplo:

100

​
feeAmount
number
obrigatório

Valor da taxa em reais

Exemplo:

1

​
finalAmount
number
obrigatório

Valor final em reais (original ± taxa)

Exemplo:

99

​
endToEndId
string
obrigatório

End-to-End ID do PIX

Exemplo:

"E12345678901234567890123456789012"

​
createdAt
string
obrigatório

Data de criação (ISO 8601)

Exemplo:

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

​
counterpart
object
obrigatório

Dados da contraparte

​
processedAt
string | null

Data de processamento (ISO 8601)

Exemplo:

"2025-01-15T10:30:05.000Z"