Are you using JTL 5? Please switch to this manual.
Step 1: Register an account
Step 2: Configure payment options
In order to configure your payment options, first open the Checkout app. To do this, either click on the Checkout symbol under Business Apps or click on the Manage or Open button on the Checkout section.
You can find the payment methods tab in the navigation bar on the left.
Then click on + Add.
Now a list of different payment methods appears, from which you can select as needed. To do this, click on install.
Once you have installed the payment channel, click on Open and a new page will open, the structure of which will vary depending on the payment method chosen.
With the payment methods credit card, direct debit, Sofortüberweisung and Paypal just click the Connect button and you will be forwarded to the respective payment provider. There you connect your existing account or create a new one.
For the payment methods Installments, invoice, Factoring and Direct Bank Transfer you have to enter the access data that you have received from Santander and then click on Connect (if you have not been in touch with Santander before, please contact email@example.com).
Regardless of the payment method, please make sure that you always enter your access data in the Default tab.
After you have connected the payment methods, you can make changes to the settings of the specific payment method. Please refer to our documentation for the specific payment method for more information, which you can find here.
Step 3: Configure channels
Select the Channels tab in the Checkout App.
Then click on + Add.
Select JTL from the list that now appears and click on Install.
Now you need to click Open so that you can generate the API keys in the next step.
Select API keys and click on + Add. Enter a name of your choice and click on Generate. Afterwards, click on the plus icon (+) and you see the credentials that you have to insert into the shop system that you use for your online business (i.e., Client Id, Client secret, Business UUID). Please copy these to your clipboard.
Finally, click on the Downloads tab (above the API key) and download the latest version of our plugin from the list that now opens (zip-file). The latest version is currently version 1.121.0 ( ast status 01/04/21). We update our plugins at regular intervals, if you are not sure which is the current version, feel free to contact us here: firstname.lastname@example.org
Step 4: Install the plugin
Log into your JTL backend and open the payever plugin settings (click on Plugins in the navigation bar, then click on plugin management).
Under the Upload tab click Choose and select the zip file that you previously downloaded from your payever account and saved on your computer.
Once you selected the zip file, click the upload button to upload the file.
Once successfully uploaded, click the Available tab and you should be able to see the plugin you just uploaded. Tick the box to the left of the plugin and click the Install button.
Step 5: Configure plugin
After the installation you will find the plugin in the tab Activated. Click on the gear icon under the Actions column to open the settings.
Here you need to make the following adjustments to the settings:
- Mode: Please select live mode (unless you want to do some test transactions first, in which case you may select sandbox mode - more information can be found at the end of this manual).
- Client ID, Client Secret and Business UUID: Please enter the data that you generated in your payever account in step 3 (unless you are in sandbox mode, then leave the pre-filled test data here).
- Standard language checkout: Here you either select the language of your shop or the setting default - which causes payever to automatically select the language that is set in the internet browser of this customer.
- Show fee for the payment method: Please select Yes here. If you request fees for a payment method, the fees will be shown to the customer in the checkout. You can specify whether you or the customer bear the fees in your payever account (Checkout App > Payment methods).
- Show logo or name for the payment method: Here you can choose whether you prefer to display the name of the payment method (eg "PayPal") or the logo of the payment provider (either or, you can not choose both).
- Show payment description: In the payment method settings, you have the option of entering a short description for each payment method which the customer will see in the checkout. Here you can specify whether these texts should be displayed or not.
- Redirect or iFrame: Here we recommend the setting Use iFrame. If you choose Use iFrame here, the payever checkout will be loaded in an area / iframe within your website, the customer will not leave your shop. If you select Use redirect, the customer will be redirected to a new window with a payever URL.
- Enabled: Please select Yes here.
- Logging level: We recommend the setting Critical news. You don't usually need the other two options unless you experience problems later - our support team may ask you to activate the All messages mode so that we can better analyze the cause of the problem.
In the APM options section, please leave everything as is was set by default.
When you are done, don't forget to click Save at the bottom of the page.
Then synchronize the payment methods in the Synchronization and Utilities tab. To do this, click on Synchronize.
(Note: if you later want to change individual settings, e.g. display payment description, it is sufficient to save the change, you do not need to synchronize again. You only need to synchronize if you a) activate the plugin in this version for the first time, or b) Switch sandbox to live mode or vice versa. Please note that when you synchronize, the settings you make in step 6 below are overwritten with the default information: i.e. if, for example, you were in sandbox mode first and then made some changes in the settings for the payment methods, you must do so after you have switched to live mode and synchronized, unless you need to make these amendments again.)
Step 6: Adjust payment methods
After synchronization, check whether all payment options that you want to offer your customers are activated in your JTL backend are that these payment options are also activated in your payever account. (To do this, click on Storefront in the navigation bar and under the Payment Methods column click Overview.
You are now in the Payment Methods settings where you can view and edit all your payment methods.
You can here see all the available payment methods listed, which for the ones you'd like to provide on your shop should all be marked with a green check-mark (if they are not, please check whether the plugin has been deactivated, or if the payment method in your payever account is deactivated). You can edit the settings of this payment methods by clicking on the symbol to the far right.
Note on the naming of payment options: You can recognize our payment methods by the "payever.de" at the end of the payment options name.
The available options may vary slightly depending on the payment method chosen. Here's an example:
Here you can, among other things, enter a descriptive test for the individual payment method.
Please note that the Accept fee (merchant versus customer bears fee) option has no effect here, since it will be overwritten by the settings in your payever account. If for example, you want the customer to pay the fee, it is not sufficient to enter No here, you must also specify this in your payever account.
It should be noted, regarding Minimum order and maximum order, that the payment providers themselves specify a framework in which you need to operate. (For example: the Santander Invoice payment option is set by Santander to range from €5 to €750 - if you were to enter, for example €900 as the max limit, your customers will still only see the invoice option available in his shopping carts for cart-values up to €750).
With Variable fee and Fixed fee, you only determine which fee the customer should see in a black box when selecting the payment methods, but not which fees the customer actually pays.
Step 7: Link shipping methods
Next, make sure that the payment methods are linked to the relevant shipping methods. To do this, click on storefront in the navigation bar and under the purchase column click on Shipping Methods.
Here you can see your different shipping methods, as shown below. Under Payment Methods you can see which payment methods are currently activated for this specific shipping method - if the payment method you want is not included, click Edit.
If you click the To edit button above, you will reach a page title Change shipping method, scroll down until you have reached the section Accepted payment methods. Tick the box next to the desired payment methods, and once done don't forget to click the Change shipping method button at the bottom of the page to save your changes.
You can determine whether it worked by checking if the selected payment methods now are listed for this shipping method under Payment methods. Repeat this process for all shipping methods for which you want to offer the specific payment method.
Attention (step 8): Do you use the PayPal Plus Checkout?
If you use the ready-made checkout module JTL PayPal, you must also add the desired payment methods to the PayPal checkout so that they are displayed to the customer. Simply add the desired payment methods under Plugins > JTL PayPal. Please note that this special PayPal checkout module allows a maximum of 5 additional payment methods from other providers.
Testing the plugin: sandbox mode
Would you like to test the plugin and the payment options before you go live? No problem - you can do so in staging/sandbox mode, since none of the transactions will then result in an actual payment. Please activate the sandbox mode in the plugin settings (see step 5 above) and enter our test data in the Business UUID, Client Secret and Client ID fields. You can copy this data in manually or simply click on the Enter sandbox API key button in the Synchronization and Utilities tab, as shown below.
To have payments confirmed in test mode, please use the relevant sub data. This way you can test the plugin without triggering a real transaction.
We would like to ask you to test only in sandbox mode, since test transactions in Live, even if you subsequently cancel them immediately, can have undesirable consequences (for example, if you test too often with your credit card, it may be reported and blocked) If you submit multiple installment loan applications in your name, this can worsen your credit score, etc.).
If you want to go live and therefore switch off sandbox mode, please do not forget to remove the test data and instead enter your own data from your payever account, save it and then synchronize it. Please note that the synchronization overwrites the changes made in the settings of the payment methods and you therefore have to set them again after switching to live mode.
When you're done testing and want to go live:
- Please do not forget to remove the test data and instead enter your own data from your payever account (see step 3), save and then synchronize (otherwise you will receive an error message when synchronizing). You cannot use your live data in sandbox mode, nor can you use our test data in live!
- Please also note that any settings made (plug-in settings, names and texts of the payment methods, etc.) are lost when switching between live and sandbox mode (regardless of the direction) . With each synchronization process you reset these settings automatically - so if you have configured everything in sandbox mode, are satisfied and want to go live, please remember what you have set and repeat these settings again after you have switched to live mode and synchronized.
After Integration: information on processing payments
In general, our plugins are designed so that all actions available in the payever account can also be initiated from your JTL backend or JTL Wawi. As a rule, you do not need to log into your payever account to find out about the status of a payment or to cancel a payment, for example!
Status Reports - the payment status in process usually only occurs with installment loans and means that the payment is not yet complete (customer still has to go through an identification process and / or submit required documents). If you see this status, please wait and do not ship the goods to your customer yet. The status Paid means that the payment was successful and complete - in this case you are free to ship the goods to your customer. The status cancellation means that the payment failed, was rejected or was canceled by you (again, for this status do not ship the goods to your customer).
Capture / Shipping Goods - Please note that with some of our payment methods (e.g. Invoice and Installment loans, and possibly also PayPal and Credit Card, if you have disabled automatic capture in the settings there), you have to report the shipping of goods. This, however, you do not need to do manually as it is sufficient if the status of the order in question is set to Shipped in JTL after the shipment of goods is done.
You can do this under Plugins > payever Payments by clicking on Goods shipped (you may have to click on Synchronize functions first to see the available options for this transaction):
Alternatively, you can do this in JTL Wawi under Sales by clicking on Deliver > OK.
Cancellations and Refunds - If you want to refund a transaction, you can also do this under payever Plugins > Payments by pressing the Cancel button.
Alternatively, you can also do this in JTL Wawi under sale by clicking cancellation reach.
Partial cancellations are not possible via JTlL or JTL Wawi, please do this via your payever account (Enter the Transactions app on the payever platform > click on the affected transaction to see Order details > Press the Refund button).
Select Refund the partial amount of the order and enter the partial amount to be refunded, and press Refund button.
Please note, however, that not all of our payment methods have an automatic cancellation function: Installment loans can only be canceled via payever / JTL before the goods have been shipped to your client (if you need to cancel the order after the goods have been shipped, please contact Santander directly). Direct Bank Transfers and Direct Debits can only be refunded from your bank account via a manual transfer to the customer.
Any questions or problems?
You can reach our support from Monday to Friday between 8 a.m. and 7 p.m. at email@example.com
Please let us know in your message which shop system and plugin version you are using, which shop (URL and / or email address with which you are registered with us) your request is concerned and which error message / issue you are dealing - so we can process your request as fast as possible!