OrderNPayWebsocketRequest Model

Required
providerID : number (int)

The PowerEPOS issued ID for the provider

Required MaxLength(64)
providerName : string

The name of the provider

Required MaxLength(64)
deviceID : string

A unique identifier representing the specific device making the request. (eg Dojo Payment Terminal ID)

Required MaxLength(36)
userIdentifier : string

An identifier for the user (either the User PIN number or POS User ID)

Required
messageType : OrderNPayMessageType

The type of message this payload represents

Required
payload : object

The payload of the websocket message (the payload structure will vary depending on the MessageType)

Nullable MaxLength(256)
requestID : string

A unique identifier for this request. Used to detect duplicate requests.
When retrying a request due to a comms error, ensure that you use the same RequestID so the POS can accurately determine if it has already processed the request.

Example
{
  "providerID": 321,
  "providerName": "string value",
  "deviceID": "string value",
  "userIdentifier": "string value",
  "messageType": 1,
  "payload": {},
  "requestID": "string value"
}