Configuration

Make the PayPal Checkout module operational for your OXID eShop.

Administering PayPal or PayPal Plus orders

If you already use PayPal or PayPal Plus module, note the following limitation:

To administer existing orders, both modules, PayPal Checkout and PayPal for example, must be active at the same time.

However, to prevent that, in our example, the PayPal payment method redundantly displayed in the frontend, you must deactivate the payment method PayPal.

We recommend the following procedure.

Procedure

Tip

Scheduling a downtime

Schedule a short downtime for the step of deactivating the payment method belonging to PayPal or PayPal Plus.

1. Install PayPal Checkout.

2. Activate and configure PayPal Checkout as described below under Basic procedure.
   Result: To administer your orders, under Administer Orders ‣ Orders you will find separate tabs for PayPal Checkout and for PayPal or PayPal Plus (depending on which of the two modules you use).

   Note

   Administering orders in PayPal merchant account

   Nothing can go wrong if you disable PayPal or PayPal Plus as described below.

   You can administer orders in your PayPal merchant account at any time.

   Technical dependencies

   On the separate tab for PayPal or PayPal Plus you can edit your old orders until you deactivate your previously used module.

   Once you deactivate your previously used module, you can still view your old orders on the PayPal Checkout tab, but not edit them.

   If you clean up your system after deactivating your previously used module and therefore also delete the module’s database, your old orders will also no longer be displayed on the PayPal Checkout tab.

   After deleting the database, you will still be able to view and administer the old orders in your PayPal merchant account.

3. Enable PayPal Checkout for live operation as described under Activating PayPal Checkout.

4. Select Shop Settings ‣ Payment Methods.

5. Identify the payment methods corresponding to PayPal or PayPal Plus:

   • PayPal (ID: oxidpaypal)

   • PayPal Plus (ID: payppaypalplus)

   Hint

   The ID is displayed in the lower left corner of the window when you hover over the payment type name.

6. Disable the payment type corresponding to PayPal or PayPal Plus.
   To do this, on the Main tab, uncheck the Active checkbox.
   Result: The PayPal or PayPal Plus module is still active, but the associated payment methods are no longer offered to your customers. Only the payment methods of PayPal Checkout are offered.
   You can still edit existing orders as usual under Administer Orders ‣ Orders on the tab corresponding to the payment module.

7. Recommended: As soon as you are sure that existing orders will no longer require any actions (refunds, for example), under Extensions ‣ Modules disable PayPal or PayPal Plus.

Basic procedure

1. Activate the module.
   The most important payment methods are automatically activated.

2. Connect to your PayPal merchant account.
   For testing purposes, create only a test account (PayPal Sandbox) at first.

3. Optional: Disable the express checkout feature of PayPal Checkout if needed.

4. Optional: Specify if you want to offer PayPal installment payment to your customers.

5. Configure the payment methods provided by PayPal Checkout as payment methods in your eShop:

   • Enable the countries you want to cover.

   • Link the payment methods to your shipping methods and shipping rules.

6. Run test payments in the PayPal Checkout sandbox.

   Hint

   Note: The Sandbox mode is set by default after enabling.

7. Test PayPal Checkout in the PayPal sandbox and adjust the configuration until all payment processes works as you want.

8. Enable PayPal Checkout:

   1. If you do not have a merchant account yet, create one for live operation.

   2. Switch to Live operation mode.

Activating PayPal Checkout

Enable PayPal Checkout in each subshop where you want to use the module.

Procedure

1. Choose Extensions ‣ Modules.

2. Choose the PayPal Checkout for OXID module and choose Overview ‣ Activate.

Result

Under Shop Settings ‣ Payment Methods, the payment methods PayPal v2 as well as important additional payment methods, are marked as active.

To actually use a certain country-specific payment method, you must have marked the respective country as active under Master Settings ‣ Countries.

Example

To be able to offer iDEAL, you must have made sure that you have set the Netherlands as active under Master Settings ‣ Countries.

Configuring PayPal Checkout

To start the configuration, choose PayPal ‣ Configuration.

API Credentials

Register a webhook to connect your eShop with PayPal.

The webhook allows PayPal to contact your OXID eShop and provide real-time status messages about, for example, completed transactions.

In the first run, you test the payment methods provided with PayPal Checkout with test credentials in a sandbox.

Only when everything works as you want, use the credentials for live operation.

Procedure

1. To log in to the sandbox, choose API credentials and click Start Merchant Integration (Sandbox).

2. Go through the registration process.

Hint

Payment method credit card.

If the activation for the payment method credit card has not been done automatically, the payment method appears as a separate creditcard button under the Paypal button.

Hint

Payment method Pay upon Invoice

PayPal offers the payment method Pay upon Invoice only to shop owners from Germany.

Result

Once you have given PayPal permission to connect your Sandbox account to the PayPal Test Store, the API credentials are displayed, and the module is active.

Under Shop Settings ‣ Payment Methods the payment method PayPal v2 is active.

Hint

Generate new webhook.

Sometimes it may be necessary to delete the existing webhook and generate a new one.

To delete a webhook, delete the credentials and select Save.

The Start Merchant Integration button appears, and you can regenerate the webhook.

Button placement settings

Decide if you want to offer the quick purchase feature of PayPal Checkout.

With the quick purchase feature, the customer skips logging into your eShop.

Example

• Your customers typically have only one item in their shopping cart when they place an order?
  In this case, it makes sense to guide customers to their destination as quickly and barrier-free as possible and activate the quick purchase function.

