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 xt:Commerce 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.
Step 4: Download the plugin
Log into your xt:Commerce account and download our free plugin. You can either do this via your xt:Commerce plugin store (recommended) or you can download the plugin from your payever account and upload it manually.
Step 5: configure plugin
Log into your xt:Commerce backend and open the payever plugin settings by clicking on Configuration in the navigation bar at the left, on Method of payment, look for payever and click on the edit icon.
- Leave the fields Directory, Icon, Tax class, Template and Display cost note as they are automatically after installation (no reconfiguration necessary/sensible).
- For Status, set a check mark to activate the plugin.
- With Sort order you can define where in the checkout the payever payment methods should be displayed (compared to other payment plugins).
- In the fields for Client Secret, Client ID, and Client Secret, enter the data that you generated in step 3 in your payever account. In the Mode field, choose Live. (Unless you want to test the plugin first, in which case you must enter either manually our Sandboy keys, or click on "Set up Sandbox API keys" at the very end of the page (see Step 8).
- For Default language, you enter the language in which the payment types are to be displayed. If your shop serves several countries with different languages, we recommend the Default setting (automatically detects the customer's language).
- Display payment icon defines whether a logo corresponding to the payment method should be displayed.
- Display payment description determines whether a description text should be displayed for the payment methods.
- At Display payment rates you can determine whether the rates of your payment types (example 0.35% fixed fee) should be displayed. This display is only for the customer view, and has no influence on the actual setting of the fee coverage, which you can edit separately for each payment type.
- Redirect on payever setting determines whether the payever checkout should be displayed within an iframe on your website, or whether the customer should be redirected to a separate payever page. We recommend the setting No, because from the user's point of view it is more convenient not to have to leave the shop for the payment.
- In the fields Status for shipping goods und Status for cancel transaction please enter, in accordance with your processes and habits, the status at which you want to report the sending of goods to the payment service provider (and thus effect the capture of the payment) and the status at which the payment should be cancelled accordingly at the respective provider.
Now synchronize the plugin by clicking on Edit > Synchronize settings.
Step 6: Configure payment methods
Stay on the same page as in step 5 and scroll down. Here you can now see the settings options for the individual payment methods.
Here you can change the name and description text of the payment method, set the payment method as active or inactive and adjust the minimum and maximum (from which amount on the payment method should appear in the checkout - please do not enter a higher maximum or lower minimum than what you have contractually agreed with the respective payment provider). With Accept fee you can specify whether you want to add the payment fees to the price (false) or whether they should be included in the price (true). If you choose false, you also specify how much of the fee is to be added.
Step 7: Configure translation keys
I this step you have the option to modify the title and description of all payment methods showing in your checkout according to your preferences.
For changing title and description (for example) of the payment method Santander Invoice DE, you need to scroll down until you see the tabs [Santander DE Invoice] Title Translation Key and [Santander DE Invoice] Description Translation Key. Copy the key first. Then go to localizing > language content and search for the translation key you just copied.
You can now edit the title (or description) of the chosen payment methods. There are two tabs, one for the german key and the other for the english key. You can customize both. Please don't forget to click on save.
Step 8: Testing the plugin: sandbox mode
Would you like to test the plugin first? Please activate the sandbox mode (sandbox = yes) and enter our test data in the following fields Business UUID, Client Secret and Client ID, which you can find here. In sandbox mode you are not connected to your own live payever account, but rather 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 own 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. - hence, on weekends, late late afternoons and early mornings you cannot make transactions in sandbox mode!
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 kindly 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 live 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 changes made to your settings (e.g. plug-in settings, names and description-texts for 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, and you are satisfied with the test-results and therefore want to go live - please remember what you need to reconfigure these settings again after switching to live Mode and synchronizing.
After the integration: Notes on processing payments
In general, our plugins are designed so that all actions available in the payever account can also be triggered from your xt:Commerce backend. Normally you do not need to log in to your payever account to check the status of a payment or to cancel a payment!
Status messages - the payment status In Process (payever) usually only occurs with installment credits and means that the payment is not yet complete (customer still has to go through an identification process and/or submit documents). If you see this status, please wait and do not ship the goods yet. The status Accepted (payever) Means that the payment was successful and is complete - in this case you can ship the goods. The status Failed (payever) means that the payment has failed or has been rejected by the payment provider (again, do not ship the goods).
Capture/ dispatch of goods - Please note that with some of our payment methods (definitely with invoice purchase, installment purchase and installment credit, possibly also PayPal and credit card, if you have decided there in the settings against an automatic capture), the dispatch of goods must be reported. However, you do not have to do this manually, it is sufficient to change the status of the affected order in xt:Commerce after the goods have been shipped. To which status you have to convert depends on what you entered in step 5 under Status for Shipping Goods.
Cancellations and refunds - If you want to refund/cancel a transaction, you also only have to change the status in xt:Commerce, the cancellation request will be automatically forwarded to us and the payment provider concerned. The status you need to change to depends on what you entered in step 5 under Status for Cancellation of Transaction.
A partial refund (customer returns part of the order) is only possible via your payever account. To do this, open the Transactions app, open the details of the transaction in question and go to Refund in the top right-hand corner. You can now enter the amount to be cancelled and complete the cancellation.
Please note, however, that not all our payment methods have an automatic cancellation function: Installment credits can only be cancelled before the goods are shipped via payever/Shopware (afterwards only manually by email to email@example.com), direct bank transfers and direct debits can only be refunded by a return transfer to the customer from your bank account.
Any further questions or problems?
You can reach our support 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 with which you are registered with us) your request is concerned and which error message / issue you are dealing with - so that we can process your request as fast as possible!