Skip to main content
  1. Home
  2. Payment
  3. Payment Plugins
  4. PayPal

PayPal

With the PayPal plugin, you integrate the PayPal payment methods in your online shop and make them available to your customers. To do so, download the PayPal plugin from the plentyMarketplace . Setup of the payment method is done with an assistant. You also have to carry out a few basic settings in your plentymarkets system so that the payment methods are activated in your system.
The explanations in this section apply after adding the plugin. You can find more information on adding and installing plugins in the Plugins section of the manual.

1. Requirement: Opening a PayPal business account

To work with PayPal, you first need a PayPal business account. You get information as well as login details when you open the account. Without these, the plugin cannot be set up and is not usable. If you don’t have one yet, open a PayPal business acount  first.

2. Completing the assistant

Activating the plugin set in the main client

For account linking and the functionality of event procedures, the PayPal plugin has to be activated in the plugin set used for the main client. Since there is a dependency on the IO plugin, IO must be active for the deployment process (saving the plugin set).

After you installed the plugin, the corresponding assistant is available in the Setup » Assistants » Plugins menu. Proceed as follows to complete the assistant and thus set up the payment method.

Setting up a payment method:

  1. Go to Setup » Assistants » Plugins » [select Plugin set].

  2. Select the assistant PayPal.

  3. Complete the assistant.
    → {name-payment-method} is available in your online shop.

Information about address validation

The PayPal assistant contains the option Address validation in the section Order processing. This validation is automatically activated. You have to select to deactivate the validation. You can either deactivate the validation for selected or for all countries. To do so, check () the countries for which addresses are not to be validated.
If the payment should also be executed with an incomplete address you should deactivate the address validation.

The default validation is a PayPal requirement. The validation checks if there is a complete address. It is not validated whether this is an actually existing address. The payment is only executed successfully if there is a complete address.
The PayPal address validation is important for the coverage when shipping goods. Moreover, PayPal offers buyer and customer protection, which is especially important when orders are processed with PayPal Express. In this case, the address is transmitted by PayPal itself.

Only when using a payment method for several clients: Complete assistant several times

Depending on the configuration of your plugin sets and clients, the PayPal assistant has to be completed more than once. Only this ensures that the PayPal payment methods are configured correctly and all functions such as event procedures and crons run smoothly in the background.

The following tables show you which assistants you have to complete in which plugin set. The upper row displays the configuration of the plugin sets and clients. The second row lists correspondingly, in which set the PayPal assistant has to be completed for which client.

Important: The examples are not about either or. The assistant has to be completed several times for multi-clients because it always also has to be completed in the plugin set which is linked with the main client.

Example 1:

Your plugin sets and clients:

Plugin set 1 is linked with the main client

Plugin set 2 is linked with multi-client 1

Plugin set 3 is linked with multi-client 2

Complete the assistant:

Complete the PayPal assistant in this plugin set for all the clients. This means for the main client, for multi-client 1 and for multi-client 2.

Complete the PayPal assistant in this plugin set for multi-client 1.

Complete the PayPal assistant in this plugin set for multi-client 2.

Example 2:

Your plugin sets and clients:

Plugin set 1 is linked with the main client

Plugin set 2 is linked with multi-client 1 and multi-client 2

Complete the assistant:

Complete the PayPal assistant in this plugin set for all the clients. This means for the main client, for multi-client 1 and for multi-client 2.

Complete the PayPal assistant in this plugin set for multi-client 1 and for multi-client 2.

Example 3:

Your plugin sets and clients:

Plugin set 1 is linked with the main client and to multi-client 1

Plugin set 2 is linked with multi-client 2

Complete the assistant:

Complete the PayPal assistant in this plugin set for all the clients. This means for the main client, for multi-client 1 and for multi-client 2.

Complete the PayPal assistant in this plugin set for multi-client 2.

Example 4:

Your plugin sets and clients:

Plugin set 1 is linked with the main client, with multi-client 1 and with multi-client 2

Complete the assistant:

Complete the PayPal assistant in this plugin set for all the clients. This means for the main client, for multi-client 1 and for multi-client 2.

3. ShopBuilder widgets

The PayPal Express Checkout Button and the Banners for PayPal Installment are available as widgets in the ShopBuilder.

4. Linking template containers

Information about linking containers

The containers needed by default are automatically linked during the setup with the PayPal assistant. From version 5.4.0 on, required as well as optional containers are linked in the same plugin set in which the assistant is completed.

You have different options how to integrate PayPal PLUS, the PayPal Express Checkout button and the Banners for PayPal Installments in your online shop. To do this, the plentymarkets system offers containers at relevant places which can be filled with content to meet your needs.

