> ## Documentation Index > Fetch the complete documentation index at: https://docs.luxxon.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get settlement for session > Returns the on-chain settlement payload + current status for a session. NOT_READY before ENDED, PENDING once composed, CONFIRMED once the relayer's tx is mined. ## OpenAPI ````yaml /openapi.json get /api/v1/settlements/{sessionId} openapi: 3.0.0 info: title: Luxxon API description: Programmable vision — on-demand live video feeds version: 0.1.0 contact: {} servers: - url: https://api.luxxon.dev/api/v1 security: [] tags: - name: Authentication description: SIWE wallet sign-in. Used by the dashboard; API-key callers skip this. - name: Me description: Identity self-introspection — wallet or API key. - name: Workspaces description: Tenant root. Coverage area, availability, members. - name: API keys description: Per-workspace scoped credentials (lxxn_*). - name: Pricing description: Live rate + optional pre-quoted rate lock. - name: Sessions description: 'Visual session lifecycle: request → dispatch → authorize → start → end.' - name: Wallet description: On-chain wallet state and event log for a workspace. - name: Settlements description: On-chain settlement view per session. - name: Health description: Proof-of-life. No auth. - name: Webhooks description: Inbound video events from Cloudflare Stream. Internal. paths: /api/v1/settlements/{sessionId}: get: tags: - Settlements summary: Get settlement for session description: >- Returns the on-chain settlement payload + current status for a session. NOT_READY before ENDED, PENDING once composed, CONFIRMED once the relayer's tx is mined. operationId: LxSettlementController_get parameters: - name: sessionId required: true in: path schema: type: string example: b1e2f3a4-5b6c-7d8e-9f0a-1b2c3d4e5f6a - name: x-lx-consistency-token required: false in: header schema: type: string responses: '200': description: Request successful content: application/json: schema: allOf: - $ref: '#/components/schemas/LxSuccessResponseDto' - properties: data: $ref: '#/components/schemas/LxSettlementViewDto' '401': description: NOT_AUTHENTICATED content: application/json: schema: $ref: '#/components/schemas/LxErrorResponseDto' examples: NOT_AUTHENTICATED: summary: NOT_AUTHENTICATED — Session expired or missing value: statusCode: 401 code: NOT_AUTHENTICATED message: Session expired or missing detail: not_authenticated:example timestamp: '2026-05-13T12:00:00.000Z' '403': description: NOT_AUTHORIZED content: application/json: schema: $ref: '#/components/schemas/LxErrorResponseDto' examples: NOT_AUTHORIZED: summary: NOT_AUTHORIZED — Not authorized for this operation value: statusCode: 403 code: NOT_AUTHORIZED message: Not authorized for this operation detail: not_authorized:example timestamp: '2026-05-13T12:00:00.000Z' '404': description: SESSION_NOT_FOUND, NOT_FOUND content: application/json: schema: $ref: '#/components/schemas/LxErrorResponseDto' examples: SESSION_NOT_FOUND: summary: SESSION_NOT_FOUND — Session not found value: statusCode: 404 code: SESSION_NOT_FOUND message: Session not found detail: session_not_found:example timestamp: '2026-05-13T12:00:00.000Z' NOT_FOUND: summary: NOT_FOUND — Resource not found value: statusCode: 404 code: NOT_FOUND message: Resource not found detail: not_found:example timestamp: '2026-05-13T12:00:00.000Z' '409': description: INVALID_STATE content: application/json: schema: $ref: '#/components/schemas/LxErrorResponseDto' examples: INVALID_STATE: summary: INVALID_STATE — Operation not allowed in the current state value: statusCode: 409 code: INVALID_STATE message: Operation not allowed in the current state detail: invalid_state:example timestamp: '2026-05-13T12:00:00.000Z' '503': description: AUTHZ_ERROR, DATABASE_ERROR content: application/json: schema: $ref: '#/components/schemas/LxErrorResponseDto' examples: DATABASE_ERROR: summary: DATABASE_ERROR — Database unavailable value: statusCode: 503 code: DATABASE_ERROR message: Database unavailable detail: database_error:example timestamp: '2026-05-13T12:00:00.000Z' AUTHZ_ERROR: summary: AUTHZ_ERROR — Authorization service unavailable value: statusCode: 503 code: AUTHZ_ERROR message: Authorization service unavailable detail: authz_error:example timestamp: '2026-05-13T12:00:00.000Z' security: - access-token: [] components: schemas: LxSuccessResponseDto: type: object properties: statusCode: type: number example: 200 message: type: string example: Request successful data: type: object description: Endpoint-specific payload. See the per-endpoint schema. timestamp: type: string example: '2026-05-13T12:00:00.000Z' required: - statusCode - message - data - timestamp LxSettlementViewDto: type: object properties: sessionId: type: string example: b1e2f3a4-5b6c-7d8e-9f0a-1b2c3d4e5f6a state: type: string enum: - NOT_READY - PENDING - SUBMITTED - CONFIRMED example: PENDING description: >- NOT_READY = session hasn't reached ENDED. PENDING = composed, not submitted. SUBMITTED = relayer broadcast. CONFIRMED = tx mined. payload: $ref: '#/components/schemas/LxSettlementPayloadDto' txHash: type: string example: '0x1234abcd5678ef901234abcd5678ef901234abcd5678ef901234abcd5678ef90' confirmedAt: type: string example: '2026-05-13T11:45:00.000Z' required: - sessionId - state LxErrorResponseDto: type: object properties: statusCode: type: number example: 400 code: type: string example: INVALID_INPUT description: Machine-readable error code — see ErrorCodes. message: type: string example: Invalid request payload detail: type: string example: session:workspaceMismatch description: Short, safe-to-expose label scoping the failure site. timestamp: type: string example: '2026-05-13T12:00:00.000Z' required: - statusCode - code - message - timestamp LxSettlementPayloadDto: type: object properties: sessionIdHash: type: string example: '0xa1b2c3d4e5f60718293a4b5c6d7e8f9000112233445566778899aabbccddeeff' description: >- Deterministic 32-byte hash of the session UUID — what gets passed to LuxxonSettlement.settle() as bytes32 sessionId. from: type: string example: '0xAbC0000000000000000000000000000000000001' description: Consumer wallet — the payer. to: type: string example: '0xDeF0000000000000000000000000000000000002' description: Operator wallet — the payee. toAmount: type: string example: '342000' description: Operator share in µUSDC (post-fee). String for BigInt safety. feeAmount: type: string example: '18000' description: Platform fee in µUSDC. ratePerSecond: type: string example: '1000' description: Locked rate in µUSDC/sec. chargeableSeconds: type: number example: 360 description: Clean seconds eligible for charge. consumerWorkspaceId: type: string example: 8c3a5b6f-1d2e-4f7a-9b8c-d1e2f3a4b5c6 operatorWorkspaceId: type: string example: 9d4b6c7f-2e3f-5a8b-0c1d-e2f3a4b5c6d7 platformFeeBps: type: number example: 500 description: Platform fee in basis points (500 = 5%). required: - sessionIdHash - from - to - toAmount - feeAmount - ratePerSecond - chargeableSeconds - consumerWorkspaceId - operatorWorkspaceId - platformFeeBps securitySchemes: access-token: scheme: bearer bearerFormat: JWT or lxxn_* type: http ````