Skip to main content

PayPal

Integration only for Callisto online stores

This page only contains instructions for integrating PayPal in Callisto online stores. For further information on using PayPal in Ceres online stores, refer to the detailed information in the plugin description available in the plentyMarketplace.

PayPal is not only used as a payment method in order processing on markets like eBay or Amazon, but also as a payment method for orders in the online store. plentymarkets offers the payment method PayPal, which helps you to process payments in the online store and during checkout. For further general information about PayPal, refer to the PayPal website.

1. Important notes

After the customer has added an item to the shopping cart (on the 'AfterArticle2Basket' page), a button will be displayed that will forward the customer directly to PayPal. The customer then has to log into PayPal. After confirming the payment there, the customer will automatically be forwarded back to the online store in order to enter the invoice address. If the customer is not logged into the online store, a new customer will be created. In this case, the customer has the possibility to change this data accordingly. The customer will then go through the rest of the order process as usual. The payment by PayPal will not be triggered before the order has been completed.

This process can also be started directly from the shopping cart, if the customer clicks on the corresponding button there. Furthermore, the customer can select PayPal when selecting the payment method during the checkout. In these cases, the customer will also be forwarded to the PayPal page and go through the same process as described above.

2. Registering with PayPal

First register with PayPal. You can set up email addresses for payments of each client (store). All payments initiated by plentymarkets will be sent to the first email address. If you wish to save different email addresses for particular stores, add an account to each client (store) when setting up the interface.

3. Setting up PayPal in plentymarkets

Proceed as follows to set up the interface to PayPal in plentymarkets.

Setting up the PayPal interface:

  1. Go to System » Orders » Payment » Methods.

  2. Place a check mark next to the setting Also show inactive.

  3. Open the folder International.

  4. Click on PayPal.
    → The Settings tab will open.

  5. Click on the Interface tab.

  6. Expand the client.

  7. Carry out the settings as desired. Pay attention to the information given in Table 1.

  8. Save the settings.

  9. Click on Add account.
    → You will be forwarded to PayPal.

  10. Log in.

  11. Confirm that plentymarkets should be allowed to access your PayPal account.
    → You will be redirected back to your plentymarkets system.

  12. Save the settings.

Table 1. setting up the PayPal interface
Setting Explanation

URL to your logo

A HTTPS URL that leads to your logo. Use a valid format, e.g. .gif, .jpg or .png. The image may not exceed a maximum size of 190 pixels in width and 60 pixels in height. PayPal cuts off images that are larger. PayPal places your logo at the very top of the shopping cart overview.

Shopping cart border

The hexadecimal HTML code of the main colour of your corporate identity. The colour fades to white in a frame around the shopping cart overview in the PayPal checkout user interface.

Time of PayPal payment collection

Sale (immediate debit) = Collect payment immediately after the order has been completed.
Authorization & Capture = Auth is triggered when the order is completed. Capture is triggered when the order is shipped. This means that payment is only collected when Capture is triggered.
Order (OrderAuthCapture procedure) = Auth is triggered when an order consisting of multiple partial deliveries is completed. Capture is triggered for each partial delivery when the order is shipped. This means that partial payment is only collected when Capture is triggered.

Standard (use for all clients)

Only visible if clients (stores) were set up. Activate to apply the account settings saved for the main store by clicking on Add account for all clients (shops). This setting is dominant over the settings saved for each client. Deactivate to use separate access data for your clients (stores). Online stores that do not have account settings saved for them cannot be used with PayPal.
Go to System » Client » Select client » Online store » Settings and make sure that you have selected the option Enable login for every store in the line Login. This makes it possible to support several clients.

4. Activating the payment method

Set up and activate the payment method PayPal in your plentymarkets system.

Caution: PayPal’s terms and conditions

Setting up a surcharge for accepting payment with PayPal conflicts with PayPal’s General Terms and Conditions.

5. Activating the PayPal instant payment notification (IPN)

plentymarkets actively queries PayPal for new payments every three hours. The last 48 hours are requested. However, this time interval is too large for most sellers. You can decrease this interval with the PayPal option Instant payment notification (IPN).

For payments in the plentymarkets online store and checkout, the instant payment notification will be automatically activated. If your customers pay onto your PayPal account from other markets like eBay checkout, then you should activate the IPN as the global setting for your PayPal account. This also ensures that payments, which have been pending for several days, as may be the case for transfer via PayPal, will end up in your plentymarkets system.