• Do you generate a significant portion of sales or margin from accessory items?
  In this case, it may make sense to delay payment and offer the PayPal buttons only in the shopping cart and checkout, for example.

So, you determine,

• whether customers have to go through your checkout process and register in your eShop

  or

• whether customers can directly trigger the order without registering with their PayPal account (quick purchase).

By default, the Quick Purchase feature is active, and the PayPal button appears on the following pages:

• on the product detail page

• in the shopping cart

• on the checkout page

So, your customers can use their PayPal account to trigger the order at any time.

If you want your customers to have to register in your eShop, disable the quick purchase feature.

Procedure

1. To disable the express checkout feature, uncheck Product details page and Basket.

2. Save your settings.

Result

The PayPal button appears only on the checkout page.

Login with PayPal

Set customers to be automatically logged into your OXID eShop

• if the email address of the PayPal account and the eShop account are identical

and

• as soon as your customer is logged in to their PayPal account.

Benefit: You make the signup process more convenient for your customers.

Your customers will skip the login mechanism. Your customers log in to your OXID eShop without having to enter their password.

Disadvantages:

• Often spouses, for example, use the same PayPal account.
  One of the partners could thereby view the partner’s order history or other customer data in the OXID eShop.
  So potentially there is a privacy risk.

• If your customers do not have to log in to your eShop, you will lose customer order history data.
  You could otherwise use such data for statistical analysis to target your customers.

If you do not enable Login with PayPal, the following happens:

• If the customer’s PayPal email address is known, the PayPal payment process will be interrupted, and the customer will have to log in to your eShop.
  The PayPal session is created, and your customer is logged into your eShop.
  The customer’s identity is clearly established, and the current order is added to the customer’s order history.

• If the customer’s PayPal email address is not known, your customer will complete the order using a guest account.
  Your customer lands on the checkout page with the PayPal address data. The data is stored only once for the current order, no customer account is created in the eShop.

Procedure

Attention

The Login with PayPal function is enabled by default.

1. Check what can go wrong in the worst case if several users use the same PayPal account and can see each other’s data in your eShop.

2. There is no serious risk if your customers conveniently log in to your eShop automatically with their PayPal accounts?
   Then leave the Automatically log in to shop during checkout checkbox selected.
   Otherwise, deselect the checkbox.

3. Save your settings.

Banner settings: re-use

Optional: If you already use the PayPal module, conveniently re-use your banner settings for PayPal Checkout.

Alternatively, set the banner settings manually as described below under Banner settings.

Prerequisites

PayPal is activated.

Procedure

1. To apply the existing PayPal banner advertising settings, choose the Apply settings from the classic PayPal module button.
   The button appears only if the PayPal module is still activated.

2. Save your settings.

Banner settings

Optional: Specify whether you want to advertise PayPal installments with banners.

If you want to take advantage of advertising PayPal installments, specify where you want the banners to appear, for example, on the home page, on the detail page of items, on category pages, in search results, and/or in the checkout process.

Attention

Privacy

To let the banners appear, a permanent communication with the PayPal servers is necessary.

For this purpose, scripts are started with every page view, which observe user behavior and collect the information necessary for the PayPal payment process and transmit it to PayPal.

This communication may be undesirable, for example for reasons of

• data protection

• performance

In this case, make sure that the feature is disabled.

By default, the feature is turned on.

Procedure

1. To disable running scripts for PayPal banner ads, uncheck the Enable installment banners checkbox.
   If you do not check the box, the scripts will not be executed.

2. If you allow running scripts for PayPal banner ads, specify on which pages the banner should appear.
   To do this, choose the appropriate checkbox.

3. If you use a custom theme or a customized OXID theme, do the following:

   1. Identify the CSS selector of the page behind which you want to place the banner.

   2. Enter the CSS selector in appropriate input field.

4. Set the desired color of the banner under Select installment banner’s color.

5. Save your settings.

Testing PayPal Checkout

Configure PayPal Checkout according to your needs and test the result.

Procedure

1. Under Master Settings ‣ Countries, make sure that the markets you want to cover are active.

2. Under Shop Settings ‣ Payment Methods, do the following:

   1. Assign at least one user group to each of the desired PayPal Checkout payment methods (for example iDEAL (via PayPal).

   2. On corresponding Master tab, make sure that you have set the desired minimum and maximum purchase value for the PayPal Checkout payment methods.
      Example: The maximum purchase value for PayPal v2 payment type is limited to €10,000 by default. The minimum purchase value is €10.

3. Under Shop Settings ‣ Shipping Methods, do the following:

   1. Assign the desired PayPal Checkout payment methods to the respective shipping methods.

   2. Make sure that at least one shipping method is created for payment with the PayPal v2 payment method.
      Typically, this is the default payment method.

Unlocking PayPal Checkout

Unlock PayPal Checkout after testing.

Prerequisites

You have configured the desired payment methods and tested them successfully with test payments in the PayPal sandbox.

Procedure

1. Under API credentials choose the Live operating mode.

2. Choose the Start Merchant Integration (Live) button.
   A dialog box for logging in to PayPal appears.

3. Log in with your existing PayPal merchant account. If you don’t have a live login yet, create a new PayPal merchant account.

4. Save your settings.

5. If you use PayPal or PayPal Plus, follow the recommendations under Administering PayPal or PayPal Plus orders.

Result

The PayPal API credentials will be inserted.

The PayPal Checkout module is active and ready for orders from your customers.