OPC UA DataTypes – OPC UA for Unattended Retail & Coffee Solutions

8 OPC UA DataTypes

8.1 OptionDescriptionDataType

This structure describes an option that can be used in a selection to order a delivery. The structure is defined in Table 90.

Table 90 - OptionDescriptionDataType Structure

Name	Type	Description
OptionDescriptionDataType	structure
OptionId	0:String	Short string identifying the option.
Range	0:Range	The minimum and maximum allowed value for the amount of the option.
Step	0:Double	The step size from the minimum that should be used to define the amount of the option.
Default	0:Double	The default value of the option.
EngineeringUnit	0:EUInformation	The unit of the option.

Its representation in the AddressSpace is defined in Table 91.

Table 91 - OptionDescriptionDataType definition

Attribute		Value
BrowseName		OptionDescriptionDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine

8.2 SelectionDescriptionDataType

This structure describes a selection that can be used to order a delivery. The structure is defined in Table 92.

Table 92 - SelectionDescriptionDataType Structure

Name	Type	Description
SelectionDescriptionDataType	structure
SelectionId	0:String	Short string identifying the selection.
AvailableOptionIds	0:String[]	OptionIds that may be used when ordering the selection.
IsStoppable	0:Boolean	True if the section can be stopped during its delivery, false otherwise.

Its representation in the AddressSpace is defined in Table 93.

Table 93 - SelectionDescriptionDataType definition

Attribute		Value
BrowseName		SelectionDescriptionDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine

8.3 DeliveryRequestDataType

This structure describes a delivery request. The structure is defined in Table 94.

Table 94 - DeliveryRequestDataType Structure

Name	Type	Description
DeliveryRequestDataType	structure
TransactionId	0:UInt64	Unique identification of the delivery request.
SelectionId	0:String	Unique identification of the selection of the delivery request.
Options	OptionSelectionDataType[]	Selected options, including the amount per option. May be an empty array if no option is selected.

Its representation in the AddressSpace is defined in Table 95.

Table 95 - DeliveryRequestDataType definition

Attribute		Value
BrowseName		DeliveryRequestDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine

8.4 OptionSelectionDataType

This structure describes the selection of an Option, including the amount. The structure is defined in Table 96.

Table 96 - OptionSelectionDataType Structure

Name	Type	Description
OptionSelectionDataType	structure
OptionId	0:String	Unique identification of the selected option.
Value	0:Double	The selected amount of the selected option.

Its representation in the AddressSpace is defined in Table 97.

Table 97 - OptionSelectionDataType definition

Attribute		Value
BrowseName		OptionSelectionDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine
UnattendedRetail PaymentService

8.5 DeliveryProgressDataType

This structure describes the process of a delivery request. The structure is defined in Table 98.

Table 98 - DeliveryProgressDataType Structure

Name	Type	Description
DeliveryProgressDataType	structure
ProgressInPercent	0:Byte	Progress of the delivery request in percent. Shall be 0 if delivery request has not been started to be executed.
Status	OutputDeliveryStatusDataType[]	The status of the delivery per output. Shall have at least one entry. If the delivery request requires to deliver several products that need to be received from different outputs or id delivers several products in one output that needs to be taken before the delivery continues, it shall have one entry for each of those.
TransactionId	0:UInt64	Unique identification of the delivery request.

Its representation in the AddressSpace is defined in Table 99.

Table 99 - DeliveryProgressDataType definition

Attribute		Value
BrowseName		DeliveryProgressDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine

8.6 OutputDeliveryStatusDataType

This structure describes the status of a delivery of an individual output of the machine engine. The structure is defined in Table 100.

Table 100 - OutputDeliveryStatusDataType Structure

Name	Type	Description
OutputDeliveryStatusDataType	structure
Status	DeliveryStatusEnum	The status of the delivery progress.
OutputId	0:UInt16	Unique identification of the output.

Its representation in the AddressSpace is defined in Table 101.

Table 101 - OutputDeliveryStatusDataType definition

Attribute		Value
BrowseName		OutputDeliveryStatusDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine

8.7 OutputStatusDataType

This structure describes the general status of an individual output of the machine engine. The structure is defined in Table 102.

Table 102 - OutputStatusDataType Structure

Name	Type	Description
OutputStatusDataType	structure
OutputId	0:UInt16	Unique identification of the output.
Status	OutputStatusEnum	Status of the output
VendorStatus	0:Int32	Vendor-specific status-

Its representation in the AddressSpace is defined in Table 103.

Table 103 - OutputStatusDataType definition

Attribute		Value
BrowseName		OutputStatusDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine

8.8 OutputStatusEnum

This enumeration represents the status of an output of a Vending Machine. The enumeration is defined in Table 104.

Table 104 - OutputStatusEnum Items

Name	Value	Description
Free	0	The output is empty and ready to be used.
ProductNotTaken	1	A product was delivered to the output and not taken.
OutOfOrder	2	The output is out of order.
Locked	3	The output is currently locked.
CleaningRequired	4	The output requires cleaning.
VendorSpecific	5	A vendor-specific status is provided.

Its representation in the AddressSpace is defined in Table 105.

Table 105 - OutputStatusEnum definition

Attribute		Value
BrowseName		OutputStatusEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail MachineEngine

8.9 DeliveryStatusEnum

This enumeration represents the status of a delivery request. The enumeration is defined in Table 106.

Table 106 - DeliveryStatusEnum Items

Name	Value	Description
ReadyToDeliver	0	The delivery request has not been started to be executed.
DeliveryStarted	1	Execution of the delivery request is ongoing.
DeliveryFinished	2	Delivery of the delivery request has successfully ended.
DeliveryFailed	3	Execution of the delivery request has failed.
DeliveryCannotStart	4	The delivery cannot start because of a machine engine condition, e.g., the output is not empty

Its representation in the AddressSpace is defined in Table 107.

Table 107 - DeliveryStatusEnum definition

Attribute		Value
BrowseName		DeliveryStatusEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail MachineEngine

8.10 MachineEngineWorkingStatusEnum

This enumeration represents the status of the machine engine. The enumeration is defined in Table 108.

Table 108 - MachineEngineWorkingStatusEnum Items

Name	Value	Description
Initializing	0
WaitingForTemperature	1
Ready	2	Ready to take requests
Cleaning	3
Dispensing	4	Currently dispensing something
Busy	5
OutOfOrder	6
EnergySavingMode	7

Its representation in the AddressSpace is defined in Table 109.

Table 109 - MachineEngineWorkingStatusEnum definition

Attribute		Value
BrowseName		MachineEngineWorkingStatusEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail MachineEngine

8.11 AvailabilityStatusDataType

This structure describes the availability status of a selection or Option by Id. The structure is defined in Table 110.

Table 110 - AvailabilityStatusDataType Structure

Name	Type	Description
AvailabilityStatusDataType	structure
Id	0:String	Unique identification of a selection or option offered by the machine engine.
Status	AvailabilityEnum	Current status of the selection in the machine engine.
EstimatedRemainingStock	0:UInt32	Indicates the remaining stock of a selection or option. Shall only be interpreted, if the Status is "Available". The number is only an estimate. If not known, 0 shall be used. For a selection, a positive number indicates, how often the selection is currently available. For an option, a positive number indicates, the amount the option is currently available. The number gets multiplied by step (defined for the option) to get the concrete estimated amount in the engineering unit defined for the option.

Its representation in the AddressSpace is defined in Table 111.

Table 111 - AvailabilityStatusDataType definition

Attribute		Value
BrowseName		AvailabilityStatusDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine

8.12 AvailabilityEnum

This enumeration represents the availability of a selection or Option offered by a machine engine. The enumeration is defined in Table 112.

Table 112 - AvailabilityEnum Items

Name	Value	Description
Available	0	The selection or option is currently available.
OutOfOrder	1	The selection or option cannot be provided due to some errors that may take a while to get fixed.
TemporaryNotAvailable	2	The selection or option is shortly not available, e.g., because some water needs to be heated first.
Empty	3	Material for the selection or option is currently not available in the machine engine and it needs to be refilled.

Its representation in the AddressSpace is defined in Table 113.

Table 113 - AvailabilityEnum definition

Attribute		Value
BrowseName		AvailabilityEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail MachineEngine

8.13 PriceDataType

This structure describes a price including the currency. The structure is defined in Table 114.

