Terminal API Reference

Review our API reference for our implementation of the nexo standard. For a definitive list of specifications for the nexo Sale to POI (Point of Interaction) protocol, see nexo standards website. 

AbortRequest

Definition: Body of the Abort Request message.

Usage: It conveys Information requested for identification of the message request carrying the transaction to abort. A message to display on the CustomerError Device could be sent by the Sale System (DisplayOutput).

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Identification of a previous POI transaction.

 

AbortReason

REQUIRED

String

Reason of aborting a transaction

 

CONDITIONAL

Defined datastructure

Information to display and the way to process the display.

To display an abort message to the Customer

AccountType

Name: AccountType

Type: Enumeration

  • Default
  • Savings
  • Checking
  • CreditCard
  • Universal
  • Investment
  • CardTotals
  • EpurseCard

Alignment

Name: Alignment

Type: Enumeration

  • Left
  • Right
  • Centred
  • Justified

AllowedProduct

Definition: Product codes that are payable by the payment card.

Usage: Product that is payable by the payment card.

Type: defined data structure

Component

Required

Type

Description

Rule

ProductCode

REQUIRED

DigitString

Product code of item purchased with the transaction.

 

The length of the string must be greater than or equal to 1 and less than or equal to 20

EanUpc

CONDITIONAL

DigitString

Standard product code of item purchased with the transaction.

 

ProductLabel

CONDITIONAL

String

Product name of an item purchased with the transaction.

 

AdditionalProductInfo

CONDITIONAL

String

Additionl information related to the line item.

 

AmountsReq

Type: defined data structure

Component

Required

Type

Description

Rule

Currency

REQUIRED

ISOCurrency

Currency of a monetary amount.

 

RequestedAmount

CONDITIONAL

SimpleAmount

Amount requested by the Sale for the payment.

 

CashBackAmount

CONDITIONAL

SimpleAmount

The cash-back part of the amount requested by the Sale for the payment.

 

TipAmount

CONDITIONAL

SimpleAmount

Amount paid for a tip. Allow the printing of the tip on the receipt, and to qualify the tip part of the amount.

 

PaidAmount

CONDITIONAL

SimpleAmount

Amount already paid amount in case of split payment. Depending on the context, a split payment is either a split amount, either a split basket (required by some payment means as fleet cards). The PaidAmount is present when the split payment is a split of the amount. Split of the basket involves two Sale Transactions, and has not to be recognised by the POI.

 

MinimumAmountToDeliver

CONDITIONAL

SimpleAmount

Minimum amount the Sale System is allowed to deliver for this payment. For the OneTimeReservation, when the maximum amount is unknown, the Sale System indicates the minimum amount it allows.

 

MaximumCashBackAmount

CONDITIONAL

SimpleAmount

Maximum amount which could be requested for cash-back to the Sale System. Allows the Cashier to limit the amount value of cash-back to deliver to the Customer.

 

MinimumSplitAmount

CONDITIONAL

SimpleAmount

Minimum amount of a split, which could be requested by a Customer.Allows the Merchant to limit the number of split requested by the Customer.

 

AmountsResp

Type: defined data structure

Component

Required

Type

Description

Rule

Currency

CONDITIONAL

ISOCurrency

Currency of a monetary amount.

AuthorizedAmount

REQUIRED

SimpleAmount

Amount requested by the Sale for the payment.

TotalRebatesAmount

CONDITIONAL

SimpleAmount

Sum of rebates in amount (total amount or line item amount) for all the loyalty programs.

TotalFeesAmount

CONDITIONAL

SimpleAmount

Total amount of financial fees.

CashBackAmount

CONDITIONAL

SimpleAmount

The cash-back part of the amount requested by the Sale for the payment.

TipAmount

CONDITIONAL

SimpleAmount

Amount paid for a tip. Allow the printing of the tip on the receipt, and to qualify the tip part of the amount.

AreaSize

Type: defined data structure

Component

Required

Type

Description

Rule

X

REQUIRED

HexString

Abscissa of a point coordinates. The hexadecimal value in text of the abscissa of the coordinates of a point. Leading zero can be removed (e.g. 3BC, 0, and 1287).

The length of the string must be greater than or equal to 1 and less than or equal to 4

Y

REQUIRED

HexString

Ordinate of a point coordinates. The hexadecimal value in text of the ordinate of the coordinates of a point. Leading zero can be removed (e.g. 3BC, 0, and 1287).

