Customize the plugin

Customize the Shopware 5 plugin to suit your unique business requirements.

As an agency or developer, you can customize the plugin according to your requirements.

Before you begin

• Install the Plugin
• Get the API credentials

Set your language preferences for payment methods

The Heidelpay CD-Edition plugin by Unzer for Shopware 5 delivers the text snippets for German (DE) and English (EN) language by default. Go to Configuration > Snippet administration > Snippet administration.

Select Namespace and then the relevant folder for which you want to update the snippets.

You can add custom translations in the Namespace folder with the various options available, including:

• frontend/payment_heidelpay
• frontend/checkout/finish
• frontend/register/hp_payment
• backend/heidelBackend

You can use the search option to easily find and edit each text snippet.

Edit Checkout success payment data texts

For secured payment methods, you can modify the text displayed on the checkout-finish page. This is required for printing the bank details on the invoice that the customer can refer to for making the payment.

1. In Shopware backend, go to Configuration > Snippets.
2. Search for the frontend/payment_heidelpay/success namespace.
3. Edit the snippet that you want to customize.
4. Edit the templates for the following payment methods:

1. Select Save.
2. Clear the caches and compile the themes.

Edit Customer Account payment data texts

The Unzer plugin displays the customer’s account order page as shown in the following example.

You can modify the text displayed on customer’s account order overview in Order details > Communication tab.

1. In Shopware back end, go to Customers > Orders, edit the order to see the Order details window and select the Communication tab.
2. Add the details in the Your comment section and then click Save external comments.

Edit the additional email with payment data

For the following payment methods, you can add one more email in addition to the confirmation email where you can send the payment details:

• Invoice
• Prepayment
• SEPA Direct Debit

To modify the corresponding email templates:

1. Go to Configuration > E-mail management > E-mail templates > User E-Mails, where you can see the templates in the Plain text and HTML tabs.

2. Add your modifications in the Plain text and HTML tabs.

3. Update the other details as required, and then click Save template.

Do not modify the variables written in curly braces “{ }”.

Modify payment data on the invoice document

If an invoice document is generated within the Shopware backend, the data for the money transfer is automatically added to the invoice PDF for payment methods Invoice (all types) and prepayment.

To modify the text:

1. Open the database table s_core_documents_box in your preferred database tool
2. Search within the s_core_documents_box table for an entry where name=Hgw_IV_contend_info.
3. Edit the column style and value.

The following list describes the standard values for each payment method:

Registered payment data

The references to stored payment data of the buyers are available in the s_plugin_hgw_regdata table.

• The reference IDs (column uid) is used for your own subscription integration.
• The shipping hash is generated to prohibit users to use stored payment types when the shipping address changed. Which should reduce the risk of fraudulent use of customer accounts.
• The column userID is a reference to the Shopware customer entity.

Stored log files

You can find the log file entries of the plugin within your Shopware Backend log.
Go to Configuration > Logfile > Backend log.

Styling of Credit Card and Debit Card payment methods

The plugin delivers a CSS file which adapts the unzer-payment form to the Shopware’s style.
This CSS file can be found in following directories:

• For Shopware version higher than or equal to 5.2 file:
  engine/Shopware/Plugins/Community/Frontend/HeidelGateway/Views/responsive/-frontend/_public/src/less/hpf_style.less
• For Shopware version less than 5.2 file:
  engine/Shopware/Plugins/Community/Frontend/HeidelGateway/Views/frontend/-_resources/styles/hpf_style.less

You can also specify your own CSS-file within plugin basic configuration.

Update error messages for the payment

In case of a declined transaction, the customer gets redirected to the shop’s frontend and a failure message is displayed. Error messages are displayed according to the error code which was sent in response to the transaction.
You can edit the error messages via the text snippets you can find here: Configuration > Snippets.
The most common error messages are already stored in the namespace frontend/payment_heidelpay/error.
You can also find them by searching for HPError.

For all non-existing messages, you can add new entries in this table for each language set.
Use the following conventions for adding new error messages:

• Namespace: frontend/payment_heidelpay/error
• Name format: Word “HPError-” followed by the 9-digit failure code from Unzer payment system. For example, “HPError-100.100.303”

Activate Push messages

Push messages are used to update payment states in your shop automatically.
If, for example, a customer completes a prepayment by transferring the money, the push message to shop is sent to update the payment state from reserved to completely paid.

Contact the Unzer support team to activate the push message feature for your shop.

Next Steps

• Set up your payment methods

• Manage transactions