Login Request

It conveys information related to the session (period between a Login and the following Logout) to process. Content of the LoginRequest message.

Click to copy

Request Parameters

DateTimestringRequired

Date and Time. In the Login request message, the Sale System gives its date and time to the POI System. In the Login response, the POI System gives its date and time to the Sale System.

SaleSoftwareobjectRequired

Information related to the software of the Sale System which manages the NEXO Sale to POI protocol.

SaleTerminalDataobject

Information related to the software and hardware features of the Sale Terminal. Sent in the Login Request if a Sale Terminal is involved in the login. In other messages, sent when a logical device is out of order (SaleCapabilities) or when other data have changed or were missing in the Login.

TrainingModeFlagboolean

Training mode. This flag indicates to the POI that the entire session will be not used to make real transaction, but is used for test of system or operator training.

OperatorLanguagestringRequired

Language of the Cashier or Operator. Default value for Device type displays.

OperatorIDstring

Identification of the Cashier or Operator. Four conditions to send it:

  • The Sale System wants the POI to log it in the transaction log.
  • Because of reconciliation with total on OperatorID.
  • Because the POI needs it.
  • Acquirer or issuer need it.
ShiftNumberstring

Shift number. Same as OperatorID.

TokenRequestedTypestring

Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period.

CustomerOrderReqarray[string]

List of customer order open, closed or both to be sent in the response messages.

POISerialNumberstring

Serial number of a POI Terminal. If the login involve a POI Terminal and not the first Login to the POI System.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200

    It conveys Information related to the Login to process. Content of the Login Response message.

    Show moreShow less