Skip to main content

Worldpay

Integration only for Callisto online stores

This page only contains instructions for integrating WorldPay in Callisto online stores. The following instructions are not valid for Ceres online stores!

WorldPay is a payment provider based in the USA and the United Kingdom that allows online sellers to accept card payments online. UK sellers can use all services offered by WorldPay whilst German online sellers can take advantage of most of the payment provider’s service portfolio. Contact the WorldPay support to select the cards you want to accept for payment.

1. Important notes

This chapter provides you with important information about integrating the payment provider in plentymarkets.

Payment process

Your customers can select a payment method during the order process as usual. If they decide to pay using WorldPay, they select the desired card in a new window and enter the card data. End customers do not have to register with WorldPay. After the data has been authorised, customers are forwarded back to your online store.

Corporate Gateway

The interface between WorldPay and plentymarkets is based on the Corporate Gateway contract model. The CardPay interface is not supported.

2. Registering with WorldPay

To integrate WorldPay into your online store as a payment method, you need to register with WorldPay and activate an account. To do so, fill in and send the WorldPay application form. You will receive an email from WorldPay containing information about the next steps. Once WorldPay accepts your application, you will receive your WorldPay login details and a link to an online activation request where you enter and send the URL of your online store. WorldPay then checks if the payment page of your online store is fully functional and activates you for online transactions in the WorldPay systems.

3. Setting up WorldPay in plentymarkets

To set up WorldPay in plentymarkets you need the access data that is stored in the WorldPay back end under Profiles. Proceed as described below to set up the interface to WorldPay.

Setting up the WorldPay 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 WorldPay.
    → 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.

Table 1. setting up the WorldPay interface
Setting Explanation

Admin ID

Enter the Admin ID as received from WorldPay.

Merchant ID

Enter the Merchant ID as received from WorldPay.

XML password

Enter password as saved in the WorldPay back end.

Max. order amount in GBP

Enter the maximum order amount in GBP.

Activate test mode

Activate the test mode and check the WorldPay functions before working live with the system.

Client (store) - options

Activate access data for all clients (stores)

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 WorldPay.
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 WorldPay payment method in the Settings tab of the payment method. In addition, check the settings for Permitted payment methods in the customer classes and for Blocked payment methods in the shipping profiles.

5. Carrying out settings in the WorldPay account

You have to save some data in your WorldPay back end to make sure the interface is fully functional. To do so, log into your WorldPay account and carry out the following settings in the Merchant Channel menu in your profile.

5.1. Setting up the merchant channel

Set up the merchant channel in the WorldPay back end.

  • Select yes under Active in the http row of the Merchant Channels area.

  • Select cgi from the Content drop-down list.

  • Enter the plentymarkets URL into the Address field: http://*your-plentystore.co.uk/plenty/api/payment_notification.php?payment=worldpay*
    → Replace "your-plentystore" with your own store.

  • Select POST from the drop-down list under Method.

  • Click on Save the settings.

5.2. Setting up the data exchange with plentymarkets

In the Merchant Channel menu, you also set the information you want to receive and via which WorldPay channel you want to receive it. The recommended method for plentymarkets is described below. Using this method, the data will be added to your system directly.

  • Activate the options that you want to transfer to plentymarkets in the http row of the Merchant Channel Events area.

  • Click on Save the settings.

6. Automatically sending shipping confirmations

Set up an event procedure to automatically send shipping confirmations when the outgoing items are booked. The shipping confirmation will automatically trigger a transfer of the payment made by the customer from WorldPay to you. The WorldPay payment status will change from authorised to captured.

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 sending automatic shipping confirmations to WorldPay
Setting Option Selection

Event

Order change: Outgoing items booked

Filter 1

Order > Payment method

WorldPay

Filter 2

Order > Order type

Order

Procedure

Shipping > Send shipping confirmation to WorldPay

7. Automatically sending cancellations or credit notes

Set up an event procedure to automatically inform WorldPay of cancellations or credit notes.

Tip: One event procedure for two events

Set up one event procedure for two events. The event procedure will change according to the payment status on WorldPay. If the WorldPay payment status for the payment is still authorised (i.e. the payment was not transferred yet), a cancellation is sent automatically. If the WorldPay payment status has changed to captured (i.e. the payment has already been transferred), a credit note is sent automatically.

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 3.

  5. Save the settings.

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

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

  8. Save the settings.

Table 3. event procedure for automatically sending cancellations or credit notes to WorldPay
Setting Option Selection

Event

Order change: Status change

Select status for cancelled orders.

Filter 1

Order > Order type

Order

Filter 2

Order > Payment method

WorldPay

Procedure

Payment methods > Send cancellation or credit note to WorldPay

8. Automatically sending cancellations

As an alternative to the previous event procedure, set up an event procedure to automatically inform WorldPay of cancellations. You can only use this event procedure to cancel a payment if it has not been collected using the event procedure above, i.e. if it is still in the WorldPay status authorised. Subsequently, set up a second event procedure to automatically inform WorldPay of credit notes.

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 4.

  5. Save the settings.

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

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

  8. Save the settings.

Table 4. event procedure for automatically sending cancellations to WorldPay
Setting Option Selection

Event

Order change: Status change

Select status for cancelled orders.

Filter 1

Order > Order type

Order

Filter 2

Order > Payment method

WorldPay

Procedure

Payment methods > Send cancellation to WorldPay

9. Automatically sending credit notes

Once you have collected a payment from WorldPay and the WorldPay status has changed to captured, you can no longer send a cancellation. You need to send a credit note instead. Set up an event procedure to automatically send credit notes to WorldPay.

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 5.

  5. Save the settings.

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

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

  8. Save the settings.

Table 5. event procedure for automatically sending credit notes to WorldPay
Setting Option Selection

Event

Order generation: New credit note

Filter

Order > Payment method

WorldPay

Procedure

Payment methods > Send credit note to WorldPay

10. Manually creating credit notes

It may be necessary to manually create credit notes for individual orders that are processed with WorldPay. You can report individual credit note amounts to WorldPay. To do so, proceed as follows.

Send credit note to WorldPay:

  1. Go to Orders » Edit orders.

  2. Open the WorldPay order.
    → The Overview tab will open.

  3. Select the option create from the Credit note…​ drop-down list.
    → The credit note will be created.

  4. Open the newly created credit note.

  5. Click on the Settings tab.

  6. Enter the amount into the Send WorldPay credit note field.

  7. Click on Send credit note to WorldPay.
    → The credit note will be sent to WorldPay.

To top