Log in and log out

Endpoint

The URL used to send  Terminal API  messages depends on your type of implementation. For more information on the architectures available, see the Terminal API Overview .

Login Request

For a list of LoginRequest fields, see LoginRequest fields. The elements of a login request are wrapped in a LoginRequest envelope.

The SaleID and ServiceID in the MessageHeader should be unique. SaleID and ServiceID combinations are rejected if used recently, within 48 hours.

The fields described below are the fields you specify when making a LoginRequest call to the Terminal API.

LoginRequest
{  
   "SaleToPOIRequest":{  
      "MessageHeader":{  
         "ProtocolVersion":"3.0",
         "MessageClass":"Service",
         "MessageCategory":"Login",
         "MessageType":"Request",
         "ServiceID":"0403105031",
         "SaleID":"POSSystemID12345",
         "POIID":"P400Plus-275008565"
      },
      "LoginRequest":{  
         "DateTime":"2018-04-03T08:50:31+00:00",
         "SaleSoftware":{  
            "ManufacturerID":"Adyen",
            "ApplicationName":"TestScripts",
            "SoftwareVersion":"1.0",
            "CertificationCode":""
         },
         "SaleTerminalData":{  
            "TotalsGroupID":"GroupA"
         },
         "OperatorLanguage":"en",
         "OperatorID":"John"
      }
   }
}

Response

For a list of LoginResponse fields, see LoginResponse fields.

The login response contains information about the status of the terminal in the following fields:

LoginResponse
{
   "SaleToPOIResponse":{
      "LoginResponse":{
         "POISystemData":{
            "POISoftware":{
               "CertificationCode":"",
               "SoftwareVersion":"adyen_423314",
               "ManufacturerID":"Adyen",
               "ApplicationName":"Nexo"
            },
            "DateTime":"2018-04-03T08:50:23.000Z",
            "POIStatus":{
               "CommunicationOKFlag":true,
               "GlobalStatus":"OK"
            }
         },
         "Response":{
            "Result":"Success"
         }
      },
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "SaleID":"POSSystemID12345",
         "MessageClass":"Service",
         "MessageCategory":"Login",
         "ServiceID":"0403105031",
         "POIID":"P400Plus-275008565",
         "MessageType":"Response"
      }
   }
}

After a successful Login Request, the terminal will save the supplied values in persistent storage. The values will remain in effect until a new login request is processed or until a logout request is done.

Logout Request

For a list of LogoutRequest fields, see LogoutRequest fields.

The elements of a logout request are wrapped in a LogoutRequest envelope.

The LogoutRequest will erase the persistent data stored by the LoginRequest.

The fields described below are the basic payment fields you specify when making a LogoutRequest call to the Terminal API.

LogoutRequest
{
   "SaleToPOIRequest":{
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "MessageClass":"Service",
         "MessageCategory":"Logout",
         "MessageType":"Request",
         "ServiceID":"0403105613",
         "SaleID":"POSSystemID12345",
         "POIID":"P400Plus-275008565"
      },
      "LogoutRequest":{

      }
   }
}


For a list of LogoutResponse fields, see LogoutResponse fields.You receive a response with the following fields:

LogoutResponse
{
   "SaleToPOIResponse":{
      "LogoutResponse":{
         "Response":{
            "Result":"Success"
         }
      },
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "SaleID":"POSSystemID12345",
         "MessageClass":"Service",
         "MessageCategory":"Logout",
         "ServiceID":"0403105613",
         "POIID":"P400Plus-275008565",
         "MessageType":"Response"
      }
   }
}