> ## 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. # List transactions > Retrieve Pix transactions with optional filtering. You can filter by multiple criteria including account, status, type, and timestamps. ## OpenAPI ````yaml en/openapi/v3-current/pix.yaml GET /v1/transactions openapi: 3.0.3 info: title: Plugin BR Pix Direct - Complete API description: | Complete API for Brazilian Pix instant payment system including Pix key dictionary operations, QR code generation/decoding, transactions and transaction limits. 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: List transactions description: > Retrieve Pix transactions with optional filtering. You can filter by multiple criteria including account, status, type, and timestamps. parameters: - name: account_id in: query description: Filter transactions by specific account UUID. schema: type: string format: uuid - name: end_to_end_id in: query description: Filter by unique end-to-end transaction identifier (E2E ID). schema: type: string - name: type in: query description: | Filter by transaction type. Use numeric value: 1=Pix. schema: $ref: '#/components/schemas/TransactionTypeEnum' - name: status in: query description: > Filter by transaction status. Possible values: PENDING, PENDING_CONFIRM, EXECUTED, REVERSAL, REPROVED, SCHEDULE, CANCELLED, ERROR. schema: $ref: '#/components/schemas/TransactionStatusEnum' - name: is_refund in: query description: Filter refund transactions. schema: type: boolean - name: is_internal in: query description: Filter internal transactions. schema: type: boolean - name: created_at in: query description: Filter by creation date. schema: type: string format: date - name: updated_at in: query description: Filter by update date. schema: type: string format: date responses: '200': description: List of transactions retrieved successfully 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: > Transaction type identifier. Numeric code specifying the type of payment transaction. **Valid values:** - `1` = Pix (Instant payment via Brazilian Pix system) enum: - 1 x-enum-varnames: - Pix example: 1 TransactionStatusEnum: type: string description: > Transaction processing status. String values indicating the current state of a Pix transaction. **Valid values:** - `PENDING` = Transaction has been initiated and is awaiting processing by the payment system - `PENDING_CONFIRM` = Transaction is awaiting final confirmation - `EXECUTED` = Transaction successfully completed and funds transferred - `REVERSAL` = Transaction was reversed (refunded) - `REPROVED` = Transaction was rejected or failed validation - `SCHEDULE` = Transaction is scheduled for future execution - `CANCELLED` = Transaction was cancelled by the user before execution - `ERROR` = A processing error occurred during transaction execution 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: Unique transaction identifier. example: txn_123456789 accountId: type: string description: Account identifier associated with the transaction. example: acc_123 endToEndId: type: string description: End-to-end transaction identifier. example: E1234567820230615123456789012345 status: $ref: '#/components/schemas/TransactionStatusEnum' amount: type: number description: Transaction amount. format: double example: 100.5 description: type: string description: Transaction description. example: Payment flow: $ref: '#/components/schemas/TransactionFlowEnum' type: $ref: '#/components/schemas/TransactionTypeEnum' payer: type: object required: - name - document properties: name: type: string description: Name of the payer. example: Maria Santos document: type: string description: CPF (11 digits) or CNPJ (14 digits) of the payer. example: '98765432100' payee: type: object required: - name - document properties: name: type: string description: Name of the payee. example: João Silva document: type: string description: CPF (11 digits) or CNPJ (14 digits) of the payee. example: '12345678901' createdAt: type: string description: Transaction creation timestamp. format: date-time example: '2023-06-15T10:30:00Z' updatedAt: type: string description: Transaction last update timestamp. format: date-time example: '2023-06-15T10:30:05Z' TransactionFlowEnum: type: integer description: > Transaction flow direction. Numeric code indicating whether money is coming in, going out, or being transferred internally. **Valid values:** - `1` = CASH_IN (Receiving payment - money coming into the account) - `2` = CASH_OUT (Sending payment - money going out of the account) - `3` = INTRA_PSP (Internal transfer within the same Payment Service Provider) enum: - 1 - 2 - 3 x-enum-varnames: - CASH_IN - CASH_OUT - INTRA_PSP example: 1 ErrorResponse: type: object properties: code: type: string description: Error code message: type: string description: Error message details: type: array items: type: string description: Additional error details responses: Unauthorized: description: Unauthorized - Invalid or missing authentication 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: Not Found - Resource does not exist 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: Internal Server Error 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: > JWT Bearer token authentication. Obtain token from `/v1/login/oauth/access_token` endpoint using client credentials (clientId and clientSecret). Include token in Authorization header: `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...` Token expires after 3600 seconds (1 hour). ````