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

# List transactions

> Retrieves transactions with optional filters for settlement window ID,
external reference ID, settlement status, and/or date range. Supports
pagination with page and pageSize parameters.




## OpenAPI

````yaml /openapi/account-settlement.json get /settlement/transactions
openapi: 3.1.0
info:
  title: lite - Account Settlement
  version: 1.0.0
servers:
  - url: https://api.lite.sa/v1
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Settlement Windows
    description: Manage settlement windows for merchant payout cycles
  - name: Transactions
    description: Query settlement transactions and their details
paths:
  /settlement/transactions:
    get:
      tags:
        - Transactions
      summary: List transactions
      description: |
        Retrieves transactions with optional filters for settlement window ID,
        external reference ID, settlement status, and/or date range. Supports
        pagination with page and pageSize parameters.
      operationId: lite.settlement.listTransactions
      parameters:
        - $ref: '#/components/parameters/x-correlation-id'
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number (1-indexed)
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: Number of items per page
        - name: settlementWindowId
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Filter by settlement window ID
        - name: externalReferenceId
          in: query
          required: false
          schema:
            type: string
          description: Filter by external reference ID
        - name: isSettled
          in: query
          required: false
          schema:
            type: boolean
          description: Filter by settlement status
        - name: dateFrom
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter transactions created from this date (ISO 8601 format)
        - name: dateTo
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter transactions created up to this date (ISO 8601 format)
      responses:
        '200':
          $ref: '#/components/responses/TransactionList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    x-correlation-id:
      name: x-correlation-id
      in: header
      required: false
      description: >-
        Unique identifier for request tracing. Generated by the client or server
        if not provided.
      schema:
        type: string
        format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    TransactionList:
      description: List of transactions retrieved successfully.
      content:
        application/json:
          schema:
            type: object
            required:
              - data
              - pagination_data
            properties:
              data:
                type: array
                description: List of transactions
                items:
                  $ref: '#/components/schemas/Transaction'
              pagination_data:
                $ref: '#/components/schemas/PaginationData'
    BadRequest:
      description: >
        The request was invalid or malformed.


        Returned when:

        - Request validation fails (missing required fields, invalid field
        formats)

        - Payment details do not match the session (amount, currency, order
        reference mismatch)

        - The operation is not allowed given the current resource state
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: |
        Authentication failed — missing or invalid token.

        Returned when:
        - The JWT bearer token is missing, expired, or has an invalid signature
        - The API key is missing or invalid
        - The authenticated session token is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >
        Request blocked by security policy.


        Returned when:

        - A security threat is detected (SQL injection, XSS, NoSQL injection,
        LDAP injection, path traversal)

        - Header injection or suspicious headers are detected

        - The request payload exceeds the maximum allowed size

        - Geo-region validation fails (user country does not match client
        region)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: >
        An unexpected error occurred on the server.


        Returned when an unhandled exception or infrastructure failure prevents
        the request from being processed. Retry the request with exponential
        backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    Transaction:
      type: object
      description: A settlement transaction record
      required:
        - id
        - amount
        - currency
        - external_reference_id
        - status
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: Unique transaction identifier
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        amount:
          type: integer
          description: Transaction amount in minor units
          minimum: 0
          example: 100000
        settled_amount:
          type: integer
          description: >-
            Settled amount in minor units (calculated as total amount minus
            fees)
          minimum: 0
          example: 95000
        currency:
          type: string
          description: Currency code (ISO 4217)
          minLength: 3
          maxLength: 3
          pattern: ^[A-Z]{3}$
          example: USD
        settlement_window_id:
          type: string
          format: uuid
          description: Settlement window ID assigned when associated to a window
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        external_reference_id:
          type: string
          description: >-
            External reference ID - unique ID for the payment transaction or
            transfer from ledger
          example: payment_123456789
        payment_transaction_id:
          type: string
          description: >-
            Payment transaction ID (for refunds, the parent payment transaction
            ID)
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        status:
          type: string
          description: Transaction settlement status
          oneOf:
            - title: Pending
              const: PENDING
              description: Transaction is pending settlement
            - title: Settled
              const: SETTLED
              description: Transaction has been settled
        fees:
          type: array
          description: Array of fee objects with fee type and amount in minor units
          items:
            $ref: '#/components/schemas/FeeSummary'
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2024-01-01T00:00:00.000Z'
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
          example: '2024-01-01T00:00:00.000Z'
    PaginationData:
      type: object
      description: Pagination metadata for list responses
      required:
        - count
        - pages
        - page
        - page_size
        - has_next
        - has_previous
      properties:
        count:
          type: integer
          description: Total number of items matching the query
          minimum: 0
          example: 100
        pages:
          type: integer
          description: Total number of pages
          minimum: 0
          example: 4
        page:
          type: integer
          description: Current page number (1-indexed)
          minimum: 1
          example: 1
        page_size:
          type: integer
          description: Number of items per page
          minimum: 1
          example: 25
        has_next:
          type: boolean
          description: Whether there is a next page
          example: true
        has_previous:
          type: boolean
          description: Whether there is a previous page
          example: false
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - timestamp
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: PAYMENT_DETAILS_MISMATCH
            message:
              type: string
              description: Human-readable error description
              example: The request was invalid or malformed
            details:
              type: object
              description: Additional error details
            correlationId:
              type: string
              format: uuid
              description: Correlation ID for tracking the request
              example: 550e8400-e29b-41d4-a716-446655440000
            timestamp:
              type: string
              format: date-time
              description: Timestamp when the error occurred
              example: '2024-12-16T10:30:00.000Z'
    FeeSummary:
      type: object
      description: A fee applied to a transaction
      required:
        - fee_type
        - amount
      properties:
        fee_type:
          type: string
          description: Fee type identifier
          enum:
            - PROCESSING
            - TRANSACTION
            - INTERCHANGE
          example: PROCESSING
        amount:
          type: integer
          description: Fee amount in minor units
          minimum: 0
          example: 5000
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for service-to-service or merchant authentication.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from user authentication. Passed as
        Authorization: Bearer <token>.

````