The length of the string must be greater than or equal to 1 and less than or equal to 4

AuthenticationMethod

Name: AuthenticationMethod

Type: Cluster

  • Bypass
  • ManualVerification
  • MerchantAuthentication
  • OfflinePIN
  • OnlinePIN
  • PaperSignature
  • SecuredChannel
  • SecureCertificate
  • SecureNoCertificate
  • SignatureCapture
  • UnknownMethod

BalanceInquiryRequest

Definition: Content of the Balance Inquiry Request message.

Usage: It conveys Information related to the account for which a Balance Inquiry is requested

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Defined datastructure

Data related to the account pointed by the payment card

 

CONDITIONAL

Defined datastructure

Data related to a requested Loyalty program or account.

 

BalanceInquiryResponse

Definition: Content of the Balance Inquiry Response message.

Usage: It conveys the balance and the identification of the associated payment, loyalty or stored value account.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Result of a message request processing.

 

CONDITIONAL

Defined datastructure

Data related to the result of a Balance Inquiry request.

If BalanceInquiryRequest. PaymentAccount present

CONDITIONAL

Defined datastructure

Data related to the result of a loyalty Balance Inquiry.

If BalanceInquiryRequest. LoyaltyData present

REQUIRED ARRAY

Defined datastructure

 

 

BarcodeType

Name: BarcodeType

Type: Enumeration

  • EAN8
  • EAN13
  • UPCA
  • Code25
  • Code128
  • PDF417
  • QRCode

CapturedSignature

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Defined datastructure

Size of an area. Contain the size of the pad area where the signature is written, given with the maximum abscissa and ordinate values (X and Y). The maximum value is 'FFFF'.

 

REQUIRED ARRAY

Defined datastructure

Coordinates of a point where the pen changes direction or lift. Contain the Coordinates of a point of the written signature where the pen changes direction or lift where (X and Y). When the signer lifts the pen, both X and Y have the value 'FFFF'.

 

CardAcquisitionRequest

Definition: Content of the Card Acquisition Request message.

Usage: It conveys Information related to the payment and loyalty cards to read and analyse. This message pair is usually followed by a message pair (e.g. payment or loyalty) which refers to this Card Acquisition message pair. 

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Data related to the Sale System.

REQUIRED

Defined datastructure

Data related to the payment and loyalty card acquisition.

CardAcquisitionResponse

Definition: Content of the Card Acquisition Response message.

Usage: It conveys Information related to the payment and loyalty cards read and processed by the POI System and entered by the Customer:As for the Payment request, the result of the CardAcquisition and the identification of the transaction.

 Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Result of a message request processing.

REQUIRED

Defined datastructure

Data related to the Sale System.

REQUIRED

Defined datastructure

Data related to the POI System.

CustomerLanguage

CONDITIONAL

ISOLanguage

Data related to the POI System.

PaymentBrand

REQUIRED ARRAY

String

Type of payment card

Brands available for payment by the card and not chosen by the Customer

CONDITIONAL

Defined datastructure

Data related to the instrument of payment for the transaction.

If this type of payment card is configured to send information if the CardAcquisition response

CardAcquisitionTransaction

Type: defined data structure

Component

Required

Type

Description

Rule

AllowedPaymentBrand

REQUIRED ARRAY

String

 

 

AllowedLoyaltyBrand

REQUIRED ARRAY

String

 

 

CONDITIONAL

Enumeration

 

 

CustomerLanguage

CONDITIONAL

ISOLanguage

 

 

CONDITIONAL

Cluster

 

 

ForceCustomerSelectionFlag

CONDITIONAL

Boolean

 

 

TotalAmount

CONDITIONAL

SimpleAmount

 

 

CONDITIONAL

Enumeration

 

 

CashBackFlag

CONDITIONAL

Boolean

 

 

CardData

Definition: Information related to the payment card used for the transaction.

Usage: Allows acquisition of the card data by the Sale System before the Payment, CardAcquisition or BalanceInquiry request to the POI. It could also be sent in the CardAcquisition response, to be processed by the Sale System. 

In this case, the card or type of card has to be configured to have this behaviour. It is then expected that for this card the information sent in response to the payment are the same for the CardAcquisition response. Data that could be protected in the response are grouped in the data structure SentitiveCardData. In BalanceInquiryResponse and CardAcquisitionResponse, AllowedProduct may be provided for card with retsrictions on products. 

Type: defined data structure

 

Component

Required

Type

Description

Rule

PaymentBrand

CONDITIONAL

String

Type of payment card

If card PAN is readable

MaskedPan

CONDITIONAL

String

PaymentAccountRef

CONDITIONAL

String

CONDITIONAL

Cluster

Entry mode of the payment instrument information

Mandatory in the request

CardCountryCode

CONDITIONAL

DigitString

Country Code attached to the card (3 numerics).

If available in the card

The length of the string must be exactly 3

ProtectedCardData

CONDITIONAL

ContentInformation

Sensitive information related to the payment card, protected by CMS.

SensitiveCardData protected by CMS EnvelopedData

CONDITIONAL

Defined datastructure

Sensitive information related to the payment card, entered or read by the Sale System.

If structure non empty and unprotected

AllowedProductCode

REQUIRED ARRAY

DigitString

Product codes that are payable by the payment card.

If not all the products are accepted for the payment card proposed by the Customer. In this case, Result is failure, ErrorCondition is Payment Restriction. For One Time Reservation, the POI can send product codes payable by the payment, even if the POI did not send SaleItem in the request. If at least one product sent in the request is accepted, the Result is Success.

The length of the string must be greater than or equal to 1 and less than or equal to 20

REQUIRED ARRAY

Defined datastructure

Product that is payable by the payment card.

CONDITIONAL

Defined datastructure

Surrogate of the PAN (Primary Account Number) of the payment card to identify the payment mean of the customer. It allows, for a merchant, to identify the customer.

Restriction of product payable by a card.

REQUIRED ARRAY

Defined datastructure

Customer order attached to a customer, recorded in the POI system. Allows the management of customer orders by the POI, for instance in a multi-channel or a click and collect sale transaction.

CardReaderAPDUResponse

Definition: Content of the Card Reader APDU Response message.

Usage: It contains the result of the requested service, APDU response sent by the chip of the card in response to the APDU request.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Result of a message request processing.

 

APDUData

CONDITIONAL

ByteSequence

Data field of the APDU command (Lc + Data)

 

CardStatusWords

REQUIRED

ByteSequence

Status of a smartcard response to a command (SW1-SW2)

 

The length of the bytesequence must be exactly 2

CashHandlingDevice

Definition: Status of cash handling device.

Usage: Indicate the status and the remaining coins and bill in a cash handling device.

Type: defined data structure

Component

Required

Type

Description

Rule

CashHandlingOKFlag

REQUIRED

Boolean

Indicates if the cash handling device is working and usable.

 

Currency

REQUIRED

ISOCurrency

Currency of a monetary amount.

 

REQUIRED ARRAY

Defined datastructure

Number of coins or bills of a given value.

 

CharacterHeight

Name: CharacterHeight

Type: Enumeration

  • SingleHeight
  • DoubleHeight
  • HalfHeight

CharacterStyle

Name: CharacterStyle

Type: Enumeration

  • Normal
  • Bold
  • Italic
  • Underline

CharacterWidth

Name: CharacterWidth

Type: Enumeration

  • SingleWidth
  • DoubleWidth

CheckData

Definition: Information related to the paper check used for the transaction.

Usage: Allows the check information to be provided by the Sale System before requesting the payment, or stored by the Sale System after processing of the payment.

Type: defined data structure

Component

Required

Type

Description

Rule

BankID

CONDITIONAL

String

Identification of the bank.

Mandatory if TrackData absent

AccountNumber

CONDITIONAL

String

Identification of the customer account.

Mandatory if TrackData absent

CheckNumber

CONDITIONAL

String

Identification of the bank check.

Mandatory if TrackData absent

CONDITIONAL

Defined datastructure

Magnetic track or magnetic ink characters line.

Mandatory if CheckNumber absent

CheckCardNumber

CONDITIONAL

String

Check guarantee card number.

If provided by the customer

CONDITIONAL

Enumeration

Type of bank check.

 

Country

CONDITIONAL

ISOCountry

Country of the bank check.

Absent if country of the Sale system

CoinsOrBills

Definition: Number of coins or bills of a given value.

Usage: Indicates the remaining number of coins or bills of a given value in a cash handling device. When the cash handling machine does not have any more coins or bills of a certain value, the number must be equal to 0.

Type: defined data structure

Component

Required

Type

Description

Rule

UnitValue

REQUIRED

SimpleAmount

Value of a coin or bill.

 

Number

REQUIRED

Integer

Number of elements

 

Color

Name: Color

Type: Enumeration

  • White
  • Black
  • Red
  • Green
  • Blue
  • Yellow
  • Magenta
  • Cyan

ConvertedAmount

Type: defined data structure

Component

Required

Type

Description

Rule

AmountValue

REQUIRED

SimpleAmount

Value of an amount.

 

Currency

REQUIRED

ISOCurrency

Currency of a monetary amount.

 

CurrencyConversion

Definition: Information related to a currency conversion

Usage: A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt)

Type: defined data structure

Component

Required

Type

Description

Rule

CustomerApprovedFlag

CONDITIONAL

Boolean

Notify if the customer has approved something. Indicates if the customer has accepted a currency conversion.

 

REQUIRED

Defined datastructure

Amount after a currency conversion.

 

Rate

CONDITIONAL

Decimal

Rate of currency conversion.

 

Markup

CONDITIONAL

Decimal

Markup of a currency conversion amount as a percentage.

 

Commission

CONDITIONAL

SimpleAmount

Commission for a currency conversion.

 

Declaration

CONDITIONAL

String

Declaration to present to the customer or the cashier for validation.

If a declaration has to be presented to the customer

CustomerOrder

Definition: Customer order attached to a customer, recorded in the POI system.

Usage: Allows the management of customer orders by the POI, for instance in a multi-channel or a click and collect sale transaction.

Type: defined data structure

Component

Required

Type

Description

Rule

CustomerOrderID

CONDITIONAL

String

Additional and optional identification of a customer order.

 

SaleReferenceID

REQUIRED

String

Identification of a Sale global transaction for a sequence of related POI transactions. Identification of a reservation transaction for the sequence of reservation and the completion

 

OpenOrderState

CONDITIONAL

Boolean

Specifies if a customer order is currently Open. An open customer order is an order waiting for further operations.

 

StartDate

REQUIRED

ISODateTime

Date time of the beginning of an operation.

 

EndDate

CONDITIONAL

ISODateTime

Date time of the end of an operation.

 

ForecastedAmount

REQUIRED

SimpleAmount

Depending on the choice of the sale system it could equal the initial amount of the order or the global amount of the order. If ForecastedAmount equals the initial amount of the order it will allow the system to follow any additional payment. In case of equality with the global amount of the order, the system will then be able to follow remaining amounts.

 

CurrentAmount

REQUIRED

SimpleAmount

Total amount of all completed transactions of a customer order.

 

Currency

CONDITIONAL

ISOCurrency

Currency of a monetary amount.

 

AccessedBy

CONDITIONAL

String

Identification of an entity accessing data to perform an operation. Allow the synchronisation of customer order processing, when several parts of the Sale System access a customer order at the same time. The Sale entity active on the customer order is identified by this data.

 

AdditionalInformation

CONDITIONAL

String

Unqualified information.

 

CustomerOrderReq

Name: CustomerOrderReq

Type: Cluster

  • Open
  • Closed
  • Both

Device

Name: Device

Type: Enumeration

  • CashierDisplay
  • CustomerDisplay
  • CashierInput
  • CustomerInput

DiagnosisRequest

Definition: Content of the Diagnosis Request message.

Usage: It conveys Information related to the target POI for which the diagnosis is requested

Type: defined data structure

Component

Required

Type

Description

Rule

POIID

CONDITIONAL

String

Identification of a POI System or a POI Terminal for the Sale to POI protocol

MessageHeader.POIID

HostDiagnosisFlag

CONDITIONAL

Boolean

Indicates if Host Diagnosis are required

 

AcquirerID

REQUIRED ARRAY

DigitString

Identification of the Acquirer

Present if requesting the diagnosis of these hosts only.

DiagnosisResponse

Definition: Content of the Diagnosis Response message.

Usage: It conveys the result of the requested diagnosis and a possible message to display on a logical device.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Result of a message request processing.

 

LoggedSaleID

REQUIRED ARRAY

String

Sale Terminal logged to.

If Sale Terminal logged to this POI Terminal

CONDITIONAL

Defined datastructure

State of a POI Terminal.

if Response.Result is Success

REQUIRED ARRAY

Defined datastructure

State of a Host.

 

DisplayOutput

Definition: Information to display and the way to process the display.

Usage: It contains a complete display operation for a Display or an Input Device type. For the Input Devices, Diagnosis and EnableService, ResponseRequiredFlag and MinimumDisplayTime shall be absent.