Linking template containers:

  1. Go to Plugins » Plugin set overview.

  2. Open the plugin set you want to edit.

  3. Open the plugin PayPal.

  4. Click on Container links.

  5. From the drop-down list, select the data provider you want to link.

  6. Select the container you want to link to the data provider. → Pay attention to the information provided in Table 1.

  7. Repeat steps 5 and 6 for all data providers you want to link to containers.

  8. Save () the settings.

Table 1. Linking template containers
Content Explanation

General

PayPal Checkout Scripts

The container Checkout: After scripts loaded has to be linked.

PayPal Confirmation Scripts

The container Script loader: After scripts loaded has to be linked.

PayPal Express Button Scripts

The container Script loader: After scripts loaded has to be linked.

PayPal Styles

The container Template: style has to be linked to activate the styles required by PayPal and to offer optimal functionality.

PayPal Express Checkout button

Optional: The PayPal Express Checkout button can be individually placed, e.g. next to the shopping cart. By clicking on this button, customers can purchase the content of the shopping cart immediately without going through the regular checkout. Instead, the customer is immediately forwarded to the PayPal payment process. The shipping address is provided by PayPal.

Banners for PayPal Installments

Optional: The Banners for PayPal Installments can be placed in many different ways to promote this payment method. You can choose between a graphic banner (PayPal Installment Graphical Promotion Banner) and a text banner (PayPal Installment Text Promotion Banner). A separate integration is not necessary. In the assistant, the banners can automatically be linked to an item page, the cart or the checkout. Additionally, the banners are also available to you as widgets in the ShopBuilder. Thus, they can be placed where they are needed, e.g. on landing pages, item pages, the shopping cart or the checkout.

PayPal Reinitialize Payment / PayPal PLUS Reinitialize Payment

A link with the container My account: Additional payment information allows the customer to reinitialise the payment in the My account area after an unsuccessful transaction. For PayPal, the Order now button is displayed, for PayPal PLUS, the Wall is displayed.
A link with the container Order confirmation: Additional payment information allows the customer to reinitialise the payment in the order confirmation area after an unsuccessful transaction. For PayPal, the Order now button is displayed, for PayPal PLUS, the Wall is displayed.

PayPal PLUS

PayPal PLUS Wall

A link with the container Checkout: Override payment method replaces all previous payment methods with the PayPal PLUS Wall. Any payment methods offered in addition to those included in the Wall – PayPal, Debit, Credit card and Payment upon invoice – are displayed below these four inside the wall in the order of their priority.
In the assistant, different options how to display the PayPal PLUS Wall are available: Wall replaces the payment list, Wall within the payment list or Wall in an overlay during the purchase.
Also pay attention to Additional information about the PayPal PLUS Wall. Additional information as well as restrictions are described there.

4.1. Additional information about the PayPal PLUS Wall

Apart from the PayPal PLUS payment methods, 10 further payment methods can be shown in the checkout within the PayPal PLUS Wall.
For Germany, for example, the payment methods Debit, Credit card and Invoice are possible. With this, a maximum of 14 payment methods can be shown in the checkout. But if, for example, only PayPal and Credit card are allowed for a certain delivery country, the maximum number is restricted to 12.

Moreover, PayPal PLUS limits the number of characters for the names of the other payment methods. The maximum number of characters is limited to 25. If a name has more than 25 characters, it is truncated.
Note that special characters, e.g. an umlaut, reduces the number of characters, because they are read out in HTML-style.

PayPal states the following:

  • max. image size of 100 x 25 px

  • max. 25 characters for methodName

  • max. 120 characters for description

5. Activating webhook notifications

Information about linking containers

The webhooks neded by default are automatically activated during setup with the PayPal assistant. You can carry out individual settings for webhooks in the Additional settings step of the assistant.

Your plentymarkets system and the PayPal interface communicate with the help of webhooks. For certain events, such as an incoming payment, PayPal sends a webhook notification to plentymarkets. plentymarkets automatically responds to these notifications. Table 2 contains additional information on the webhooks.

Table 2. Webhook notifications
Webhook Explanation

PAYMENT.SALE.COMPLETED

A payment has been completed. When PayPal sends this notification, a pending payment is marked as paid in plentymarkets.

PAYMENT.SALE.DENIED

A payment has been denied. When PayPal sends this notification, a pending payment is marked as unpaid in plentymarkets.

PAYMENT.SALE.PENDING

There is a pending payment. When PayPal sends this notification, a pending payment is created in plentymarkets.

PAYMENT.SALE.REFUNDED

A payment has been partially or completely refunded by the seller. When PayPal sends this notification, a credit note for the payment is created in plentymarkets.

PAYMENT.SALE.

A payment has been reversed by PayPal.

6. Customer classes and shipping profiles

Make sure that the payment method is allowed in the customer classes and is not deactivated in the shipping profiles. For this, you should consider first for which customer classes and shipping profiles the payment method should be allowed. This can be set individually.

