Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Handpoint is proud to offer an online portal for Terminal Management System, the place to manage your merchants and their card readers. Please get in touch with us if you would like to learn more about it or you would like to gain access to it.

Table of Contents
minLevel1
maxLevel3



Introduction to TMS

The Handpoint portal TMS is a web-based terminal management system for easy setup and management of your

...

merchants.

Who is it for?

It's meant for any

...

organisation that needs to manage and onboard merchants on the Handpoint

...

platform.

How is it used?

...

Within the Handpoint portal TMS, you are able to

...

setup your merchants, terminals and to extract the merchant key (

...

Overview of the onboarding workflow

Image Removed

The Handpoint TMS requires just a few pieces of information to setup and activate a merchant:

VAR sheet information provided by the processor

The serial number of the Handpoint card reader   
 

Use the VAR sheet to CREATE a merchant profile in the TMS

Next, use the TMS to ASSIGN the correct card readers to that merchant and easily EDIT special terminal features, e.g., tipping

...

Shared Secret Key and/or API key).

...

Gaining access to

...

Handpoint TMS

Access to the Handpoint

...

portal TMS is provided to selected partners and is requested through your account manager.

The following basic information is needed to create a new

...

partner profile:

...

  • Partner’s name

  • Name of

...

  • organisation, company, etc

...

  • Location information

...

  • (Address, City, Zip Code,

...

  • State and Country)

  • Contact information

...

  • (Phone number

...

  • , Email)

NOTE

...

: You will

...

receive login information via email after your organisation has been

...

set up in the TMS.

...

An

...

organisation might be provided with more than one login if to the TMS.

...

This can occur if a

...

reseller is supporting multiple

...

SWPs or if an

...

SWP is working with more than one processor.

...

Getting Started in the TMS - Front page

The TMS front page provides you with quick access to the most common actions you can take.

...

From here you can create merchants and assign terminals, or go directly to your management view of your merchants and terminals

...

.

  • Create Merchant: This allows you to set up a new merchant.

  • Assign Terminals to Merchant: This allows you to assign card readers to a specific merchant.

  • Assign Terminals to Partner: This allows you to assign a bulk of card readers, so you have them available for assignation to your merchants.


User profile

Clicking the dropdown menu on the right lets you update your user profile.

...

Change User Password

We strongly recommend changing the password when Handpoint creates a new user for an SWP.
This is done by clicking on User Profile. It will require to enter the assigned password and the new one of your choice. Your password must be at least 8 characters long and include both numeric and alphabetic characters.

Management page

The management page provides you with a detailed view of your onboarded merchants

...

.

 

Creating a Merchant

 

Image Removed

...

From one single page, you can

...

setup merchants

...

, assign terminals,

...

and access

...

all

...

the related actions. The information can be grouped by merchants or viewed as a list of terminals.

...

The data can be filtered by

...

different parameters using the top search bar.

Management Page Navigation

