You are currently looking at the article on an older version of the extension!

Paypal

The PayPal extension offers you the possibility to provide your customers with the most common PayPal payment methods.

Installation

The installation of Shopware Markets is possible in several ways.
On the one hand, you can obtain and configure the extension directly during the installation of Shopware in the initial setup wizard.
On the other hand, you can also license the Shopware Markets extension directly in the Shopware Store at store.shopware.com. You can then download and install the extension under Extensions > My Extensions.
It is important that you have previously logged in with your account in the Shopware Account tab.
After the extension has been installed, you can activate it using the button to the left of the extension.

General configuration

You can configure PayPal in the admin under Settings > Extensions by clicking on PayPal.

Sales channels

In this drop-down menu you can select for which of your sales channels the settings should be made. You can choose between All sales channels or individual sales channels.

With the button Set PayPal as default you can activate PayPal in the selected sales channel and set it as default payment method

Configuration of the API settings

In the next step you have to enter your PayPal access data received from PayPal.

Client ID (1): Here you enter the PayPal REST-ID. This is used by the extension to authenticate itself with the PayPal API.

Client-Secret (2): Here you enter the REST-API Client-Secret, which is also used by the extension to authenticate itself with the PayPal-API.

Get API credentials (3): With this button you can request new API credentials from PayPal via a pop-up window.

Test API access data (4): With this button you can test the access data you have entered. The result of the test will be displayed directly in the Save button.

Activate Sandbox (5): Check this box if you only want to test the PayPal integration. Please note that the sandbox environment has its own access data.

Sandbox-Client-ID (6): Enter the PayPal Sandbox REST-ID here. This is used by the extension to authenticate itself with the PayPal API.

Sandbox-Client-Secret (7): Here you enter the Sandbox REST-API Client-Secret, which is also used by the extension to authenticate itself with the PayPal-API.

Get Sandbox API credentials (8): With this button you can request new Sandbox API credentials from PayPal via a pop-up window.

Test Sandbox API credentials (9): Use this button to test the credentials you have entered. The result of the test is displayed directly in the Save button.

Behaviour

Under behaviour you can make basic settings for the extension, that are not only valid for the classic PayPal, but also for the Express Checkout and PayPal PLUS.

Merchant location (1): Here you can enter your merchant location.

Payment acquisition (2): This is where you define when the payment is collected - i.e. when it is closed.

Submit cart (3): Here you can choose whether the customer's shopping cart, i.e. the exact positions of the order, are allowed to be transferred to PayPal. If this option is deactivated, only the total amount is transferred.

Your own brand name on PayPal page (4): Here you can set your own brand name for the advertisement on the PayPal payment page.

PayPal landing page (5): Here you can choose whether the PayPal landing page should display the registration form or the login screen.

Submit order number (6): Activate this option if you want to send the order number to PayPal after completion.

Order number prefix (7): Here you can determine which text is appended to the original order number, e.g. myShopSW20001. This option is only available if you have activated the previous option "Submit order number to PayPal".

Order number suffix (8): Here you can determine which one is attached to the order number, SW20001meinShop.

Debugging (9): This records additional data from the ordering process in order to track down errors. The "Advanced" option should only be activated temporarily.

Classic PayPal

By entering the API access data you are using the classic PayPal for your shop. Thus your customers are able to pay for their orders with their PayPal account.

PayPal Express Checkout

The PayPal extension also offers the possibility of express checkout. With this option, your customer does not have to register in the shop for his order. The order will be processed solely through his PayPal account.

Configuration

'Direct to PayPal' on detail page (1): Here you can define whether the PayPal Express Button is shown on the item detail page.

'Direct to PayPal' in the shopping cart (2): Here you can define if the PayPal Express Button should be shown in the shopping cart.

'Direct to PayPal' in the Off-Canvas shopping cart (3): If you activate this option, the Express Checkout Button will be shown in the Off-Canvas/Modal shopping cart.

'Direct to PayPal' on the login page (4): Here you can determine whether the PayPal Express Checkout Button is offered on the login page.

'Direct to PayPal' on listing pages (5): If you activate this option, the Express Checkout Button will be displayed on listing pages.

Button colour (6): This option offers you some colours in which the PayPal Express Button can be displayed. Gold, blue, silver and black are offered.

Button shape (7): Here you define the shape of the PayPal Express Button. You can choose between round and square.

Transfer shopping cart (8): Here you can choose whether the customer's shopping cart, i.e. the exact positions of the order may be transferred to PayPal. If this option is deactivated, only the total amount is transferred.

