Fire Bankingdocs

Consultar transacción por clave PIX e identificador

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

Retorna una transacción específica asociada a una clave PIX, buscada por el identificador proporcionado.

Lógica de resolución de identificador: El valor proporcionado se compara simultáneamente contra endToEndId (PIX e2eId), externalId e id numérico. En la práctica no hay ambigüedad: cada tipo tiene un formato único (e2eId comienza con E + 32 caracteres alfanuméricos; id es puramente numérico; externalId es cualquier otra cadena).

Autenticación

Requiere un Bearer token en el header Authorization.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
pixKeystringClave PIX (CPF, CNPJ, teléfono, email o clave EVP aleatoria)
identifierstringIdentificador de la transacción: se compara contra endToEndId, externalId o id numérico

Respuesta (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"
    }
  }
}

Errores

EstadoDescripción
401Token faltante o inválido
404Transacción no encontrada para la clave PIX e identificador proporcionados

En esta página