{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-embedded-key-response-schema.json",
  "title": "EmbeddedKeyResponse",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-embedded-fields-api-openapi.yml#/components/schemas/EmbeddedKeyResponse",
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "description": "<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>Response code from the API. `0` indicates success. Refer to <a href=\"/docs/api-conventions#platform-api-response-codes\" target=\"_blank\">Platform API Response Codes</a> for the entire list of return codes.",
      "format": "int32",
      "readOnly": true
    },
    "message": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the API response code.",
      "readOnly": true
    },
    "data": {
      "$ref": "#/$defs/EmbeddedKey"
    }
  },
  "$defs": {
    "EmbeddedKey": {
      "type": "object",
      "properties": {
        "transient_key": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>A single-use token for loading embedded fields. The key will be invalidated   when a card is successfully verified. If unused, the token will expire in 12 hours. ",
          "readOnly": true
        },
        "merchant_id": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>The unique ID assigned to a merchant.",
          "format": "int64",
          "readOnly": true
        },
        "db_timestamp": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>The timestamp of transient key creation. ",
          "readOnly": true
        },
        "expiry_time": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>The timestamp of when the transient key will expire.",
          "readOnly": true
        }
      }
    }
  }
}