Table 114 - PriceDataType Structure

Name	Type	Description
PriceDataType	structure
Amount	0:UInt32	The amount of the price. If the Currency is provided with an exponent, the amount is expressed in the minor currency unit, like cent for USD (US Dollar).
Currency	0:CurrencyUnitType	The currency of the price. Based in ISO 4217. Shall be NULL, if the default currency (defined in the BaseConfigurationType) is used and the currency of Amount is the default currency.

Its representation in the AddressSpace is defined in Table 115.

Table 115 - PriceDataType definition

Attribute		Value
BrowseName		PriceDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine
UnattendedRetail PaymentService
UnattendedRetail PriceService
UnattendedRetail UI
UnattendedRetail PaymentDevice Coin
UnattendedRetail PaymentDevice Bill
UnattendedRetail PaymentDevice Cashless

8.14 PriceAndContextDataType

This structure describes a price including the currency and in addition the PriceListId, Tax and DiscountSurcharge to provide additional context. It is a subtype of the PriceDataType. The structure is defined in Table 116.

Table 116 - PriceAndContextDataType Structure

Name	Type	Description
PriceAndContextDataType	structure
PriceListId	0:String	Identifies a price list containing the prices for the individual selections of a Vending Machine. May be null or an empty string if the price service does not identify or exposes its price list.
Tax	0:Double	The tax to be paid from the Amount in percentage. Any negative value indicates that the tax is unknown. All applications doing calculations with the Tax field shall check for negative values before doing calculations.
DiscountSurcharge	0:Int32	Informative value of the discount or surcharge received. The Amount is the price where the DiscountSurcharge is already considered. The currency of the DiscountSurcharge is defined in the Currency field. A negative value indicates a surcharge, a positive value a discount. By adding this value to the Amount, you get the assumed default price.

Its representation in the AddressSpace is defined in Table 117.

Table 117 - PriceAndContextDataType definition

Attribute		Value
BrowseName		PriceAndContextDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of PriceDataType

Conformance Units
UnattendedRetail MachineEngine
UnattendedRetail PaymentService
UnattendedRetail PriceService
UnattendedRetail UI
UnattendedRetail PaymentDevice Coin
UnattendedRetail PaymentDevice Bill
UnattendedRetail PaymentDevice Cashless

8.15 TransactionProgressDataType

This structure describes the progress of a TransactionId. The structure is defined in Table 118.

Table 118 - TransactionProgressDataType Structure

Name	Type	Description
TransactionProgressDataType	structure
TransactionId	0:UInt64	Unique identification of the delivery request.
Status	DeliveryAndPaymentStatusEnum	The status of the payment of the delivery request.
TransactionFinished	0:Boolean	Shall be true, if the TransactionId is finished and the Status is not changing anymore.
PaymentMode	0:String	Initially indicates the PaymentMode the transaction is created with. This may contain a "NoCheck" or null or empty string. If the actual used PaymentMode is changing, it provides the actual used PaymentMode. If the transaction is executed in the context of a basket, the PaymentMode may be null or an empty string, since the information is provided in the BasketProgress.
UserId	0:String	Initially indicates the UserId the transaction is created with. If the actual used UserId is changing, it provides the actual used UserId. If the transaction is executed in the context of a basket, the UserId may be null or an empty string, since the information is provided in the BasketProgress.
UsedPrice	PriceAndContextDataType	When the transaction was successfully executed, it provides the actually used price for the transaction. Otherwise, it shall be null. If the transaction is executed in the context of a basket, the UsedPrice may be null, even if the transaction was successfully executed, since the overall price is provided in the BasketProgress.

Its representation in the AddressSpace is defined in Table 119.

Table 119 - TransactionProgressDataType definition

Attribute		Value
BrowseName		TransactionProgressDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail PaymentService

8.16 DeliveryAndPaymentStatusEnum

This enumeration represents the status of the payment and delivery of a delivery request. The enumeration is defined in Table 120.

Table 120 - DeliveryAndPaymentStatusEnum Items

