In Deployment, vendors can set up the location, room, and redeem hardware in one section. When setting up in the first place, you should fill in all the required fields in New Deployment. You can check the deployment status in the Pending and Completed sections.
Location Setup
You can follow the descriptions in the table below to help you fill in the Location information based on your actual situation.
Fields | Value Needed | Description |
|---|---|---|
Branch | Drop-down Choice | Defines the branch that the location belongs to. Branches in the drop-down list are created in the “Branch Management” section. If no branch is created yet, you can proceed to finish the location, then create a branch and assign the location to the created branch by editing the location. |
Location ID | Alpha-Numeric | Enter the location ID. |
Location Name | Alpha-Numeric | Enter the location name. |
Monthly Fee ($) | Numeric | The fee charged by the vendor for the system. You can define it based on the actual situation. |
Address Line 1 | Alpha-Numeric | Enter the address of the location. |
Address Line 2 | Alpha-Numeric | Enter additional address information if needed. |
City | Alpha-Numeric | Enter the city of the location. |
Province/State | Drop-down choice | Click and choose from the list of provinces/states available in the list. You may type the first few letters of your option to narrow the search. |
Postal/Zip Code | Alpha-Numeric | Enter the Zip code of the location. |
Contact Phone Number | Numeric | Phone number of the location creator or primary contact. |
Contact Name | Alpha-Numeric | Name of the location creator or primary contact. |
Contact Email Address | Alpha-Numeric | Email address of the location creator or primary contact. |
Number of Units | Numeric | The number of units/apartments at this location. |
Comments | Alpha-Numeric | Descriptions or notes of the location. |
Timezone | Drop-down choice | Select the timezone for the location from the list. |
Advanced Options
Laundry Card Setting
Field Name | Value Needed | Description |
|---|---|---|
Site Code | Numeric | A six-digit Site Code for the location, which defines the value cards that can be used in the location. If you want value cards to be used between locations, use the same site code. If you don't want value cards to be shared between locations, assign a unique Site Code. |
Maximum Top Up Amount ($) | Numeric | The maximum amount users can add at a time. |
Purchase Value Code | Radio button choice | It determines whether to enable value code purchase under this location. |
Card Price ($) | Numeric | Defines the cost charged to purchase a card (laundry card or game card, as the case may be). |
Amount List ($) | Numeric | List of amounts that users can select from when purchasing Value Code. |
Mobile Settings
Field Name | Value Needed | Description |
|---|---|---|
Max Account Balance ($) | Numeric | Define the maximum account balance in the app. The default value is $99.00. |
Refill Amount List ($) | Numeric | The refill amount options displayed in the app when refilling the account. |
Terminal Encryption | Checkbox | Select the encryption method for the terminal to deal with transactions. |
TouchNet Account | Radio button choice | It is to define whether to display the payment account of TouchNet in the app. The default setting is "Disable." |
TouchNet Account Alias | Alpha-Numeric | This field will appear after you click "Enable" for the "TouchNet Account" field. You can customize the account name, which will be displayed in the app wallet. |
TouchNet API URL | Alpha-Numeric | This is the URL of the TouchNet API that is installed on the web server. |
TouchNet Terminal ID | Alpha-Numeric | This is the network address of a valid terminal definition in TouchNet card. |
TouchNet Terminal Type | Alpha-Numeric | This is the terminal types that the third party needs/supports. |
TouchNet Operator ID | Alpha-Numeric | This is the ID and password of an operator which is created after running the TouchNet Card program. |
TouchNet Operator Password | Alpha-Numeric | |
KioSoft Account | Radio button choice | It is to define whether to display the payment account of CleanPay in the app. The default setting is "Enable." |
KioSoft Account Alias | Alpha-Numeric | You could customize the account name, which will be displayed in the app wallet. |
Language | Drop-down list | This will determine the language displayed on the terminals. You can select one or more language options from English, French, Spanish, and German. When you select multiple options, you can drag an option to change the display order. |
Machine Selection Method | Drop-down list | There are three options: "Machine number select only," "Machine Number + QR Code where Machine Number is the primary method," and "Machine Number + QR Code where QR Code is the primary method." You can select the one based on your actual situation. |
Coin | Radio button choice | Defines whether to allow the payment option of coins. |
Mobile App | Radio button choice | Defines whether to allow using a smartphone application for payment. |
Value Card | Radio button choice | Defines whether to allow the payment option of physical value cards. |
Credit/Debit Card | Radio button choice | Defines whether to allow the payment option of Credit/Debit Cards. |
Request Refund | Radio button choice | It applies to US customers only. It is designed for app users to make refunds. |
Offline | Radio button choice | It allows the Mobile App to work offline in rooms where signal is not great. |
Facebook Login | Radio button choice | If the system allows the Facebook Login method. |
Free Play | Radio button choice | When enabled, Free Play gives a set refill amount to the customer’s bonus balance whenever their balance reaches 0.25. |
Free Play Refill Amount | Numeric | This field displays when Free Play is enabled. It defines the refill amount for the customer for Free Play. Unit is cent. Range is 0-3000. |
Google Login | Radio button choice | If the system allows the Google Login method. |
AVS Verification | Radio button choice | To control if open the payment gateway (IBX/Payroc) verification. If the verification is enabled, when registering a credit card in the app, information about the address and zip code is required. |
SRC Codes | Alpha-Numeric | Smartphone Registration Code (SRC) is used to link mobile apps to a location in PayRange. When creating a location in the server, the SRC will be used to identify the location and route the end users to the correct system. Length limitation is 7 characters. You can use the auto-generated one by the system or define it yourself. The custom SRC code, though random, shall also be within the SRC code range defined for the Vendor in IMS. |
Transact Card | Radio button | This field determines whether to enable the Transact card or not. |
Transact Encrypted Package | Alpha-Numeric | This field is used to decrypt the Transact card number when the reader reads the card. Please note that the invalid values cannot be saved. You should make sure the value you input here is correct. |
Transact Institution RouteID | Alpha-Numeric | Institution ID is a Globally Unique Identifier (GUID) based identifier for an institution. This value should be considered as "configuration" data and will be different for each institution. |
Incentive Program
Field Name | Value Needed | Description |
|---|---|---|
Status | Numeric | An incentive program is used to reward new consumers (end-users) with a bonus for registration. Select “Enable” to activate the incentive program. |
Amount ($) | Numeric | For credit mode locations, enter the bonus credits the customers receive after registration, and for value mode locations, enter the amount (＄). |
Expiry Date | Checkbox | Bonuses can be assigned an expiry date. To make it never expire, navigate to Rewards → Incentive Program. |
Room Set Up
After location setup, you can set up the rooms under the location. Fill in the fields based on the actual situation. You may refer to the table below for instructions.
Field Name | Value Needed | Description |
|---|---|---|
Room# | Numeric | Customize the room number. There should not be repeated numbers at one location. Range is 1-500. |
Room Name | Alpha-Numeric | The room name that will be displayed in the system. |
Machine Model# | Alpha-Numeric | The model of the configured machine (The model number must exist in KPS). |
Quantity | Numeric | It defines the machine quantity, which is used to calculate the cables needed for this room. |
Price | Numeric | The amount needed to start the machine. You can find more specific configuration in the CCM profile settings. |
DryerMinutes | Numeric | It defines the time needed for the dryer. Please note that the parameters are different depending on the control type for the machine. |
Choose Hardware
In this section, you should provide the details for the reader, kiosk, and modem located in this room.
For the Reader: Select the reader model. For the Ultra Series, when Retail Mode is on, retail ultra data will be generated. Select “Yes” for Coin Support if a coin cable is required.
For the Kiosk: Select the model and room to be installed. Specify the Card Price and the number of cards to be loaded into the Dispenser.
For the Modem: Select the model and ensure at least two modems are deployed in this room.
Final Review
In the final review, you can check all the information you've entered. If you need to make any changes, you can go back to the relevant section. Once you've confirmed everything is correct, save the settings.
You can then track the deployment status under Deployment → Pending.
