Point of Interaction

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/order-service-api-basepoitype.json",
  "title": "Point of Interaction",
  "description": "The Point of Interaction. This may refer to a number of different entities, but is primarily considered to be the Terminal. This object contains the POI details as they pertain to an individual payment, an instance of POI. This does not attempt to define all the settings or attributes that may be associated to a POI. Also, for a specific Acquirer/Contract combination there may be a different instance of the POI(TID). These different relationships are not part of this object.",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/PoiTypeEnum"
    },
    "poiId": {
      "maxLength": 36,
      "minLength": 1,
      "type": "string",
      "description": "Point of interaction identifier (Often referred to as Terminal ID)"
    },
    "subPoiId": {
      "maxLength": 15,
      "minLength": 1,
      "type": "string",
      "description": "An optional secondary identifier for a point of interaction (Terminal). This is relevant for some markets where an additional terminal number is required."
    },
    "altVfiPoiId": {
      "$ref": "#/components/schemas/AltVfiPoiId"
    },
    "estateManagementId": {
      "type": "string",
      "description": "This has very specific meaning as an identifier used for Estate Management. This should generally be left blank\nas Verifone will allocate this ID.\n\nIn VHQ this is related to the deviceId."
    },
    "estateManagementQrCode": {
      "type": "string",
      "description": "Base64 of a .png QR code representing the estateManagementId. Generated by the SelfSignup Service and patched onto the POI before Oracle/B2B boarding."
    },
    "serialNumber": {
      "$ref": "#/components/schemas/SerialNumber"
    },
    "laneInformation": {
      "$ref": "#/components/schemas/PoiLaneInformation"
    },
    "networkConfig": {
      "$ref": "#/components/schemas/PoiNetworkConfig"
    },
    "name": {
      "maxLength": 35,
      "type": "string",
      "description": "The name used to represent this POI. This is a label not an identifier."
    },
    "description": {
      "maxLength": 30,
      "type": "string",
      "description": "An optional value where some Merchant specific entry is associated with a POI."
    },
    "status": {
      "$ref": "#/components/schemas/PoiStatusEnum"
    },
    "cutoverTime": {
      "$ref": "#/components/schemas/CutoverTime"
    },
    "poiUid": {
      "$ref": "#/components/schemas/PoiUid"
    },
    "acquirerPoiIds": {
      "maxItems": 50,
      "type": "array",
      "description": "Key value Pairs linking acquirer POI with their TID",
      "items": {
        "$ref": "#/components/schemas/VariableResponseType"
      }
    },
    "poiLabels": {
      "type": "array",
      "description": "Free form labels/tags that can be attached to an entity to enable grouping and searching",
      "maxLength": 10,
      "items": {
        "type": "string",
        "description": "Logical grouping of poi's. A tag or label which is meaningful to the customer which groups pois, e.g Area, Timezone, Restaurant, Retail etc",
        "maxLength": 30
      }
    },
    "activationCode": {
      "description": "Activation code for the SoftPOS solution which is generated by VHQ.",
      "type": "string",
      "pattern": "^[A-Z0-9-]{14}$"
    },
    "vhqCustomerId": {
      "type": "string",
      "description": "Customer ID of the VHQ instance."
    },
    "vhqUrl": {
      "type": "string",
      "description": "URL of the VHQ Instance"
    }
  },
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "POINT_OF_SALE": "#/components/schemas/PoiType",
      "MULTI_MERCHANT_CHILD": "#/components/schemas/MultiMerchantChildPoiType",
      "STANDALONE": "#/components/schemas/PoiType",
      "ELECTRONIC_CASH_REGISTER": "#/components/schemas/PoiType",
      "UNATTENDED": "#/components/schemas/PoiType",
      "MOBILE": "#/components/schemas/PoiType",
      "VIRTUAL": "#/components/schemas/VirtualPoiType"
    }
  },
  "required": [
    "status",
    "type"
  ]
}