Type: defined data structure

Component

Required

Type

Description

Rule

ResponseRequiredFlag

CONDITIONAL

Boolean

Request of a message response.

MinimumDisplayTime

CONDITIONAL

Integer

Number of seconds the message has to be displayed

REQUIRED

Enumeration

Logical device located on a Sale Terminal or a POI Terminal, in term of class of information to output (display, print

CashierDisplay, CustomerDisplay

REQUIRED

Enumeration

Qualification of the information to sent to an output logical device, to display or print to the Cashier or the

Status, Error, Display, POIReplication

REQUIRED

Defined datastructure

Content to display or print.

MenuEntry

REQUIRED ARRAY

Defined datastructure

An entry of the menu to present to the Cashier

Conveys message text and parameters of the menu entry. This output data could be provided

for an input command, to choose an entry of the menu

OutputSignature

CONDITIONAL

ByteSequence

Vendor specific signature of text message to display or print.

If protection has to be provided to the vendor on the text to display or print.

DisplayRequest

Definition: Content of the Display Request message.

Usage: It conveys the data to display and the way to process the display. It contains the complete content to display. It might contain an operation (the DisplayOutput element) per Display Device type.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED ARRAY

Defined datastructure

Information to display and the way to process the display.

Complete display content for output devices. At most one DisplayOutput per Device/ InfoQualify pair

DisplayResponse

Definition: Content of the Display Response message.

Usage: It conveys the result of the display, parallel to the message request, except if response not required and absent.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED ARRAY

Defined datastructure

Information related to the result the output (display, print, input).

One per DisplayOutput item of the request, and in the same order.

DocumentQualifier

Name: DocumentQualifier

Type: Enumeration

  • SaleReceipt
  • CashierReceipt
  • CustomerReceipt
  • Document
  • Voucher
  • Journal

EnableServiceRequest

Definition: Content of the Enable Service Request message.

Usage: It conveys the services that will be enabled for the POI Terminal without the request of the Sale System, and a possible invitation for the Customer to start the services.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Enumeration

Action to realise on a transaction.

 

CONDITIONAL

Cluster

Services which are enabled before the start-up of a transaction

Mandatory if TransactionAction is 'StartTransaction', absent if not.

CONDITIONAL

Defined datastructure

Information to display and the way to process the display.

 

EnableServiceResponse

Definition: Content of the Enable Service Response message.

Usage: It conveys the result of the Enable Service processing.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Result of a message request processing.

 

EntryMode

Name: EntryMode

Type: Cluster

  • RFID
  • Keyed
  • Manual
  • File
  • Scanned
  • MagStripe
  • ICC
  • SynchronousICC
  • Tapped
  • Contactless
  • Mobile

ErrorCondition

Name: ErrorCondition

Type: Enumeration

  • Aborted
  • Busy
  • Cancel
  • DeviceOut
  • InsertedCard
  • InProgress
  • LoggedOut
  • MessageFormat
  • NotAllowed
  • NotFound
  • PaymentRestriction
  • Refusal
  • UnavailableDevice
  • UnavailableService
  • InvalidCard
  • UnreachableHost
  • WrongPIN

EventNotification

Definition: Content of the EventNotification message.

Usage: It conveys Information related to the event, and possible action (maintenance, message to display).

Type: defined data structure

Component

Required

Type

Description

Rule

TimeStamp

REQUIRED

ISODateTime

Date and time of a transaction for the Sale System, the POI System or the Acquirer.

 

REQUIRED

Enumeration

Event the POI notifies to the Sale System.

 

EventDetails

CONDITIONAL

String

Information about the event the POI notifies to the Sale System.

If present, the Sale logs it for further examination

RejectedMessage

CONDITIONAL

ByteSequence

Message request rejected by the receiver.

Mandatory if EventToNotify is 'Reject', absent in other cases

MaintenanceRequiredFlag

CONDITIONAL

Boolean

Indicates if the occurred event requires maintenance call or action.

 

CustomerLanguage

CONDITIONAL

ISOLanguage

Language of the Customer

If the language is selected by the Sale System before the request to the POI.

REQUIRED ARRAY

Defined datastructure

Information to display and the way to process the display.

To display an event message

EventToNotify

Name: EventToNotify

Type: Enumeration

  • BeginMaintenance
  • EndMaintenance
  • Shutdown
  • Initialised
  • OutOfOrder
  • Completed
  • Abort
  • SaleWakeUp
  • SaleAdmin
  • CustomerLanguage
  • KeyPressed
  • SecurityAlarm
  • StopAssistance
  • CardInserted
  • CardRemoved
  • Reject

ForceEntryMode

Name: ForceEntryMode

Type: Cluster

  • RFID
  • Keyed
  • Manual
  • File
  • Scanned
  • MagStripe
  • ICC
  • SynchronousICC
  • Tapped
  • Contactless
  • CheckReader

GenericProfile

Name: GenericProfile

Type: Enumeration

  • Basic
  • Standard
  • Extended

GeographicCoordinates

Type: defined data structure

Component

Required

Type

Description

Rule

Latitude

REQUIRED

String

 

 

Longitude

REQUIRED

String

 

 

Geolocation

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Defined datastructure

 

 

CONDITIONAL

Defined datastructure

 

 

GetTotalsRequest

Definition: Content of the Get Totals Request message.

Usage: It conveys information from the Sale System related to the scope and the format of the totals to be computed by the POI System.

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Cluster

Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation.

Require to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift,

CONDITIONAL

Defined datastructure

Filter to compute the totals.

If structure is not empty

GetTotalsResponse

Definition: Content of the Reconciliation Response message.

Usage: It conveys Information related to the Reconciliation transaction processed by the POI System

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Result of a message request processing.

 

POIReconciliationID

REQUIRED

DigitString

Identification of the reconciliation period between Sale and POI.

 

REQUIRED ARRAY

Defined datastructure

Result of the Sale to POI Reconciliation processing.

if Response.Result is Success

GlobalStatus

Name: GlobalStatus

Type: Enumeration

  • OK
  • Busy
  • Maintenance
  • Unreachable

HostStatus

Definition: State of a Host.

Usage: Indicate the reachability of the host by the POI Terminal.

Type: defined data structure

Component

Required

Type

Description

Rule

AcquirerID

REQUIRED

DigitString

Identification of the Acquirer

 

IsReachableFlag

CONDITIONAL

Boolean

Indicate if a Host is reachable

 

IdentificationSupport

Name: IdentificationSupport

Type: Enumeration

  • NoCard
  • LoyaltyCard
  • HybridCard
  • LinkedCard

IdentificationType

Name: IdentificationType

Type: Enumeration

  • PAN
  • ISOTrack2
  • BarCode
  • AccountNumber
  • PhoneNumber

InfoQualify

Name: InfoQualify

Type: Enumeration

  • Status
  • Error
  • Display
  • Sound
  • Input
  • POIReplication
  • CustomerAssistance
  • Receipt
  • Document
  • Voucher

InputCommand

Name: InputCommand

Type: Enumeration

  • GetAnyKey
  • GetConfirmation
  • SiteManager
  • TextString
  • DigitString
  • DecimalString
  • GetFunctionKey
  • GetMenuEntry
  • Password

InputData

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Enumeration

 

 

REQUIRED

Enumeration

 

 

REQUIRED

Enumeration

 

 

NotifyCardInputFlag

CONDITIONAL

Boolean

 

 

MaxInputTime

CONDITIONAL

Integer

 

 

ImmediateResponseFlag

CONDITIONAL

Boolean

 

 

MinLength

CONDITIONAL

Integer

 

 

MaxLength

CONDITIONAL

Integer

 

 

MaxDecimalLength

CONDITIONAL

Integer

 

 

WaitUserValidationFlag

CONDITIONAL

Boolean

 

 

DefaultInputString

CONDITIONAL

String

 

 

StringMask

CONDITIONAL

String

 

 

FromRightToLeftFlag

CONDITIONAL

Boolean

 

 

MaskCharactersFlag

CONDITIONAL

Boolean

 

 

BeepKeyFlag

CONDITIONAL

Boolean

 

 

GlobalCorrectionFlag

CONDITIONAL

Boolean

 

 

DisableCancelFlag

CONDITIONAL

Boolean

 

 

DisableCorrectFlag

CONDITIONAL

Boolean

 

 

DisableValidFlag

CONDITIONAL

Boolean

 

 

MenuBackFlag

CONDITIONAL

Boolean

 

 

InputRequest

Definition: Content of the Input Request message.

Usage: It conveys data to display and the way to process the display, and contains the complete content to display. In addition to the display on the Input Device, it might contain an operation (the DisplayOutput element) per Display Device type.

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Defined datastructure

Information to display and the way to process the display.

 

REQUIRED

Defined datastructure

Information related to an Input request.

 

InputResponse

Definition: Content of the Input Response message.

Usage: It conveys:The result of the outputs, parallel to the message request, except if response not required and absent. The result of the input

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Defined datastructure

Information related to the result the output (display, print, input).

If DisplayOutput present in the request.

REQUIRED

Defined datastructure

Information related to the result the input.

 

InputResult

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Enumeration

REQUIRED

Enumeration

REQUIRED

Defined datastructure

Input

CONDITIONAL

Defined datastructure

Instalment

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Enumeration

 

 

SequenceNumber

CONDITIONAL

Integer

 

 

PlanID

CONDITIONAL

String

 

 

Period

CONDITIONAL

Integer

 

 

CONDITIONAL

Enumeration

 

 

FirstPaymentDate

CONDITIONAL

ISODate

 

 

TotalNbOfPayments

CONDITIONAL

Integer

 

 

CumulativeAmount

CONDITIONAL

SimpleAmount

 

 

FirstAmount

CONDITIONAL

SimpleAmount

 

 

Charges

CONDITIONAL

SimpleAmount

 

 

InstalmentType

Name: InstalmentType

Type: Enumeration

  • DeferredInstalment
  • EqualInstalments
  • UnequalInstalments

LoginRequest

Definition: Content of the Login Request message.

Usage: It conveys Information related to the session (period between a Login and the following Logout) to process

Type: defined data structure

Component

Required

Type

Description

Rule

DateTime

REQUIRED

ISODateTime

Date and Time

 

REQUIRED

Defined datastructure

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

 

CONDITIONAL

Defined datastructure

Information related to the software and hardware feature of the Sale Terminal.

Present if the login involve a Sale Terminal

TrainingModeFlag

CONDITIONAL

Boolean

Training mode

The POI does not realise the transaction with the Acquirer

OperatorLanguage

REQUIRED

ISOLanguage

Language of the Cashier or Operator.

Default value for Device type displays

OperatorID

CONDITIONAL

String

Identification of the Cashier or Operator.

4 conditions to send it: a) the Sale System wants the POI log it in the transaction log b) because of reconciliation

ShiftNumber

CONDITIONAL

String

Shift number.

Same as OperatorID

CONDITIONAL

Enumeration

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

 

CONDITIONAL

Cluster

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

 

POISerialNumber

CONDITIONAL

String

Serial number of a POI Terminal

If the login involve a POI Terminal and not the first Login to the POI System

LoginResponse

Definition: Content of the Login Response message.

Usage: It conveys Information related to the Login to process

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Result of a message request processing.

 

CONDITIONAL

Defined datastructure

Information related to the POI System

if Response.Result is Success

TokenRequestStatus

CONDITIONAL

Boolean

 

 

CustomerOrderStatus

CONDITIONAL

Boolean

 

 

LogoutRequest

Definition: Content of the Logout Request message.

Usage: Empty

Type: defined data structure

Component

Required

Type

Description

Rule

MaintenanceAllowed

CONDITIONAL

Boolean

 

 

LogoutResponse

Definition: Content of the Logout Response message.

Usage: It conveys the result of the Logout.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Result of a message request processing.

 

LoyaltyAccount

Definition: Data related to a loyalty account processed in the transaction.

Usage: This data structure conveys the identification of the account and the associated loyalty brand.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Identification of a Loyalty account.

 

LoyaltyBrand

CONDITIONAL

String

Identification of a Loyalty brand.

