Terminal API reference

Here we provide reference information about our Terminal API. This API is our implementation of the nexo standard. For the complete nexo specifications and protocols, see the 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
MessageReference	Required	Defined datastructure	Identification of a previous transaction.
AbortReason	Required	String	Reason of aborting a transaction.
DisplayOutput	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	Additional information related to the line item.

AmountsReq

Type: defined data structure

Component	Required	Type	Description
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 recognized 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
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
PaymentAccountReq	Conditional	Defined datastructure	Data related to the account pointed by the payment card.
LoyaltyAccountReq	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
Response	Required	Defined datastructure	Result of a message request processing.
PaymentAccountStatus	Conditional	Defined datastructure	Data related to the result of a Balance Inquiry request.	If BalanceInquiryRequest. PaymentAccount present.
LoyaltyAccountStatus	Conditional	Defined datastructure	Data related to the result of a loyalty Balance Inquiry.	If BalanceInquiryRequest. LoyaltyData present.
PaymentReceipt	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
AreaSize	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'.
SignaturePoint	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
SaleData	Required	Defined datastructure	Data related to the Sale System.
CardAcquisitionTransaction	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 payment terminal and entered by the Customer.

Type: defined data structure

Component	Required	Type	Description	Rule
Response	Required	Defined datastructure	Result of a message request processing.
SaleData	Required	Defined datastructure	Data related to the Sale System.
POIData	Required	Defined datastructure	Data related to the payment terminal.
PaymentBrand	Required Array	String	Type of payment card.	Brands available for payment by the card and not chosen by the Customer.
PaymentInstrumentData	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
AllowedPaymentBrand	Required Array	String
AllowedLoyaltyBrand	Required Array	String
LoyaltyHandling	Conditional	Enumeration
ForceEntryMode	Conditional	Cluster
ForceCustomerSelectionFlag	Conditional	Boolean
TotalAmount	Conditional	SimpleAmount
PaymentType	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.

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
EntryMode	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.
SensitiveCardData	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 payment terminal can send product codes payable by the payment, even if the terminal 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
AllowedProduct	Required Array	Defined datastructure	Product that is payable by the payment card.
PaymentToken	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.
CustomerOrder	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
Response	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
CashHandlingOKFlag	Required	Boolean	Indicates if the cash handling device is working and usable.
Currency	Required	ISOCurrency	Currency of a monetary amount.
CoinsOrBills	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.
TrackData	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.
TypeCode	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.
ConvertedAmount	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
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 synchronization 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 payment terminal for which the diagnosis is requested.

Type: defined data structure

Component	Required	Type	Description	Rule
POIID	Conditional	String	Identification of a payment terminal for the NEXO 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
Response	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.
POIStatus	Conditional	Defined datastructure	State of a POI Terminal.	if Response.Result is Success.
HostStatus	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.
Device	Required	Enumeration	Logical device located on a Sale Terminal or a POI Terminal, in term of class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer.	CashierDisplay, CustomerDisplay.
InfoQualify	Required	Enumeration	Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer.	Status, Error, Display, POIReplication.
OutputContent	Required	Defined datastructure	Content to display or print.
MenuEntry	Required Array	Defined datastructure
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
DisplayOutput	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
OutputResult	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
TransactionAction	Required	Enumeration	Action to realize on a transaction.
ServicesEnabled	Conditional	Cluster	Services which are enabled before the start-up of a transaction.	Mandatory if TransactionAction is 'StartTransaction', absent if not.
DisplayOutput	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
Response	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
Communication timeout
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 payment terminal or the Acquirer.
EventToNotify	Required	Enumeration	Event the payment terminal notifies to the Sale System.
EventDetails	Conditional	String	Information about the event the payment terminal 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.
DisplayOutput	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
KeyPressed
SecurityAlarm
StopAssistance
CardInserted
CardRemoved
Reject

ForceEntryMode

Name: ForceEntryMode

Usage: Use this cluster to limit the entry modes that the payment terminal allows. If the cluster contains Keyed, the terminal only allows manual keyed entry.

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
GeographicCoordinates	Conditional	Defined datastructure
UTMCoordinates	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 payment terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
TotalDetails	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, TotalsGroupID).
TotalFilter	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 payment terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
Response	Required	Defined datastructure	Result of a message request processing.
POIReconciliationID	Required	DigitString	Identification of the reconciliation period between Sale and POI.
TransactionTotals	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

Input

Type: defined data structure

Component	Required	Type
InputCommand	Required	Enumeration
ConfirmedFlag	Conditional	Boolean
FunctionKey	Conditional	DigitString
TextInput	Conditional	Unicode String
DigitInput	Conditional	DigitString
Password	Conditional	ContentInformation
MenuEntryNumber	Required Array	Integer

InputCommand

Name: InputCommand

Type: Enumeration

GetConfirmation
TextString
DigitString
DecimalString
GetMenuEntry

InputData

Type: defined data structure

Component	Required	Type
Device	Required	Enumeration
InfoQualify	Required	Enumeration
InputCommand	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
DisplayOutput	Conditional	Defined datastructure	Information to display and the way to process the display.
InputData	Required	Defined datastructure	Information related to an Input request.

InputResponse

Definition: Content of the Input Response message.

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

Type: defined data structure

Component	Required	Type	Description	Rule
OutputResult	Conditional	Defined datastructure	Information related to the result the output (display, print, input).	If DisplayOutput present in the request.
InputResult	Required	Defined datastructure	Information related to the result the input.

InputResult

Type: defined data structure

Component	Required	Type
Device	Required	Enumeration
InfoQualify	Required	Enumeration
Response	Required	Defined datastructure
Input	Conditional	Defined datastructure

Instalment

Type: defined data structure

