Vendor Portal - Locations

In this section, you can see the layout of Location Management is displayed with the consolidation of location management, branch management and cluster management. You can see there are three subsets: “Locations,” “Branch Management,” and “Cluster Management”; as shown below.

In the Locations section, you can create/view/edit/delete the information of the location and the room information under the location.

Create Location

Click the “Create Location” button in blue; you will be led to the section where you can create a location. The parameters needed for creating a location are summarized and divided into six subsets, namely, “Location,” “Options,” “Address,” “Payment Gateway,” “Campus Solution” and “Rooms.” Please see the content below for detailed information on the subsets in sequence.

The subset “Rooms” is greyed out by default and will become editable after all necessary information in the subsets ahead of it is completed and saved.

Location

You can hover your mouse above the field name or follow the descriptions in the table below to help you fill in the “Location” subset based on your actual situation.

Field Name	Value Needed	Description
Location Name	Alpha-Numeric	The name of the Location which will be displayed in the system.
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.
Location ID	Alpha-Numeric	A unique location code that identifies the location. You can use the auto-generated one by the system or define it by yourself.
Monthly Fee ($)	Numeric	The fee charged from the vendor for the system.
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.
TID	Numeric	Short for Terminal ID. It is required that the TID be entered in one row and the duplicates in different rows will be merged as one.
SRC Codes	Alpha-Numeric	Smartphone Registration Code (SRC) is used to link mobile apps to a location in KioCentral. 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 by yourself. The custom SRC code though being random, shall also be within the SRC code range defined for the Vendor in IMS.

Options

Click the “Options” tab to enter this section. It includes configurations of the supported payment options, mobile app related options, login options and so on. For descriptions of the fields, you may move your mouse to the field name or refer to the table below for details.

Field Name	Value Needed	Description
Supported Payment Type
Coin	Radio button choice	Defines whether to allow the payment option of coins.
Mobile App	Radio button choice	Defines whether to allow using 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.
Adapt	Radio button choice	Defines whether to allow the payment option using Adapt device. “Adapt”: The kiosk named “Adapt” to purchase ESD/Heartland/Greenwald laundry cards and load balance to the cards.
Purchase Value Code	Radio button choice	Defines whether to allow the users to buy Value Code online.
AVS Verification	Radio button choice	To control if open the IBX verification. If IBX verification is enabled, when registering credit card in the app, information about address and zip code is required.
Free Play	Radio button choice	This feature offers users the chances to use the service without having to load the account. If enabled, the consumer’s account balance will be replenished by the amount defined in the following field when the user’s account balance (credit + bonus) reaches $0.25.
Free Play Refill Amount	Numeric	This field displays when Free Play is enabled. It defines the refill amount to customer for Free Play. Unit is cent. Range is 0-3000.
Mobile App Options
Terminal Encryption	Checkbox	Select the encryption way for terminal to deal with transactions.
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.
Location Mode	Radio button choice	This feature applies to Amusement Market only. It decides whether to support payment with credits.
Mobile Advertising Monetization	Radio button choice	Defines whether to display advertisement in the mobile app. Low, medium and high represents the frequency/place that the ads appear.
Request Refund	Radio button choice	It is applicable to US customers only. It is designed for app users to make refunds.
Offline Transactions	Radio button choice	It allows the Mobile App to work offline in rooms where signal is not great.
Loves Loyalty Card	Radio button choice	It allows the transactions (such as start laundry machine, value deduction, etc.) on Ultra terminals by using Loves Loyalty & Rewards card.
Service Only	Radio button choice	To control if Mobile App will work in Service Only mode.
Show on Map	Radio button choice	This field applies to LAVA PAY app only. It is available only when enabled in the Company Management section and determines whether the location appears on the LAVA PAY map.
Lat & Long	Text	When ‘Show on Map’ is enabled, you need to fill in the coordinates of the location.
Cash to App	Radio button choice	This field applies to LAVA PAY app only. It is displayed only when enabled in the Company Management section. It decides whether the Add Funds button in LAVA PAY is shown. To disable it means the App does not support refill with cash and vice versa.
Social Login
Facebook Login	Radio button choice	If the system allows Facebook Login method.
Google Login	Radio button choice	If the system allows Google Login method.
Apple Login	Radio button choice	If the system allows Apple Login method.
Others
On-premise Server	Radio button choice	The feature is to help optimize the network of Cloud Card transactions for laundry, amusement and integration markets. Enable it to begin the configuration of the local box equipped for AVU Touch, Ultra series or Elevate Card Connect (CRCS).
Server IP Address	Text	Please enter the server IP address of the On-premise Server. Contact the KioSoft team for KioSoft Edge Box Setup and Upgrade Guide for detailed instructions to obtain Server IP Address.
Server Port	Text	Enter 443 for AVU Touch and Ultra Series products; enter 16000 for Elevate Card Connect (CRCS).
Language	Drop-down list	This will determine the language display on the terminals. You could select one or more language options from English, French, Spanish and German. When you make multiple options, you could drag the option to change the display order.
Maximum Top Up Amount ($)	Numeric	The maximum amount users can add at a time.
Max Account Balance ($)	Numeric	Define the maximum account balance in the app. The default value is $99.00.
Card Price ($)	Numeric	Defines the cost charged to purchase a card (laundry card or game card as the case may be).
Convenience Fee ($)	Numeric	An additional fee charged for online transactions by vendors.
Amount Dropdown List ($)	Numeric	List of amounts that users can select from when purchasing Value Code.
Refill Account Amount Dropdown List ($)	Numeric	The refill amount options displayed in the app when refilling the account.
Debit Fee	Text	Customers will be charged debit fee during app refill. The feature can only be applied in Canada.
Credit Fee	Text	Customers will be charged credit fee during app refill. The feature will be applied in both Canada and US.
Account Refill Amount (Applicable to LAVA KIOS app only)
Min Refill Amount ($)	Numeric	Defines the minimum amount that can be refilled in a single transaction per user. The range is 100-10000. The default value is 1500.
Limit Amount ($)	Numeric	Sets the maximum value that Property Manager staff can refill within the timeframe specified in the "Renewal" field below. The range is 50000-999999. The default value is 50000.
Renewal	Radio button choice	It determines whether the refill limit resets daily, weekly, or monthly. Once the total refill amount reaches the set limit within the defined period, staff must wait for the next period to perform additional refills for customers.
Commission Rate	Radio button choice	The "Commission Rate" specifies the percentage or amount that property manager staff earn as commission for each customer refill they process.