If a card is analysed

LoyaltyAccountID

Definition: Identification of a Loyalty account.

Usage: In the Payment or the Loyalty Request message, it allows to identify the loyalty account by the Sale Terminal instead of the POI Terminal (e.g. because the account identification is a bar-code read by the Cashier on a scanner device). In

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Cluster

 

 

REQUIRED

Enumeration

 

 

CONDITIONAL

Enumeration

 

 

LoyaltyID

REQUIRED

String

 

 

LoyaltyAccountReq

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Defined datastructure

 

 

CONDITIONAL

Defined datastructure

 

 

LoyaltyAccountStatus

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

 

 

CurrentBalance

CONDITIONAL

SimpleAmount

 

 

CONDITIONAL

Enumeration

 

 

Currency

CONDITIONAL

ISOCurrency

 

 

LoyaltyAcquirerData

Type: defined data structure

Component

Required

Type

Description

Rule

LoyaltyAcquirerID

CONDITIONAL

String

 

 

ApprovalCode

CONDITIONAL

String

 

 

CONDITIONAL

Defined datastructure

 

 

HostReconciliationID

CONDITIONAL

String

 

 

LoyaltyAmount

Definition: Amount of a loyalty account.

Usage: An awarded amount or an amount to redeem to the loyalty account might be sent in the Payment request message. The amount to apply on the requested loyalty service, if not computed from the TotalAmount of the Loyalty request message. The

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Enumeration

 

 