Activating the PayPal IPN function:

  1. Log in with your email address at PayPal.

  2. Go to Summary » Seller preferences » Instant payment notifications.

  3. Click on Choose IPN Settings in the screen that opens next.

  4. Activate the option.

  5. Enter the following address as the notification URL:
    https://www.MY-SHOP-ADDRESS.co.uk/plenty/api/payment_notification.php?payment=PayPal
    Replace www.MY-SHOP-ADDRESS.co.uk with your own store domain.

  6. Save the settings.

This address also works if you use the PayPal standard integration or if you do not offer PayPal as a payment method in your online store.

SSL certificate

Use the URL with http instead of https if you do not use SSL encryption in your online store. We recommend that you use an SSL certificate.

EN Payment Methods PayPal 01
Figure 1. activating IPN

6. Setting up UTF-8 encoding

You have to carry out the following settings in your PayPal account to ensure that UTF-8 encoding, e.g. Chinese characters, is displayed correctly.

Setting up UTF-8 encoding:

  1. Log in with your email address at PayPal.

  2. Go to Summary » Seller preferences.

  3. Click on PayPal button language encoding.

  4. Click on More Options.

  5. Select the UTF-8 option from the Encoding drop-down list (Figure 2).

  6. Select Yes for the option Do you want to use the same encoding for data sent from PayPal to you.

  7. Save the settings.

EN Payment Methods PayPal 02
Figure 2. more encoding options for PayPal

7. Blocking direct payments to your email address

Another setting in your PayPal account can be very useful for sellers: blocking direct payments to your email address. Using the function send money, all PayPal customers are able to send payments to email addresses as they desire. In this case, a delivery address does not have to be saved and this will overrule the seller protection. You can block this type of payment in your PayPal settings.

Blocking direct payments to email addresses:

  1. Log in with your email address at PayPal.

  2. Go to Summary » Seller preferences » Block payments.

  3. Click on Update.

  4. Activate the option Initiate payments from the Pay Anyone subtab of the Send Money tab.

  5. Save the settings.

EN Payment Methods PayPal 03
Figure 3. Payment Receiving Preferences

8. Setting up the PayPal settlement report

The PayPal settlement report is used for assigning PayPal payments to orders. The report includes all of the payments for a specific day. The settlement report is the most reliable way to assign payments to orders, especially if you have a large number of PayPal payments. You need to create an extra PayPal account and generate your own user name in order to access the FTP server from which the settlement reports are loaded. Enter the access data for this account in plentymarkets.

Entering the access data:

  1. Go to System » Orders » Payment » Methods.

  2. Place a check mark next to the setting Also show inactive.

  3. Open the folder International.

  4. Click on PayPal.
    → The Settings tab will open.

  5. Click on the Settlement report tab.

  6. Enter your User name.

  7. Enter the Password.

  8. Save the settings.
    → The settlement report will automatically be retrieved 1 time per day.

Open the document archive to view the settlement reports that were retrieved. The report includes a list of payments that were automatically assigned. It is not necessary to view the reports in order for data to be assigned.

Viewing the settlement report:

  1. Go to Orders » Document archive.

  2. Select the option Settlement report from the drop-down list Document.
    → The rest of the settings are optional.

  3. Save the settings.

The API log includes entries that relate to connecting with the PayPal SFTP server and to the number of transactions included in the settlement report.

9. Refunding the total amount and automatically sending it to PayPal

It is possible to refund customers the total purchase amount by creating an order of the type Credit note. Credit notes will automatically be assigned to the payment.

Creating a credit note to refund the total amount:

  1. Go to Orders » Edit orders.

  2. Open the desired PayPal order.

  3. In the Overview tab, click on the Credit note …​ drop-down list and then select create.
    → The credit note will be created.

Then create an event procedure to automatically send the refunds to PayPal.

Setting up an event procedure
  1. Go to System » Orders » Events.

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

  3. Enter a name.

  4. Select the Event listed in table 2.

  5. Save the settings.

  6. Pay attention to the explanations given in table 2 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 2. event procedure for automatically sending refunds to PayPal
Setting Option Selection

Event

Order generation: New credit note

Filter

Order > Payment method

PayPal

Procedure

Payment methods > Send refund to PayPal

To top