Name	Value	Description
DeliveryRequestReceived	0	The delivery request has been received and the payment can start.
PaymentInExecution	1	Execution of the payment is ongoing.
PaymentFinished	2	Payment of the delivery request has successfully ended.
PaymentFailed	3	Execution of the payment has failed. No delivery will be triggered. This is an end state of a delivery and afterwards the state is not changing anymore.
PaymentCancelledByUser	4	The payment has been cancelled by the user, for example by calling the CancelDeliverRequest() method.
PaymentFailedWrongPrice	5	The price used for requesting the delivery is different from the price that effectively has to be used (e.g., because payment mode or user id have changed). Therefore, execution of the payment does not take place and no delivery will be triggered. This is an end state of a delivery and afterwards the state is not changing anymore.
DeliveryInExecution	6	The payment has successfully ended and the delivery has started.
DeliveryAndPaymentSuccess	7	Payment and delivery request have been successful. This is an end state of a delivery and afterwards the state is not changing anymore.
DeliveryFailRefundInExecution	8	Delivery has failed and refund has started.
DeliveryFailRefundSuccess	9	Delivery has failed and refund has successfully ended. This is an end state of a delivery and afterwards the state is not changing anymore.
DeliveryAndRefundFailed	10	Delivery has failed and the refund has failed, as well. This is an end state of a delivery and afterwards the state is not changing anymore.
DeliveryMixResultRefundInExecution	11	Shall only be applied to basket delivery. Parts of the basket have been delivered and parts have failed, refund has started.
DeliveryMixResultRefundSuccess	12	Shall only be applied to basket delivery. Parts of the basket have been delivered and parts have failed, refund has successfully ended. This is an end state of a delivery and afterwards the state is not changing anymore.
DeliveryMixResultRefundFailed	13	Shall only be applied to basket delivery. Parts of the basket have been delivered and parts have failed, refund has failed. This is an end state of a delivery and afterwards the state is not changing anymore.
CancelledByUserRefundInExcecution	14	The deliver request has been cancelled by the user and the refund operation is in execution. If a basket is cancelled after delivery has started, use the DeliveryMixResultRefundInExecution state.
CancelledByUserRefundSuccess	15	The deliver request has been cancelled by the user and the refund operation has successfully ended. This is an end state of a delivery and afterwards the state is not changing anymore.
CancelledByUserRefundFailed	16	The deliver request has been cancelled by the user and the refund has failed. This is an end state of a delivery and afterwards the state is not changing anymore.

Its representation in the AddressSpace is defined in Table 121.

Table 121 - DeliveryAndPaymentStatusEnum definition

Attribute		Value
BrowseName		DeliveryAndPaymentStatusEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail MachineEngine
UnattendedRetail PaymentService
UnattendedRetail UI
UnattendedRetail PaymentDevice Coin
UnattendedRetail PaymentDevice Bill
UnattendedRetail PaymentDevice Cashless

8.17 BasketProgressDataType

This structure describes the progress of the payment and delivery of a basket delivery request. The structure is defined in Table 122.

Table 122 - BasketProgressDataType Structure

Name	Type	Description
BasketProgressDataType	structure
BasketId	0:UInt64	Unique identification of the basket delivery request.
TransactionIds	0:UInt64[]	Array of all TransactionIds assigned to the basket.
Status	DeliveryAndPaymentStatusEnum	The overall status of the payment of the basket delivery request, taking all transactions into account.
BasketFinished	0:Boolean	Shall be true, if the BasketId is finished and the Status is not changing anymore.
PaymentMode	0:String	Initially indicates the PaymentMode the basket is created with. This may contain a "NoCheck" or null or empty string. If the actual used PaymentMode is changing, it provides the actual used PaymentMode.
UserId	0:String	Initially indicates the UserId the basket is created with. If the actual used UserId is changing, it provides the actual used UserId.
UsedPrice	PriceAndContextDataType	When the basket was successfully executed, or partially executed, it provides the effectively used price for the basket. Otherwise, it shall be null.

Its representation in the AddressSpace is defined in Table 123.

Table 123 - BasketProgressDataType definition

Attribute		Value
BrowseName		BasketProgressDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail PaymentService BasketDelivery

8.18 SelectionPriceDataType

This structure describes the price of a selection. The structure is defined in Table 124.

Table 124 - SelectionPriceDataType Structure