Component	Required	Type
InstalmentType	Conditional	Enumeration
SequenceNumber	Conditional	Integer
PlanID	Conditional	String
Period	Conditional	Integer
PeriodUnit	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.
SaleSoftware	Required	Defined datastructure	Information related to the software of the Sale System which manages the NEXO Sale to POI protocol.
SaleTerminalData	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 payment terminal does not realize 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.
TokenRequestedType	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.
CustomerOrderReq	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 payment terminal.

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
Response	Required	Defined datastructure	Result of a message request processing.
POISystemData	Conditional	Defined datastructure	Information related to the payment terminal.	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
Response	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
LoyaltyAccountID	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).

Type: defined data structure

Component	Required	Type
EntryMode	Required	Cluster
IdentificationType	Required	Enumeration
IdentificationSupport	Conditional	Enumeration
LoyaltyID	Required	String

LoyaltyAccountReq

Type: defined data structure

Component	Required	Type	Description	Rule
CardAcquisitionReference	Conditional	Defined datastructure
LoyaltyAccountID	Conditional	Defined datastructure

LoyaltyAccountStatus

Type: defined data structure

Component	Required	Type
LoyaltyAccount	Required	Defined datastructure
CurrentBalance	Conditional	SimpleAmount
LoyaltyUnit	Conditional	Enumeration
Currency	Conditional	ISOCurrency

LoyaltyAcquirerData

Type: defined data structure

Component	Required	Type
LoyaltyAcquirerID	Conditional	String
ApprovalCode	Conditional	String
LoyaltyTransactionID	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.

Type: defined data structure

Component	Required	Type
LoyaltyUnit	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
CardAcquisitionReference	Conditional	Defined datastructure	Reference to the last CardAcquisition, to use the same card.	If the loyalty account ID comes from a previous CardAcquisition.
LoyaltyAccountID	Conditional	Defined datastructure	Identification of a Loyalty account.	If loyalty identification of the loyalty account is realized by the Sale System.
LoyaltyAmount	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 payment terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
Response	Required	Defined datastructure	Result of a message request processing.
SaleData	Required	Defined datastructure	Data related to the Sale System.
POIData	Required	Defined datastructure	Data related to the payment terminal.
LoyaltyResult	Required Array	Defined datastructure	Data related to the result of a processed loyalty transaction.	if loyalty account identified.
PaymentReceipt	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
LoyaltyAccount	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).
LoyaltyAmount	Conditional	Defined datastructure	Amount of a loyalty account.	If awarded amount.
LoyaltyAcquirerData	Conditional	Defined datastructure	Data related to the loyalty Acquirer during a loyalty transaction.	if content not empty.
Rebates	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
TransactionType	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

MenuEntry

Definition: An entry of the menu to show to the Cashier.

Usage: It conveys message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.

Type: defined data structure

Component	Required	Type	Description
MenuEntryTag	Conditional	Enumeration	Characteristics related to the selection of a menu entry.
DefaultSelectedFlag	Conditional	Boolean
OutputFormat	Required	Enumeration
PredefinedContent	Conditional	Defined datastructure
OutputText	Required Array	Defined datastructure
OutputXHTML	Conditional	ByteSequence

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 NEXO Sale to POI protocol message.

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

Type: defined data structure

Component	Required	Type	Description	Rule
ProtocolVersion	Conditional	String		Required Required if MessageCategory is Login or Diagnosis. Also required for any other MessageCategory if not using Login first. Also required for any other MessageCategory if not using Login first.
MessageClass	Required	Enumeration	Class of the message.
MessageCategory	Required	Enumeration	Category of message.
MessageType	Required	Enumeration	Type of message of the NEXO Sale to POI protocol.
ServiceID	Required	String	Identification of a message pair, which processes a transaction.	The length of the string must be greater than or equal to 1 and less than or equal to 10
DeviceID	Conditional	String	Identification of a device message pair.	Required if MessageClass is Device. The length of the string must be greater than or equal to 1 and less than or equal to 10
SaleID	Required	String	Identification of a Sale System for the NEXO Sale to POI protocol.
POIID	Required	String	Identification of a payment terminal for the NEXO Sale to POI protocol.

MessageReference

Definition: Identification of a previous transaction.

Usage: To abort a transaction in progress or to request the status of a transaction from which no response has been received. It identifies the message header of the message request to abort or request the status.

Type: defined data structure

Component	Required	Type	Description	Rule
MessageCategory	Conditional	Enumeration	Category of message.	CardAcquisition, Display, Input, Loyalty, Payment, Print, CardReaderAPDU, CardReaderInit, CardReaderPowerOff.
ServiceID	Conditional	String	Identification of a message pair, which processes a transaction.	The length of the string must be greater than or equal to 1 and less than or equal to 10
DeviceID	Conditional	String	Identification of a device message pair.	Required if MessageClass is Device. The length of the string must be greater than or equal to 1 and less than or equal to 10
SaleID	Conditional	String	Identification of a Sale System for the NEXO Sale to POI protocol.	default MessageHeader.SaleID.
POIID	Conditional	String	Identification of a payment terminal for the NEXO Sale to POI protocol.	default MessageHeader.POIID.

MessageType

Name: MessageType

Type: Enumeration

Request
Response
Notification

MobileData

Definition: Information related to the mobile for the payment transaction.

Usage: Mobile phone is used as a payment instrument for the transaction.

Type: defined data structure

Component	Required	Type	Description	Rule
MobileCountryCode	Conditional	DigitString	Identifies the country/region of a mobile phone operator.	If data available. The length of the string must be exactly 3
MobileNetworkCode	Conditional	DigitString	Identifies the mobile phone operator inside a country/region.	If data available. The length of the string must be greater than or equal to 2 and less than or equal to 3
MaskedMSISDN	Conditional	DigitString	Masked Mobile Subscriber Integrated Service Digital Network.	If data available.
Geolocation	Conditional	Defined datastructure	Geographic location specified by geographic or UTM coordinates.	If data available.
ProtectedMobileData	Conditional	ContentInformation	Sensitive information related to the mobile phone, protected by CMS.	SensitiveMobileData.
SensitiveMobileData	Conditional	Defined datastructure	Sensitive information related to the mobile phone.	If unprotected mobile data.

OriginalPOITransaction

