Login Request

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

Request Parameters

Required

Optional

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.

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

Show children

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.

Show children

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.

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

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.

Shift number. Same as OperatorID.

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. Possible values:

Customer
Transaction

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

Both
Closed
Open

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
Responseobject
Result of a message request processing. If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can refine the processing of the message response. AdditionalResponse gives more information about the success or the failure of the message request processing, for logging without real time involvements.
Show children Hide children
Resultstring
Result of the processing of the message. Possible values:

Failure

Partial

Success

ErrorConditionstring
Condition that has produced an error on the processing of a message request. Returned if Result is not Success. Possible values:

Aborted

Busy

Cancel

DeviceOut

InProgress

InsertedCard

InvalidCard

LoggedOut

MessageFormat

NotAllowed

NotFound

PaymentRestriction

Refusal

UnavailableDevice

UnavailableService

UnreachableHost

WrongPIN

AdditionalResponsestring
Additional information related to processing status of a message request. If present, the POI logs it for further examination.
POISystemDataobject
Information related to the POI System. Returned if the response result is Success.
Show children Hide children
DateTimestring
Date and Time. In the response, the POI System gives its date and time to the Sale System.
POISoftwareobject
Information related to the software of the POI System which manages the Sale to POI protocol. In a session allows identifying the product features of a POI System.
Show children Hide children
ManufacturerIDstring
Identification of the Manufacturer. Sent in the Login Request (Response) to identify the Sale System (POI System) manufacturer during the session.
ApplicationNamestring
Name of the software product. Sent in the Login Request (Response) to identify the Sale System (POI System) product name during the session.
SoftwareVersionstring
Version of the software product. Sent in the Login Request (Response) to identify the version of the Sale System (POI System) product software during the session.
CertificationCodestring
Certification code of the software which manages the Sale to POI protocol. Sent in the Login Request (Response) to get the certification code of the Sale System (POI System) product software. This code can be a software checksum or any number associated with the software.
POITerminalDataobject
Information related to the software and hardware features of the POI Terminal. In a session, it allows identifying the features of the POI Terminal attached to a Sale Terminal per Login Request message.
Show children Hide children
TerminalEnvironmentstring
Environment of the Terminal. Sent in the Login Request (Response) to identify the environment of the Sale System (POI System) during the session. Sent in other messages when the data has changed since the Login. Possible values:

Attended

SemiAttended

Unattended

POICapabilitiesarray[string]
Hardware capabilities of the POI Terminal. They are the POI capabilities the POI System allows the Sale System to use. These POI capabilities include the logical devices enumerated in the devices data element (most of these devices could be on the POI part), plus card reader devices. Sent in the Login Response to identify the devices of the POI Terminal which can be used by the Sale System during the session. Possible values:

CashHandling

CashierDisplay

CashierError

CashierInput

CustomerDisplay

CustomerError

CustomerInput

EMVContactless

ICC

MagStripe

PrinterDocument

PrinterReceipt

PrinterVoucher

POIProfileobject
Functional profile of the POI Terminal. Sent in the Login Response to identify the profiles the POI Terminal support during the session.
Show children Hide children
GenericProfilestring
Functional profile of the Sale to POI protocol. Sent in the Login Request to identify the messages that might be requested or received by the Sale Terminal during the session. Sent in the Login Response to identify the messages that might be processed or sent by the POI Terminal during the session. Possible values:

Basic

Extended

Standard

ServiceProfilesarray[string]
Service profiles of the Sale to POI protocol. Sent in the Login Request to identify the specific services that might be requested by the Sale Terminal during the session. Sent in the Login Response to identify the specific services that might be processed by the POI Terminal during the session. Possible values:

Batch

CardReader

Communication

Loyalty

OneTimeRes

PIN

Reservation

Sound

StoredValue

Synchro

POISerialNumberstring
Serial number of a POI Terminal. Sent in the Login Request by the Sale System to inform the POI System about the last known POI Terminal hardware.
POIStatusobject
Indicate the availability of the POI Terminal components. The data element is absent if the component is not part of the POI Terminal. State of a POI Terminal.
Show children Hide children
GlobalStatusstring
Global status of a POI Server or POI Terminal. Possible values:

Busy

Maintenance

OK

Unreachable

SecurityOKFlagboolean
Indicates if the security module of the POI is working and usable. If security module present.
PEDOKFlagboolean
Indicates if the PED is working and usable. If PED present.
CardReaderOKFlagboolean
Indicates if the card readers are working and usable. If card reader device present.
PrinterStatusstring
Indicates if the printer is working and usable. Possible values:

NoPaper

OK

OutOfOrder

PaperJam

PaperLow

CommunicationOKFlagboolean
Indicates if the communication infrastructure is working and usable. If communication infrastructure present.
CashHandlingDevicearray[object]
Status of cash handling device. If cash handling devices present.
Show children Hide children
CashHandlingOKFlagboolean
Indicates if the cash handling device is working and usable.
Currencystring
Currency of a monetary amount.
CoinsOrBillsarray[object]
Number of coins or bills of a given value.
Show children Hide children
UnitValuenumber
Maximum: 99999999.999999
Value of a coin or bill.
Numberinteger
Number of coins or bills of a certain value.
FraudPreventionFlagboolean
Indicates a suspicion of fraud by the POI System. Could be set to True by the POI system to notify to the Sale system and the Cashier that a suspicion of fraud had been detected on the POI as an unexpected reboot of the POI.
TokenRequestStatusboolean
If token is managed by the POI, the status of the token request.
CustomerOrderStatusboolean
If the POI supports the CustomerOrder functionality, the status of the customer order.

Login Request

Request Parameters

Response parameters

HTTP Responses

200