Menu

User Tools

Create PDF

Site Tools


Wirecard Shop Plugin for Shopware 5

Installation guide for Wirecard Checkout Page

This installation guide shows the step-by-step installation of the plugin to your installed shop system on your web server. Please test your online shop and the configuration of the plugin on a test system before installing the plugin on your production system.

Before installing the shop plugin please install the Cron plugin, which is delivered together with your shop as standard, for shops in version 4.3.x.

Do not install the plugin from two sources at the same time.

Step 1

Log in to the administration section of your online shop.

Select “Plugin Manager” within “Configuration”.

Step 2

You can install the plugin via the Shopware store by searching for “Wirecard Checkout Page”. Click “Install” to install the plugin.

Alternatively you can install the plugin via the provided zip-file. Select the manual adding of a new plugin and choose the zip file provided by Wirecard. After uploading you are informed by your online shop that the plugin has been successfully uploaded. The plugin is now displayed in the list of “inactive Plugins”.

Step 3

Click on the green ”(+)” icon to install the plugin to your online shop.

Step 4

In order to guarantee a proper operation of the plugin, it is necessary to clear the Shopware cache and recompile the Shopware theme. Therefore confirm the following two dialog windows

and

After successful installation you may configure the details of the plugin in the “Configuration” tab which appears after successful installation.

Configuring the plugin

In order to edit the configuration go to “Plugin Manager” within the “Configuration” tab. Click “Installed”, select Wirecard Checkout Page and click “Open” to edit the configuration.

To activate the plugin, check the “Active” checkbox.

Customer ID Your customerId you received from Wirecard.
Shop ID Unique identifier for your shop. This parameter has to be enabled by Wirecard for your customerId.
To use Wirecard Checkout Page in demo mode during the integration into your online shop, leave this field empty.
Secret Your secret which you also received from Wirecard.
Service Url URL which leads to the imprint of your shop, this field is mandatory.
Restore basket If enabled, the original content of the shopping basket is restored if your consumer changed the basket during the payment process. If disabled, the order is not executed and set to a clarification state.
Confirmation mail E-mail address of the merchant for receiving payment information details regarding the orders placed by the consumers in your online shop. This parameter has to be enabled by Wirecard for your customerId.
Use auto-deposit Activating or deactivating the automated deposit immediately after a successful payment was made by your consumer. This parameter has to be enabled by Wirecard for your customerId.
Max. retries Maximum number of retry attempts during payment.
Send additional data Sending additional data regarding consumer data (consumerBilling data and consumerShipping data).
Use iframe If enabled, Wirecard Checkout Page is displayed within an iframe in your online shop. If disabled, Wirecard Checkout Page is displayed in the current web browser window during the payment process. After your consumer finished the payment process a redirection to your online shop is performed automatically. If you decide to enable iframes be aware that XHTML strict mode does not support iframes.
Save Wirecard response The response of Wirecard contains detailed information regarding the transaction. You may store these data in an internal field which is not visible to your consumer.
Logging For debugging purposes you can enable the logging. The log data are written to log files within the ”/log/” folder of this plugin. Make sure to set proper access rights for this folder and use this logging option only during testing and never in production mode.
Delete log-file after x days Count of days until log files are deleted.
Shopware transaction ID The orderNumber or the the gatewayReferenceNumber can be used and shown as Shopware Transaction ID.
Display text Optional text which is displayed together with the data of the order.

Activating payment methods

Select “Configuration” → “Shipping”. Then select one type of shipping in the window “Shipping costs management” for editing. A new window named “Shipping costs” opens. Please select the “Payments” tab. Move your required payment methods from the left list named “Available” to the right list named “Selected” by selecting the payment method and pressing the ”→” button. After selection, click the “Save” button and close this dialog.

From the main menu select “Configuration” → “Payment methods” to activate the new payment methods. This is done by selecting one payment method in the left list named “Available payments” and check the “Active” checkbox in the “General” tab.

Optionally it is possible to modify the description of the payment method. This text is visible to the consumer of your online shop during the payment process. Additionally you are able to set surcharges and discounts per payment method. Within the “Position” field you are able to change the sort order of the payment methods presented during the payment process in your online shop. After configuring the selected payment method, click the “Save” button and proceed with the next payment method.

Technical details

For implementation details of this plugin consult the inline documentation of the provided source code.

The source of the plugin is structured to the following folders and files:

The Bootstrap.php file is the starting file containing all configurations, hooks and events.

/Components contains the Wirecard Library and the Zend framework. The files are automatically included via Loader.php.

/Controller manages the control flow between the Wirecard Library, the models and the views. Each method ending with the suffix Action within the PaymentWirecardCEE.php file can be directly called by a proper URL (e.g. https://www.yourserver.com/PaymentWirecardCEE/saveOrder). Especially the confirmation of a successful payment can be done within the URL https://www.yourserver.com/PaymentWirecardCEE/confirm. Please be aware that this URL has to be reachable over the Internet either on port 80 for http or port 443 for https.

/Models manages the data, processing, resources, logs and the basket. Especially the method Config::getPaymentMethods() is used for configuring the different payment methods.

/View contains templates, HTML, JavaScript and style-sheets for the plugin.

Customization and translation of text resources

You may customize and translate text resources. Example files are available within the zip-file at WirecardCheckoutPage/assets/lang/<language>.php.

FAQ

Your consumer gets an error message regarding a missing CVC after entering the credit card number even if the option for the corresponding check is not activated?

The CVC has to be used for all types of cards where a CVC is required (like Visa or Mastercard). If you activate that check in the backend of your shop, only cards without CVC can be used by your consumers (like Maestro or UATP).

How can you retrieve information on the payment method used by your consumer for a transaction after the plugin has been deleted/uninstalled?

After deleting or uninstalling the plugin, the payment method used for a transaction is not displayed anymore in the field “Payment method” and only an ID is shown instead (go to the administration section of your online shop, select “Orders” within “Customers”, click “Show details” and go to “Details”).

In order to be able to still retrieve information on the used payment method go to “Plugin Manager” within the “Configuration” tab. Click “Installed”, select Wirecard Checkout Page, click “Open” and select “Internal commentfield” as value for “Save Wirecard response”.

The payment method used by your consumer is then displayed in the “Customers” tab. Select “Orders”, “Show details” and “Communication” to see the payment method.

There are irregularities regarding the status of payments? What is the problem?

Plugins with a version lower than v1.5.2 are incompatible with the statistics plugin from Shopware AG in the default configuration. In order to avoid any unintended consequences, we recommend to carry out test transactions prior to live operation.

If there are any irregularities in your transactions you may either uninstall the statistics plugin, see screen “Plugin Manager”, or follow these steps to edit the plugin in order to prevent such irregularities:

Go to the “Configuration” tab. Click “Plugin Manager”.

Select “Installed”, select “Statistiken” and click the edit button.

Next, delete ;HTTPclient from the bot-List.


This website uses cookies to deliver the best service to you. By continuing to browse the site, you are agreeing to our use of cookies.