...

    Image Removed

    1. Information can be grouped by merchants or viewed as a list of terminals. In this case, the merchant view is displayed.

    2. This is the hierarchical view of terminals assigned to merchants

    ...

    1. , starting with the most recent one.

    2. Here you have a quick access to common action: create new merchants, assign multiple terminals, manage a group of terminals, generate a Report on the devices assigned to each merchant.

    3. More dropdown and Edit Merchant:

      • More: Allows to generate and consult the available API Key of the merchant, Reset the merchant password and Delete the merchant.

      • Edit merchant: Merchant information can be updated here if needed, and below this, terminal information can be updated.

    ...

     

    Image Added

    1. A list of your assigned/unassigned terminals can be found here. Contact Handpoint to have new terminals added to this list.

    2. More dropdown and Edit Merchant:

      • More: Unassign terminal from the merchant

      • Edit terminal: Terminal information can be updated here if needed.

    Searching and Filtering

    The TMS comes with a powerful filtering tool to help you quickly find what you need.

    ...

    The results are presented dynamically on the screen. The search dataset is defined by the selected view (Merchants or Terminals)

    ...

    Image Removed

    ...

    . To see the complete list of results of your search, just press Enter.

    ...

    Searching terminals: On the Terminals screen (click on the Terminals button on the page), simply enter part of the terminal's serial number into the

    ...

    search bar – the last 4 digits should suffice. The results list updates automatically when it finds data

    ...

    matching the criteria.

    ...

    Searching merchants: On the Merchants screen (click on the Merchants button on the page), simply enter what you are looking for into the search bar – at least 3 characters. You can search by fields such as merchant's name, location, ID, category code, etc.

    ...

    The results will be updated automatically.

     

    Creating Merchants in the System

    Image Removed

    Creating a merchant is the first step in onboarding merchants to the Handpoint platform.

    Here you fill in the relevant information from the processor VAR sheet.

    Select the relevant acquirer.

    The Shared Secret can be found at the bottom of the page.

    You will continue entering the rest of the VAR sheet information when assigning terminals.

    The Handpoint Merchant ID is generated by the system based on what is input in the Merchant Name field. 

    After information has been input, press Save.  You can stop and restart this process.  Once the Merchant Information is complete, you will be given the option to immediately Publish the information and activate the merchant.

    Which fields are required?

    Typically all fields are required, the system will let you know if it’s missing some required fields.

    Assigning terminals to merchants

    Terminals can be assigned from 3 different places in the TMS: from the front page, the top of the management page, or next to an unassigned terminal. They all lead to the same process.

    This will bring up a view where you are able to select a merchant and assign one or more terminals to it.  Terminals are identified by the Serial Number found on the back of the terminal.

    After assigning a terminal to a merchant, the next step is to Edit that terminal and finish the setup from the VAR sheet.

    To Edit a terminal, locate the terminal in the management view and click Edit terminal. 

     

    Can I start creating a merchant without assigning terminals?

    Yes. It is very possible to first create the merchant and then add the terminal later on when the serial number for that terminal is known.

    Where do I locate the Serial Number?

    The terminal serial number can be found on the back of the Card Reader and its packaging. It is a unique identifier for the terminal.

    Editing a terminal

    ...

    Editing a terminal is the final stage in finalizing the onboarding

    You can copy duplicate information from the merchant setup to speed up process.

    Fields in the terminal information section might differ depending on which processor the merchant is setup for

    When do changes go live?

    Changes are live as soon as they are published. However, changes that propogate to the card reader do not go live until the card reader connects to the gateway, i.e., through a transaction or an update. Then the terminal will automatically download and update itself.  This generally takes less than a minute to complete.

    Save and publish when done.

    Locating the Shared Secret

    ...

    Configuring Merchants

    Please note that the any change on the merchant’s configuration is effective immediately and might prevent your merchants from taking payments.

    Depending on your agreement with Handpoint, you might need to create and configure the merchants to onboard them into the Handpoint platform. This can be done within a few minutes and with just a few pieces of information. Please contact Handpoint support team if you need to create merchants or refer to the specific section of this help centre.

    Where is the merchant key?

    • Partners with Native integrations or Standalone - the merchant key is found on the merchant profile as Shared Secret Key.

    • Partners with Cloud integrations - the merchant key can be created when publishing the merchant. Remember to copy or download the Merchant API key at that moment, since afterwards it will not be visible. If necessary, you can create a new API key from the merchant page.

    Locating the Merchant key: Shared Secret

    The shared secret is the key to the merchants’ terminals – It

    ...

    is needed by the organisation responsible for storing the key on the behalf of the merchant. Typically it is the

    ...

    SWP’s responsibility.  

    ...

    The shared secret is a randomly generated string of text and is the same for all terminals

    ...

    assigned to a single merchant

    ...

    . It

    ...

    can only be edited by Handpoint admins

    ...

    .

    1. To locate the shared secret click Edit Merchant next to the merchant

    ...

    1. listed on the management page. This will bring up the Merchant Information

    ...

    1. screen.

    2.  Locate the Shared Secret

    ...

    1. as shown below. Click on the text to highlight

    ...

    You should now be able to paste it into the tool of your choice for sending

    Tipping Configuration

    Handpoint supports tipping on the card reader. If enabled, the card holder is prompted to tip on the card reader during a sale. The card holder can choose between preset values, a custom value, or “No Tip” before commencing with the transaction.

    Tipping is enabled per terminal and custom values can be configured both on a merchant level and terminal level.

    On the merchant level you can configure custom tip values – This is done in the Edit Merchant or Create Merchant views

    Image Removed

     

    Tipping has to be enabled per terminal and custom values can be configured further there if needed. This is done in the Edit Terminal view.

    Image Removed

    Deleting and unassigning

    Image Removed

    Merchants can be deleted and terminals can be unassigned.

    Obviously, deleting a merchant is a high risk operation and should only be done if there was an error during the onboarding and it is considered quicker to just delete and start over.

    Terminals can be unassigned from merchants. This is done if, e.g., a merchant returns the device to you for replacement or to upgrade to an alternative Handpoint device, such as the HiPro. Merchants with no assigned terminals are considered inactive.

    When terminals are unassigned from a merchant they are moved to the list of unassigned terminals.

    Both deleting and unassigning is done from the More dropdown button next to an item in the management view.

    Reusing Terminals

    Terminals can be reused and moved from merchant to merchant. In order to do so, the following best practices help ensure a smooth merchant experience and minimze the risk of additional customer support.

    1. Unassign terminal from old merchant
    2. Assign alternative terminal to new merchant
    3. Update terminal information
    4. Extract and send the shared secret
    5. Do a flash reset on the card reader with simple instructions provided to the merchant
    6. Initiate an update to the card reader

    Point 5 and 6 can be done by the merchant, and require minimal effort.

     

    You can find the Powerpoint version of this guide here:

     

     

    ...

    1. it and Download or copy it.

    ...

    Locating the Merchant key: API key (Cloud Integrations)

    The shared secret is the key to the merchants’ terminals – It is needed by the organisation responsible for storing the key on the behalf of the merchant. Typically it is the SWP’s responsibility.  

    The merchant API key can be created when publishing a merchant after its creation or edition. Remember to copy or download the Merchant API key at that moment, since afterwards it will not be visible. If necessary, you can create a new API key from the merchant list on the management page.

    How to create a new API key? If you need to create a new API key for the merchant, navigate to the Handpoint APIs Configuration screen (it’s one of the options under the More menu). On this screen enter a name for the new API key and click Add Handpoint API Key.

    ...

    Other sections on the Handpoint portal TMS

    • Cloud - Get your API key

    • Analytics - Get insights of your business and merchants' performance

    • Support - Video explanation of the most common actions

    To learn more about the above, please review the corresponding pages.


    If you have any questions, please contact Handpoint support team: support@handpoint.com 📬