---
updatedAt: 2026-05-29T13:25:42.000Z
agentTools:
  projectIndex: https://developer.eftcorp.com/llms.txt
---

# Manage session keys for terminals

Processes a session key operation for a terminal or other use case. The mode field dictates the exact behaviour.

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://eclipse-java-sandbox.ukheshe.rocks",
      "description": "Eclipse sandbox environment"
    },
    {
      "url": "https://ukheshe.live",
      "description": "Eclipse production environment"
    },
    {
      "url": "https://eclipse-java-develop.ukheshe.rocks",
      "description": "Eclipse development environment"
    },
    {
      "url": "https://zw.ukheshe.live",
      "description": "Zim Eclipse production environment"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "SessionKeyData": {
        "type": "object",
        "properties": {
          "mode": {
            "$ref": "#/components/schemas/SessionKeyMode"
          },
          "terminalId": {
            "type": "integer",
            "format": "int64"
          },
          "terminalIdentifier": {
            "type": "string"
          },
          "terminalIdentifierType": {
            "type": "string"
          }
        }
      },
      "SessionKeyMode": {
        "type": "string",
        "enum": [
          "RANDOM_TERMINAL_KEY_UNDER_TMK"
        ]
      },
      "SessionKeyResult": {
        "type": "object",
        "properties": {
          "base64EncodedKey": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "JWTBearerAuthorisation": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "description": "A RESTful API using JSON as the data transfer model, covering all tenant-facing functionality in the Eclipse payments platform.",
    "title": "Eclipse ReST API",
    "version": "3.0.0"
  },
  "tags": [
    {
      "name": "b) Tenant Configuration & Onboarding",
      "description": "Manages tenant lifecycle, configuration, wallets, billing, notifications, and related onboarding operations."
    }
  ],
  "paths": {
    "/eclipse-conductor/rest/v1/tenants/{tenantId}/session-keys": {
      "post": {
        "summary": "Manage session keys for terminals",
        "description": "Processes a session key operation for a terminal or other use case. The mode field dictates the exact behaviour.",
        "tags": [
          "b) Tenant Configuration & Onboarding"
        ],
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SessionKeyData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SessionKeyResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ]
      }
    }
  }
}
```