For the complete documentation index, see llms.txt. This page is also available as Markdown.
Support

Multi-merchant and card range parameter management

Configure multi-merchant and card range parameter management for VHQ managed devices, including importing instances via XML and editing merchants directly in VHQ.

Use this when you need to configure or edit parameters for multiple merchants sharing a single terminal, or manage card range instances.

VHQ supports Multi-Merchant functionality and editing of Card Range parameters for all VHQ-managed devices. Multiple merchants can share a single terminal — the device owner creates merchant IDs, and each merchant logs in with their own credentials to perform transactions, which are recorded in the system. VHQ supports this by reusing the same set of parameters and creating multiple instances with different values.

With standard functionality, VHQ manages parameters at the container level, mapped to a single instance. Multi-merchant functionality extends this to multi-instance and multi-level parameter handling:

  • Multi-Level: Multiple child levels under a parent — a hierarchical parent-child relationship.

  • Multi-Instance: A set of parameters repeated at the same level with different values.

Application developers build a parameter definition file (.vpdx) defining all parameters and their attributes, plus multiple form files (.vpfx) for editing them.

Example: A hair salon terminal serves up to 20 different merchants — each stylist/contractor logs into the same terminal with their own credentials to perform transactions.

Multi-merchant terminals typically download parameters once per business day (or more often); editing a parameter or adding an instance triggers a download.

Parameter editing and viewing is allowed only if the application is configured with, or has had uploaded, a form file.

Import instances via XML

1

Open Add Devices

Go to Device Management > Add Devices.

2

Choose file import

Select Add Device via File Import.

3

Import the file

Browse for the XML file and click Import.

XML files for adding or modifying instances or merchants are typically prepared by customer administrators, regional support representatives, or VHQ support personnel.

Set up multi-instance support in VHQ

Before editing parameters, upload the .vpdx and .vpfx files.

1

Check the MultiInstance attribute

Confirm the container-level MultiInstance attribute is set to Yes in the .vpdx file.

2

Upload the vpfx file(s)

You can upload multiple levels of .vpfx file to the application assigned to the device. Check the parent ID attribute is present when uploading. Within the vpfx: AllowAdd, AllowDelete, and AllowEdit set to True allow the user to create, delete, and edit instances; AllowSequence set to True allows setting the ordering for merchants (on deletion, the preceding merchant takes the sequence order).

3

Assign the application

Once the vpdx and vpfx files are uploaded, assign the application to the device.

If AllowSequence is True in both VPDX and VPFX, the user can change the instance sequence; if False, they cannot.

Edit merchant parameters

1

Find the device

Select a device or search for one.

2

Open the Parameter tab

On Device Profile, click Device Details > Parameter.

3

Click the edit icon

4

Manage merchants

On the Edit Parameter for Application window, click the merchant node to view configured merchants. You can add a new merchant, edit merchant-specific parameters, or delete an existing merchant from the List tab. Merchants are identified by ID and name; the Details tab shows full details and lets you edit them.

Add, edit, or delete a merchant

Adding a merchant

  1. On the Edit Parameter for Application window, click the edit icon.

  2. Enter the merchant ID, name, address, and other details (or restore defaults).

  3. Click Add. The new instance is added.

Editing a merchant

  1. Select the merchant and click the pencil icon.

  2. On the Details tab, edit the value and click Save.

Deleting a merchant

  1. Select the merchant and click the remove icon.

  2. Use the up/down icons to reorder the merchant sequence. You can manage multiple levels on the Edit Parameter for Application screen.

On creating or modifying a merchant, parameters are downloaded to the terminal once the job is scheduled. The output parameter file format is generated as shown below:

Keywords

Also called: multi-merchant, card range parameters. Search terms: merchant ID, multi-instance, multi-level.

Last updated

Was this helpful?