Table of Contents | ||||
---|---|---|---|---|
|
...
Cancelling from the WAWI
Automatic full charge for partial or complete shipment
Installation / Update
System requirements
JTL-Shop 5.00+ and its requirements
Other requirements
You need a trader account. Register at https://portal.dibspayment.eu/registration.
...
Plugin-Installation
...
Explanation of terms
A reserved amount is reserved/authorized for payment collection, but no payment has been collected on it yet.
A charge can be understood as a payment collection of a previously reserved amount. Accordingly, full charge means that the entire order amount is collected.
A refund is a refund of a previously collected payment.
A cancel is the cancellation of a reserved payment before the payment is collected.
Installation / Update
System requirements
JTL-Shop 5.0.0 and its requirements
Other requirements
You need a trader account. Register at https://portal.dibspayment.eu/registration.
...
Plugin-Installation
The installation of the plugin is carried out according to the JTL standard as described here or you can also provide your existing ZIP file of the plugin via the "Upload" tab in the plugin administration and then start the installation in the "Existing" tab.
...
The configuration of the payment type is done via the standard administration in the JTL shop. You can find the payment types under Administration → Payment methods. You can also find a direct link to this on the help page of the plugin. Select Nets Easy via the pencil icon and configure the payment method if required.
In addition to the standard settings for payment methods, the settings for the payment method are located in the plug-in under Settings. Here you can store the data from your Nets Easy account that is necessary for operation in the plugin.
...
Option
...
Description
...
Plugin active
...
Logo
Here you can change or remove the payment method logo. Ideally, the logo should display the payment providers that you have agreed upon with netsEasy.
Some sample logos are contained in the plugin directory (<Shop>/plugins/s360_netseasy_shop5/paymentmethod/images). However, you also can configure any image you uploaded to your shop.
Always enter the logo url as an absolute URL (starting with https://).
Plugin-Settings
In addition to the standard settings for payment methods, the settings for the payment method are located in the plug-in under Settings. Here you can store the data from your Nets Easy account that is necessary for operation in the plugin.
Option | Description |
---|---|
Plugin active | Here you can activate or deactivate the plugin outside the plugin administration. |
Live Secret Key | The API key for Live Mode. You can find this key in your Nets Easy account under "Company > Integration > Live Environment > Secret key". |
Live Checkout Key | The checkout key for Live Mode. You can also find this key in your Nets Easy account. |
Test Secret Key | The API key for the test mode. You can find this key in your Nets Easy account under "Company > Integration > Test Environment > Secret key". |
Test Checkout Key | The checkout key for Test Mode. You can also find this key in your Nets Easy account. |
Plugin mode | Select the operating mode here Test - the plugin is in test mode and communicates with the sandbox. No real payments are made in this mode. Live - the plugin is in live mode and accepts real payments. |
Checkout mode | Select the checkout mode here Hosted - customers are redirected to an external Nets Easy site and complete the payment process there. Afterwards, they will be redirected back to the shop. Embedded - to complete the checkout process, an iframe is displayed below the product overview on the order summary page. After successful payment, the customer is redirected to the order confirmation page. Further settings may be necessary for this. (See Tab. 2) |
Optional GTC-URL | If an optional GTC URL is stored, it is transferred to Nets Easy and set in the checkbox text. If this is not specified, the shop's GTC URL is used. |
Optional Privacy-URL | If an optional data protection URL is stored, it is transferred to Nets Easy and set in the checkbox text. |
Charge | This option describes when a charge is performed: manual - no charges are performed, the merchant must trigger the charge via the plugin or the Nets Easy backend. Immediately - a Full-Charge will be executed immediately after the reservation in Nets Easy. First partial shipment - after the Wawi reconciliation, a full charge is carried out at Nets Easy for a partial shipment. Complete shipment - after the Wawi reconciliation, a full charge is carried out at Nets Easy for a full shipment. Note: Some payment methods (like SOFORT) are always immediately charged, independend of this setting. |
Payment error email | Alternative e-mail address of the shop administrator. If an e-mail address is stored, an automatic e-mail is sent in the event of errors in charge or refund. Otherwise, the Shop Master e-mail address is used. |
Mail template language | Select the language in which the notification e-mails are to be sent. If you select German, the e-mails will be sent in German. The same applies to English. |
Debug Frontend | Activate extended logs in the shop log for the frontend. This adds additional debug messages to the debug log. |
Debug Backend | Activate extended logs in the shop log for the backend. This adds additional debug messages to the debug log. |
Tab. 1
Option | Description |
---|---|
PHP Query Selector | Enter an alternative class or ID of the element in the DOM to which the embedded checkout is to be intergated. If the embedded checkout is selected, the "Complete order" button is always hidden. Make sure you always specify a valid element, otherwise the embedded checkout will not be displayed and the customer will not be able to complete an order with Nets Easy. |
PHP Query Method | Specify here the method in which the embedded checkout is to be integrated. after - the checkout is added after the specified element. before - the checkout is added before the specifying element. append - the checkout is appended to the specifying element. prepend - the checkout is prepended to the specifying element replaceWith - the specified element is replaced with the checkout |
PHP Query Hide elements | Specify here the elements in the DOM that are to be hidden when using embedded checkout. By default, the element "#complete-order-button" is always hidden. (the “Complete order” button in JTL defaults) is always hidden. If your button ID is labeled differently, you can enter your own selector here. |
...
Open the payment method management in the JTL-WAWI via Payments → Payment methods.
Create Nets Easy Online checkout as the payment method. Please note that the payment types must correspond to the "Displayed name" in the JTL shopShop in each language.
By default, the payment collection is set to immediate. However, if you decide on payment collection for the first partial shipment or only for complete shipment, then further settings are required. “Auslieferung vor Zahlungseingang möglich“ must be activated. The full charge will then be executed depending on the plug-in settings with the next Wawi synchronisation.
...
Your shop must support the currencies Danish Krone, Euro, British Pound, Norwegian Krone, Swedish Krona, US Dollar, Polish Zloty or Swiss Franc.
Info |
---|
If the currently active currency is not supported, Nets Easy will not be offered as a payment method. |
...
If the charge could not be performed, an info mail is sent to the shop administrator by the plug-in.
Cancel
Go to the JTL-WAWI → F6 → Select order → right mouse button → Storno → Stornieren
Synchronize with JTL-Shop
The full charge is performed against Nets-Easy after the WAWI syncronization.
Warning |
---|
+++ ATTENTION, IMPORTANT +++Please make sure that you do not accidentally cancel a wrong order in the JTL-WAWI! The JTL-WAWI offers the possibility to reverse a cancellation, but the actions you have made in this regard are transferred 1:1 to the online shop! In this case, the order will be cancelled first and the payment will be cancelled against Nets Easy. Afterwards, the order would be reactivated but a payment will not be possible anymore! If you subsequently send the goods, this will be done without a payment! |
...
The status and action buttons are only displayed if the API keys are entered under Settings. Please make sure that you transfer the keys correctly, otherwise you will see this message:
Warning |
---|
Unauthorized |
Why are refunds offered for some payments and not for others?
...
This message is displayed if the customer has clicked on "< Go back" in the Nets Easy Checkout and cancels the payment without going through the checkout.
...
Warning |
---|
Attention: Only edit the shop's config file if you know what you are doing! Incorrect adjustments here can make your shop inaccessible or (encrypted) data unusable. If in doubt, ask your hoster or service partner for help. |
Changelog
v1.0.7 (August 2023)
Improvement: Webhook-Handling logs more specific/helpful information
Improvement: Internal Admin-Mails extended with information on order number and payment IDs to be more helpful.
Attention: E-Mail Templates are not automatically updated with plugin updates. You have to manually reset the plugin mail templates in the shop admin to benefit from the improved mail templates.
v1.0.6 (July 2023, unreleased)
Improvement: Use product SKU instead of internal product ID towards NetsEasy
Improvement: Only set payment ID as transaction ID on payments to better allow for automatic handling in JTL Wawi
Improvement: Better backend url generation when in JTL-Shop >= 5.2.0
Fix: Check for existing column in migration.
v1.0.5 (May 2023)
Rework of payment logic to support both, embedded and redirected checkout, as well as different payment handlers.
Renamed initial display name to “Online Checkout”
Delivery now includes preset payment method description and logos
More debug logging messages and option to turn them on/off
multiple further improvements and fixes
v1.0.4 (unreleased)
v1.0.3 (February 2023)
Fix Bestellungen werden nach erfolgreicher Zahlung nicht angelegt!
v1.0.2 (January 2023)
Update Exsid
v1.0.1 (November 2022)
Kompatibilität mit JTL-Shop 5.2
Fix Embedded Checkout Link
v1.0.0 (August 2022)
Initial Release
...