Payment Gateway

Within this preset, you can configure the payment gateways for online transactions and reader transactions preferred for the location, ensuring the payments are processed through the selected gateway.

Payment Gateway - Online Transactions

In this section, you can set the preferred payment gateway for your online payments such as payments for mobile apps or for online value code purchase. There are three payment types that you can define: Credit/Debit payment, Digital Wallets (Apple Pay/Google Pay) and PayPal payments.

In Payment Gateway Preference you will be provided with two preference options for the payment gateways setup: Vendor Default Settings and Set Custom Gateway.

If you select Vendor Default Settings, the 1st payment gateway configured for each payment type at the Settings -> Payment Gateway -> Online Transaction section will be defined as the gateway at the location level. This is also the default setting applicable to the location.
If you select Set Custom Gateway for This location, you can customize the payment gateway for this specific location. This allows you to configure separate gateways for Credit/Debit payments, Digital Wallet payments (such as Apple Pay and Google Pay), and PayPal payments.

The payment gateways in the drop-down menu will only display the gateway options that have been configured at Settings => Payment Gateway => Payment Gateway - Online Transactions.

When you configure a custom gateway for the location, if it is Heartland or Payroc - IBX, you’ll need to configure additional parameters. Please click the accordions below for an explanation of the parameters.

Payroc - IBX Parameters

When “Payroc-IBX” is selected, the following three required fields: “Merchant Token,” “API Username” and “API Password,” will be displayed. These fields are credentials provided by IBX, and you can fill them out based on the actual situation.

Remember to click the “Verify Account” button after filling out the information.

Heartland - Portico Parameters

When “Heartland-Portico” is selected, the required fields are displayed as below.

Public Key: The Public Key is provided by Heartland Payment Systems. They generate a unique Public Key for your merchant account. The Public Key is a part of the asymmetric encryption system. It is freely available and is used for encrypting sensitive data during communication. If the location is newly created, the Public Key field will be blank. You can either click on the “Generate Keys” button or manually enter the key. For an existing location, if the key has been filled in manually, you can still click on the “Generate keys” button to refill the key again.

