Feature Deployment Instructions: Automated VAR

Prev Next

The Automated VAR feature as its name suggests, has automated the process of generating and assigning payment processing credentials to each terminal. Users can view credential statuses and remotely update them via the KioCentral portal. This automation reduces the complexity of credential generation, minimizes human handling errors, improves overall efficiency, and streamlines the workflow. Additionally, it decreases reliance on manual interventions and after-sale technical support, leading to improved customer satisfaction.

During the deployment of this product, in addition to following the general deployment process outlined in a separate document, please pay special attention to the aspects mentioned below.

Scope and Limitations

  • Country: only USA

  • Market: All

  • Payment gateways: only supports TSYS

  • Auth mode: Single Auth

  • Payment Types: only supports credit/debit cards

  • Reader Work Mode: Retail

  • Minimum Terminal Version Requirement: Ultra VX Series [1300.847.017.008]; Ultra LX [1200.839.010.001]

Define Settings on Market Server

When configuring Settings options on the Vendor Portal, please make sure the section “Credentials for New Development (Automation) (Payroc)” in General Settings has been well configured so that this feature can be supported.

Create/Edit Location

Please make sure the Credit/Debit Card is supported by the location.

Creating CCM Profile

When creating/editing the Universal Pulse / Universal Continental Girbau Max / Ultra Data profiles for readers supporting the Automated VAR feature, you can leave the default values of POS ID, Auth Code and Auth Factor to 0. The system will automatically request the credentials from Payroc when setting up this reader using KLM, thus eliminating the manual input efforts.

Reader Setup using KLM

Please follow the steps below to set up the reader. The key injection procedure will be implemented together with the setup for a new reader.

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; select “Other Reader Series” for “Universal Pulse” profile.

5-1-1) For Ultra Series, first select the profile (site data + machine data) created in Profile Builder of CCM.

5-1-2) Second select the CleanReader Ultra Data created in CCM. Please make sure your selected ultra data is the one newly created for the automated VAR.

5-1-2) Second select the Universal Pulse profile. Please make sure your selected universal pulse profile is the one newly created for the automated VAR.

6) Enter Machine number and Machine ID then click NEXT.

7) Click Scan QR Code or Enter Machine Number to complete the setup.

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.

During this process, the reader’s UIs will present as follows:

UI for Setup Mode

UI for Activation in Progress

UI for Successful Activation

UI for Failed Activation

Manage Credentials Remotely in KioCentral Room View

The payment gateway credentials are automatically updated in the Room View and are updated on a real-time basis.

Navigate to Location Management > View Location > Room > View to open the room view.

Roles that have access to features in Room View include Laundry/Amusement/Integration Vendor Admin, Laundry/Amusement/Integration Staff, Laundry Portal Role, Integration Portal Staff, KioSoft Express Laundry/Amusement User, and Laundry Technician. Roles that do not have the Room Management permission won’t be able to access this section.

At the bottom of each machine information card, you can find a section called Reader Credentials. This feature is designed to automate the process of generating and assigning payment processing credentials to each terminal, eliminating the need for manual input. But it does not apply to kiosks. Below are descriptions of the fields and feature buttons in this section.

  • Status (Active / Inactive / Activation in Progress / Null / Error / Pre-auth / Demo):

Active: Indicates that payment credentials have been successfully returned from Tsys and the terminal is activated.

Inactive: Signals that the terminal is not activated, with a prompt on the reader’s idle screen indicating activation failure. When credentials are obtained but the reader is not activated, the system will automatically attempt activation one more time.

Activation in Progress: Represents the status when a request for credentials has been sent but not yet returned.

Null: Appears if the credentials have been deleted by clicking the Edit > Delete > Save button.

Error: Will display when it fails to get the reader credentials. When it fails to get callback data from the payment gateway provider, the system will automatically attempt to get them one more time.

Pre-auth: The auth mode of the machine is set to Pre-auth mode.

Demo: Indicates that the machine is in demo mode

  • Provider (Tsys): Specifies the payment gateway provider. Currently Tsys is supported.

  • POS ID & Auth Code & Auth Factor: These are payment processing credentials. They can be auto-generated using the Request New Credentials button, manually edited with the Edit Credentials button, or uploaded from manually defined CCM profiles.

  • Request New Credentials: This button can be used to call the Payroc-Tsys API to get new credentials. The credentials will be updated in about 2-3 minutes and the reader will be activated immediately after credentials are received. This only works with payroc tsys. This button is hidden for all the other providers.

  • Edit Credentials button allows you to manually modify credentials for operational flexibility. Like the Request button, it is available only when all specified conditions are met. During editing, you need to click the save button to apply changes and/or exit editing mode. Immediately, the credentials will be updated and the reader will be activated.

  • Delete button appears after clicking the Edit Credentials button. Clicking it will clear all credentials and disable credit/debit card transactions when confirmed, and the reader will become inactive immediately.

For machines where Credit/Debit card functionality is enabled at the location level but not in its CCM profile, the status will display as Inactive. If a user clicks the Request New Credentials button or the Edit button, we interpret this action as intending to enable Credit/Debit card payment and will execute the command to activate the payment gateway.

The UI for a failed Automated VAR is as follows:

FAQ

Why can’t I find the credentials configuration section in Room View for the target machine?

Please refer to the table below for the display rules in various scenarios of the credentials configuration section.

Scenarios related to older versions:

Readers with older versions will always have fields disabled on the room view.

Reader Type

FW Version

Profile

Credentials Flow

Room View Display in KioCentral

Existing active readers

Old

has credentials

Pull credentials from the profile, and store them in the database.

Hide/Disable credential section

New

has credentials

Edit/Request buttons enabled.

New Reader Setup

Old

new profile

Edit/Request buttons disabled.

New

  1. Have → Pull credentials from the profile, and store them in the database.

  2. Don’t have →

    check with server database, if available, assign; If not, request from Payroc API, show credentials on room view on server frontend.

Edit/Request buttons enabled.

Scenarios for Credit Card/Debit Card payment setup:

Prioritize the CCM payment method – ignore the location options.

Location

CCM Profile

Credentials Flow

Room View Display in KioCentral

Enabled

Enabled

Request credentials from the server if not already present on the profile.

Show and enable the credential configuration section.

Enabled

Disabled

Not request credentials from the server when the profile is injected

Disabled

Enabled

Request credentials from the server if not already present on the profile.

Disabled

Disabled

Not request new credentials.

Hide/Disable the credential configuration section.

For files with pre-auth:

  • Edit and Request buttons are disabled.

  • Status display pre-auth.

  • Other fields are blank.