3rd party voucher integration
As a connection, we can integrate other voucher systems (also known as third-party vouchers) via a standard interface (3rd party voucher API).
Introduction to third-party vouchers and 3rd parties
3rd party vouchers can be used in a similar way to the Hypersoft web voucher system , which must be licensed and set up as a basis for the use of these third-party voucher functions. The Hypersoft web vouchers are licensed per location.
The vouchers can be created and topped up in the 3rd party system and independently of Hypersoft. With regard to legal regulations, we refer Hypersoft customers to their 3rd party voucher partner and both to their own responsibility. Hypersoft uses the transmitted means of payment and books or signs it in the standard system.
Hypersoft may request 3rd party vouchers at the time of redemption, use credit balances for payment and reduce them by the payment amount accordingly.
General information on 3rd party vouchers with Hypersoft
As a rule, 3rd party vouchers (third-party vouchers) cannot be topped up by Hypersoft, as this is not provided for by most providers and serves your security in terms of traceability. Please note the following:
When using the Hypersoft checkout function Change payment method, it is possible to use a voucher as a means of payment. With Hypersoft Web vouchers, the voucher is recharged if this process is suddenly interrupted (e.g. by removing the operator key). However, this top-up is not possible with a third-party voucher. Therefore, if a third-party voucher is used and interrupted (e.g. by removing a key), the process is forced to be completed using a different payment method and the operator is forced to complete the process. The transaction remains open and the Cancel key is locked until you select the payment method.
Requirements for using the 3rd party voucher integration via API
Please book for the connection (one to two days of support (depending on the task, this can also be more) of the Hypersoft development department. This allows us to assist you in setting up a test bypass, answering questions and, if necessary, obtaining 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
- Naming of the technical contact person/ developer 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 licenses for unproductive use
- Training in Hypersoft basics (via Teamviewer or similar)
- Preliminary discussion between our and the development department of the technology partner
- Handover of the vouchers Interface description
- Support of the interface on the part of the technology partner
- Joint unproductive tests
- going-Live & project completion
This topic concerns project work that is subject to planning.
The Hypersoft // system is a standard programme that can be used in many different configurations. The correct application of the topics described here requires expert knowledge and an alignment of expectations, and not all Hypersoft employees and partners are equally trained in all of the topics labelled in this way. For this reason, we characterise these topics as project work requiring planning, so that you can contact your Hypersoft sales partner or Hypersoft Support in good time with this necessary planning. This approach ensures that we record your requirements carefully and respond to them in a targeted manner.
API interface for external voucher systems (external systems)
External vouchers are billed per transaction like Hypersoft web vouchers. The use of external vouchers also requires Hypersoft Web Voucher licenses per participating site.
The MCP device for connecting web vouchers can manage 10 free third-party vouchers that 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 third-party voucher is initiated with a special function on the Hypersoft POS system. A macro with the corresponding prefix and the checkout function is used here, e.g. 5 + 0+ Use foreign voucher. The scanned or entered number of the foreign voucher gets the prefix (e.g. in Germany) 4950... followed by the number of the voucher. This number is used to send a request to the portal and it recognizes from the prefix that the check must be forwarded to another server. The prefix (in our example 4950) is the recognition and must also be set up in the portal with valid customer number, password and URL for API forwarding. The remaining balance of these foreign vouchers can also be paid out optionally, for this the standard entry must be set to Pay out remaining amount.
Complete the settings in the MCP and make sure to make the same entries as in the portal.
Set currency table...
Example for payment types voucher payment and voucher remainder. Residual credit is not possible with all voucher types:
Multi-payment supported or not...
Third-party vouchers cannot be returned. You can reopen transactions that have been paid in part or in full with a third-party voucher, but the voucher remains in the transaction. A return or cancellation of third-party vouchers is not possible.
We therefore recommend deactivating third-party vouchers in the multi-payment here: Multi-payment without tip key, voucher key and third-party voucher key
3rd Party Vouchers In Cashier Mode
For the POS cashier mode, corresponding cashier functions for third-party vouchers are available (the description of the cashier function also tells you how to set up the macro):
With the function Voucher foreign balance, the credit balance is queried and displayed. To pay, activate the macro with the checkout function Use foreign voucher, you then have the option of entering the voucher number via the number block displayed or simply scanning the voucher.
Any remaining credit will be applied as set in the definition of the web voucher. If, however, the remaining amount is set to pay out, but a payment type voucher overpayment is available, the rest of the voucher is rebooked to this payment type and the guest does not get any remaining credit.
Settings in the Hypersoft Portal...
Before the settings for the third-party vouchers are made at the checkout, the following settings must be made for the respective branches in MyHypersoft in the central settings of the web vouchers:
- Call up central settings. Navigation in MyHypersoft
-
Create a password for the POS interface of the third-party voucher. Configure web vouchers
-
This password must be deposited in the cashier at the API of the foreign voucher.
-
Depending on the interface type (interface type 50 to 59, defined on the cash register), it is necessary to enter a password or a transfer parameter for the API of the third-party voucher. For example, it may be necessary that a password to this branch is required to access the API of the foreign voucher. However, this varies depending on the interface type.
Third-party voucher prefix number (depending on the connection):
- Prefix xx50 for Hypersoft voucher systems
- 3rd party prefix xx51 for the E-GUMA
- 3rd party prefix xx52 for the 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 for setting up the POS keyboard and handling at the POS: Vouchers, third-party vouchers - All
External vouchers at the mPOS...
Third-party vouchers can also be used on the mPOS: Vouchers and third-party vouchers
Payments with Hypersoft and 3rd party vouchers
Thematically already described here: Payments with Hypersoft and 3rd party vouchers
Further documentation:
Vouchers, third-party vouchers - All
Back to the parent page: Integrations and Interfaces