Definition: Identification of a previous POI transaction.

Usage: In the Payment or the Loyalty Request message, it allows using the card of a previous CardAcquisition or Payment/Loyalty request.

Type: defined data structure

Component	Required	Type	Description	Rule
SaleID	Conditional	String	Identification of a Sale System for the NEXO Sale to POI protocol.
POIID	Conditional	String	Identification of a payment terminal for the NEXO Sale to POI protocol.	If original transaction is coming from another POI.
POITransactionID	Conditional	Defined datastructure	Unique identification of a POI transaction for a POI.	Absent if SaleReferenceID is sufficient to identify the transaction.
ReuseCardDataFlag	Conditional	Boolean	Indicate if the card data has to be got from a previous transaction.
ApprovalCode	Conditional	String	Code assigned to a transaction approval by the Acquirer.	If referral.
AcquirerID	Conditional	DigitString	Identification of the Acquirer.	Restrict to these Acquirer if present.
AmountValue	Conditional	SimpleAmount
HostTransactionID	Conditional	Defined datastructure	Identification of the transaction by the host in charge of the stored value transaction.	If POITransactionID not present.

OutputBarcode

Type: defined data structure

Component	Required	Type	Description	Rule
BarcodeType	Conditional	Enumeration
BarcodeValue	Required	String

OutputContent

Definition: Content to display or print.

Usage: This is a sequence of elements if they have different formats.

Type: defined data structure

Component	Required	Type	Description	Rule
OutputFormat	Required	Enumeration	Format of the content to display or print.
PredefinedContent	Conditional	Defined datastructure	Reference of a predefined message to display or print.	Mandatory, if OutputFormat is MessageRef, not allowed otherwise.
OutputText	Required Array	Defined datastructure	Content of text message to display or print.	Mandatory, if OutputFormat is Text, not allowed otherwise. One instance of OutputText per shared format.
OutputXHTML	Conditional	ByteSequence	XHTML document body containing the message to display or print.	Mandatory, if OutputFormat is XHTML, not allowed otherwise.
OutputBarcode	Conditional	Defined datastructure	BarCode content to display or print.	Mandatory, if OutputFormat is BarCode, not allowed otherwise.

OutputFormat

Name: OutputFormat

Type: Enumeration

MessageRef
Text
XHTML
BarCode

OutputResult

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

Usage: In the message response, it contains the result of the output, if required in the message request.

Type: defined data structure

Component	Required	Type	Description	Rule
Device	Required	Enumeration	Logical device located on a Sale Terminal or a POI Terminal, in term of class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer.	Copy.
InfoQualify	Required	Enumeration	Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer.	Copy.
Response	Required	Defined datastructure	Result of a message request processing.

OutputText

Definition: Content of text message to display or print.

Usage: It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content.

Type: defined data structure

Component	Required	Type
Text	Required	Unicode String
CharacterSet	Conditional	Integer
Font	Conditional	String
StartRow	Conditional	Integer
StartColumn	Conditional	Integer
Color	Conditional	Enumeration
CharacterWidth	Conditional	Enumeration
CharacterHeight	Conditional	Enumeration
CharacterStyle	Conditional	Enumeration
Alignment	Conditional	Enumeration
EndOfLineFlag	Conditional	Boolean

PaymentAccountReq

Type: defined data structure

Component	Required	Type
AccountType	Conditional	Enumeration
CardAcquisitionReference	Conditional	Defined datastructure
PaymentInstrumentData	Conditional	Defined datastructure

PaymentAccountStatus

Type: defined data structure

Component	Required	Type
PaymentInstrumentData	Conditional	Defined datastructure
CurrentBalance	Conditional	SimpleAmount
Currency	Conditional	ISOCurrency
PaymentAcquirerData	Conditional	Defined datastructure

PaymentAcquirerData

Definition: Data related to the response from the payment Acquirer.

Type: defined data structure

Component	Required	Type	Description	Rule
AcquirerID	Conditional	DigitString	Identification of the Acquirer.	If several Acquirers.
MerchantID	Required	String	Identification of the Merchant for the Acquirer.
AcquirerPOIID	Required	String	Identification of the POI for the payment Acquirer.
AcquirerTransactionID	Conditional	Defined datastructure	Identification of the Transaction for the Acquirer.	If provided by the Acquirer.
ApprovalCode	Conditional	String	Code assigned to a transaction approval by the Acquirer.	If available.
HostReconciliationID	Conditional	String

PaymentData

Type: defined data structure

Component	Required	Type
PaymentType	Conditional	Enumeration
SplitPaymentFlag	Conditional	Boolean
RequestedValidityDate	Conditional	ISODate
CardAcquisitionReference	Conditional	Defined datastructure
Instalment	Conditional	Defined datastructure
CustomerOrder	Conditional	Defined datastructure
PaymentInstrumentData	Conditional	Defined datastructure

PaymentInstrumentData

Definition: Data related to the instrument of payment for the transaction.

Usage: Sent in the result of the payment transaction. For a card, it could also be sent in the CardAcquisition response, to be processed by the Sale System.

Type: defined data structure

Component	Required	Type	Description	Rule
PaymentInstrumentType	Required	Enumeration	Type of payment instrument.
ProtectedCardData	Conditional	ContentInformation
CardData	Conditional	Defined datastructure	Information related to the payment card used for the transaction.	If PaymentInstrumentType is 'Card'.
CheckData	Conditional	Defined datastructure	Information related to the paper check used for the transaction.	If PaymentInstrumentType is 'Check'.
MobileData	Conditional	Defined datastructure	Information related to the mobile for the payment transaction.	If PaymentInstrumentType is 'Mobile'.
StoredValueAccountID	Conditional	Defined datastructure

PaymentInstrumentType

Name: PaymentInstrumentType

Type: Enumeration

Card
Check
Mobile
StoredValue
Cash

PaymentReceipt

Definition: Customer or Merchant payment receipt.

Usage: If the payment receipts are printed by the Sale System and the terminal or the Sale System does not implement the Print exchange (Basic profile).

