Fire Bankingdocs

Consultar transação por chave PIX e identificador

GET /api/pix/transactions/pix-key/{pixKey}/{identifier}

Retorna uma transação específica associada a uma chave PIX, buscando pelo identificador fornecido.

Logica de resolução do identificador: O valor informado e comparado simultaneamente contra endToEndId (e2eId do PIX), externalId e id numérico. Na pratica não ha ambiguidade: o formato de cada tipo e único (e2eId comeca com E + 32 chars alfanuméricos; id e puramente numérico; externalId e qualquer outra string).

Autenticação

Requer token Bearer no header Authorization.

Path Parameters

ParâmetroTipoObrigatórioDescrição
pixKeystringSimChave PIX (CPF, CNPJ, telefone, e-mail ou chave aleatória EVP)
identifierstringSimIdentificador da transação: comparado contra endToEndId, externalId ou id numérico

Response (200)

{
  "transactionId": "12345",
  "externalId": "ext-123456",
  "status": "Confirmado",
  "operationType": "Pix in",
  "movementType": "CREDIT",
  "originalAmount": 100.00,
  "feeAmount": 1.00,
  "finalAmount": 99.00,
  "endToEndId": "E12345678901234567890123456789012",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "processedAt": "2025-01-15T10:30:05.000Z",
  "counterpart": {
    "name": "João Silva",
    "document": "***.456.789-**",
    "bank": {
      "bankISPB": "00000000",
      "bankName": "Banco do Brasil",
      "bankCode": "001",
      "accountBranch": "0001",
      "accountNumber": "123456-7"
    }
  }
}

Erros

StatusDescrição
401Token não fornecido ou inválido
404Transação não encontrada para a chave PIX e identificador informados

Nesta página