Display
Last updated: 12-Jan-2024
This API is used to initiate a Display to the POI specifying the following details:
NOTE: Display is not supported in SCA.
| Request Details | Values |
|---|---|
| Method | POST |
| URL | https://{ENVIRONMENT}/oidc/poscloud/nexo/display |
| Authorization | https://verifone.cloud/docs/in-store-payments/integration-set-terminal#step-3__003a__00a0setting-up-basic-auth-in-postman |
|
Headers: Content-Type x-terminal-simulator x-site-entity-id
Authorization |
application/json true Entity ID of child to be passed in case parent token is used while calling this API. "user-uid:api" key pair encoded in base64. See the Obtaining API Keys guide for more information. |
| Body > Raw | See the request example below. |
Check the POS Cloud API reference for more details on the required parameters.
| Required parameters | Description |
|---|---|
MessageHeader |
Object |
MessageHeader.MessageClass |
"DEVICE" |
MessageHeader.MessageCategory |
|
| MessageHeader.MessageType | "REQUEST" |
| MessageHeader.DeviceID | String |
| MessageHeader.SaleID | String |
| MessageHeader.POIID | String |
| DisplayRequest | Object |
| DisplayRequest.DisplayOutput | Array of Object |
| DisplayRequest.Device | String |
| DisplayRequest.InfoQualify | String |
| DisplayRequest.OutputContent | Object |
| DisplayRequest.OutputFormat | String |
| DisplayRequest.ReferenceID | String |
| DisplayRequest.Text | String |
{
"MessageHeader": {
"MessageClass": "DEVICE",
"MessageCategory": "DISPLAY",
"MessageType": "REQUEST",
"ServiceID": "34567",
"DeviceID": "23456",
"SaleID": "1992",
"POIID": "Devaraj P400"
},
"DisplayRequest": {
"DisplayOutput": [
{
"ResponseRequiredFlag": true,
"MinimumDisplayTime": 5000,
"Device": "CashierDisplay",
"InfoQualify": "Status",
"OutputContent": {
"OutputFormat": "MESSAGEREF",
"PredefinedContent": {
"ReferenceID": "string",
"Language": "string"
},
"OutputText": [
{
"Text": "LOGIN",
"CharacterSet": 0,
"Font": "string",
"StartRow": 0,
"StartColumn": 0,
"Color": "WHITE",
"CharacterWidth": "SINGLEWIDTH",
"CharacterHeight": "SINGLEHEIGHT",
"CharacterStyle": "NORMAL",
"Alignment": "LEFT",
"EndOfLineFlag": true
},
{
"Text": "SUCCESS",
"CharacterSet": 0,
"Font": "string",
"StartRow": 0,
"StartColumn": 0,
"Color": "WHITE",
"CharacterWidth": "SINGLEWIDTH",
"CharacterHeight": "SINGLEHEIGHT",
"CharacterStyle": "NORMAL",
"Alignment": "LEFT",
"EndOfLineFlag": true
}
],
"OutputXHTML": "string",
"OutputBarcode": {
"BarcodeType": "EAN8",
"BarcodeValue": "string",
"QRCodeBinaryValue": "string",
"QRCodeVersion": "string",
"QRCodeEncodingMode": "string",
"QRCodeErrorCorrection": "L"
}
},
"MenuEntry": [
{
"MenuEntryTag": "Selectable",
"DefaultSelectedFlag": true,
"OutputFormat": "MESSAGEREF",
"PredefinedContent": {
"ReferenceID": "string",
"Language": "string"
},
"OutputText": [
{
"Text": "string",
"CharacterSet": 0,
"Font": "string",
"StartRow": 0,
"StartColumn": 0,
"Color": "WHITE",
"CharacterWidth": "SINGLEWIDTH",
"CharacterHeight": "SINGLEHEIGHT",
"CharacterStyle": "NORMAL",
"Alignment": "LEFT",
"EndOfLineFlag": true
}
],
"OutputXHTML": "string"
}
],
"OutputSignature": "string"
}
]
}
}Based on the response from the terminal, the POS Cloud will send back the response.
{
"MessageHeader": {
"MessageClass": "DEVICE",
"MessageCategory": "DISPLAY",
"MessageType": "RESPONSE",
"ServiceID": "34567",
"DeviceID": "23456",
"SaleID": "1992",
"POIID": "Devaraj P400"
},
"DisplayResponse": {
"OutputResult": [
{
"Device": "CashierDisplay",
"InfoQualify": "Status",
"Response": {
"Result": "SUCCESS",
"ErrorCondition": null,
"AdditionalResponse": "MessageDisplayed Successfully"
}
}
]
}
}
Rate this article:
