Third-party voucher integrations
We can connect other voucher systems (also known as third-party vouchers) via a standard interface (third-party voucher API) in a compatible manner.
Introduction to third-party vouchers and third parties
Third-party vouchers can be used in a similar way to the Hypersoft web voucher system, which must be licensed and set up as the basis for using these third-party voucher functions. Hypersoft web vouchers are licensed per location.
The vouchers can be created and loaded in the third-party system independently of Hypersoft. With regard to legal regulations, we refer Hypersoft customers to their third-party voucher partner and both parties to their own responsibility. Hypersoft uses the transmitted payment method and books or signs it in the standard system.
Hypersoft can query third-party vouchers at the time of redemption, use the credit balance for payment and reduce the payment amount accordingly.
General information about third-party vouchers with Hypersoft
Third-party vouchers (external vouchers) cannot usually be loaded by Hypersoft, as this is not provided for by most providers and serves your security in terms of traceability. Therefore, please note the following:
When using the Hypersoft cash register function "Change payment method", it is possible to use a voucher as a means of payment. With Hypersoft web vouchers, if this process is suddenly interrupted (e.g. by removing the operator key), the voucher is recharged. However, this top-up is not possible with third-party vouchers. Therefore, when using a third-party voucher and interruption (e.g. by removing a key), the transaction must be completed using another payment method, and the operator is forced to complete the transaction. The process remains open and the cancel button is disabled until the payment method is selected.
Requirements for using third-party voucher integration via API
Please book the connection (one to two days of support (depending on the task, this may take longer) with the Hypersoft development department. We can assist you with setting up a test bypass, answering questions and, if necessary, certification.
- Written description of the desired function and workflow
- Enterprise Support Level (minimum term 12 months)
- Signed LOI (Letter of Intent) between the technology partner and Hypersoft
- Name of technical contact persons/developers of the technology partner
- Commissioning of (at least) 1 day of support & development assistance
Once the above requirements have been met, the following steps are taken:
- Activation of all licences for non-productive use
- Training in Hypersoft Basics (using Teamviewer or similar)
- Preliminary discussion between our development department and that of our technology partner
- Handover of voucher interface description
- Support for connection from the technology partner
- Joint unproductive tests
- Going live & project completion
Note: Project work subject to planning
This is an area that requires detailed project planning.
The Hypersoft system is a flexible standard solution that can be used in a variety of configurations. The correct implementation of the functions described here requires specialist expertise and a clear comparison of your requirements and expectations.
Please note that not all Hypersoft employees or partners are trained to the same extent in each of these labelled subject areas.
For this reason, we characterise certain content as "project work requiring planning". We would like to ensure that you contact your Hypersoft sales partner or Hypersoft Support at an early stage in order to carry out the necessary planning and coordination.
This structured approach enables us to carefully analyse your requirements and implement them in a targeted manner.
API connection for third-party voucher systems (external systems)
External vouchers are billed per transaction, just like Hypersoft web vouchers. The use of external vouchers also requires licences for Hypersoft Web Vouchers for each participating location.
The MCP setup for connecting web vouchers can manage 10 free third-party vouchers, which are processed by the web voucher system in MyHypersoft.
The voucher prefixes 50 to 59 are available for this purpose. This means that the acceptance of the external voucher is initiated with a special function on the Hypersoft POS system. Here, a macro with the corresponding prefix and the cash register function, e.g. 5 + 0+ Use external voucher, is used. The number of the external voucher that is then scanned or entered is given the prefix (e.g. in Germany) 4950... followed by the voucher number. This number is used to send a request to the portal, which recognises from the prefix that the check must be forwarded to another server. The prefix (4950 in our example) is the identifier and must also be set up in the portal with a valid customer number, password and URL for API forwarding. The remaining balance of these third-party vouchers can also be paid out if desired. To do this, the standard entry must be set to Pay out remaining balance.
Complete the settings in the MCP and ensure that you make the same entries as in the portal.
Set currency table...
Example of payment types: voucher payment and voucher balance. A remaining balance is not possible with all voucher types:
Multi-payment supported or not...
Third-party vouchers cannot be accepted. You can reopen transactions that were paid for in part or in full with an external voucher, but the voucher will remain included in the transaction. Returns or cancellations of third-party vouchers are not possible.
We therefore recommend deactivating third-party vouchers in multi-payment here: Multi-payment without tip key, voucher key and third-party voucher key
Third-party vouchers in cashier mode
For POS checkout mode, corresponding checkout functions are available for third-party vouchers (you can also find out how to set up the macro in the description of the checkout function):
With the External Voucher Balance function, the credit balance is queried and displayed. To make a payment, activate the macro with the cash register function "Use external voucher". You then have the option of entering the voucher number using the number pad displayed or simply scanning the voucher.
Any remaining credit will be applied as specified in the definition of the web voucher. However, if the "Pay out remaining amount" option is set, but there is a "Voucher overpayment" payment type, the remainder of the voucher will be transferred to this payment type and the guest will not receive any remaining credit.
Settings in the Hypersoft Portal...
Before configuring the settings for third-party vouchers on the cash register, the following settings must be made for the respective branches in MyHypersoft in the central settings for web vouchers:
- Access central settings. Navigation in MyHypersoft
-
Create a password for the cash register interface of the third-party voucher. Configure web vouchers
-
This password must be stored in the checkout under the API of the third-party voucher.
-
Depending on the interface type (interface types 50 to 59, defined on the cash register), it is necessary to store a password or transfer parameter for the API of the third-party voucher. For example, it may be necessary to have a password for this branch in order to access the API of the third-party voucher. However, this varies depending on the interface type.
External voucher prefix number (depending on connection):
- Prefix xx50 for Hypersoft voucher systems
- 3rd party prefix xx51 for E-GUMA
- 3rd party prefix xx52 for Incert
- 3rd party prefix xx53 for Innocard
-
3rd party prefix xx54 for lunch check
- 3rd party prefix xx59 for HKS
Third-party vouchers at the POS...
Example of setup in the POS keyboard and handling at the POS: Vouchers, third-party vouchers - All
Third-party vouchers at mPOS...
Third-party vouchers can also be used at the mPOS: Vouchers and third-party vouchers
Payments with Hypersoft and third-party vouchers
Thematically already described here: Payments with Hypersoft and 3rd party vouchers
Further topics:
Vouchers, third-party vouchers - All
Back to the overarching topic: Integrations and Interfaces