POST /login

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

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
OperatorID String No

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.
DateTime String Yes

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.

ShiftNumber String No

Shift number. Same as OperatorID.

POISerialNumber String No

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

TrainingModeFlag Boolean No

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.

Default value: false

CustomerOrderReq[] Array No

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

  • Both
  • Closed
  • Open
SaleSoftware Object Yes

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

SaleSoftware.CertificationCode String Yes

Certification code of the software which manages the Sale to POI protocol.

SaleSoftware.SoftwareVersion String Yes

Version of the software product.

SaleSoftware.ApplicationName String Yes

Name of the software product.

SaleSoftware.ManufacturerID String Yes

Identification of the Manufacturer.

OperatorLanguage String Yes

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

SaleTerminalData Object No

Information related to the software and hardware feature of the Sale Terminal. Present if the login involve a Sale Terminal.

SaleTerminalData.TotalsGroupID String No

Identification of a group of transactions on a POI Terminal, having the same Sale features. Could be used to group POI for reconciliation or other purpose defined by the Sale System. The default value is assigned by the Login Request.

TokenRequestedType String No

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

Valid values:

  • "Customer"
  • "Transaction"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.