Device request

post

/device

supports the usage of custom forms on the payment device. The device requests are sent over channel 0 and cannot be used during a payment request session. If a device request is sent during an ongoing payment session it will ignored.

Request

There are no request parameters for this operation.

Back to Top

Response

200 Response

Success

400 Response

Invalid parameters have been passed in

401 Response

Not authorized.

500 Response

Invalid request.
Back to Top

Examples

Example of the Request Body

The following example shows the contents of the Request Body in JSON format:

{
    "links": [{
			"href": "wss://localhost:{port}/device",
			"method": "post",
			"rel": "self"
	}], 
    {
    "RequestType": "Input",
    "ApplicationSender": "XSTORE",
    "WorkstationID": "1",
    "RequestID": "1",
    "Input": {
        "InDeviceTarget": "CashierKeyboard",
        "InResult": "Success",
        "Command": "GetMenu",
        "InputValue": {
        "InNumber": "1"
        }
    },
    "Output": {
        "OutDeviceTarget": "CashierDisplay",
        "OutputTextLines": [
        "EFTLink Simulator"
        ],
        "OutResult": "true"
    }
    }
}

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "RequestType": "Input",
  "ApplicationSender": "XSTORE",
  "WorkstationID": "1",
  "RequestID": "1",
  "OverallResult": "Success",
  "Input": {
    "InDeviceTarget": "CashierKeyboard",
    "InResult": "Success",
    "Command": "GetMenu",
    "InputValue": {
      "InNumber": "1"
    }
  },
  "Output": {
    "OutDeviceTarget": "CashierDisplay",
    "OutputTextLines": [
      "EFTLink Simulator"
    ],
    "OutResult": "true"
  }
}
Back to Top