Log in/on to the payment system in the store

post

/login

Whilst not all payment solutions require a login / logout, some do, and some cores use these messages from the POS to initialize and /or instantiate objects, therefore it is mandatory that the POS sends a login message before attempting to use the core for Payment / Line display functionality etc.

Request

There are no request parameters for this operation.

Back to Top

Response

200 Response

Returns response data to determine if the operation was successful or not.

401 Response

Not authorized.

404 Response

Redirects to an error page if the page does not exist
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}/login",
			"method": "post",
			"rel": "self"
	}], 
    {
    "ApplicationSender": "XSTORE",
    "WorkstationID": "1",
      "POSdata": {
        "TransactionNumber": "0",
        "LanguageCode": "eng",
           "StoreID": "101"
    }
    }
}

Example of the Response Body

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

{
"RequestType":"LOGIN",
"ApplicationSender":"XSTORE",
"WorkstationID":"1", 
"RequestID":"1",
"OverallResult":"Success", 
"CommsErrorMessage":"Certificates are valid",
"Certificates": {
	"Expired": "false",
	"ValidTo": "261220"
 }
 "success":"true"
}
Back to Top