> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firebanking.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# 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` → `Pendente`
- `CONFIRMED` → `Confirmado`
- `ERROR` → `Error`

**Mapeamento de Tipos:**
- `PAYMENT` → `Pix in`
- `WITHDRAW` → `Pix out`
- `REFUND_IN` → `Refund in`
- `REFUND_OUT` → `Refund out`



## OpenAPI

````yaml get /api/pix/transactions/pix-key/{pixKey}
openapi: 3.0.0
info:
  title: Fire Banking Public API
  description: >-
    API Pública da Plataforma Fire Banking para integração com serviços de
    pagamento PIX e gestão de contas
  version: 0.1.0
  contact: {}
servers:
  - url: https://api.public.firebanking.com.br
    description: Servidor de produção
security: []
tags:
  - name: auth
    description: Endpoints de autenticação
  - name: Balance
    description: Endpoints de consulta de saldo
  - name: PIX
    description: Endpoints de transações PIX
  - name: Webhooks
    description: Endpoints de gerenciamento de webhooks
paths:
  /api/pix/transactions/pix-key/{pixKey}:
    get:
      tags:
        - PIX
      summary: Listar transações por chave PIX
      description: >-
        **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` → `Pendente`

        - `CONFIRMED` → `Confirmado`

        - `ERROR` → `Error`


        **Mapeamento de Tipos:**

        - `PAYMENT` → `Pix in`

        - `WITHDRAW` → `Pix out`

        - `REFUND_IN` → `Refund in`

        - `REFUND_OUT` → `Refund out`
      operationId: PixController_listTransactionsByPixKey
      parameters:
        - name: pixKey
          required: true
          in: path
          description: Chave PIX (CPF, CNPJ, telefone, e-mail ou chave aleatória EVP)
          schema:
            type: string
            example: joao@example.com
        - name: page
          in: query
          description: Número da página (1-indexed)
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            example: 1
        - name: size
          in: query
          description: Quantidade de registros por página (máximo 1000)
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 20
            example: 20
        - name: status
          in: query
          description: Filtro por status da transação
          required: false
          schema:
            type: string
            enum:
              - PENDING
              - CONFIRMED
              - ERROR
            example: CONFIRMED
        - name: type
          in: query
          description: Filtro por tipo de transação
          required: false
          schema:
            type: string
            enum:
              - PAYMENT
              - WITHDRAW
              - REFUND_IN
              - REFUND_OUT
            example: PAYMENT
        - name: startDate
          in: query
          description: >-
            Data inicial para filtro (ISO 8601). Se não informado, usa últimos
            30 dias.
          required: false
          schema:
            type: string
            format: date
            example: '2025-01-01'
        - name: endDate
          in: query
          description: Data final para filtro (ISO 8601). Se não informado, usa data atual.
          required: false
          schema:
            type: string
            format: date
            example: '2025-01-31'
      responses:
        '200':
          description: Lista de transações por chave PIX retornada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTransactionsByPixKeyOutputDto'
        '400':
          description: Parâmetros inválidos ou intervalo de datas excede 31 dias
        '401':
          description: Token não fornecido ou inválido
      security:
        - bearer: []
components:
  schemas:
    PaginatedTransactionsByPixKeyOutputDto:
      type: object
      required:
        - data
        - metadata
      properties:
        data:
          type: array
          description: >-
            Lista de transações da chave PIX. O total de resultados é limitado a
            1000 registros.
          items:
            $ref: '#/components/schemas/TransactionSearchOutputDto'
        metadata:
          $ref: '#/components/schemas/PaginationMetadataOutputDto'
          description: Metadados de paginação
    TransactionSearchOutputDto:
      type: object
      required:
        - transactionId
        - externalId
        - status
        - operationType
        - movementType
        - originalAmount
        - feeAmount
        - finalAmount
        - endToEndId
        - createdAt
        - counterpart
      properties:
        transactionId:
          type: string
          description: ID único da transação
          example: '12345'
        externalId:
          type: string
          description: ID externo da transação
          example: ext-123456
        status:
          type: string
          description: Status da transação (em português)
          enum:
            - Confirmado
            - Pendente
            - Error
          example: Confirmado
        operationType:
          type: string
          description: Tipo de operação (em português)
          enum:
            - Pix in
            - Pix out
            - Refund in
            - Refund out
          example: Pix in
        movementType:
          type: string
          description: Tipo de movimento (DEBIT para saída, CREDIT para entrada)
          enum:
            - DEBIT
            - CREDIT
          example: CREDIT
        originalAmount:
          type: number
          description: Valor original em reais
          example: 100
        feeAmount:
          type: number
          description: Valor da taxa em reais
          example: 1
        finalAmount:
          type: number
          description: Valor final em reais (original ± taxa)
          example: 99
        endToEndId:
          type: string
          description: End-to-End ID do PIX
          example: E12345678901234567890123456789012
        createdAt:
          type: string
          description: Data de criação (ISO 8601)
          example: '2025-01-15T10:30:00.000Z'
        processedAt:
          type: string
          nullable: true
          description: Data de processamento (ISO 8601)
          example: '2025-01-15T10:30:05.000Z'
        counterpart:
          $ref: '#/components/schemas/CounterpartOutputDto'
          description: Dados da contraparte
    PaginationMetadataOutputDto:
      type: object
      required:
        - page
        - size
        - total
        - totalPages
        - hasNext
        - hasPrevious
      properties:
        page:
          type: integer
          description: Página atual
          example: 1
        size:
          type: integer
          description: Tamanho da página
          example: 20
        total:
          type: integer
          description: Total de registros
          example: 150
        totalPages:
          type: integer
          description: Total de páginas
          example: 8
        hasNext:
          type: boolean
          description: Existe próxima página
          example: true
        hasPrevious:
          type: boolean
          description: Existe página anterior
          example: false
    CounterpartOutputDto:
      type: object
      required:
        - name
        - document
        - bank
      properties:
        name:
          type: string
          description: Nome da contraparte
          example: João Silva
        document:
          type: string
          description: 'Documento mascarado (CPF: ***.XXX.XXX-**, CNPJ: **.XXX.XXX/****-**)'
          example: '***.456.789-**'
        bank:
          $ref: '#/components/schemas/CounterpartBankOutputDto'
          description: Dados bancários da contraparte
    CounterpartBankOutputDto:
      type: object
      properties:
        bankISPB:
          type: string
          nullable: true
          description: Código ISPB do banco
          example: '00000000'
        bankName:
          type: string
          nullable: true
          description: Nome do banco
          example: Banco do Brasil
        bankCode:
          type: string
          nullable: true
          description: Código do banco (COMPE)
          example: '001'
        accountBranch:
          type: string
          nullable: true
          description: Agência da conta
          example: '0001'
        accountNumber:
          type: string
          nullable: true
          description: Número da conta
          example: 123456-7
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter JWT token

````