7.27 VendingAuditEventType definition
7.27.1 Overview
The VendingAuditEventType provides audit information to the audit collect. A more detailed overview is given in 6.3.4. It is formally defined in Table 86.
7.27.2 ObjectType definition
| Attribute | Value | ||||
| BrowseName | VendingAuditEventType | ||||
| IsAbstract | True | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of the VendingBaseAuditEventType | |||||
| 0:HasProperty | Variable | Counter | 0:UInt32 | 0:PropertyType | O |
| 0:HasProperty | Variable | MonetaryValue | PriceDataType | 0:PropertyType | O |
| 0:HasProperty | Variable | SlotIndex | 0:Int32 | 0:PropertyType | O |
| 0:HasProperty | Variable | NewSlotContent | 0:UInt32 | 0:PropertyType | O |
| 0:HasProperty | Variable | Selection | SelectionDataType | 0:PropertyType | O |
| 0:HasProperty | Variable | UserId | 0:String | 0:PropertyType | O |
| 0:HasProperty | Variable | PaymentDetails | ActualPaymentDataType[] | 0:PropertyType | O |
| 0:HasProperty | Variable | MonetaryValueWithContext | PriceAndContextDataType | 0:PropertyType | O |
| 0:HasProperty | Variable | PaymentMode | 0:String | 0:PropertyType | O |
| 0:HasProperty | Variable | FailStatus | DeliveryAndPaymentStatusEnum | 0:PropertyType | O |
| 0:HasProperty | Variable | NonRefundedValue | PriceAndContextDataType | 0:PropertyType | O |
| Conformance Units | |||||
|---|---|---|---|---|---|
| UnattendedRetail PaymentService | |||||
| UnattendedRetail PaymentDevice Coin | |||||
| UnattendedRetail PaymentDevice Bill | |||||
| UnattendedRetail PaymentDevice Cashless |
The mandatory Category defines the category of Event. This specification defines a set of categories. Vendors may define additional categories according to their implementations. The categories are defined in Table 87. In addition to the category, it is defined what optional fields of the Event shall be provided.
| Category | Mandatory Fields | ObjectTypes of Objects generating the Event | Description |
| CoinInCashbox | Counter MonetaryValue | PaymentDeviceType | Gets generated when coins get inserted into cashbox. Fields contain information of new inserted coins. The counter is the number of coins, the MonetaryValue the value of one coin. This event only considers coins of the same value. If coins of different values get inserted, several events need to be generated. |
| CoinInTube | Counter MonetaryValue SlotIndex NewSlotContent | PaymentDeviceType | Gets generated when coins get inserted into tube. Fields contain information of new inserted coins. The counter is the number of coins, the MonetaryValue the value of one coin. The SlotIndex indicates in which SlotIndex the coins get stored. This event only considers coins of the same value and the same SlotIndex. If coins of different value and / or SlotIndex get inserted, several events need to be generated. The NewSlotContent is the number of coins in the SlotIndex after the coins have been added. |
| CoinManualFillTube | Counter MonetaryValue SlotIndex NewSlotContent | PaymentDeviceType | Gets generated when coins get manually inserted into tube. Fields contain information of new inserted coins. The counter is the number of coins, the MonetaryValue the value of one coin. The SlotIndex indicates in which SlotIndex the coins get stored. This event only considers coins of the same value and the same SlotIndex. If coins of different value and / or SlotIndex get inserted, several events need to be generated. The NewSlotContent is the number of coins in the SlotIndex after the coins have been added. |
| CoinOut | Counter MonetaryValue SlotIndex NewSlotContent | PaymentDeviceType | Gets generated when coins get dispensed by technician manually. Fields contain information of coins dispensed. The counter is the number of coins, the MonetaryValue the value of one coin. The SlotIndex indicates from which SlotIndex the coins get dispensed. This event only considers coins of the same value and the same SlotIndex. If coins of different value and / or SlotIndex get dispensed, several events need to be generated. The NewSlotContent is the number of coins in the SlotIndex after the coins have been dispensed. |
| CoinPayout | Counter MonetaryValue SlotIndex NewSlotContent | PaymentDeviceType | Gets generated when coins get dispensed as payout. Fields contain information of coins dispensed. The counter is the number of coins, the MonetaryValue the value of one coin. The SlotIndex indicates from which SlotIndex the coins get dispensed. This event only considers coins of the same value and the same SlotIndex. If coins of different value and / or SlotIndex get dispensed, several events need to be generated. The NewSlotContent is the number of coins in the SlotIndex after the coins have been dispensed. |
| CoinReject | - | PaymentDeviceType | Gets generated when coin was inserted into payment service and got rejected. |
| BillInStacker | Counter MonetaryValue | PaymentDeviceType | Gets generated when bill was inserted into payment service and moved into stacker. The counter is the number of bills, the MonetaryValue the value of one bill. |
| BillInRecycle | Counter MonetaryValue SlotIndex NewSlotContent | PaymentDeviceType | Gets generated when bill was inserted into payment service and moved into recycler. The counter is the number of bills, the MonetaryValue the value of one bill. The SlotIndex indicates from which SlotIndex the bills get inserted. This event only considers bills of the same value and the same SlotIndex. If bills of different value and / or SlotIndex get inserted, several events need to be generated. The NewSlotContent is the number of bills in the SlotIndex after the bills have been inserted. |
| BillOut | Counter MonetaryValue SlotIndex NewSlotContent | PaymentDeviceType | Gets generated when bills get manually removed from recycler. The counter is the number of bills, the MonetaryValue the value of one bill. The SlotIndex indicates from which SlotIndex the bills get removed. This event only considers bills of the same value and the same SlotIndex. If bills of different value and / or SlotIndex get removed, several events need to be generated. The NewSlotContent is the number of bills in the SlotIndex after the bills have been removed. |
| BillPayout | Counter MonetaryValue SlotIndex NewSlotContent | PaymentDeviceType | Gets generated when bills get dispensed as payout from recycler. The counter is the number of bills, the MonetaryValue the value of one bill. The SlotIndex indicates from which SlotIndex the bills get dispensed. This event only considers bills of the same value and the same SlotIndex. If bills of different value and / or SlotIndex get dispensed, several events need to be generated. The NewSlotContent is the number of bills in the SlotIndex after the bills have been dispensed. |
| BillManualFillRecycle | Counter MonetaryValue SlotIndex NewSlotContent | PaymentDeviceType | Gets generated when bills get manually inserted into recycler. Fields contain information about the manually inserted bills. The counter is the number of bills, the MonetaryValue the value of one bill. The SlotIndex indicates to which SlotIndex the bills get inserted. This event only considers bills of the same value and the same SlotIndex. If bills of different value and / or SlotIndex get inserted, several events need to be generated. The NewSlotContent is the number of bills in the SlotIndex after the bills have been inserted. |
| BillTransferRecycle | Counter MonetaryValue SlotIndex NewSlotContent | PaymentDeviceType | Gets generated when bills get transferred from the recycler to the stacker. Fields contain information about the transferred bills. The counter is the number of bills, the MonetaryValue the value of one bill. The SlotIndex indicates from which SlotIndex the bills get transferred. This event only considers bills of the same value and the same SlotIndex. If bills of different value and / or SlotIndex get transferred, several events need to be generated. The NewSlotContent is the number of bills in the SlotIndex after the bills have been transferred. |
| BillReject | - | PaymentDeviceType | Gets generated when bill was inserted into payment service and got rejected. |
| CardIn | MonetaryValue UserId | PaymentDeviceType | Gets generated when the cashless payment service is able to start the payment (e.g., when card gets inserted or card or app on a device is contactless read from payment device). The MonetaryValue contains the monetary value, the Vending Machine may consume. Depending on the system, this may be handled differently, e.g., may be the amount on a pre-paid card or some general credit allowed for a credit card. The UserId contains the identification of the user associated with the card. |
| CardRefund | MonetaryValue UserId | PaymentDeviceType | Gets generated when a delivery gets cancelled and a monetary value gets refunded back to the card. The MonetaryValue contains the monetary value refunded, the UserId contains the identification of the user associated with the card. |
| CardRevalue | MonetaryValue UserId | PaymentDeviceType | Gets generated when a monetary value gets recharged to the card, for example from cash. The MonetaryValue contains the monetary value recharged to the card, the UserId contains the identification of the user associated with the card. |
| CardCharge | MonetaryValue UserId | PaymentDeviceType | Gets generated when a monetary value gets charged from the card by requesting a delivery. The MonetaryValue contains the monetary value charged from the card, the UserId contains the identification of the user associated with the card. |
| CardOut | MonetaryValue UserId | PaymentDeviceType | Gets generated when card was removed from payment service. The MonetaryValue is the MonetaryValue of CardIn minus and the amount of value taken from the card plus the value added to the card. The UserId contains the identification of the user associated with the card. |
| DeliverRequestDone | Selection, PaymentDetails, MonetaryValueWithContext | PaymentServiceType | Gets generated when a deliver request was successfully executed. Fields contain information about the effective selection, the effective PaymentDetails (an array of a structure containing the effective PaymentMode, the effective payment device, the effective UserId and the price received in the combination) to support mixed payments, and the overall paid price in the MonetaryValueWithContext, contain additional information like tax. |
| DeliverRequestFailed | Selection, PaymentMode, UserId, FailStatus, NonRefundedValue | PaymentServiceType | Generated when a deliver request fails. The Fields contain information about the requested selection, the PaymentMode and UserId used in the DeliverRequest method, the reason for the failure, and the amount of money that could not be refunded to the customer. |
| DeliverBasketRequestDone | BasketContent, PaymentDetails, MonetaryValuePerBasketContent | PaymentServiceType | Generated when a deliver request is successfully executed. The Fields contain information about the effective BasketContent, the effective PaymentDetails (an array of structures containing the effective PaymentMode, the effective payment device, the effective UserId, and the price received for each combination, to support mixed payments), and the paid price per basket content represented as a MonetaryValuePerBasketContent, which may include additional information such as tax. |
| DeliverBasketRequestFailed | BasketContent, PaymentMode, UserId, FailStatus, NonRefundedValue | PaymentServiceType | Generated when a deliver request of a basket fails. The Fields contain information about the requested basket content, the PaymentMode and UserId used in the DeliverBasketRequest method, the reason for the failure, and the amount of money that could not be refunded to the customer. |
| DeliverBasketRequestPartiallyDone | BasketContent, PaymentDetails, MonetaryValuePerBasketContent, PartialSuccessful, FailStatus, NonRefundedValue | PaymentServiceType | Generated when a deliver request of a basket was partially done. The Fields contain information about the requested basket content, the effective PaymentDetails (an array of structures containing the effective PaymentMode, the effective payment device, the effective UserId, and the price received for each combination, to support mixed payments), and the paid price per basket content represented as a MonetaryValuePerBasketContent, which may include additional information such as tax. In addition, PartialSuccessful indicates what parts of the basket have been delivered, FailStatus the reason for the partial failure, and NonRefundedValue the amount of money that could not be refunded to the customer. |
| Restart | - | PaymentDeviceType PaymentServiceType MachineEngineType UIType | Gets generated when the device gets restarted. The event gets actually generated before the device gets restarted. |
| Overpay | MonetaryValue | PaymentServiceType | Gets generated when the payment service cannot payout all inserted monetary value. That may be because the payment service does not have the possibility to payout enough monetary value or the user has not interacted / left the vending machine. |
| EVADTSStatusCode | EVADTSStatusCode EVADTSStatusIsActive | PaymentServiceType PaymentDeviceType MachineEngineType | Gets generated when a DTSStatus becomes active or inactive. The Fields indicate the status as well as it has become active or inactive. |
Note: When customer cancels the coins, a Vending Machine may create a CoinOut or a CoinPayout Event.
Note: Card as in CardIn, CardCharge, CardOut, can reference to any cashless asset like a credit card, company card, payment apps, etc.
Note: Tokens are managed the same way as cash, but the Currency of the PriceDataType shall use 000 as NumericCode and 0 as Exponent.
The optional Counter indicates the number of assets of value (coins, bills, or tokens) that are affected by the Event. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional MonetaryValue indicates the monetary value of the asset of value (coins, bills, or tokens) affected by the Event. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional SlotIndex indicates the slot used for buffering assets of value (coins, bills, or tokens). For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional NewSlotContent indicates the number of assets of value (coins, bills, or tokens) in the SlotIndex after the operation triggering the Event has been done. This field shall only be provided, if the SlotIndex is also provided. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional Selection identifies the selection that has been delivered or should have been delivered. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional UserId identifies the user associated with any cashless asset inserted into a payment device, or the UserId of the deliver request. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional PaymentDetails contains details of the payment done for a specific delivery associated to the Event. It provides an array to be able to represent mixed payments. If no mixed payment is used, the array shall have one entry. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional MonetaryValueWithContext contains the absolute amount of monetary value paid for a specific delivery associated to the Event. It contains additional information like the tax rate used, the discount or surcharge and the used price list. The monetary value shall be the sum of the monetary value provided in the PaymentDetails, if provided. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional PaymentMode indicates the PaymentMode of the DeliverRequest method in case the deliver associated to the Event was not successful. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional FailStatus indicates the failure, when the deliver request associated with the Event was not successful. Only the following values of the DeliveryAndPaymentStatusEnum are allowed: PaymentFailed, PaymentCancelledByUser, PaymentFailedWrongPrice, DeliveryFailRefundSuccess, DeliveryAndRefundFailed, DeliveryMixResultRefundSuccess, DeliveryMixResultRefundFailed. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
The optional NonRefundedValue indicates, how much money could not be refunded when a delivery (partially) fails and stays in the Vending Machine. It may provide additional information like tax if applicable. For the standardized Categories (see Table 87) it is defined whether this optional Property shall be provided.
7.27.3 Examples of Events of VendingAuditEventType
In the following, Events of VendingAuditEventType are shown, that would occur on a Vending Machine, having as payment devices a coin device COIN1, a bill device BILL1 and a cashless device CARD1.
The user requests a delivery which costs 9 €, inserts a 1 € coin, a token worth 1 €, a 5 € bill, and then inserts a credit card to pay the remaining 2 €. Afterwards the delivery is executed.
Event for 1 € coin:
Event for 1 token:
Event for 5 € bill:
Event for presenting a credit card:
Event for successful delivery: