terminal_api_models library

Classes

AbortRequest
Body of the Abort Request message. 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).
AbortRequestBuilder
AccountType
AccountTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
AdminRequest
Empty. Content of the Custom Admin Request message.
AdminRequestBuilder
AdminResponse
It conveys the result of the Custom Admin. Content of the Custom Admin Response message.
AdminResponseBuilder
Alignment
AlignmentMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
AmountsReq
Various amounts related to the payment request from the Sale System.
AmountsReqBuilder
AmountsResp
AmountsResp
AmountsRespBuilder
AreaSize
AreaSize
AreaSizeBuilder
BalanceInquiryRequest
It conveys Information related to the account for which a Balance Inquiry is requested. Content of the Balance Inquiry Request message.
BalanceInquiryRequestBuilder
BalanceInquiryResponse
Content of the Balance Inquiry Response message. It conveys the balance and the identification of the associated payment, loyalty or stored value account.
BalanceInquiryResponseBuilder
CapturedSignature
CapturedSignature
CapturedSignatureBuilder
CardAcquisitionRequest
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. Content of the Card Acquisition Request message.
CardAcquisitionRequestBuilder
CardAcquisitionResponse
It conveys Information related to the payment and loyalty cards read and processed by the POI System and entered by the Customer. Content of the Card Acquisition Response message.
CardAcquisitionResponseBuilder
CardAcquisitionTransaction
CardAcquisitionTransaction
CardAcquisitionTransactionBuilder
CardAcquisitionTransactionForceEntryModeEnum
CardData
Information related to the payment card used for the transaction. Allows acquisition of the card data by the Sale System before the Payment, CardAcquisition, or BalanceInquiry request to the POI. It can also be sent in the CardAcquisition response, to be processed by the Sale System.
CardDataBuilder
CardDataEntryModeEnum
CardHolderPIN
CardHolderPIN
CardHolderPINBuilder
CardReaderAPDURequest
It contains the APDU request to send to the chip of the card, and a possible invitation message to display on the CashierInterface or the CustomerInterface. Content of the Card Reader APDU Request message.
CardReaderAPDURequestBuilder
CardReaderAPDUResponse
Content of the Card Reader APDU Response message. It contains the result of the requested service, APDU response sent by the chip of the card in response to the APDU request.
CardReaderAPDUResponseBuilder
CharacterHeight
CharacterHeightMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
CharacterStyle
CharacterStyleMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
CharacterWidth
CharacterWidthMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
CheckData
Information related to the paper check used for the transaction. 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.
CheckDataBuilder
ConvertedAmount
ConvertedAmount
ConvertedAmountBuilder
CurrencyConversion
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).
CurrencyConversionBuilder
Date
A gregorian calendar date generated by OpenAPI generator to differentiate between DateTime and Date formats.
Device
DeviceMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
DiagnosisRequest
It conveys Information related to the target POI for which the diagnosis is requested. Content of the Diagnosis Request message.
DiagnosisRequestBuilder
DiagnosisResponse
It conveys the result of the requested diagnosis and a possible message to display on a logical device. Content of the Diagnosis Response message.
DiagnosisResponseBuilder
DisplayOutput
Information to display and how to process 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.
DisplayOutputBuilder
DisplayRequest
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. Content of the Display Request message.
DisplayRequestBuilder
DisplayResponse
It conveys the result of the display, parallel to the message request, except if response not required and absent. Content of the Display Response message.
DisplayResponseBuilder
DocumentQualifier
DocumentQualifierMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
EnableServiceRequest
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. Content of the Enable Service Request message.
EnableServiceRequestBuilder
EnableServiceRequestServicesEnabledEnum
EnableServiceResponse
It conveys the result of the Enable Service processing. Content of the Enable Service Response message.
EnableServiceResponseBuilder
ErrorCondition
ErrorConditionMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
EventNotification
Content of the EventNotification message. It conveys Information related to the event, and possible action (maintenance, message to display).
EventNotificationBuilder
EventToNotify
EventToNotifyMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
GeographicCoordinates
GeographicCoordinates
GeographicCoordinatesBuilder
Geolocation
Geolocation
GeolocationBuilder
GetTotalsRequest
It conveys information from the Sale System related to the scope and the format of the totals to be computed by the POI System. Content of the Get Totals Request message.
GetTotalsRequestBuilder
GetTotalsRequestTotalDetailsEnum
GetTotalsResponse
Content of the Reconciliation Response message. It conveys Information related to the Reconciliation transaction processed by the POI System.
GetTotalsResponseBuilder
GlobalStatus
GlobalStatusMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
HostStatus
Indicate the reachability of the host by the POI Terminal. State of a Host.
HostStatusBuilder
ICCResetData
ICCResetData
ICCResetDataBuilder
IdentificationSupport
IdentificationSupportMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
IdentificationType
IdentificationTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
InfoQualify
InfoQualifyMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
Input
Input
InputBuilder
InputCommand
InputCommandMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
InputData
InputData
InputDataBuilder
InputRequest
Content of the InputRequest message. It conveys the data to display and how to process it. In addition to the display on the Input Device, it might contain an operation (the DisplayOutput element) per Display Device type.
InputRequestBuilder
InputResponse
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. Content of the Input Response message.
InputResponseBuilder
InputResult
InputResult
InputResultBuilder
InputUpdate
Definition: Content of the Input Update message. : It conveys update of the display of an Input request in progress.
InputUpdateBuilder
Instalment
Instalment
InstalmentBuilder
InstalmentType
InstalmentTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
LoginRequest
It conveys information related to the session (period between a Login and the following Logout) to process. Content of the LoginRequest message.
LoginRequestBuilder
LoginRequestCustomerOrderReqEnum
LoginResponse
It conveys Information related to the Login to process. Content of the Login Response message.
LoginResponseBuilder
LogoutRequest
Empty. Content of the Logout Request message.
LogoutRequestBuilder
LogoutResponse
It conveys the result of the Logout. Content of the Logout Response message.
LogoutResponseBuilder
LoyaltyAccount
This data structure conveys the identification of the account and the associated loyalty brand. Data related to a loyalty account processed in the transaction.
LoyaltyAccountBuilder
LoyaltyAccountID
Identification of a Loyalty account. In the Payment 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).
LoyaltyAccountIDBuilder
LoyaltyAccountIDEntryModeEnum
LoyaltyAccountReq
LoyaltyAccountReq
LoyaltyAccountReqBuilder
LoyaltyAcquirerData
LoyaltyAcquirerData
LoyaltyAcquirerDataBuilder
LoyaltyData
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. Data related to a Loyalty program or account.
LoyaltyDataBuilder
LoyaltyHandling
LoyaltyHandlingMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
LoyaltyResponse
It conveys Information related to the Loyalty transaction processed by the POI System. Content of the Loyalty Response message.
LoyaltyResponseBuilder
LoyaltyResult
Data related to the result of a processed loyalty transaction. In the Message Response, the result of each loyalty brand transaction.
LoyaltyResultBuilder
An entry of the menu to present to the Cashier. 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 entry of the menu.
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
MessageCategory
MessageCategoryMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
MessageClass
MessageClassMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
MessageHeader
Message header of the Sale to POI protocol message. It conveys Information related to the Sale to POI protocol management.
MessageHeaderBuilder
MessageReference
Identification of a previous POI transaction. 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.
MessageReferenceBuilder
MessageType
MessageTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
MobileData
Mobile phone is used as a payment instrument for the transaction. Information related to the mobile for the payment transaction.
MobileDataBuilder
OriginalPOITransaction
Identification of a previous POI transaction. In the Payment Request message, it allows using the card of a previous CardAcquisition or Payment request.
OriginalPOITransactionBuilder
OutputBarcode
OutputBarcode
OutputBarcodeBuilder
OutputContent
Content to display or print. This is a sequence of elements if they have different formats.
OutputContentBuilder
OutputFormat
OutputFormatMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
OutputResult
In the message response, it contains the result of the output, if required in the message request. Information related to the result the output (display, print, input).
OutputResultBuilder
OutputText
Content of text message to display or print. 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.
OutputTextBuilder
PaymentAccountReq
PaymentAccountReq
PaymentAccountReqBuilder
PaymentAccountStatus
PaymentAccountStatus
PaymentAccountStatusBuilder
PaymentAcquirerData
Data related to the response from the payment Acquirer.
PaymentAcquirerDataBuilder
PaymentData
PaymentData
PaymentDataBuilder
PaymentInstrumentData
Data related to the instrument of payment for the transaction. 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.
PaymentInstrumentDataBuilder
PaymentInstrumentType
PaymentInstrumentTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
PaymentReceipt
Customer or Merchant payment receipt. If the payment receipts are printed by the Sale system and the POI or the Sale does not implement the Print exchange (Basic profile).
PaymentReceiptBuilder
PaymentRequest
Request sent to terminal to initiate payment. It conveys Information related to the Payment transaction to process. Content of the PaymentRequest message.
PaymentRequestBuilder
PaymentResponse
It conveys Information related to the Payment transaction processed by the POI System. Content of the Payment Response message.
PaymentResponseBuilder
PaymentResult
PaymentResult
PaymentResultAuthenticationMethodEnum
PaymentResultBuilder
PaymentToken
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.
PaymentTokenBuilder
PaymentTotals
Totals of the payment transaction during the reconciliation period.
PaymentTotalsBuilder
PaymentTransaction
PaymentTransaction
PaymentTransactionBuilder
PaymentType
PaymentTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
PerformedTransaction
PerformedTransaction
PerformedTransactionBuilder
PeriodUnit
PeriodUnitMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
PINFormat
PINFormatMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
PINRequestType
PINRequestTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
POIData
Data related to the POI System. In the Message Response, identification of the POI transaction.
POIDataBuilder
Point
Point
PointBuilder
POISoftware
Information related to the software of the POI System which manages the Sale to POI protocol. In a session allows identifying the product features of a POI System.
POISoftwareBuilder
POIStatus
Indicate the availability of the POI Terminal components. The data element is absent if the component is not part of the POI Terminal. State of a POI Terminal.
POIStatusBuilder
POISystemData
POISystemData
POISystemDataBuilder
PredefinedContent
Reference of a predefined message to display or print. It conveys information related to the predefined message.
PredefinedContentBuilder
PrinterStatus
PrinterStatusMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
PrintOutput
PrintOutput
PrintOutputBuilder
PrintRequest
Content of the Print Request message. It conveys the complete data to print and how to process the print.
PrintRequestBuilder
PrintResponse
It conveys the result of the print, parallel to the message request, except if response not required and absent. Content of the Print Response message.
PrintResponseBuilder
ReconciliationRequest
Content of the Reconciliation Request message. It conveys Information related to the Reconciliation requested by the Sale System.
ReconciliationRequestBuilder
ReconciliationResponse
It conveys Information related to the Reconciliation transaction processed by the POI System. Content of the Reconciliation Response message.
ReconciliationResponseBuilder
ReconciliationType
ReconciliationTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
RepeatedMessageResponse
RepeatedMessageResponse
RepeatedMessageResponseBuilder
RepeatedResponseMessageBody
RepeatedResponseMessageBody
RepeatedResponseMessageBodyBuilder
Response
Result of a message request processing. If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can refine the processing of the message response. AdditionalResponse gives more information about the success or the failure of the message request processing, for logging without real time involvements.
ResponseBuilder
ResponseMode
ResponseModeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
Result
ResultMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
ReversalReason
ReversalReasonMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
ReversalRequest
It conveys Information related to the reversal of a previous payment or a loyalty transaction. Content of the Reversal Request message.
ReversalRequestBuilder
ReversalResponse
It conveys Information related to the reversal processed by the POI System. Content of the Reversal Response message.
ReversalResponseBuilder
SaleData
Data associated with the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition.
SaleDataBuilder
SaleDataCustomerOrderReqEnum
SaleSoftware
Information related to the software of the Sale System which manages the NEXO Sale to POI protocol.
SaleSoftwareBuilder
SaleTerminalData
Information related to the software and hardware features of the Sale Terminal. Sent in the Login Request if a Sale Terminal is involved in the login. In other messages, sent when a logical device is out of order (SaleCapabilities) or when other data have changed or were missing in the Login.
SaleTerminalDataBuilder
SaleToIssuerData
Sale information intended for the Issuer. The POI System receives this information and sends it to the Acquirer for the Issuer without any change.
SaleToIssuerDataBuilder
SecurityTrailer
It contains information related to the security of the message. SecurityTrailer as used by Adyen.
SecurityTrailerBuilder
SensitiveCardData
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 POI System. Sensitive information related to the payment card, entered or read by the Sale System.
SensitiveCardDataBuilder
SensitiveMobileData
SensitiveMobileData
SensitiveMobileDataBuilder
SoundAction
SoundActionMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
SoundContent
SoundContent
SoundContentBuilder
SoundFormat
SoundFormatMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
StoredValueAccountID
Identification of the stored value account or the stored value card and the associated product sold by the Sale System for stored value requests.
StoredValueAccountIDBuilder
StoredValueAccountIDEntryModeEnum
StoredValueAccountStatus
StoredValueAccountStatus
StoredValueAccountStatusBuilder
StoredValueAccountType
StoredValueAccountTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
StoredValueData
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. Data related to the stored value card.
StoredValueDataBuilder
StoredValueRequest
It conveys Information related to the Stored Value transaction to process. Content of the Stored Value Request message.
StoredValueRequestBuilder
StoredValueResponse
It conveys Information related to the Stored Value transaction processed by the POI System. Content of the Stored Value Response message.
StoredValueResponseBuilder
StoredValueResult
For each stored value card loaded or reloaded, in the StoredValue response message. Result of loading/reloading a stored value card.
StoredValueResultBuilder
StoredValueTransactionType
StoredValueTransactionTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
TokenRequestedType
TokenRequestedTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
TotalFilter
TotalFilter
TotalFilterBuilder
TrackData
Magnetic track or magnetic ink characters line. ISO 7813 - ISO 4909. 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.
TrackDataBuilder
TrackFormat
TrackFormatMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
TransactionAction
TransactionActionMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
TransactionConditions
Conditions on which the transaction must be processed.
TransactionConditionsBuilder
TransactionConditionsForceEntryModeEnum
TransactionIDType
Identification of a transaction for the Sale System or the POI System.
TransactionIDTypeBuilder
TransactionStatusRequest
Content of the TransactionStatus Request message. It conveys Information requested for status of the last or current Payment, Loyalty or Reversal transaction.
TransactionStatusRequestBuilder
TransactionStatusResponse
Content of the TransactionStatus Response message. It conveys Information related to the status of the last or current Payment, Loyalty or Reversal transaction.
TransactionStatusResponseBuilder
TransactionTotals
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. Result of the Sale to POI Reconciliation processing.
TransactionTotalsBuilder
TransactionType
TransactionTypeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
TypeCode
TypeCodeMixin
Optionally, enum_class can generate a mixin to go with your enum for use with Angular. It exposes your enum constants as getters. So, if you mix it in to your Dart component class, the values become available to the corresponding Angular template.
UTMCoordinates
UTMCoordinates
UTMCoordinatesBuilder

Extensions

DateTimeToDate on DateTime