"Order N Pay" Method

Summary

This method allows the integrator to request to validate a user PIN number.

Request/Response Payload Models

• OrderNPayGetUserFromPINRequest
• OrderNPayGetUserFromPINResponse

Enumeration Values

• MessageType - OrderNPayMessageType
• ResultCode - OrderNPayResultCode

Important Notes

If the OrderNPayGetUserFromPINResponse CanMakePayments field is false, this indicates that while it is a valid user, that user does not have sufficient permission to use the methods within the interface and will be rejected if they attempt to do so.

GetUserFromPIN (Websocket Message)

Message: OrderNPayWebsocketRequest, Payload: OrderNPayGetUserFromPINRequest

{
    "RequestID": "60a6f3c4-4043-49a2-b317-8807b77d9685",
    "ProviderID": 12345,
    "ProviderName": "Example Provider",
    "DeviceID": "DeviceABC123",
    "UserIdentifier": null,
    "MessageType": 0,
    "Payload": {
        "PIN": "1234"
    }
}

On success, the POS responds with

Message: OrderNPayWebsocketResponse, Payload: OrderNPayGetUserFromPINResponse

{
    "RequestID": "60a6f3c4-4043-49a2-b317-8807b77d9685",
    "ResultCode": 0,
    "ErrorMessage": null,
    "MessageType": 0,
    "Payload": {
        "UserID": "f9248a0f-ba0c-4c80-b9f2-fe020b456ce4",
        "UserName": "Manager",
        "CanMakePayments": true
    }
}

On failure, the POS may respond with

Message: OrderNPayWebsocketResponse, Payload: null

{
    "RequestID": "60a6f3c4-4043-49a2-b317-8807b77d9685",
    "ResultCode": 4,
    "ErrorMessage": "No user was found matching the specified logon!",
    "MessageType": 0,
    "Payload": null
}