Do you have Shopware 6? 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.
Click + Add.
Select Shopware 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: Install plugin
Log into your Shopware account, click on Configuration in the header bar and select the Plugin Manager.
Once the Plugin Manager has opened (please note that you have to be logged in for this), please type "payever" into the search bar in the upper left corner and click on Install.
You will now be asked to confirm that the cache will be emptied. Please answer Yes. In case you don't get this pop-up, please contact our support or your shop admin, as this is an indication that there could be a technical defect in your shop.
Should you not get this pop-up for whatever reason, please empty the cache manually (by the following steps Settings > Caches/Performance > Clear shop cache.
Step 5: Connect to payever
Next you need to activate the plugin by clicking on Activate (you may be asked once more to confirm that the cache will be cleared - please respond with yes again).
Now you need to configure some settings:
- Sandbox: Please select No (unless you want to do test transactions - if this is the case, select Yes. You can find more information about the Sandbox/Testing mode towards the end of this article).
- Iframe: We recommend choosing Yes. If you choose Yes the payever Checkout will be loaded within an iFrame inside your website, the customer won't leave your shop for the checkout. If you select No, your customer will be redirected to a new page with a payever URL. Please note that not all payment methods can be displayed within an iframe (some payment methods such as PayPal do not support this) - for these payment methods we always automatically forward the user to a new page, regardless of what you have selected here.
- Force redirect to payment gateway: This setting affects you if you use at least one redirect payment method (payment methods for which payever does not provide the user interface - specifically Zinia, Santander Austria, Santander Netherlands, Santander Finland, Klarna Sofortüberweisung and PayPal). We recommend you choose "Yes" in this case. If you choose "No", the customer will always be redirected to payever first, where he needs to click a button in order to be redirected to the payment provider's page - if you choose "Yes", the customer will instead be forwarded directly to the payment provider's website.
- Send logs via APM: We recommend to select yes in this option.
- Logging: We recommend selecting Critical Payment Data. You probably won't need the other two options, unless you run into problems later on - in that case our support may ask you to switch to Payment data with debug data as this helps us to better analyze your issues.
- Client ID, Client Secret and Business UUID: Please enter the data you have generated in your payever account in Step 3 (unless you are in the Sandbox Mode, if that is the case please use our test credentials).
- Order status for paid payment: Here you can select upon which order status a capture request should be sent to payever. Preferrably this should be a status that signals that the order has been fulfilled/ processed/ shipped, to ensure that the customer is not getting charged or invoiced anything before the order has actually been processed.
- Payment icon: Here you can decide whether you would like to have a logo/icon next to the payment option (different icons for each payment option, usually logo of payment provider).
- Checkout language: We recommend to either choose the language of your shop, or (especially in case you sell in multiple countries) the option Default. Choosing Default means that payever will show the checkout in the user's browser language.
- Save rejected orders: Here you can decide whether you would like to create an order in Shopware when the customer has been rejected by the payment provider. We recommend you to choose No.
- Restock on failed payment: If you select "Yes" here, our plugin will automatically restock the corresponding items if an order won't be processed due to rejected payment. We recommend selecting "Yes" so that inventory levels are tracked correctly and items that are not shipped to the customer in the end are not deducted from the inventory.
Last but not least, first click Save and then click Synchronize payment methods. (Please note the order - it won't work the other way around!)
You can ignore the options and buttons below Synchronize payment methods and leave them as they are - these are meant for other use cases that go beyond payment processing and are thus not relevant or required for using our payment methods.
Step 6: Edit payment options
After synchronizing the payment options, you can edit them in your settings. To do so, please open Configuration and choose Payment methods.
Select the payment option you would like to edit. Here you can, amongst other things, type a name and description text for this payment option. Once you are done, don't forget to click Save.
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 you do in this mode will result in an actual payment. We kindly ask you to not test outside of the Sandbox Mode, since testing payments in live mode can have unintended consequences - even if your cancel the transaction right away after you have submitted it (If you test too often with your own credit card, it may be blocked, and if for instance you submit too many installment requests via Santander with your name, this may negatively affect your credit score).
To activate staging/sandbox mode, set Sandbox = Yes in the payever plugin configurations and fill in the test credentials (Business UUID, Client Secret, Client ID). To make sure your test transactions get accepted, please use stub data.
Once you have finished testing and switched to live (Sandbox = No), please don't forget to fill in your own live credentials (Business UUID, Client Secret, Client ID) then save and synchronize (otherwise you will get an error message).
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 the configuration you made and repeat these settings again in live Mode. Once configured again, please remember to press synchronize.
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 the status of a payment or to cancel a payment, for example!
Status reports - The payment status (do not mix this up with order status) Open usually only occurs with installment credit and means that the payment is not yet complete (customer still has to go through an identification process and/or submit documents later). If you see this status, please wait and don't send the goods yet. The status Accepted means that the payment was successful and is complete - in this case you can send the goods. The status Verification necessary means that the payment failed, was rejected or canceled/refunded (please do not send any goods in this case either). The payment status Fully Paid means that the transaction has already been activated/captured (i.e. the amount has been debited or invoiced from the customer, and the payout to the merchant has been initiated by the payment provider - please note that the actual date on which the money is booked on your bank account may differ, since it can take 1-2 working days for the money to be booked to your account, and you may also have agreed a monthly or weekly payout schedule with the respective payment provider instead of immediate payouts per transaction).
Capture / Shipping Goods - Please note that for most of our payment options you have to notify us about the fulfilment/ shipment of the order by setting a certain status (see step 5) in Shopware in order to have the previously approved payment executed/ captured. However, if you have configured "Autocapture" (automatic activation upon approval) for the respective payment option in your payever account, no such shipment/fulfilment note must be sent to payever (the same also applies to the payment options instant payment and direct debit - for those payment methods, the payments are always being booked automatically right away).
Please note that most payment methods also have a defined activation period (differs depending on the payment method, please read more about this in our payment option manuals). If you fail to send us a shipment/execution notification for an order within this period, the authorisation will expire and it hence won't be possible anymore to carry out the payment. Therefore please make sure you know the activation periods of the payment options you're using and process the orders within that time (in case your order processing times are usually longer than the maximum activation period of a certain payment option, consider setting up Autocapture for this payment option).
Some payment providers (Santander AT, Santander BE) also require additional proof of the shipment/ execution of the order, which then usually has to be sent directly to the payment provider (in the case of Santander Austria, please send it firstname.lastname@example.org) in order to receive the payout.
Cancellations and Refunds - If you would like to partially or fully reimburse a transaction, please open the order details (Customers > Orders > click the pencil icon on the transaction concerned). For a cancellation choose Cancel / Credit, for a partial return or partial cancellation please choose Partial refund and enter the amount to be reimbursed.
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'd like to cancel the order after the goods have been shipped you need to contact Santander directly). Direct bank Transfers and Direct Debits can only be reimbursed from your bank account via a transfer to the customer.
Questions or problems?
Our support team is there to help you free of charge from 8am to 7pm at email@example.com
When you write to us, please let us know which version of our plugin and of shopware you are using, which shop you are working on (URL or email address you used to register at payever) and what error message/issue you have noticed at which point of the process - this helps us to solve your issue faster.