Name	Type	Description
SelectionPriceDataType	structure
SelectionId	0:String	Short string identifying the selection.
Price	PriceAndContextDataType	The price of the selection if no option is selected effecting the price.
OptionsThatMayAffectThePrice	0:String[]	OptionIds of the selection that may affect the price. Shall only contain OptionIds available in the selection. If an option is available in the selection, but not in the OptionsThatMayAffectThePrice, the option is free of additional charge. Clients may use this information to avoid calling GetPriceForOneSelection again when an option has changed, that is not affecting the price.

Its representation in the AddressSpace is defined in Table 125.

Table 125 - SelectionPriceDataType definition

Attribute		Value
BrowseName		SelectionPriceDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail PaymentService
UnattendedRetail PriceService

8.19 SelectionDataType

This structure describes one selection of a Vending Machine. The structure is defined in Table 126.

Table 126 - SelectionDataType Structure

Name	Type	Description
SelectionDataType	structure
MachineEngineProductInstanceUri	0:UriString	The unique identification of the machine engine as defined in the ProductInstanceUri of the Identification Object of the MachineEngineType.
SelectionListVersion	0:SemanticVersionString	Provides the version of the Selections as defined in the Capabilities. Used as context to interpret the SelectionId and Options correctly.
SelectionId	0:String	SelectionId identifying the selection. Method execution shall fail, if SelectionId not in the SelectionList of the Capabilities Object of the MachineEngineProductInstanceUri.
Options	OptionSelectionDataType[]	List of selected options for the SelectionId. May be an empty array, if no option is selected. The option shall be allowed for the SelectionId as defined in the SelectionList of the Capabilities Object of the MachineEngineProductInstanceUri.

Its representation in the AddressSpace is defined in Table 127.

Table 127 - SelectionDataType definition

Attribute		Value
BrowseName		SelectionDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine
UnattendedRetail PaymentService
UnattendedRetail PriceService
UnattendedRetail UI
UnattendedRetail PaymentDevice Coin
UnattendedRetail PaymentDevice Bill
UnattendedRetail PaymentDevice Cashless

8.20 SlotConfigurationDataType

This structure describes one configuration of a payment device. The structure is defined in Table 128.

Table 128 - SlotConfigurationDataType Structure

Name	Type	Description
SlotConfigurationDataType	structure
SlotIndex	0:Int32	Indication of the slot buffering cash or token. -1 indicates that no slot is used.
SupportedAssetListIndex	0:UInt32	Index into the SupportedAssetList identifying what coin, bill or token should go into the slot identified by SlotIndex.

Its representation in the AddressSpace is defined in Table 129.

Table 129 - SlotConfigurationDataType definition

Attribute		Value
BrowseName		SlotConfigurationDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail PaymentService
UnattendedRetail PaymentDevice Coin
UnattendedRetail PaymentDevice Bill

8.21 PaymentModeOrDeviceStatusEnum

This enumeration represents the status of a payment mode or device of a Vending Machine. The enumeration is defined in Table 130.

Table 130 - PaymentModeOrDeviceStatusEnum Items

Name	Value	Description
Available	0	The payment mode or device is ready to be used.
Offline	1	No connection can be established to the payment mode or device.
OutOfOrder	2	The payment mode or device is out of order.

Its representation in the AddressSpace is defined in Table 131.

Table 131 - PaymentModeOrDeviceStatusEnum definition

Attribute		Value
BrowseName		PaymentModeOrDeviceStatusEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail PaymentService
UnattendedRetail PaymentDevice Coin
UnattendedRetail PaymentDevice Bill
UnattendedRetail PaymentDevice Cashless

8.22 PaymentServiceStatusEnum

This enumeration represents the status of a payment service, and thereby the overall status of a Vending Machine. The enumeration is defined in Table 132.

Table 132 - PaymentServiceStatusEnum Items

Name	Value	Description
Available	0	The payment service is ready to be used.
Offline	1	No connection can be established to needed components like the price service or machine engines.
OutOfOrder	2	The payment service is out of order.
ExternallyStopped	3	The payment service was stopped by calling the RequestStatusChange method.

Its representation in the AddressSpace is defined in Table 133.

Table 133 - PaymentServiceStatusEnum definition

Attribute		Value
BrowseName		PaymentServiceStatusEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail PaymentService

