{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-api-response-entity-set-pin-response-schema.json",
  "title": "ApiResponseEntitySetPinResponse",
  "description": "Issuer response entity",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-card-pin-api-openapi.yml#/components/schemas/ApiResponseEntitySetPinResponse",
  "type": "object",
  "required": [
    "responseMetadata"
  ],
  "properties": {
    "data": {
      "description": "Response data",
      "allOf": [
        {
          "$ref": "#/$defs/SetPinResponse"
        }
      ]
    },
    "responseMetadata": {
      "description": "Response metadata",
      "allOf": [
        {
          "$ref": "#/$defs/ResponseMetadata"
        }
      ]
    }
  },
  "$defs": {
    "EncryptedData": {
      "type": "object",
      "required": [
        "algoId",
        "encryptedData",
        "keyId"
      ],
      "properties": {
        "algoId": {
          "type": "string",
          "description": "Algorithm used to encrypt Session Key\nAllowed Value:\n06 for RSA"
        },
        "encryptedData": {
          "type": "string",
          "description": "Cryptogram in hexadecimal string representation"
        },
        "keyId": {
          "type": "string",
          "description": "Key set used for request\nAllowed Value:\n01 - Keyset1\n02 - Keyset2"
        }
      },
      "title": "EncryptedData"
    },
    "Links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "type": "string",
          "description": "Service method URL"
        },
        "next": {
          "type": "string",
          "description": "URL pagination query parameter next page"
        }
      },
      "title": "Links"
    },
    "PinAttribute": {
      "type": "object",
      "required": [
        "pinAlgorithmId",
        "pinBlock",
        "pinBlockFormat"
      ],
      "properties": {
        "encryptedSessionKey": {
          "$ref": "#/$defs/EncryptedData"
        },
        "key": {
          "type": "string",
          "description": "Not used"
        },
        "keyId": {
          "type": "string",
          "description": "Key set used for response\nAllowed Value:\n01 - Keyset1\n02 - Keyset2"
        },
        "pinAlgorithmId": {
          "type": "string",
          "description": "Algorithm used to encrypt the PIN\nAllowed Value:\n04 = ISO-4 (=> encryptedSessionKey required)\n05 = ISO-1-BAPOF (internal transport + BE banks)\n06 = RSA-APAC (deprecated)\n07 = BEST-PIN (internal migration)"
        },
        "pinBlock": {
          "type": "string",
          "description": "PIN block in hexadecimal string representation"
        },
        "pinBlockFormat": {
          "type": "string",
          "description": "ISO-4, ISO-1-BAPOF, RSA-APAC, BEST-PIN, etc. (free text, no strict constraint)"
        }
      },
      "title": "PinAttribute"
    },
    "ResponseMetadata": {
      "type": "object",
      "required": [
        "correlationId",
        "responseDateTime",
        "statusCode",
        "statusMessage"
      ],
      "properties": {
        "correlationId": {
          "type": "string",
          "description": "Correlation Identifier"
        },
        "links": {
          "description": "Metadata Links",
          "allOf": [
            {
              "$ref": "#/$defs/Links"
            }
          ]
        },
        "statusMessage": {
          "type": "string",
          "description": "Executed REST API status message"
        },
        "statusCode": {
          "type": "integer",
          "format": "int32",
          "description": "HTTP status code"
        },
        "responseDateTime": {
          "type": "string",
          "description": "Timestamp when response date was generated"
        },
        "timeTakenMs": {
          "type": "integer",
          "format": "int64",
          "description": "Wall clock time required from service to generate the response"
        }
      },
      "title": "ResponseMetadata"
    },
    "SetPinResponse": {
      "type": "object",
      "description": "pinAttribute is just an echo of the input PIN",
      "properties": {
        "pinAttribute": {
          "$ref": "#/$defs/PinAttribute"
        }
      },
      "title": "SetPinResponse"
    }
  }
}