vobapay payment App

Installation and Configuration Guide – vobapay App for Shopware 6

Preliminary Notes

• Important: Always create a full backup (files and database) before installing or updating the plugin.

• Installation method:  Preferred: Installation from the Shopware Community Store. Alternative: Manual upload of the ZIP file.

Shopware Community Store

• Go to Extensions > Store > Apps
• Enter "vobapay" in the search field at the top. The vobapay app will be displayed in the lower area. Click on the corresponding entry.
• Click on the button "Add extension" to install the plugin.
• Proceed with the configuration of the app as described below.

Manual Installation

1. Go to Extensions > My Extensions > Apps and click on Upload extension to upload the ZIP file.

2. Find the app in the list and install it via the three-dot menu (...).

3. Activate the app using the switch in the first column.

4. Proceed with the configuration of the app as described below.

Configuration

Follow these steps to correctly configure the app after activation:

1. Open configuration interface
   Navigate to Settings > My Extensions > Apps, find vobapay Payments and select the link Install if available, then the link Configure.

2. Enter API URL

   • Here you must specify which URL Shopware should use to communicate with the vobapay API. Choose:

   • https://sandbox.api2.vobapay.de for the test phase, to ensure that all payment methods work as expected.

   • https://api2.vobapay.de to switch to live payments once you go into production.

3. Set purpose field
   • Specify here the payment purpose (max. 30 characters).  You can use free text and insert the following placeholders: 
   • {ordernumber} = Order number
   • {customernumber} = Customer number
   • If the field remains empty, {ordernumber} will be used automatically.

4. Enter API credentials

   • In the API Key field, please enter your API key from the vobapay portal.  This is required to enable communication with the payment platform at all.

5. Save changes
     Click Save in the upper right corner.

6. Activate payment methods

   • Go to Settings > Commerce > Payment methods.

   • Activate the desired vobapay payment methods. You can recognize them by the label “vobapay Payment” in the name.

7. Assign sales channels

   • In the left column, select the corresponding Sales channel.

   • Under Payment and Shipping in the Payment methods field, add the activated vobapay payment methods and select your default payment method to the right. This will then be activated by default once the customer reaches checkout.

   • Save the changes again in the upper right corner.

The vobapay app is now fully configured and ready for use in your Shopware 6 shop.