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

# Listar transacciones

> Recupera transacciones Pix con filtrado opcional. Puedes filtrar por múltiples criterios,
incluyendo cuenta, estado, tipo y marcas de tiempo.




## OpenAPI

````yaml es/openapi/v3-current/pix.yaml GET /v1/transactions
openapi: 3.0.3
info:
  title: Plugin BR Pix Directo - API completa
  description: >
    API completa para el sistema de pagos instantáneos Pix de Brasil,

    que incluye operaciones del diccionario de claves Pix,
    generación/decodificación

    de códigos QR, transacciones y límites transaccionales.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/transactions:
    get:
      tags:
        - Transactions API
      summary: Listar transacciones
      description: >
        Recupera transacciones Pix con filtrado opcional. Puedes filtrar por
        múltiples criterios,

        incluyendo cuenta, estado, tipo y marcas de tiempo.
      parameters:
        - name: account_id
          in: query
          description: Filtra las transacciones por un UUID de cuenta específico.
          schema:
            type: string
            format: uuid
        - name: end_to_end_id
          in: query
          description: >-
            Filtra por el identificador único de punta a punta de la transacción
            (E2E ID).
          schema:
            type: string
        - name: type
          in: query
          description: |
            Filtra por tipo de transacción. Usa el valor numérico: 1=PIX.
          schema:
            $ref: '#/components/schemas/TransactionTypeEnum'
        - name: status
          in: query
          description: >
            Filtra por estado de la transacción. Valores posibles: PENDING,
            PENDING_CONFIRM, EXECUTED, REVERSAL, REPROVED, SCHEDULE, CANCELLED,
            ERROR.
          schema:
            $ref: '#/components/schemas/TransactionStatusEnum'
        - name: is_refund
          in: query
          description: Filtra transacciones de reembolso.
          schema:
            type: boolean
        - name: is_internal
          in: query
          description: Filtra transacciones internas.
          schema:
            type: boolean
        - name: created_at
          in: query
          description: Filtra por fecha de creación.
          schema:
            type: string
            format: date
        - name: updated_at
          in: query
          description: Filtra por fecha de actualización.
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Lista de transacciones recuperada correctamente
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Transaction'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    TransactionTypeEnum:
      type: integer
      description: >
        Identificador del tipo de transacción. Código numérico que especifica el
        tipo de transacción de pago.


        **Valores válidos:**

        - `1` = PIX (Pago instantáneo a través del sistema Pix brasileño)
      enum:
        - 1
      x-enum-varnames:
        - PIX
      example: 1
    TransactionStatusEnum:
      type: string
      description: >
        Estado del procesamiento de la transacción. Valores en texto que indican
        el estado actual de una transacción Pix.


        **Valores válidos:**

        - `PENDING` = La transacción fue iniciada y está a la espera de
        procesamiento por el sistema de pagos

        - `PENDING_CONFIRM` = La transacción está esperando la confirmación
        final

        - `EXECUTED` = La transacción se completó con éxito y los fondos fueron
        transferidos

        - `REVERSAL` = La transacción fue revertida (reembolsada)

        - `REPROVED` = La transacción fue rechazada o no pasó la validación

        - `SCHEDULE` = La transacción está programada para una ejecución futura

        - `CANCELLED` = La transacción fue cancelada por el usuario antes de
        ejecutarse

        - `ERROR` = Ocurrió un error de procesamiento durante la ejecución de la
        transacción
      enum:
        - PENDING
        - PENDING_CONFIRM
        - EXECUTED
        - REVERSAL
        - REPROVED
        - SCHEDULE
        - CANCELLED
        - ERROR
      example: EXECUTED
    Transaction:
      type: object
      required:
        - id
        - accountId
        - endToEndId
        - status
        - amount
        - description
        - flow
        - type
        - payer
        - payee
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          description: Identificador único de la transacción.
          example: txn_123456789
        accountId:
          type: string
          description: Identificador de la cuenta asociada con la transacción.
          example: acc_123
        endToEndId:
          type: string
          description: Identificador end-to-end de la transacción.
          example: E1234567820230615123456789012345
        status:
          $ref: '#/components/schemas/TransactionStatusEnum'
        amount:
          type: number
          description: Monto de la transacción.
          format: double
          example: 100.5
        description:
          type: string
          description: Descripción de la transacción.
          example: Pago
        flow:
          $ref: '#/components/schemas/TransactionFlowEnum'
        type:
          $ref: '#/components/schemas/TransactionTypeEnum'
        payer:
          type: object
          required:
            - name
            - document
          properties:
            name:
              type: string
              description: Nombre del pagador.
              example: Maria Santos
            document:
              type: string
              description: CPF (11 dígitos) o CNPJ (14 dígitos) del pagador.
              example: '98765432100'
        payee:
          type: object
          required:
            - name
            - document
          properties:
            name:
              type: string
              description: Nombre del beneficiario.
              example: João Silva
            document:
              type: string
              description: CPF (11 dígitos) o CNPJ (14 dígitos) del beneficiario.
              example: '12345678901'
        createdAt:
          type: string
          description: Marca de tiempo de creación de la transacción.
          format: date-time
          example: '2023-06-15T10:30:00Z'
        updatedAt:
          type: string
          description: Marca de tiempo de la última actualización de la transacción.
          format: date-time
          example: '2023-06-15T10:30:05Z'
    TransactionFlowEnum:
      type: integer
      description: >
        Dirección del flujo de la transacción. Código numérico que indica si el
        dinero ingresa, sale o se transfiere internamente.


        **Valores válidos:**

        - `1` = CASH_IN (Recepción de pago: dinero que entra a la cuenta)

        - `2` = CASH_OUT (Envío de pago: dinero que sale de la cuenta)

        - `3` = INTRA_PSP (Transferencia interna dentro del mismo proveedor de
        servicios de pago)
      enum:
        - 1
        - 2
        - 3
      x-enum-varnames:
        - CASH_IN
        - CASH_OUT
        - INTRA_PSP
      example: 1
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Código de error
        message:
          type: string
          description: Mensaje de error
        details:
          type: array
          items:
            type: string
          description: Detalles adicionales del error
  responses:
    Unauthorized:
      description: No Autorizado - Autenticación inválida o ausente
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_token:
              summary: Missing authentication token
              value:
                code: MISSING_TOKEN
                message: Authorization header is required
                details: []
            invalid_token:
              summary: Invalid token
              value:
                code: INVALID_TOKEN
                message: Invalid or expired access token
                details: []
            expired_token:
              summary: Expired token
              value:
                code: TOKEN_EXPIRED
                message: Access token has expired. Please obtain a new token.
                details: []
    NotFound:
      description: No Encontrado - El recurso no existe
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            pix_key_not_found:
              summary: Pix key not found
              value:
                code: PIX_KEY_NOT_FOUND
                message: PIX key does not exist or is not registered
                details: []
            account_not_found:
              summary: Account not found
              value:
                code: ACCOUNT_NOT_FOUND
                message: Account with specified ID does not exist
                details: []
            transaction_not_found:
              summary: Transaction not found
              value:
                code: TRANSACTION_NOT_FOUND
                message: Transaction not found
                details: []
    InternalServerError:
      description: Error Interno del Servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            generic_error:
              summary: Generic internal error
              value:
                code: INTERNAL_ERROR
                message: An internal error occurred. Please try again later.
                details: []
            database_error:
              summary: Database error
              value:
                code: DATABASE_ERROR
                message: Database operation failed
                details: []
            external_service_error:
              summary: External service error
              value:
                code: EXTERNAL_SERVICE_ERROR
                message: External service (JD PIX) is temporarily unavailable
                details: []
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticación con token JWT Bearer. Obtén el token desde el endpoint
        `/v1/login/oauth/access_token`

        usando credenciales de cliente (`clientId` y `clientSecret`).


        Incluye el token en el encabezado Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        El token expira después de 3600 segundos (1 hora).

````