Step 1: create an account
Register a payever account here: https://commerceos.payever.org/entry/registration/business
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.
If you are using the Checkout app for the first time: simply follow the instructions of our on-boarding assistant and select the desired payment method from the list by clicking on install.
If you have already used the Checkout app: You can find the payment methods in the Payment Options tab at the top of the screen. Click on + Add and select the desired payment method from the list that now appears and click on install.
Once you click Install 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 Shopware from the list that now appears and click on Install.
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: Install plugin
Log in to your Shopware account and get our free plugin. You can either do this via your Shopware Marketplace access (recommended) or you can download the plugin from your payever account and upload it manually.
Now install the plugin first by clicking on the three-point menu and clicking on Install, in order to then be able to activate it.
Step 5: Establish a link to payever
Now make a few changes in the settings, as shown below.
- Enable Sandbox: Please deactivate sandbox mode (unless you want to carry out some test transactions first, in this case please select Yes - more information regarding testing can be found at the end of this article).
- 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).
- Iframe: Here we recommend the setting Yes. If you choose Yes here the payever checkout will be loaded in an area/iframe within your website, hence the customer will not be required to leave your shop to complete the payment. If you select No, the customer will be redirected to a new window with a payever URL.
- Checkout language: Here you choose either the language of your shop or the setting Standard - this causes payever to automatically select the language that is set in the browser of this customer.
Now please click on the Save button in the settings and then click the Payment synchronize button (please do so in that order).
Step 6: edit payment methods
After you have synchronized all payment methods, you can edit them in the settings under Plugins for the payment methods.
Here you can see at a glance which payment methods you have activated and can adapt the descriptions and names of the specific payment methods.
Step 7: Add payment methods to the sales channel
Finally, under Sales Channel add the desired payment methods you wish to provide to your customers under Payment methods. Please do not forget this step, as if you do you will not be able to find the payment methods in your checkout afterwards.
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 fields Business UUID, Client Secret and Client ID, which you can find here. 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 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 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 Open (versions < 6.2) or in progress (versions from and including 6.2) usually only occur with for Installment loans and the status means that the payment is not yet complete (customer still has to go through an identification process and/or submit necessary 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 Canceled means that the payment failed, was rejected or was canceled by you (also for this status, do not ship any 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. To do this, please open the order details (> Orders > click on the three-point menu symbol for the transaction concerned). You now have two options: either you simply set the order status to Done.
or you scroll down to the section called payever payment where you simply need to press the Shipping Goods button and save the change.
Cancellations and Refunds - If you would like to refund a transaction then please open the order details (> Orders > click on the three-point menu symbol for the transaction concerned). Here you can either set the order status to cancelled.
or scroll down to the section payever payment where you may cancel the order by pressing the Cancel button and save the change.
In order to make a refund to your customer, please go to the section payever payment and enter the amount to be refunded under Refund amount and then click on Refund to finalize.
Please note, however, that not all of our payment methods have an automatic cancellation function: Installment loans can only be canceled via payever / Shopware before the goods are shipped to the customer (if you wish to cancel the order after the goods have been shipped to the customer please contact Santander directly). Direct Bank Transfers and Direct Debits can only be reimbursed from your bank account via a 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 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 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.