> ## 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.

# Get settlement window by ID

> Retrieves a single settlement window by its unique identifier.




## OpenAPI

````yaml /openapi/account-settlement.json get /settlement/settlement-windows/{id}
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/settlement-windows/{id}:
    get:
      tags:
        - Settlement Windows
      summary: Get settlement window by ID
      description: |
        Retrieves a single settlement window by its unique identifier.
      operationId: lite.settlement.getSettlementWindowById
      parameters:
        - $ref: '#/components/parameters/settlement_window_id'
        - $ref: '#/components/parameters/x-correlation-id'
      responses:
        '200':
          $ref: '#/components/responses/SettlementWindowDetails'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    settlement_window_id:
      name: id
      in: path
      required: true
      description: Unique identifier of the settlement window
      schema:
        type: string
        format: uuid
        example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
    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:
    SettlementWindowDetails:
      description: Settlement window details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SettlementWindow'
    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'
    NotFound:
      description: |
        The requested resource was not found.

        Returned when:
        - The specified resource ID does not exist
        - The path does not match any known endpoint
      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:
    SettlementWindow:
      type: object
      description: A settlement window representing a merchant payout cycle
      required:
        - id
        - merchant_id
        - cycle_id
        - value_date
        - status
        - created_by
        - updated_by
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: Unique settlement window identifier
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        merchant_id:
          type: string
          description: Merchant identifier
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        cycle_id:
          type: string
          description: Settlement cycle identifier
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        value_date:
          type: string
          format: date-time
          description: Date that actual settlement should be sent
          example: '2024-01-01T23:59:59.000Z'
        closing_date:
          type: string
          format: date-time
          description: Date after all instructions are done and window is completed
          example: '2024-01-02T00:00:00.000Z'
        status:
          type: string
          description: Settlement window status
          oneOf:
            - title: Opened
              const: OPENED
              description: Window is open and accepting transactions
            - title: In Progress
              const: IN_PROGRESS
              description: Window is being processed
            - title: Success
              const: SUCCESS
              description: Window settled successfully
            - title: Failed
              const: FAILED
              description: Window settlement failed
            - title: Partially Success
              const: PARTIALLY_SUCCESS
              description: Window settled with partial success
        total_instructions:
          type: integer
          description: Total number of instructions in this window
          minimum: 0
          example: 5
        total_amount:
          type: integer
          description: Total sales amount in minor units
          minimum: 0
          example: 100000
        settled_amount:
          type: integer
          description: >-
            Total settled amount in minor units (sum of transaction settled
            amounts)
          minimum: 0
          example: 95000
        currency:
          type: string
          description: Currency code (ISO 4217)
          minLength: 3
          maxLength: 3
          pattern: ^[A-Z]{3}$
          example: USD
        created_by:
          type: string
          description: User who created the settlement window
          example: system
        updated_by:
          type: string
          description: User who last updated the settlement window
          example: system
        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'
    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'
  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>.

````