Enable Service
Last updated: 12-Jan-2024
This API is used to initiate Enable Service Request specifying the following details:
| Request Details | Values |
|---|---|
| Method | POST |
| URL | https://{ENVIRONMENT}/oidc/poscloud/nexo/EnableService |
| 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 |
"SERVICE" |
MessageHeader.MessageCategory |
"ENABLESERVICE" |
| MessageHeader.MessageType | "REQUEST" |
| MessageHeader.ServiceID | String |
| MessageHeader.SaleID | String |
| MessageHeader.POIID | String |
| EnableServiceRequest | Object |
| EnableServiceRequest.TransactionAction | String |
| EnableServiceRequest.Device | String |
| EnableServiceRequest.InfoQualify | String |
| EnableServiceRequest.OutputContent | Object |
| EnableServiceRequest.OutputFormat | String |
| EnableServiceRequest.ReferenceID | String |
| EnableServiceRequest.Text | String |
{
"MessageHeader": {
"MessageClass": "SERVICE",
"MessageCategory": "ENABLESERVICE",
"MessageType": "REQUEST",
"ServiceID": "1234",
"SaleID": "1992",
"POIID": "401-921-303"
},
"EnableServiceRequest": {
"TransactionAction": "ABORTTRANSACTION",
"ServicesEnabled": "CARDACQUISITION",
"DisplayOutput": {
"ResponseRequiredFlag": true,
"MinimumDisplayTime": 0,
"Device": "CashierDisplay",
"InfoQualify": "Status",
"OutputContent": {
"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",
"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": "SERVICE",
"MessageCategory": "ENABLESERVICE",
"MessageType": "RESPONSE",
"ServiceID": "1234",
"SaleID": "1992",
"POIID": "401-921-303"
},
"EnableServiceResponse": {
"Response": {
"Result": "SUCCESS",
"ErrorCondition": null,
"AdditionalResponse": "EnableService Successfully"
}
}
}
Rate this article:
