Do you have JTL 4? 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 firstname.lastname@example.org).
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.
Click + 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) (Usually at the top); if you have any problems, please contact us here: email@example.com).
Step 4: Install plugin
Log in to your JTL account and select in the side bar from the Plugins tab the Plugin Manager.
Once the side has opened, select the Upload tab on the right upper corner and click on Select. Now click on Uploading to upload the zip file that you have previously downloaded from your payever account and saved on your computer.
If the upload was successful, you should see the following status message.
Now switch to the tab Available. There you should now be able to see the plugin you just uploaded. Place a check mark to the left of the plugin and click the Install button.
Step 5: Configure your JTL account to payever
After installation, you will find the plugin in the tab Active. Click on the gear icon under Actions to open the settings. Alternatively, you can access the settings in the left side bar under Installed plug-ins > payever Payments.
Now make the following changes to your settings:
- Mode: Please activate the Live mode (unless you want to carry out some test transactions first, in this case please select sandbox - more information on testing can be found at the end of this article).
- Client ID, Client Secret and Business UUID: Please enter the API keys that you generated in your payever account (see Step 3) in the corresponding fields (unless you are in sandbox mode).
- Default laguage on payever checkout: Here you choose either the language of your store or the setting Default - this causes payever to automatically choose the language that is set in the browser of this customer.
- Display fee for payment method: If you charge fees for a payment method, the fees are displayed to the customer in the checkout if you select Yes. For some payment methods, you can define whether you or the customer will bear the fees in your payever account (Checkout App > Payment methods) (this is not possible for Santander payment methods, where you must always cover the fees).
- Display logo or name of the payment method:Here you can specify whether you prefer to display the name of the payment method (e.g. "PayPal") or the logo of the payment provider (either one or the other; you cannot display both together).
- Display payment description: Here you can specify whether a description text should be shown under the payment method. If you decide to do this, please make sure to enter a suitable text for the specific payment option.
- Redirect or iframe method: Here we recommend the Iframe setting. If you choose Iframe here the payever checkout will be loaded in an area (Iframe) within your website, and your customer will not need to leave your shop to complete the payment. Otherwise, the customer will be redirected to a new window with a payever URL. Please note: If you use a so-called "One-Step Checkout" you may only be able to use the redirect mode.
- Enabled: Please choose yes here.
- Logging level: Here we recommend the Critical messages setting. You usually don't need the other two options, unless you experience problems later on - then our support may ask you to activate the All messages mode, so that we can better analyse the causes of the problem.
When you are all set, please do not forget to click Save.
Open the tab Synchronisation and Utilities in order to adjust the payment methods. Click on Synchronize.
(Note: If you want to change individual settings later, e.g. Display payment description, it is sufficient to save the change, you do not need to synchronise. You only have to synchronise if you a) activate the plugin in this version for the first time or b) switch from sandbox to live mode or vice versa. Please note that when you synchronise, the settings you make in the following step 6 will be overwritten with the default settings again: i.e. if you were e.g. first in sandbox mode and then made some settings to the payment types, after you have switched to live mode and synchronised, you have to make these settings again).
Step 6: Configure payment methods
After synchronisation, check whether all payment types are activated which are also activated in your payever account and which you want to offer to your customers. To do this, click on Payments and on Payment methods in the left side bar.
You are now in the payment methods settings, where you can view and edit all available payment methods.
Browse the list for the payment methods you want to use. These should be marked with a green checkmark (if this is not the case please check if the plugin is inactive or the payment method is deactivated in your payever account). By clicking on the icon on the far right, you can edit the settings of this specific payment method.
Note on naming: You can recognise our payment methods by the payever.de at the end of the label. In addition, the following applies: Santander Factoring DE = Installment Purchase, Santander Installment = Installment Credit, Santander Invoice DE = Invoice Purchase, Stripe = Credit Card, Stripe Directdebit = Direct Debit, Instant Payment = Direct Bank Transfer, Cash = Prepayment, Sofort = Instant Bank Transfer).
Depending on the payment method, the functions available are slightly different. Here is an example:
In this section you can specify, for instance, the description texts for each payment method.
Please note that the option Accept fee (merchant versus customer covers the fee) is ineffective here, as it is invalidated by the settings in your payever account. So, for example, if you want the customer to cover the fee, it is not enough to enter No here, you also need to set this in your payever account.
For Minimum order value and maximum order value it is important to note that the payment providers specify the fscope in which to operate. (Example: Santander invoice purchase is set at 5€ to 750€ - if you enter 900€ here, for example, invoice purchase will still only be displayed to your customers for shopping carts up to 750€).
With variable fee and fixed fee, you only determine which fee should be displayed to the customer in a black background info box when selecting the payment methods. However, not which fees the customer actually pays.
Step 7: Link shipping methods
Next, make sure that the payment types are linked to the relevant shipping methods. Therefore click on the navigation bar Shipping > Shipping methods. Here you can now see your different shipping methods. Under payment methods you can see which payment methods are currently activated for the respective shipping method - if the required payment method is not available, click on the edit-icon on the far right to specify.
The page Change shipping method shows several different setting categories. Keep scrolling down until you reach the Accepted payment methods section. Now place a checkmark next to the preferred payment methods and be sure to click the Save button at the bottom of the page.
To see if it was successful, check if the selected payment method is now listed for this shipping method under Payment methods. Repeat this process for all shipping methods for which you want to offer the payment method.
Step 8: Do you use PayPal Plus Checkout?
If you use the pre-built checkout module JTL PayPal, you also need to add the preferred payment methods to the PayPal checkout so that they are displayed for the customer. For this, simply add the preferred payment types under Installed Plugins > JTL PayPal > Paypal Plus Payment methods. Note that this particular checkout module from PayPal allows a maximum of 5 additional payment methods from other providers.
Testing the plugin: The Sandbox mode
Would you like to test the plugin first? Please activate the sandbox mode (sandbox = yes) and enter our test data in the fields Business UUID, Client Secret and Client ID, which you can find here. You can copy this data manually or simply click the button Enter Sandbox API Key in the tab Synchronization and Utilities.
In sandbox mode, you are not connected to your own payever account, but to our general test account - that's why you now see all available payment methods here, not just those that you have activated in your payever account (please note that you will not see test transactions in your payever account). Also note that the test account only works on weekdays from 8 a.m. to 10 p.m., and hence you are unable to carry out test transaction in sandbox mode on weekends, late afternoons and early mornings.
To have a payment confirmed in test mode please use the relevant stub data which you can find here.
Now you can test the plugin without triggering a real transaction. We would like to ask you to test only in sandbox mode, as test transactions in Live mode, 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 or if you submit multiple installment loan applications in your name this may worsen your credit score, etc.).
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 change you reset these settings - so if you have configured everything in sandbox mode, are satisfied and therefore want to go live, please remember what you had set and repeat these settings again after going into live Mode and have synchronized.
After the integration: Notes on the processing of payments
In general, our plugins are designed so that all actions available in the payever account can also be initiated from your Shopware backend. 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 for PayPal and Credit Card if you have disabled automatic capture in the settings) you have to report the shipping of goods. However, you do not have to do this manually, it is sufficient if you set the status of the affected order to Shipped in JTL after the goods have been shipped.
You can do this under Installed Plugins > payever Payments > Orders, by clicking on Goods Shipped (you may need 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?
Our support team is there to help you free of charge from Monday to Friday between 8 a.m. and 7 p.m. at firstname.lastname@example.org.
Please let us know in your message which shop system and plugin version you are using, which shop (URL and/or email address which you are registered with us) your request concerns, and which error message / problem you are dealing with - so we can process your request as fast as possible.