Currency

CONDITIONAL

ISOCurrency

 

 

AmountValue

REQUIRED

SimpleAmount

 

 

LoyaltyData

Definition: Data related to a Loyalty program or account.

Usage: In the Payment, Loyalty or Balance Inquiry Request message, it allows the Sale Terminal to send the identification of the loyalty account or an awarded amount or an amount to redeem to the loyalty account.

Type: defined data structure

Component

Required

Type

Description

Rule

CONDITIONAL

Defined datastructure

Reference to the last CardAcquisition, to use the same card.

If the loyalty account ID comes from a previous CardAcquisition

CONDITIONAL

Defined datastructure

Identification of a Loyalty account.

If loyalty identification of the loyalty account is realised by the Sale System

CONDITIONAL

Defined datastructure

Amount of a loyalty account.

When the Sale System want to award the Loyalty account (not for BalanceInquiryRequest)

LoyaltyHandling

Name: LoyaltyHandling

Type: Enumeration

  • Forbidden
  • Processed
  • Allowed
  • Proposed
  • Required

LoyaltyResponse

Definition: Content of the Loyalty Response message.

Usage: It conveys Information related to the Loyalty transaction processed by the POI System.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Result of a message request processing.

 

REQUIRED

Defined datastructure

Data related to the Sale System.

 

REQUIRED

Defined datastructure

Data related to the POI System.

 

REQUIRED ARRAY

Defined datastructure

Data related to the result of a processed loyalty transaction.

if loyalty account identified

REQUIRED ARRAY

Defined datastructure

 

 

LoyaltyResult

Definition: Data related to the result of a processed loyalty transaction.

Usage: In the Message Response, the result of each loyalty brand transaction.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Defined datastructure

Data related to a loyalty account processed in the transaction.

 

CurrentBalance

CONDITIONAL

SimpleAmount

Balance of an account.

if known (provided by the card or an external host)

CONDITIONAL

Defined datastructure

Amount of a loyalty account.

If awarded amount

CONDITIONAL

Defined datastructure

Data related to the loyalty Acquirer during a loyalty transaction.

if content not empty

CONDITIONAL

Defined datastructure

Rebate form to an award;

if rebates awarded

LoyaltyTotals

Definition: Totals of the loyalty transaction during the reconciliation period.

Type: defined data structure

Component

Required

Type

Description

Rule

REQUIRED

Enumeration

Type of transaction for which totals are grouped.

Award, ReverseAward, Redemption, ReverseRedemption, Rebate, ReverseRebate

TransactionCount

REQUIRED

Integer

Number of processed transaction during the period.

 

TransactionAmount

REQUIRED

SimpleAmount

Sum of amount of processed transaction during the period.

 

LoyaltyUnit

Name: LoyaltyUnit

Type: Enumeration

  • Point
  • Monetary

MenuEntryTag

Name: MenuEntryTag

Type: Enumeration

  • Selectable
  • NonSelectable
  • SubMenu
  • NonSelectableSubMenu

MessageCategory

Name: MessageCategory

Type: Enumeration

  • Abort
  • Admin
  • BalanceInquiry
  • Batch
  • CardAcquisition
  • CardReaderAPDU
  • CardReaderInit
  • CardReaderPowerOff
  • Diagnosis
  • Display
  • EnableService
  • Event
  • GetTotals
  • Input
  • InputUpdate
  • Login
  • Logout
  • Loyalty
  • Payment
  • PIN
  • Print
  • Reconciliation
  • Reversal
  • Sound
  • StoredValue
  • TransactionStatus
  • Transmit

MessageClass

Name: MessageClass

Type: Enumeration

  • Service
  • Device
  • Event

MessageHeader

Definition: Message header of the Sale to POI protocol message.

Usage: It conveys Information related to the Sale to POI protocol management

Type: defined data structure

Component

Required

Type

Description

Rule