Release Date | Market | Country | Payment Gateways | Ultra Transaction Type | Payment Types | Ultra Work Mode | Minimum Terminal Version Requirement |
05/14/2025 | Integration (Vending) | USA | only supports TSYS | Single Auth | Only applied when using credit/debit or transact cards | Retail | [UltraVQM][2200.002.000.005][Branch] |
The functionality of the revalue process is developed to equip the Ultra VQM with the capability to identify the scenarios when some selected products failed to dispense from the machine (e.g., a jammed product slot) and initiate the reversal process (by Credit/Debit card) or the re-adjustment of the total paid amount (by Transact Card) by means of recalculation. The Revalue process ensures the financial accuracy when delivery failures occur and maintains transactional integrity by aligning the consumer’s balance with the actual goods received.
The revalue process is a custom functionality at the present stage and is developed for Level-3 French pizza vending machine in the U.S. market.
At the current development stage, the Revalue process is only applicable for the transactions on the vending machine via Credit/Debit card and Transact Card. Consequently, two transaction scenarios will be expounded separately to demonstrate how Revalue process works in practical contexts.
General Deployment of Ultra VQM in CCM Profile & KLM Profile
1. Create vendor Company on Universal Server
First, as a server owner, admin or distributor admin, you can go to Universal Server (KioCentral) => Company Management => Create Company to create a vendor company. The newly created company will be laid out in the list with a Login button via which you can log in to your vendor portal for further deployment from location, room, staff, CCM, etc. perspectives.
2. General Steps for Creating CCM Profile
This document serves as an introductory guide to the general steps for creating profiles for Ultra Series Readers using the KioSoft backend management system (such as Washboard) and the Cloud Configuration Manager (CCM). For a comprehensive overview of CCM and the backend management system, please consult the Retail Server User Manual. For detailed instructions on configuring specific features, refer to the dedicated feature user manual.
2.1 Preparation work
Use your account information to log in to the KioSoft backend management system (Washboard for example). Create Location, Room, Branch, and Staff information for the terminal.
1. The location information is required when you create the profile in CCM.
2. For transactions on vending machine by using Transact Card, you should click on the “Campus Solution” tab and select “Transact” in Supported Campus Solution. The related parameters should be configured as required and based on the actual needs. For detailed instructions on the fields’ configuration of Transact Card, please refer to the section of Campus Solution (Transact) in the user guide Vendor Portal - Location Management - Locations.
2.2 Create the Profile
Click CCM to enter the Profile Builder.
Typically, there are two types of profiles:
Site Data + Machine Data + CleanReader Ultra Data: compatible with a specific machine model.
Universal: universally applicable to a wide range of machines (not applicable for Revalue feature).
As the Revalue feature is only applicable to KioSoft MDB vending machine. You should configure the profile as the “Site Data + Machine Data + CleanReader Ultra Data.”
2.2.1 Create Site Data + Machine Data profile
To create the profile compatible with a special machine model, typically we should create site data + machine data.
Site Data
Site data includes location and room information, display customization, and payment type configurations, etc.
Machine Data
Machine data encompasses the configuration of machine operations, including running time and pricing for different washing modes.
Please select Machine Data → KioSoft → MDB → Vending, shown as below because the Revalue feature is only supported by this specific machine model.
Save the Profile
After completing all the configurations of the terminal, click the drop-down menu in the top right corner, and select “Save Profile.”
The main body of the profile name is generated automatically, marking the information like profile type and generating time, etc. Input the customized part of the profile name and descriptions if necessary.
Note: This custom profile name will facilitate quick location of the profile when using KLM to inject it into the reader.
Click “Save,” and then the profile is created successfully.
|
2.2.2 Create CleanReader Ultra Data
For Ultra Series Terminals, if you created the Site + Machine Data profile, you also should create the CleanReader Ultra Data profile.
Navigate to CCM > CleanReader Ultra Data, then click “Add” to open the configuration page.
Please refer to the enclosed table for instructions on filling out the form.
Field Name | Value Needed | Description |
|---|---|---|
Location Code | Numeric | This parameter is assigned to you when you create location and should be same as the Location ID set previously. |
Room# | Numeric | It is the Room # when you create the room and should be the same as the room number set previously. |
Work Mode | Fixed Value | This parameter is determined by the “Ultra Work Mode” field. It is displayed same as the selection of the “Ultra Work Mode”. |
Custom text | Alpha-Numeric | This field is designated for identifying profiles specifically and should include details such as location name, room number, etc. |
Server Address | Alpha-Numeric | The URL of the Server. |
Terminal ID | Numeric | For vendors using AIB Payment Gateway only. The POS ID for transaction. |
Payment Gateway | Drop-down Choice | The supported payment gateway applied in the target market(s) and countries. !Note!: Please make sure “TSYS-Summit” is selected as the payment gateway, as Revalue process is only supported in U.S. vending market at the present stage. |
Ultra Transaction Type | Drop-down list | Single Authorization: A separate fee is deducted for each transaction. !Note!: Please ensure “Single Authorization” has been selected as the Ultra Transaction Type, otherwise the Revalue process won’t be initiated in transactions. |
HCS POS | Numeric | The POS ID for transaction. Will not display for vendors using AIB Payment Gateway. |
HCS Auth Code | Alpha-Numeric | The Auth Code for POS ID. Will not display for vendors using AIB Payment Gateway. |
HCS Auth Factor | Numeric | The Zip Code of the vendor. Will not display for vendors using AIB Payment Gateway. |
Pre-Authorization Amount | Numeric | The amount of the Pre-Authorization type of transaction. Will not display for vendors using AIB Payment Gateway. |
Reboot Time | Drop-down choice | Choose a time for the daily reboot of readers. |
Server Upload Port | Numeric | The port of the Report Server. |
Server Upload Time | Drop-down choice | The settlement time of the reader. Note: For Ultra VXT on AVU Touch kiosk, pls set the field to 6 PM. |
Ultra Work Mode | Drop-down choice (Master, Backup, Normal, Retail) | Normally when you have multiple machines in a room to share one POS ID for bank card transactions, you need to define one machine as the Master machine to own the POS ID and other machines will go through this one for bank communication. For security purpose, one Backup machine shall also be configured just in case the Master machine goes down. And all other remaining machines can be defined as Normal machines. If only one machine uses the POS ID for bank card transaction in this room, you can define it as Retail mode. |
Ultra Coin Support | Drop-down choice (ON / OFF) | If the reader supports payment by coin, choose ON. If not, choose OFF. |
Ultra Coin Timeout | Numeric | This parameter means the valid time after inserting coin, from 1-9. The unit is minute. |
Ultra Offline Mode | Drop-down choice (ON / OFF) | If you choose ON, the reader will still work after it is offline. When the reader is re-connected to network, it will upload the offline transaction data. |
Offline Washer Use | Numeric | The maximal times a card can be used on the washer in offline mode, from 0-9. |
Offline Dryer Use | Numeric | The maximal times a card can be used on the dryer in offline mode, from 0-9. |
Max Card Use Offline | Numeric | The maximal times a card can be used in this room, from 0-9. |
WIFI SSID | Alpha-Numeric | The WIFI SSID of the router. It must be totally the same as the WLAN WIFI SSID in router’s setup. |
Label ID | Numeric | Should be same as the Label ID while doing the KLM setup. |
3.Inject Profile Using KLM
The KLM (KioSoft Logistic Manager) mobile app is a comprehensive tool for managing KioSoft terminals in the field. It enables users to perform essential tasks such as vendor key injection, profile uploads, firmware updates, and TMS/NMS updates. Additionally, the app facilitates cash collection and various configuration interactions with KioSoft terminals, streamlining operations and maintenance processes.
3.1 Install the KLM app
You can download the latest version of KLM either from the App Store or Google Play.
3.2 Log in to KLM
1) Search for “KioSoft Logistics Manager” in the Apple Store or Google Play and download the app. | 2) To ensure the correct location, click “Re-Scan Registration QR Code.” | 3) Select one method of gaining the room’s SRC then click “Back to Sign in” to go backward. |
|
|
|
4) Input your credentials, then press “SIGN IN” to log in to this app. | 5) After logging in, you will see “Install” section on home page. *Upon your first login, the app will request permissions for wireless data, location, and Bluetooth. It is recommended to grant these permissions to enhance your user experience. | INTENTIONALLY LEFT BLANK |
|
| INTENTIONALLY LEFT BLANK |
3.3 Setup Ultra Series Terminals Using KLM
Follow the procedures below to set up ultra series terminals via KLM.
1) Click Setup | 2) Click “Proceed Setup with + location” | 3) Select the target room and click “Setup New Reader.” |
|
|
|
4) The machines in the room will be displayed. Click “Setup New Reader” to proceed. Note: Click “Installation Video” for help. | 5) Select “Ultra Series” for “Site Data + Machine Data + CleanReader Ultra Data” profiles. | 5-1) For Ultra Series, first select the profile (site data + machine data) created in Profile Builder of CCM. |
|
|
|
5-2) Second, select the CleanReader Ultra Data created in CCM. | 6) Enter Machine number and Machine ID then click NEXT. | 7) Click Scan QR Code or Enter Machine Number to complete the setup. Note: The QR code includes the Machine ID information. Please refer to the attachment at the end of the document for instructions on how to obtain it. |
|
|
|
8) A green sign will appear to indicate the successful injection. | 9) Go back to the location page and click “Finish Setup and Upload Data to Server.” | |
|
|
Multiple payment types might be supported by your vending machine. The Revalue process functionality will be only applied in the Transact Card and Credit/Debit Card payments. Two scenarios for each of them with the involvement of Revalue will be demonstrated as below:
Scenario #1: Revalue Process in Transactions by Using Transact Card
Before using Transact Card to make transactions on the MDB vending machine, you should make sure “Transact” has been configured at Server’s side (Location Management → Location Level → Campus Solution), which has been illustrated above in the the section of General Deployment Process.
The transaction procedures below will be followed under the scenario that the consumer selects and makes the payment on vending machine by using the Transact Card:
1) The customer goes to the vending machine and selects multiple products valued at $3.25 in total. | 2) Upon customer’s selection of a product, the vending machine transmits the amounts command to the reader to initiate transaction processing. | 3) The customer presents the card on reader to make payments. The Ultra VQM reads the card. |
|
|
|
4) After the card’s reading, the card’s balance amount (before deduction) will be shown on the screen. | 5) “DISPENSING PRODUCT” prompts when the machine starts to dispense the selected products. | 5-1) For successful dispensing, the original balance, paid amount and the new balance amount will be shown on the screen. |
|
|
|
5-2) For unsuccessful dispensing, initiate the Revalue process: When the machine is dispensing the selected products, if one undispensed product valued at $1.00 is detected, the Revalue process will be initiated. The backend will compute and re-adjust the total paid amount and initiate the deduction. After the paid amount has been deducted from the card’s balance, the paid amount and the new balance will be shown on the reader’s screen. | Note: For the transaction process made via Transact card, the paid amount of the selected product(s) will be issued after the dispensing. If all the products are dispensed successfully, the paid amount will be the total value of the selected products. If one product failed to dispense, the amount of the product will not be included in the final paid amount. | |
|
Scenario #2: Revalue Process in Transactions by Using a Credit/Debit Card
The consumers can make transactions on the vending machine by using Credit/Debit card as well. The transaction scenario will be illustrated as below:
1) The customer goes to the vending machine and selects multiple products valued at $3.25. | 2) Upon customer’s selection of a product, the vending machine transmits the amounts command to the reader to initiate transaction processing. | 3) The customer presents the card on reader to make payments. The Ultra VQM reads the card. |
|
|
|
4) Then begins the sale and processing approval. | 5) “DISPENSING PRODUCT” prompts when the machine starts to dispense the selected products. | 5-1) Successful dispensing will be indicated by the prompt below. |
|
|
|
5-2) If the machine failed to dispense one or more products, initiate Revalue: Upon detection of an undispensed product valued at $1.00, the Revalue process will be initiated. After a while, the error prompt with the reversal amount will be shown on the reader’s screen. Note: The total amount of the selected products have been deducted from the card’s balance prior to the dispensing. Therefore, if Revalue occurs, the revalued amount should be refunded back the card. | 6) Then the reader proceeds with the reversal process. When the “REVERSAL APPROVED” prompts on the reader’s screen, the amount of the undispensed product will be refunded to the consumer’s card automatically. | Note: For the transaction process made via Credit/Debit Card, the paid amount of the selected products will be deducted from the card’s balance before the dispensing. The amount of the undispensed product(s) should be refunded back to the card with the revalue process initiated. |
|
|
Extreme Cases to Note
There is an extreme case that the operators should be aware of and assume the risks with the full acknowledgement of the case.
Scenario: Assume two vending machines are positioned together with little clearance and a consumer is going to purchase products on both machines by using a Transact Card with $28 in balance.
The consumer selects one product valued at $20 in vending machine 1 (VM1) and selects another product valued at $15 in vending machine 2 (VM2).
The consumer presents the Transact Card to pay $20 in VM1 and the balance turns $8.
The consumer presents the Transact Card to pay $15 in VM2 and the balance ($8) is not sufficient.
Then $8 will be deducted from the card’s balance. The loss of $7 shall be borne by the operator.
Check Revalue Transaction Records at KLEO Server
The Revalue records that generated from the transactions on the vending machine will be uploaded to the “Pay At Machine” report at KLEO server. You can log in to the server and navigate to “Detail Reports” → “Pay At Machine” to check the records.
The records differ based on the payment types (Credit/Debit Card or Transact Card) used in the transactions.
Revalue Records by Using Credit/Debit Card
As demonstrated in the transaction and revalue process above, two transaction procedures (the deduction and reversal) are included for Credit and Debit card-based transactions if the Revalue process is initiated. Two records will be uploaded to the report:
Record #1: The deduction of the paid amount of the selected products occurs before the machine starts dispensing. This record can be found in the report with its Transaction Type indicated as “Single-Auth.”
Record #2: The reversal of the undispensed product(s) to the consumer’s card with Revalue initiated. This record can be found in the report with its Transaction Type marked as “Revalue.”
Revalue Record by Using Transact Card
As demonstrated in the transaction and revalue process above, only one-time deduction is included for Transact Card-based transactions if Revalue process is triggered. Thus, only one record will be uploaded to the report.