Type: defined data structure

Component	Required	Type	Description	Rule
DocumentQualifier	Required	Enumeration	Qualification of the document to print to the Cashier or the Customer.	SaleReceipt or CashierReceipt.
IntegratedPrintFlag	Conditional	Boolean	Type of the print integrated to other prints.
RequiredSignatureFlag	Conditional	Boolean	Indicate that the cardholder payment receipt requires a physical signature by the Customer.
OutputContent	Required	Defined datastructure	Content to display or print.

PaymentRequest

Definition: Content of the Payment Request message.

Usage: It conveys Information related to the Payment transaction to process.

Type: defined data structure

Component	Required	Type	Description	Rule
SaleData	Required	Defined datastructure	Data related to the Sale System.
PaymentTransaction	Required	Defined datastructure	Data related to the payment and loyalty transaction.
PaymentData	Conditional	Defined datastructure	Data related to the payment transaction.	If one data element is present.
LoyaltyData	Conditional	Defined datastructure	Data related to a Loyalty program or account.	Loyalty cards used with the payment transaction and read by the Sale System.

PaymentResponse

Definition: Content of the Payment Response message.

Usage: It conveys Information related to the Payment transaction processed by the payment terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
Response	Required	Defined datastructure	Result of a message request processing.
SaleData	Required	Defined datastructure	Data related to the Sale System.	Copy.
POIData	Required	Defined datastructure	Data related to the payment terminal.
PaymentResult	Conditional	Defined datastructure	Data related to the result of a processed payment transaction.	If one data element is present.
LoyaltyResult	Required Array	Defined datastructure	Data related to the result of a processed loyalty transaction.	Loyalty cards used with the payment transaction.
PaymentReceipt	Required Array	Defined datastructure
CustomerOrder	Required Array	Defined datastructure

PaymentResult

Type: defined data structure

Component	Required	Type	Description
PaymentType	Conditional	Enumeration
PaymentInstrumentData	Conditional	Defined datastructure
AmountsResp	Conditional	Defined datastructure
Instalment	Conditional	Defined datastructure	Information related an instalment transaction. To request an instalment to the issuer, or to make individual instalments of a payment transaction.
CurrencyConversion	Conditional	Defined datastructure	Information related to a currency conversion. 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).
MerchantOverrideFlag	Conditional	Boolean	Indicates that the Merchant forced the result of the payment to successful. Allows the Sale System to be sure that the payment has been forced.
CapturedSignature	Conditional	Defined datastructure	Numeric value of a handwritten signature. Contain the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. Only one format of the signature is allowed, it contains: The size of the pad area where the signature is written, given with the maximum abscissa and ordinate values. The sequence of coordinates where the pen changes direction or lift.
ProtectedSignature	Conditional	ContentInformation	Numeric value of a handwritten signature. Contain the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding.
OnlineFlag	Conditional	Boolean	Indicate that the payment transaction processing has required the approval of a host. Allows the Sale System to know if the payment was online or offline.
AuthenticationMethod	Conditional	Cluster	Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction.
ValidityDate	Conditional	ISODate
PaymentAcquirerData	Conditional	Defined datastructure

PaymentToken

Definition: 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.

Type: defined data structure

Component	Required	Type	Description
TokenRequestedType	Required	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.
TokenValue	Required	String	Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
ExpiryDateTime	Conditional	ISODateTime	Expiry date and time. Limits the validity of a payment token.

PaymentTotals

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

Type: defined data structure

Component	Required	Type	Description	Rule
TransactionType	Required	Enumeration	Type of transaction for which totals are grouped.	Debit, Credit, ReverseDebit, ReverseCredit, OneTimeReservation, CompletedDeffered, FirstReservation, UpdateReservation, CompletedReservation, CashAdvance.
TransactionCount	Required	Integer	Number of processed transaction during the period.
TransactionAmount	Required	SimpleAmount	Sum of amount of processed transaction during the period.

PaymentTransaction

Type: defined data structure

Component	Required	Type	Description
AmountsReq	Required	Defined datastructure	Various amounts related to the payment and loyalty request from the Sale System.
OriginalPOITransaction	Conditional	Defined datastructure
TransactionConditions	Conditional	Defined datastructure
SaleItem	Required Array	Defined datastructure

PaymentType

Name: PaymentType

Type: Enumeration

Normal
Refund
OneTimeReservation
FirstReservation
UpdateReservation
Completion
CashAdvance
CashDeposit
Recurring
Instalment
IssuerInstalment
PaidOut

PeriodUnit

Name: PeriodUnit

Type: Enumeration

Daily
Weekly
Monthly
Annual

POICapabilities

Name: POICapabilities

Type: Cluster

CashierDisplay
CashierError
CashierInput
CustomerDisplay
CustomerError
CustomerInput
PrinterReceipt
PrinterDocument
PrinterVoucher
MagStripe
ICC
EMVContactless
CashHandling

POIData

Definition: Data related to the payment terminal.

Usage: In the Message Response, identification of the transaction.

Type: defined data structure

Component	Required	Type	Description	Rule
POITransactionID	Required	Defined datastructure	Unique identification of a POI transaction for a POI.
POIReconciliationID	Conditional	DigitString	Identification of the reconciliation period between Sale and POI.	If Result is Success.

Point

Type: defined data structure

Component	Required	Type	Description	Rule
X	Required	HexString		The length of the string must be greater than or equal to 1 and less than or equal to 4
Y	Required	HexString		The length of the string must be greater than or equal to 1 and less than or equal to 4

POIProfile

Type: defined data structure

Component	Required	Type	Description	Rule
GenericProfile	Conditional	Enumeration
ServiceProfiles	Conditional	Cluster

POISoftware

Type: defined data structure

Component	Required	Type
ManufacturerID	Required	String
ApplicationName	Required	String
SoftwareVersion	Required	String
CertificationCode	Required	String

POIStatus

Definition: State of a POI Terminal.