8.23 ActualPaymentDataType

This structure describes part of a payment actually done. The structure is defined in Table 134.

Table 134 - ActualPaymentDataType Structure

Name	Type	Description
ActualPaymentDataType	structure
PaymentMode	0:String	Contains the PaymentModeId of the payment mode used for the payment.
PaymentDevice	0:String	The ProductInstanceUri of the PaymentDevice receiving the MonetaryValue. May be an empty string or null if the PaymentDevice is of no relevance, for example for cash payment.
UserId	0:String	Identifies the user associated with any cashless asset inserted into a payment device. May be null or empty string if no specific UserId is used.
MonetaryValue	PriceDataType	The money collected by the PaymentMode / PaymentDevice with the given UserId.

Its representation in the AddressSpace is defined in Table 135.

Table 135 - ActualPaymentDataType definition

Attribute		Value
BrowseName		ActualPaymentDataType
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure

Conformance Units
UnattendedRetail MachineEngine
UnattendedRetail PaymentService
UnattendedRetail UI
UnattendedRetail PaymentDevice Coin
UnattendedRetail PaymentDevice Bill
UnattendedRetail PaymentDevice Cashless

8.24 AssetConfigurationEnum

This enumeration represents the configuration of an asset. The enumeration is defined in Table 136.

Table 136 - AssetConfigurationEnum Items

Name	Value	Description
AcceptToCashboxOrStacker	0	Asset shall be accepted and moved into cashbox (coins or token) or stacker (bills or token). If the system does not have a cashbox or stacker, the setting shall change to AcceptToRecyclerOrTube.
AcceptToRecyclerOrTube	1	Asset shall be accepted and moved into recycler (bills and token) or tube (coins or token). If the system does not have a recycler or tube, the setting shall change to AcceptToCashboxOrStacker.
AcceptToEscrowAndStacker	2	Asset shall be accepted and kept in the escrow. Can only be applied to bills and tokens. If escrow gets accepted, bill gets moved into stacker. If the system does not have an escrow, the setting shall change to AcceptToCashboxOrStacker. If the system does not have a stacker, the setting shall change to AcceptToEscrowAndRecycler.
AcceptToEscrowAndRecycler	3	Asset shall be accepted and kept in the escrow. Can only be applied to bills and tokens. If escrow gets accepted, bill gets moved into recycler. If the system does not have an escrow, the setting shall change to AcceptToRecyclerOrTube. If the system does not have a recycler, the setting shall change to AcceptToEscrowAndStacker.
Reject	4	Asset shall be rejected, when inserted.

Its representation in the AddressSpace is defined in Table 137.

Table 137 - AssetConfigurationEnum definition

Attribute		Value
BrowseName		AssetConfigurationEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail PaymentDevice Coin
UnattendedRetail PaymentDevice Bill

8.25 PayoutStatusEnum

This enumeration represents the status of a payout. The enumeration is defined in Table 138.

Table 138 - PayoutStatusEnum Items

Name	Value	Description
Idle	0	No payout is currently ongoing.
Ongoing	1	The payout is currently ongoing.
SuccessfullyFinished	2	The payout was successfully finished.
Failed	3	The payout failed.

Its representation in the AddressSpace is defined in Table 139.

Table 139 - PayoutStatusEnum definition

Attribute		Value
BrowseName		PayoutStatusEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail PaymentDevice Coin
UnattendedRetail PaymentDevice Bill

8.26 OperationStatusEnum

This enumeration represents the status of an operation. The enumeration is defined in Table 140.

Table 140 - OperationStatusEnum Items

Name	Value	Description
Idle	0	Currently no operation is ongoing.
Ongoing	1	The operation is currently ongoing.
SuccessfullyFinished	2	The operation was successfully finished.
Failed	3	The operation failed.
Failed_NoCommunication	4	The operation failed because there was no communication with the backend.
Failed_NotEnoughCredit	5	The operation failed because the card does not provide enough credit.

Its representation in the AddressSpace is defined in Table 141.

Table 141 - OperationStatusEnum definition

Attribute		Value
BrowseName		OperationStatusEnum
IsAbstract		False

References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText []	0:PropertyType

Conformance Units
UnattendedRetail PaymentDevice Cashless