Permitting the payment method in a customer class:

  1. Go to Setup » CRM » Classes.

  2. Open the customer class for which you want to permit the payment method.

  3. Select the payment method from the list Permitted payment methods by clicking on it.

  4. Save () the settings.

If needed, repeat these steps for other customer classes as well.

Checking payment method in existing shipping profiles:

  1. Go to Setup » Orders » Shipping » Settings.

  2. Change into the Shipping profiles tab.

  3. Open the shipping profile in which the payment method should be allowed.

  4. Check whether the payment method is selected in the Blocked payment methods area.

  5. Deselect the payment method if you want to allow it for this shipping profile.

  6. Save () the settings.

If needed, repeat these steps for shipping profiles as well.

7. Automatically refunding PayPal payments

Set up an event procedure to automatically refund a PayPal payment.

Setting up an event procedure

Setup of an event procedure:

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window opens.

  3. Enter a name.

  4. Select the event as listed in Table 3.

  5. Save () the settings.

  6. Select the settings as listed in Table 3.

  7. Activate the option Active.

  8. Save () the settings.

Table 3. Event procedure for automatically refunding PayPal payments
Setting Option Selection

Event

Select the event that will trigger a refund.

Filter 1

Order > Payment method

Plugin: PayPal
Plugin: PayPalExpress
PayPal: PayPalPlus

Procedure

Plugin > Refunding a PayPal payment<

Following the procedure Refunding a PayPal payment, two additional event procedures are available to follow the further process of the order: PayPal refund successful and PayPal refund failed. You can optionally set up event procedures with these events in the same way as described above.

8. Editing text elements

You can edit texts of the plugin in the CMS » Multilingualism menu. The texts can be adapted into all available system languages. To do so, proceed as described below.

Adapting language files:

  1. Go to CMS » Multilingualism.

  2. On the left side, select the Source language from the drop-down list.

  3. On the right side, select the Target language from the drop-down list.

  4. Expand the various sections in the PayPal area.

  5. Enter the text for the individual text elements in the area of the target language.

  6. Save () the settings.

Find more information in how to edit online shop texts on the manual page Editing online store texts.

9. FAQ about the PayPal plugin

In this section, FAQ about linking the PayPal with plentymarkets are compiled. Additionally, you can also make use of our Forum . You can either look for information in already existing threads or open a new thread and ask our supporters.

9.1. Configuring PayPal using the assistant

When configuring PayPal with the assistant, problems in the online shop may occur under certain circumstances.

  1. I want to update PayPal. How should I proceed?

    If you want to update the PayPal plugin in a copy of your plugin set, you have to change the back end plugin set that is linked to your user account. For further information on how to change your back end plugin set, refer to the page Installing added plugins. After reloading your back end, you can complete the assistant.

9.2. First aid: Problems with linking your PayPal account

If you have problems with linking your PayPal account with plentymarkets, it is advisable to use a different browser, just to eliminate this as a source of errors. Moreover, you should make sure that there are no basic problems with your PayPal account itself. Possibly, the email address was not confirmed yet, PayPal PLUS was not activated yet or you did not set a password yet. More possible sources of error and their solutions are described below.

9.2.1. I am using Ceres and the PayPal Plugin. What am I to do if I am not redirected to plentymarkets after I activated my PayPal account?

Check first whether the latest PayPal plugin version is installed and deployed in your plentymarkets system.

Activation and preview of the plugin

Make sure that the PayPal plugin is already activated and deployed in the Plugin-Set of the main client when you are linking your account with plentymarkets. If this is not the case, malfunctions can occur.

Attention: The plugin-set preview must not be open while the PayPal account is linked with plentymarkets.
Plugin Fehlermeldung 1
Figure 1. Redirection to plentymarkets is not possible

  • Solution 1: Change the browser and try again. plentymarkets supports the browsers Google Chrome and Mozilla Firefox.

  • Solution 2: There is still an active API right in the PayPal account. Remove the rights for plentymarkets. Die API-Berechtigung ist unter folgender URL zu finden: https://www.paypal.com/cgi-bin/webscr?cmd=_profile-api-list-auths .

NOTE

With removing the API rights, all linked PayPal accounts are disconnected from your plentymarkets system. In case a PayPal account is linked with the market eBay, this account has to be linked with the PayPal interface again.

9.2.2. I am using Ceres and the PayPal Plugin. What am I to do if I am asked to sign up for a business account again?

Plugin Fehlermeldung 2
Figure 2. Account setting

If this window opens, check whether the data in the add PayPal account step were correctly inserted.

Plugin Daten
Figure 3. Entry fields in plentymarkets

Email: Use the email address you are also using for your PayPal login.
Environment Choose whether you want to use the account for the test version or the live version.
PayPal PLUS: Only activate this, if you also signed up for PayPal PLUS.

To top