Usage: Indicate the availability of the POI Terminal components. The data element is absent if the component is not part of the POI Terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
GlobalStatus	Required	Enumeration	Global status of a POI Server or POI Terminal.
SecurityOKFlag	Conditional	Boolean	Indicates if the security module of the POI is working and usable.	If security module present.
PEDOKFlag	Conditional	Boolean	Indicates if the PED is working and usable.	If PED present.
CardReaderOKFlag	Conditional	Boolean	Indicates if the card readers are working and usable.	If card reader device present.
PrinterStatus	Conditional	Enumeration
CommunicationOKFlag	Conditional	Boolean	Indicates if the communication infrastructure is working and usable.	If communication infrastructure present.
CashHandlingDevice	Conditional Array	Defined datastructure	Status of cash handling device.	If cash handling devices present.
FraudPreventionFlag	Conditional	Boolean	Indicate a suspicion of fraud by the payment terminal.	default False.

POISystemData

Type: defined data structure

Component	Required	Type
DateTime	Required	ISODateTime
POISoftware	Required	Defined datastructure
POITerminalData	Conditional	Defined datastructure
POIStatus	Conditional	Defined datastructure

POITerminalData

Type: defined data structure

Component	Required	Type
TerminalEnvironment	Required	Enumeration
POICapabilities	Required	Cluster
POIProfile	Conditional	Defined datastructure
POISerialNumber	Required	String

PredefinedContent

Definition: Reference of a predefined message to display or print.

Usage: It conveys Information related to the predefined message.

Type: defined data structure

Component	Required	Type	Description	Rule
ReferenceID	Required	Enumeration	Identification of a predefined message to display or print.
Language	Conditional	ISOLanguage	Identification of a language.

PrinterStatus

Name: PrinterStatus

Type: Enumeration

OK
PaperLow
NoPaper
PaperJam
OutOfOrder

Rebates

Type: defined data structure

Component	Required	Type
TotalRebate	Conditional	SimpleAmount
RebateLabel	Conditional	String
SaleItemRebate	Required Array	Defined datastructure

ReconciliationRequest

Definition: Content of the Reconciliation Request message.

Usage: It conveys Information related to the Reconciliation requested by the Sale System.

Type: defined data structure

Component	Required	Type	Description	Rule
ReconciliationType	Required	Enumeration	Type of Reconciliation requested by the Sale to the POI.
AcquirerID	Required Array	DigitString	Identification of the Acquirer.	Could be present only if ReconciliationType is 'AcquirerReconciliation' or 'AcquirerSynchronisation'.
POIReconciliationID	Conditional	DigitString	Identification of the reconciliation period between Sale and POI.	Absent if ReconciliationType is not 'PreviousReconciliation'.

ReconciliationResponse

Definition: Content of the Reconciliation Response message.

Usage: It conveys Information related to the Reconciliation transaction processed by the payment terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
Response	Required	Defined datastructure	Result of a message request processing.
ReconciliationType	Required	Enumeration	Type of Reconciliation requested by the Sale to the POI.	Copy.
POIReconciliationID	Conditional	DigitString	Identification of the reconciliation period between Sale and POI.	Absent if ReconciliationType is 'AcquirerReconciliation'.
TransactionTotals	Required Array	Defined datastructure	Result of the Sale to POI Reconciliation processing.	if Response.Result is Success.

ReconciliationType

Name: ReconciliationType

Type: Enumeration

SaleReconciliation
AcquirerSynchronisation
AcquirerReconciliation
PreviousReconciliation

ReferenceID

Name: ReferenceID

Type: String

Accepted: shows an 'Approved' screen without an "OK" animation.
AcceptedAnimated: shows the regular 'Approved' screen.
AcceptedCustom: shows an 'Approved' screen with a custom animation.
Declined: shows a 'Declined' screen without an "X" animation.
DeclinedAnimated: shows the regular 'Declined' screen.
Idle: shows the regular standby screen that is used when no other process is in progress.
Image: shows an image.

RepeatedMessageResponse

Type: defined data structure

Component	Required	Type	Description	Rule
MessageHeader	Required	Defined datastructure
RepeatedResponseMessageBody	Required	Defined datastructure

RepeatedResponseMessageBody

Type: defined data structure

Component	Required	Type
LoyaltyResponse	Conditional	Defined datastructure
PaymentResponse	Conditional	Defined datastructure
ReversalResponse	Conditional	Defined datastructure
StoredValueResponse	Conditional	Defined datastructure
CardAcquisitionResponse	Conditional	Defined datastructure
CardReaderAPDUResponse	Conditional	Defined datastructure

Response

Definition: Result of a message request processing.

Usage: 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.

Type: defined data structure

Component	Required	Type	Description	Rule
Result	Required	Enumeration	Result of the processing of the message.
ErrorCondition	Conditional	Enumeration	Condition that has produced an error on the processing of a message request.	If Result is not Success.
AdditionalResponse	Conditional	String	Additional information related to processing status of a message request .	If present, the payment terminal logs it for further examination.

Result

Name: Result

Type: Enumeration

Success
Failure
Partial

ReversalReason

Name: ReversalReason

Type: Enumeration

CustCancel
MerchantCancel
Malfunction
Unable2Compl

ReversalRequest

Definition: Content of the Reversal Request message.

Usage: It conveys Information related to the reversal of a previous payment or a loyalty transaction.

Type: defined data structure

Component	Required	Type	Description	Rule
SaleData	Conditional	Defined datastructure
OriginalPOITransaction	Required	Defined datastructure	Identification of a previous transaction.
ReversedAmount	Conditional	SimpleAmount	Amount of the payment or loyalty to reverse..	ReversedAmount is implicitly the AuthorizedAmount if absent.
ReversalReason	Required	Enumeration	Reason of the payment or loyalty reversal..
CustomerOrder	Conditional	Defined datastructure

ReversalResponse

Definition: Content of the Reversal Response message.