Secret Key: Secret Key is associated with your merchant account and is securely generated and managed by Heartland Payment Systems. The Secret Key is the counterpart to the Public Key in the asymmetric encryption system. It is kept confidential and is used for decrypting the encrypted data that was encrypted with the corresponding Public Key. If the location is newly created, the Secret Key field will be blank. You can either click on the “Generate Keys” button or manually enter the key. For an existing location, if the key has been filled in manually, you can still click on the “Generate keys” button to refill the key again.

The keys value will be automatically saved. The next time you open this page and select Heartland as payment gateway, the values saved last time will be displayed on the page.

AVS Verification: Select an option from the drop-down list. The options are “None,” “Address + Zip,” “Zip Only,” and “Address Only.” Your selection here determines the prompt fields in the app:

• Hide the AVS section on the Credit Card registration page if “None” is selected

• Prompt Address & Zip if “Address + Zip” is selected

• Prompt only Zip Code if “Zip” is selected

• Prompt only Street if “Address” is selected

Once Heartland is selected, the “AVS Verification” field will be displayed here and hidden in Options -> Supported Payment Type.

CVV Verification: This field is applicable in Location Management only when “Heartland-Portico” is selected as the payment gateway.

Click “Enable” and it will prompt for CVV Verification when the end user registers a credit card in the app; click “Disable” and the CVV Verification will be hidden in the app.

Payment Gateway - Reader Transactions

This section allows you to set the payment processor for transactions at readers in this location.

If the radio button of “Vendor Default Settings” is selected, the payment gateway defined in Settings => Payment Gateway => Reader will apply to this location.
If “Set Custom Gateway for This Location” is chosen, users can select the desired one from the drop-down list options, which also comes from the Payment Gateway Settings.

The configuration made here will determine the payment gateway related fields in the CCM profiles (Universal Pulse, Universal Continental, Universal LG and Ultra Data profiles) under this location.

Campus Solution

When you click on the tab “Campus Solution,” the “Supported Campus Solution” field will be shown. The default value is “--”, meaning the campus solution is not enabled. If you’d like to configure the campus solution, click the drop-down list and select “Atrium,” “TouchNet,” “Transact” or “CBORD” based on your actual situation. The corresponding fields will be displayed based on your selection. You can refer to tables below to see the detailed description of Atrium, TouchNet, and Transact and hover over the help bubbles of the CBORD fields to view the description.

Atrium

Field Name	Value Needed	Description
Atrium API URL	Alpha-Numeric	You can set up the “atrium_api_url” here.
Atrium Account	Radio button choice	Defines whether to enable Atrium wallet in the app.
Atrium Account Alias	Alpha-Numeric	It is displayed when you enable the Atrium Account. You could customize the account name that will be displayed in the app.
Campus ID Attribute Name	Alpha-Numeric	It is displayed when you enable the Atrium Account. You could rename the Campus ID with this field. Campus ID is essential for consumers to get while they login to the campus environment and send requests to Atrium for linking the Atrium Card.
Atrium Card	Radio button choice	Defines whether to allow the payment option to use Atrium cards.
LEAF Read Key	Alpha-Numeric	It is displayed when you enable the Atrium Card field. This parameter is required to allow the payment option of Atrium cards.
Google Wallet Read Key	Alpha-Numeric	It is displayed when you enable the Atrium Card field. It is required if you use Google Pay for Atrium.
Apple Wallet Privacy Key	Alpha-Numeric	They are displayed when you enable the Atrium Card field. These are parameters required to allow the payment option of Apple Pay for Atrium.
Apple Wallet Credential Key	Alpha-Numeric
KioSoft Account	Radio button choice	Defines whether to display the payment account of CleanPay in the app.
KioSoft Account Alias	Alpha-Numeric	You could customize the account name which will be displayed in the app wallet.

TouchNet

