Terminal-2 icon

Log in and log out

Log in your terminal and begin processing payments. Log out of your terminal when changing operator, or at the end of a shift.

If you want to use Terminal API requests to retrieve transaction totals of a terminal or reconcile balance mismatches, you must first make a Terminal API request to log in to the terminal.

This login request can additionally mark events like a change of operator or the start of a new shift, so that you can get the totals by operator or shift.

The login request does not authenticate the operator.

Requirements

Before you begin, take into account the following requirements.

Requirement Description
Integration type A Terminal API integration with payment terminals.

Log in to the terminal

  1. Make a Terminal API login request, specifying:

    • The standard SaleToPOIRequest.MessageHeader object, with MessageClass set to Service and MessageCategory set to Login.

      Parameter Required Description
      ProtocolVersion -white_check_mark- 3.0
      MessageClass -white_check_mark- Service
      MessageCategory -white_check_mark- Login
      MessageType -white_check_mark- Request
      ServiceID -white_check_mark- Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.
      SaleID -white_check_mark- Your unique ID for the POS system component to send this request from.
      POIID -white_check_mark- The unique ID of the terminal to send this request to. Format: [device model]-[serial number].

    • The LoginRequest object, with:

      Parameter Required Description
      DateTime -white_check_mark- The date and time in UTC format.
      SaleSoftware -white_check_mark- An object with the manufacturer, application name, software version, and certification code of the sale system.
      OperatorLanguage -white_check_mark- The language of the operator in two-character ISO 639-1 format. For example, en for English.
      OperatorID Your identification of the operator.
      SaleTerminalData.TotalsGroupID Your identification of a group of transactions, for reconciliation purposes.
      ShiftNumber Your identification of the shift.

  2. In the LoginResponse, check the following:

    • Response.Result: Success indicates that you logged in to the terminal.
    • POIStatus: Indicates if the terminal is ready for use.
    {
  "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 logging in, the terminal saves the provided values. The values remain in effect until a new login request is processed for the same terminal, or until you log out from this terminal.

Log out from the terminal

  1. Make a Terminal API logout request, specifying:

    • The standard SaleToPOIRequest.MessageHeader object, with MessageClass set to Service and MessageCategory set to Logout.

      Parameter Required Description
      ProtocolVersion -white_check_mark- 3.0
      MessageClass -white_check_mark- Service
      MessageCategory -white_check_mark- Logout
      MessageType -white_check_mark- Request
      ServiceID -white_check_mark- Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.
      SaleID -white_check_mark- Your unique ID for the POS system component to send this request from.
      POIID -white_check_mark- The unique ID of the terminal to send this request to. Format: [device model]-[serial number].

    • An empty LogoutRequest object.

  2. In the LogoutResponse, check the following:

    • Response.Result: Success indicates that you logged out from the terminal.
    {
  "SaleToPOIResponse":{
     "LogoutResponse":{
        "Response":{
           "Result":"Success"
        }
     },
     "MessageHeader":{
        "ProtocolVersion":"3.0",
        "SaleID":"POSSystemID12345",
        "MessageClass":"Service",
        "MessageCategory":"Logout",
        "ServiceID":"0403105613",
        "POIID":"P400Plus-275008565",
        "MessageType":"Response"
     }
  }
}

See also