Usage: It conveys Information related to the reversal processed by the payment terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
Response	Required	Defined datastructure	Result of a message request processing.
POIData	Conditional	Defined datastructure	Data related to the payment terminal.	If Result is Success.
OriginalPOITransaction	Conditional	Defined datastructure
ReversedAmount	Conditional	SimpleAmount	Amount of the payment or loyalty to reverse..	Copy.
CustomerOrder	Required Array	Defined datastructure
PaymentReceipt	Required Array	Defined datastructure

SaleCapabilities

Name: SaleCapabilities

Type: Cluster

CashierStatus
CashierError
CashierDisplay
POIReplication
CashierInput
CustomerAssistance
CustomerDisplay
CustomerError
CustomerInput
PrinterReceipt
PrinterDocument
PrinterVoucher
MagStripe
ICC
EMVContactless

SaleData

Definition: Data related to the Sale System.

Usage: Data associated with the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition.

Type: defined data structure

Component	Required	Type	Description	Rule
OperatorID	Conditional	String
OperatorLanguage	Conditional	ISOLanguage	Language of the Cashier or Operator.	if different from the Login.
ShiftNumber	Conditional	String	Shift number.	if different from the Login and see Login .SaleData.
SaleTransactionID	Required	Defined datastructure	Identification of a Sale transaction.
SaleReferenceID	Conditional	String	Identification of a Sale global transaction for a sequence of related POI transactions.	If payment reservation.
SaleTerminalData	Conditional	Defined datastructure	Information related to the software and hardware feature of the Sale Terminal.	If content is not empty.
TokenRequestedType	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.
CustomerOrderID	Conditional	String	Additional and optional identification of a customer order.
CustomerOrderReq	Conditional	Cluster	List of customer order open, closed or both to be sent in the response messages.
SaleToPOIData	Conditional	String	Sale information intended for the POI.	Stored with the transaction.
SaleToAcquirerData	Conditional	String	Sale information intended for the Acquirer.	Send to the Acquirer if present.
SaleToIssuerData	Conditional	Defined datastructure	Sale information intended for the Issuer.	Send to the Acquirer if present.

SaleItem

Definition: Sale items of a transaction.

Usage: In loyalty or value added payment card transaction, the items of the sale are entering in the processing of the transaction.

Type: defined data structure

Component	Required	Type	Description	Rule
ItemID	Required	Integer	Item identification inside a transaction (0 to n).
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.	If data sent, the payment terminal has to store it and send it if the host protocol allows it.
UnitOfMeasure	Conditional	Enumeration	Unit of measure of a quantity.	if Quantity present.
Quantity	Conditional	Decimal	Product quantity.	If data sent, the payment terminal has to store it and send it if the host protocol allows it.
UnitPrice	Conditional	SimpleAmount	Price per unit of product.	if Quantity present.
ItemAmount	Required	SimpleAmount	Total amount of the item line.
TaxCode	Conditional	DigitString	Type of taxes associated with the line item.	If data sent, the payment terminal has to store it and send it if the host protocol allows it.
SaleChannel	Conditional	DigitString	Commercial or distribution channel associated with the line item.	If data sent, the payment terminal has to store it and send it if the host protocol allows it.
ProductLabel	Conditional	String
AdditionalProductInfo	Conditional	String	Additional information related to the line item.	If data sent, the payment terminal has to store it and send it if the host protocol allows it.

SaleItemRebate

Definition: The awarded amount that is attached to an item as a rebate.

Usage: To be differentiated from the award which is the amount or quantity earned on the loyalty account.

Type: defined data structure

Component	Required	Type	Description	Rule
ItemID	Required	Integer	Item identification inside a transaction (0 to n).
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
UnitOfMeasure	Conditional	Enumeration	Unit of measure of a quantity.	if Quantity present.
Quantity	Conditional	Decimal	Product quantity.	if rebate is additional units.
ItemAmount	Conditional	SimpleAmount	Total amount of the item line.	if rebate on the line item amount.
RebateLabel	Conditional	String	Short text to qualify a rebate on an line item.	If provided by the Acquirer.

SaleProfile

Type: defined data structure

Component	Required	Type	Description	Rule
GenericProfile	Conditional	Enumeration
ServiceProfiles	Conditional	Cluster

SaleSoftware

Type: defined data structure

Component	Required	Type
ManufacturerID	Required	String
ApplicationName	Required	String
SoftwareVersion	Required	String
CertificationCode	Required	String

SaleTerminalData

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

Usage: In the Login Request, if a Sale Terminal is involved in the login. In other messages, when a logical device is out of order (SaleCapabilities), or when the other data have changed since or were not in the Login.

Type: defined data structure

Component	Required	Type	Description	Rule
TerminalEnvironment	Conditional	Enumeration	Environment of the Terminal.
SaleCapabilities	Conditional	Cluster	Hardware capabilities of the Sale Terminal.
SaleProfile	Conditional	Defined datastructure	Functional profile of the Sale Terminal.	If at least one element is present.
TotalsGroupID	Conditional	String	Identification of a group of transaction on a payment terminal, having the same Sale features.	If present, default value for all transaction. The length of the string must be greater than or equal to 1 and less than or equal to 16

SaleToIssuerData

Definition: Sale information intended for the Issuer.

Usage: The payment terminal receives this information and sends it to the Acquirer for the Issuer without any change.

Type: defined data structure

Component	Required	Type	Description	Rule
StatementReference	Conditional	String	Label to print on the bank statement.	Information to print on the bank statement.

SecurityTrailer

Definition: SecurityTrailer as used by Adyen.

Usage: It contains information related to the security of the message.

Type: defined data structure

Component	Required	Type
AdyenCryptoVersion	Required	Integer
KeyIdentifier	Required	String
KeyVersion	Required	Integer
Nonce	Required	ByteSequence
Hmac	Required	ByteSequence

SensitiveCardData

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