Field Name	Value Needed	Description
API URL	Alpha-Numeric	This is the URL of the TouchNet API that is installed on the web server.
Terminal ID	Alpha-Numeric	This is the network address of a valid terminal definition in TouchNet card.
Terminal Type	Alpha-Numeric	This is the terminal types that the third party needs/supports.
Operator ID	Alpha-Numeric	This is the ID and password of an operator that is created after running the TouchNet Card program.
Operator Password	Alpha-Numeric
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.
Contactless Card	Radio button choice	The default setting is “Disable.” Click “Enable” and the fields regarding Contactless Card will be unfolded.
Application ID	Alpha-Numeric	Please contact TouchNet for detailed descriptions or the exact values.
File ID	Alpha-Numeric
Data Length	Numeric
Data Offset	Numeric
Read Key Number	Numeric
Read Card Key	Alpha-Numeric
Magstripe Card	Radio button choice	The default setting is “Disable.” Click “Enable” and the fields regarding MagStripe Card will be unfolded.
Account Position	Numeric	Account position is where the account number string starts on the reader. The default value is 1.
Account Length	Numeric	Account length is how long the account number is. The default value is 9.
Suffix Position	Numeric	Suffix position is the position of the suffix in the number string. The default value is 11.
Suffix Length	Numeric	Suffix length is how long the suffix is. The default value is 2.
Customer Position	Numeric	Customer position is the position of the customer number in the number string. The default value is 0.
Customer Length	Numeric	Customer length is how long the customer number is. The default value is 0.
Separator Position	Numeric	Separator position is the position of the separator in the number string. The default value is 10.
Extra Field Number	Numeric	The default value is 0. For the values to fill in, please contact TouchNet to get details.
Extra Field Position	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.

Either TouchNet Account or KioSoft Account must be enabled. For TouchNet Account, Contactless Card, and Magstripe Card, at least one of them must be enabled.

Transact

Field Name	Value Needed	Description
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, therefore you should make sure the value you input here is correct.
Second Transact Encrypted Package	Alpha-Numeric	This field needs to be configured in order to support the second type of Transact card. The information shall be provided by Transact.
Transact Institution Route ID	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.
Offline Support	Radio button	This feature allows consumers to perform a Transact transaction even if the reader is offline.
Transact Magstripe Card	Radio button	This field determines whether to enable the Transact Magstripe card or not.
Transact Card Type Name	Alpha-Numeric	You could define the Transact Card Type with this field using numbers and letters.
Priority	Drop-down list	This field is used to define the priority for the reader to follow to identify Transact Magstripe Card(s). Its range is 1-4 as the minimum format is 1 and the maximum format is 4.
Minimum digits	Number	The minimum digit of the card number. Its range is 1-37.
Maximum digits	Number	The maximum digits of the card number. Its range is 1-37 and it must be equal or greater than the minimum digits.
Site Code Check Enabled	Radio button	Enabled/Disabled When Disabled, the Site Code parameters (Site Code Start Position, Site Code Relative to, Site Code Length, and Site Code Value) will be gray and cannot be edited.
Site Code Start Position	Alpha-numeric	The digit of start of site code (first digit is position). It needs to fall within the Maximum digits.
Site Code Relative to	Drop-down list	First Separator/Tracking Beginning This is to define if the start code starts relative to start of the track 2 data or from the first field separator.
Site Code Length	Number	The number of digits for Site Code. It needs to fall within the Maximum digits.
Site Code Value	Alpha-numeric	The actual digits of the Site Code.

Don’t forget to click the Save button to save the configurations before you proceed with the following actions to search/view/edit the location or continue to create rooms under this location which will be elaborated in another page.

Search Location

When there are multiple locations created, users can use the search bar to find the location needed. Keywords supported by the search bar include location name, site code, location ID and comments.

In addition, the options folded in the “Show More” section can also be used to narrow down the search scope. Click the words “Show More,” then all the options will be unfolded. Tick those that fit the parameters of your desired location and click the “Search” button at the bottom.

View Location

You can click the “View” button in the column of Actions to view the details of the location created.

Click the tabs to toggle among the subsets to view the corresponding information. If you need to return to the “Location Management” page, click “Back” at the upper-right corner.

Edit Location

Click the “Edit” button in the Actions column to open up the page to edit the information of the location.

You can click the tabs to toggle among the subsets to edit the corresponding information. Click “Back” at the upper-right corner if you’d like to return to the location management page; click “Save” after you’ve made some modifications.

Delete Location

Click the “Delete” button in red; a pop-up window will then display. Click “Yes” to delete the location or “No” to cancel the action.

Vendor Portal - Location Management - Locations