Button language (9): In this field you can enter different shop languages for the Express Checkout button. If the field is empty, the sales channel language will be used.
It is important that you enter the so-called "locale code" here, such as en_GB. A list of available language codes can be found on the PayPal site. You can also open the page by clicking on the link "here".

Payment by installments*

The PayPal extension enables you to display a banner for the new installment payment on the item detail page, the (offcanvas) shopping cart and when changing the payment method in the order process. This banner will be displayed on the items that match the criteria for the installment payment.

In order for your customers to use the new installment payment in your shop, they must select the payment method PayPal in the checkout and log in with their PayPal account. Your customers can then check whether the payment method Installment Payment is available.

Further information about PayPal installment payment can be found here.

*Only available in Germany

Configuration

Under payment by installments you have the option to activate the installment banner. This only works with your Live Client ID (not with the Client ID sandbox).

Storefront view

The order process can be carried out as usual if you want to use the payment options of PayPal Plus. PayPal, direct debit, credit card and purchase on account via iFrame are displayed in the payment method selection in the checkout. The prerequisite for this is that the customer has selected PayPal as the payment method in his account.

PayPal Checkout with Smart Payment Buttons

If you have selected "Other location" under "Behaviour at merchant location", the PayPal Checkout with Smart Payment Buttons instead of PayPal PLUS is available in your shop. For the configuration of these Smart Payment Buttons, a new configuration option will appear as soon as you have changed and saved the merchant location.

Configuration

Activate Smart Payment Buttons (1): Here you can activate or deactivate the Smart Payment Buttons.

Activate the alternative payment methods of the Smart Payment Buttons (2): Here you can activate the alternative payment methods like SEPA, credit card, etc.

Button colour (3): This option offers you some colours in which the PayPal Express Button can be displayed. Gold, blue, silver and black are offered.

Button shape (4): Here you define the shape of the PayPal Express Button. You can choose between round and square.

Button language (5): In this field you can enter different shop languages for the Express Checkout Button. If the field is empty, the sales channel language is used.
It is important that you enter the so-called "locale code" here, such as en_GB. A list of available language codes can be found on the PayPal site. You can also open the page by clicking on the link "here".

Invoice document for payment with PayPal invoice purchase

If your customers place their orders with PayPal invoice purchase, the invoice will be paid by PayPal to you as the shop operator. This means that your customers have to transfer the invoice amount of their order directly to PayPal. For this purpose, your customers will automatically be shown the correct bank details after placing their order.

This payment information is also automatically displayed in the invoice if you create it under "Receipts" for this order.

Storefront view

The Smart Payment Buttons are displayed in the checkout instead of the PayPal PLUS payment methods:

Paypal Refund

If an order has already been paid for and you would like to cancel or refund this payment, this is possible via the actual order. For this purpose, you will find the Paypal tab with the item Create a new refund within the order.

The button create a new refund opens a new window in which optional information such as an invoice number or a reason for payment can be entered.

Via Execute the amount is refunded and the payment status of the order is automatically set to Refunded.

PayPal disputes

If customers can pay you with PayPal, it can of course happen that disputes are opened on PayPal to which you have to react. These can be, for example, incomplete or defective deliveries.

As of version 2.1.1, the PayPal extension offers you the ability to display all open PayPal disputes in your Shopware Admin.

Overview

You can find the open cases in your Shopware Admin under Customers > PayPal Disputes.

Overview (1): In the overview you will find all open PayPal disputes and the most important information. On the one hand, the case ID, which you can use to open the case details. Furthermore, the last update, the due date of the next reply, the current status, the current stage of the conflict and the amount at stake in the conflict case.
PayPal resolution center (2): This link, next to each conflict, will take you directly to the PayPal resolution center for the case in question.
Refresh (3): With this button you can refresh the view of the conflicts.
Filter (4): The filter allows you to filter the displayed disputes according to the dispute status and the sales channel.

In order to filter by sales channel, it is necessary to use a separate API for each sales channel.

Case details

You can access the case details through the case ID in the overview. Here you have all the details of the case listed once again.

Details (1): Here you will find all the details of the open case.
Links (2): The links at the top of the page will take you directly to the PayPal resolution center for the case in question, where you can handle the case. On the other hand, you will find a link to the affected order. (This is currently only displayed for orders that were created using PayPal Express).
Raw data (3): In the raw data field you will find a JSON string that contains all the information that Shopware has received from PayPal concerning the case.

Paypal

Installation