Usage: This data structure could be CMS protected (EnvelopedData). In this case the data structure
SensitiveCardData is replaced by the data structure ProtectedCardData of type
ContentInformationType.
When this data is protected, the exact content is unknown by the Sale System, and might include
all the information which are required by an external backup POI Server to make a batch payment
transaction in case of problem with the payment terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
PAN	Conditional	DigitString	Primary Account Number.	The length of the string must be greater than or equal to 8 and less than or equal to 28
CardSeqNumb	Conditional	DigitString	Card Sequence Number.	if EntryMode is File, Keyed or Manual. The length of the string must be greater than or equal to 2 and less than or equal to 3
ExpiryDate	Conditional	DigitString	Date after which the card cannot be used.	if EntryMode is File. The length of the string must be exactly 4
TrackData	Conditional Array	Defined datastructure	Magnetic track or magnetic ink characters line.	if EntryMode is MagStripe or RFID .

SensitiveMobileData

Type: defined data structure

Component	Required	Type
MSISDN	Required	DigitString
ISMI	Conditional	DigitString
IMEI	Conditional	DigitString

ServiceProfiles

Name: ServiceProfiles

Type: Cluster

Synchro
Batch
OneTimeRes
Reservation
Loyalty
StoredValue
PIN
CardReader
Sound
Communication

ServicesEnabled

Name: ServicesEnabled

Type: Cluster

CardAcquisition
Payment
Loyalty

StoredValueAccountID

Definition: Identification of the stored value account or the stored value card.

Usage: It contains the identifications of the stored value account or the stored value card, and the associated product sold by the Sale System for stored value requests.

Type: defined data structure

Component	Required	Type	Rule
StoredValueAccountType	Required	Enumeration
StoredValueProvider	Conditional	String
OwnerName	Conditional	String
ExpiryDate	Conditional	DigitString	The length of the string must be exactly 4
EntryMode	Required	Cluster
IdentificationType	Required	Enumeration
StoredValueID	Required	String

StoredValueAccountStatus

Type: defined data structure

Component	Required	Type	Description	Rule
StoredValueAccountID	Required	Defined datastructure
CurrentBalance	Conditional	SimpleAmount		If relevant and known.

StoredValueAccountType

Name: StoredValueAccountType

Type: Enumeration

GiftCard
PhoneCard
Other

StoredValueData

Definition: Data related to the stored value card.

Usage: It contains: - the identification of the stored value accounts or the stored value cards, if provided by the Sale System, and - the associated products sold by the Sale System..

Type: defined data structure

Component	Required	Type	Description	Rule
StoredValueProvider	Conditional	String	Identification of the provider of the stored value account load/reload.	If more than one provider to manage on the POI, and StoredValueAccountID absent.
StoredValueTransactionType	Required	Enumeration	Identification of operation to proceed on the stored value account or the stored value card.
StoredValueAccountID	Conditional	Defined datastructure	Identification of the stored value account or the stored value card.	If the identification of the Stored Value account or card has been made by the Sale System before the request.
OriginalPOITransaction	Conditional	Defined datastructure	Identification of a previous transaction.	if StoredValueTransactionType is Reverse or Duplicate.
ProductCode	Conditional	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.
ItemAmount	Conditional	SimpleAmount	Total amount of the item line.
Currency	Conditional	ISOCurrency	Currency of a monetary amount.

StoredValueRequest

Definition: Content of the Stored Value Request message.

Usage: It conveys Information related to the Stored Value transaction to process.

Type: defined data structure

Component	Required	Type	Description	Rule
SaleData	Required	Defined datastructure	Data related to the Sale System.
StoredValueData	Required Array	Defined datastructure	Data related to the stored value card.

StoredValueResponse

Definition: Content of the Stored Value Response message.

Usage: It conveys Information related to the Stored Value transaction processed by the payment terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
Response	Required	Defined datastructure	Result of a message request processing.
SaleData	Required	Defined datastructure	Data related to the Sale System.
POIData	Required	Defined datastructure	Data related to the payment terminal.
StoredValueResult	Required Array	Defined datastructure	Result of loading/reloading a stored value card..	If StoredValueResponse.Result is 'Success' or 'Partial', one entry per StoredValueRequest.StoredValueData loaded or activated.
PaymentReceipt	Required Array	Defined datastructure

StoredValueResult

Definition: Result of loading/reloading a stored value card..

Usage: For each stored value card loaded or reloaded, in the StoredValue response message.

Type: defined data structure

Component	Required	Type	Description	Rule
StoredValueTransactionType	Required	Enumeration	Identification of operation to proceed on the stored value account or the stored value card.	Copy.
ProductCode	Conditional	DigitString	Product code of item purchased with the transaction.	Copy. 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.	Copy.
ItemAmount	Conditional	SimpleAmount	Total amount of the item line.
Currency	Conditional	ISOCurrency	Currency of a monetary amount.	Copy.
StoredValueAccountStatus	Conditional	Defined datastructure	Data related to the result of the stored value card transaction.
HostTransactionID	Conditional	Defined datastructure	Identification of the transaction by the host in charge of the stored value transaction.	If provided by the Host.

StoredValueTransactionType

Name: StoredValueTransactionType

Type: Enumeration

Reserve
Activate
Load
Unload
Reverse
Duplicate

TerminalEnvironment

Name: TerminalEnvironment

Type: Enumeration

Attended
SemiAttended
Unattended

TokenRequestedType

Name: TokenRequestedType

Type: Enumeration

Transaction
Customer

TotalDetails

Name: TotalDetails

Type: Cluster

POIID
SaleID
OperatorID
ShiftNumber
TotalsGroupID

TotalFilter

Type: defined data structure

Component	Required	Type	Rule
POIID	Conditional	String
SaleID	Conditional	String
OperatorID	Conditional	String
ShiftNumber	Conditional	String
TotalsGroupID	Conditional	String	The length of the string must be greater than or equal to 1 and less than or equal to 16

TrackData

Definition: Magnetic track or magnetic ink characters line.

Usage: Generic data structure for a card track, used when the magstripe card
reader is located on the Sale Terminal, or for magstripe Card Reader device request.
The data structure is also used to store the line at the bottom of a bank check.

Type: defined data structure

Component	Required	Type	Rule
TrackNumb	Conditional	Integer
TrackFormat	Conditional	Enumeration
TrackValue	Required	String	The length of the string must be greater than or equal to 1 and less than or equal to 104

TrackFormat

Name: TrackFormat

Type: Enumeration

ISO
JIS-I
JIS-II
AAMVA
CMC-7
E-13B

TransactionAction

Name: TransactionAction

Type: Enumeration

StartTransaction
AbortTransaction

TransactionConditions

Definition: Conditions on which the transaction must be processed.

Type: defined data structure

Component	Required	Type	Description	Rule
AllowedPaymentBrand	Required Array	String	Card payment brands allowed by the Sale System for the payment transaction.	Restrict brand if data sent.
AcquirerID	Required Array	DigitString	Identification of the Acquirer.	Restrict to these Acquirer if present.
DebitPreferredFlag	Conditional	Boolean	The preferred type of payment is a debit transaction rather a credit transaction.	The preferred type of payment is a debit transaction rather a credit transaction.
AllowedLoyaltyBrand	Required Array	String	Loyalty brands or programs allowed by the Sale System for the loyalty transaction.	Restrict brand if data sent.
LoyaltyHandling	Conditional	Enumeration	Type of Loyalty processing requested by the Sale System.
ForceOnlineFlag	Conditional	Boolean	Indicates if the Cashier requires POI forces online access to the Acquirer.	Go online if data sent.
ForceEntryMode	Conditional	Cluster	Payment instrument entry mode requested by the Sale System.	Restrict entry mode if sent.
MerchantCategoryCode	Conditional	String	The code which identifies the category of the transaction (MCC).	The payment implies a specific MCC. The length of the string must be greater than or equal to 3 and less than or equal to 4

TransactionIDType

Definition: Identification of a transaction for the Sale System or the payment terminal.

Type: defined data structure

Component	Required	Type	Description	Rule
TransactionID	Required	String	Unique identification of a transaction. To identify the transaction on the Sale System (e.g. ticket number), or the payment terminal.
TimeStamp	Required	ISODateTime	Date and time of a transaction for the Sale System, the payment terminal or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

TransactionStatusRequest

Definition: Content of the TransactionStatus Request message.

Usage: It conveys Information requested for status of the last or current Payment, Loyalty or Reversal transaction.

Type: defined data structure

Component	Required	Type	Description	Rule
MessageReference	Conditional	Defined datastructure	Identification of a previous POI transaction.	Present if it contains any data.
ReceiptReprintFlag	Conditional	Boolean	Request to reprint the POI receipt(s).
DocumentQualifier	Conditional Array	Enumeration

TransactionStatusResponse

Definition: Content of the TransactionStatus Response message.

Usage: It conveys Information related to the status of the last or current Payment, Loyalty or Reversal transaction.

Type: defined data structure

Component	Required	Type	Description	Rule
Response	Required	Defined datastructure	Result of a message request processing.
MessageReference	Conditional	Defined datastructure	Identification of a previous POI transaction.	if Response.Result is Success.
RepeatedMessageResponse	Conditional	Defined datastructure	Content of the requested Message Response.	If Result is Success (process completed).

TransactionTotals

Definition: Result of the Sale to POI Reconciliation processing.

Usage: If Result is Success, contains all the totals, classified as required by the Sale in the message request. At least, transaction totals are provided per Acquirer, Acquirer Settlement, and Card Brand.

Type: defined data structure

Component	Required	Type	Description	Rule
PaymentInstrumentType	Required	Enumeration	Type of payment instrument.
AcquirerID	Conditional	DigitString	Identification of the Acquirer.	If available.
HostReconciliationID	Conditional	String	Identifier of a reconciliation period with a payment or loyalty host.	If available.
CardBrand	Conditional	String	Type of payment or loyalty card.	If configured to present totals per card brand, and Response.Result is Success.
POIID	Conditional	String	Identification of a payment terminal for the NEXO Sale to POI protocol.	If requested in the message request.
SaleID	Conditional	String	Identification of a Sale System for the NEXO Sale to POI protocol.	If requested in the message request.
OperatorID	Conditional	String	Identification of the Cashier or Operator.	If requested in the message request.
ShiftNumber	Conditional	String	Shift number.	If requested in the message request.
TotalsGroupID	Conditional	String	Identification of a group of transactions on a payment terminal, having the same Sale features.	If requested in the message request. The length of the string must be greater than or equal to 1 and less than or equal to 16
PaymentCurrency	Conditional	ISOCurrency	Currency of a monetary amount.
PaymentTotals	Conditional Array	Defined datastructure	Totals of the payment transaction during the reconciliation period.	If both TransactionCount and TransactionAmount are not equal to zero.
LoyaltyUnit	Conditional	Enumeration	Unit of a loyalty amount.
LoyaltyCurrency	Conditional	ISOCurrency	Currency of a monetary amount.	If LoyaltyUnit is Monetary.
LoyaltyTotals	Conditional Array	Defined datastructure	Totals of the loyalty transaction during the reconciliation period.	If both TransactionCount and TransactionAmount are not equal to zero.

TransactionType

Name: TransactionType

Type: Enumeration

Debit
Credit
ReverseDebit
ReverseCredit
OneTimeReservation
CompletedDeffered
FirstReservation
UpdateReservation
CompletedReservation
CashAdvance
IssuerInstalment
Declined
Failed
Award
ReverseAward
Redemption
ReverseRedemption
Rebate
ReverseRebate

TypeCode

Name: TypeCode

Type: Enumeration

Personal
Company

UnitOfMeasure

Name: UnitOfMeasure

Type: Enumeration

Case
Foot
UKGallon
USGallon
Gram
Inch
Kilogram
Pound
Meter
Centimetre
Litre
Centilitre
Ounce
Quart
Pint
Mile
Kilometre
Yard
Other

UTMCoordinates

Type: defined data structure

Component	Required	Type
UTMZone	Required	String
UTMEastward	Required	String
UTMNorthward	Required	String