Skip to main content

Connect Worldpay (beta)

SharePay takes each share of a split on your own Worldpay merchant code, with your own XML login. The money settles to you and every payment appears in your Worldpay Merchant Admin Interface and reports, like your other payments. SharePay never holds the money. SharePay tells your shop the order is paid through its own webhooks, as it does for every business.

Worldpay is in beta

Test mode works now: switch the SharePay dashboard to test mode and use your Worldpay test (secure-test) details. Live Worldpay payments on SharePay open once we have finished our own end-to-end run on Worldpay's test platform; until then the connect screen tells you so.

Who this is for​

Businesses on Worldpay's corporate gateway (WPG), the XML gateway your team manages in the Merchant Admin Interface at secure.worldpay.com.

Business Gateway is not supported yet

If your team signs in to Business Manager, you are on Worldpay Business Gateway, which SharePay does not support yet. Contact us and we will tell you when it is.

Not sure which one you have? Check how your team signs in to Worldpay:

You haveYou are on
A sign-in page titled Merchant Admin Interface (or Merchant Administration Interface) on secure.worldpay.com, a merchant code in capitals such as YOURCOMPANYECOM, and an XML password on your Profile pageWPG. Carry on with this guide.
A sign-in to Business Manager, an installation reference of 27 characters, and no XML username or passwordBusiness Gateway. Not supported yet.

If you type a Business Gateway installation reference into the SharePay form, SharePay tells you so before it sends anything to Worldpay.

What you need​

  • Access to your Worldpay Merchant Admin Interface with permission to change your profile and integration settings.
  • These five details, which steps 1 to 5 below show you how to find or set:
    • your merchant code;
    • your Merchant Admin Interface username;
    • an XML password;
    • your installation ID (a number, for your payment page set-up);
    • a MAC secret (signs the payment result, so SharePay can trust it).
  • The owner or an admin role in SharePay.

Some settings can only be switched on by Worldpay. Ask your Worldpay Relationship Manager or Implementation Manager early (step 4), because it can take a few days.

1. Set an XML password​

In the Merchant Admin Interface, open Account, then Profile. Note your username, then click the pencil next to XML Password and save a new one.

Worldpay's guide: hosted integration quick start

Screenshot coming soon

Merchant Admin Interface, Account, Profile, with the pencil next to XML Password. Until it is here, follow Worldpay's quick start.

2. Let SharePay's servers in​

Open Integration, then the Merchant Environment tab. Copy each address shown on the SharePay connect screen and add it as a new IP, in test and in production.

Worldpay only accepts XML messages from addresses registered for your merchant code. The SharePay connect screen lists SharePay's server addresses, each with a Copy button; SharePay works them out for you, so there is nothing to ask for. If it shows none, contact us for SharePay's server addresses.

Worldpay's guide: restrict IP addresses

Screenshot coming soon

Merchant Admin Interface, Integration, Merchant Environment tab, with New Test IP. Until it is here, follow Worldpay's guide to restricting IP addresses.

3. Sign the payment result​

In the Payment Page Designer, open Merchant Configuration. Turn on Send URL parameters and set Redirect MAC algorithm to HMAC SHA256. Then set a MAC secret of 20 to 30 characters on your Profile page and paste it into SharePay.

The MAC secret needs upper and lower case letters, a number and a symbol.

Worldpay's guide: securing payments

Screenshot coming soon

Payment Page Designer, Merchant Configuration, with Send URL parameters on and Redirect MAC algorithm set to HMAC SHA256. Until it is here, follow Worldpay's guide to securing payments.

4. Ask Worldpay to switch on three things​

3-D Secure (3DS Flex) on your payment pages, the iframe integration for your installation ID, and order inquiries.

You cannot change these yourself; your Worldpay Relationship Manager or Implementation Manager does it. Without the iframe integration the card form cannot show inside SharePay's split page. Without order inquiries SharePay still works from Worldpay's notifications, but cannot double check a payment if a notification goes missing.

Worldpay's guide: JavaScript SDK (iframe)

Screenshot coming soon

There is no screen for this step: it is a request to Worldpay. See Worldpay's JavaScript SDK guide for what the iframe integration is.

5. Copy four details​

Your merchant code, your username, the XML password from step 1 and your installation ID.

Your merchant code is shown in the Merchant Admin Interface and in the details your Worldpay Implementation Manager sent you. Your installation ID came with them too; it is a number.

Worldpay's guide: hosted integration quick start

Screenshot coming soon

Merchant Admin Interface, with the merchant code and username on the Profile page. Until it is here, follow Worldpay's quick start.

Connect in SharePay​

In the SharePay dashboard, go to Settings, Processors and choose Connect next to Worldpay.

  1. Answer Which Worldpay login does your team use? with Merchant Admin Interface (you sign in at secure.worldpay.com).
  2. Confirm it's you. Choose Email me a code and enter the code we send to your SharePay email address. Changing where payments go always needs a fresh code.
  3. Enter the merchant code, username, XML password, installation ID and MAC secret.
  4. Choose Save and connect.

SharePay then checks your details with Worldpay, without charging anyone. If Worldpay does not accept them, the form shows each check as a line of text, with any that failed marked in red:

  • XML login: Worldpay accepted the username and XML password for this merchant code.
  • Server addresses: SharePay's servers are registered in your Merchant Environment.
  • Installation ID: Worldpay recognised your installation ID.
  • Order inquiries: whether Worldpay has switched them on for you.

The MAC secret is optional when you connect. Without it SharePay waits for Worldpay's notification before showing a payment as held, which can take a moment longer for your customers.

Once Worldpay accepts them, the form gives way to Worldpay is connected and a summary of what is saved: the merchant code, a masked username, the installation ID, and whether the XML password and MAC secret are saved. The last step below sits straight under it. To change anything, choose Change details.

Your XML password and MAC secret are encrypted as soon as they reach SharePay, and no screen ever shows them again. To change one, type a new one; leave the box blank to keep the saved one.

Last step: send payment updates to SharePay​

Worldpay keeps this in your production Merchant Admin Interface, even for test. Open Integration, then Merchant Channel. Turn on the http channel with xml content. Paste the address as the test address for a test connection, or as the production address for a live one, and tick these statuses under the matching events:

  • AUTHORISED
  • REFUSED
  • CANCELLED
  • CAPTURED
  • SENT_FOR_REFUND
  • REFUNDED
  • REFUND_FAILED
  • EXPIRED
  • ERROR

The address is shown on the SharePay connect screen straight after you connect, with a Copy button. It is unique to your connection, so treat it like a password. To see it again later, choose Manage on Worldpay in Settings, Processors, then Show notification address.

Use the production Merchant Admin Interface even for test: Worldpay keeps the test notification address there too.

Worldpay's guide: order notifications

Screenshot coming soon

Production Merchant Admin Interface, Integration, Merchant Channel, with the http channel, xml content, the address and the ticked statuses. Until it is here, follow Worldpay's guide to order notifications.

What SharePay does​

  • Holds each share. Each person in the split pays their own share on Worldpay's payment page, embedded in SharePay's split page, with 3-D Secure where their bank asks for it. SharePay switches capture off on that order, so the card is held, not charged. Your own capture delay setting in Worldpay is not changed.
  • Captures when everyone has paid. Every share is captured together.
  • Cancels if the split expires. If the split does not complete, every hold is cancelled at Worldpay.
  • Refunds from SharePay. Refund a share, in full or in part, from the SharePay dashboard; SharePay sends the refund to Worldpay.

Payments appear in your Merchant Admin Interface under order codes starting SP-. A customer pays only their own share; SharePay's fee is billed to you monthly.

Test mode​

Connect your Worldpay test (secure-test) details in SharePay's test mode. On Worldpay's test payment page use the test card 4444 3333 2222 1111, any future expiry date and any security code, and set the cardholder name to choose the outcome:

Cardholder nameResult
AUTHORISEDThe payment is approved and the share is held.
REFUSEDThe bank refuses the payment.
3DOpens Worldpay's 3-D Secure simulator, where you choose the outcome.

Worldpay's guide: test values

Troubleshooting​

What you seeWhat to do
Worldpay did not accept the XML username and passwordCheck the username on your Profile page and set the XML password again (step 1). Make sure you are using the test details in test mode and the live ones in live.
Server addresses not registeredAdd each of SharePay's server addresses as a new IP in Integration, Merchant Environment, in test and in production (step 2). This also shows if the merchant code does not match the username.
Installation ID not recognisedCheck the installation ID with your Worldpay Implementation Manager. It is a number. A 27 character reference means Business Gateway, which is not supported yet.
Payments stay as waiting for confirmationSharePay has not heard from Worldpay. Check the MAC secret and Send URL parameters (step 3), and that the notification address and statuses are set up in the production Merchant Admin Interface (last step).

Disconnecting​

Choose Manage on Worldpay in Settings, Processors, then remove it (the owner can do this). SharePay deletes your XML password and MAC secret. Then, in your Merchant Admin Interface, remove SharePay's notification address from Merchant Channel and SharePay's server addresses from Merchant Environment; Worldpay gives SharePay no way to do this for you.

SharePay refuses to remove Worldpay while:

  • a split on it is still open, because the holds on your customers' cards need it to be captured or cancelled;
  • money is still settling with Worldpay, for up to 7 days: a capture or refund Worldpay has not yet confirmed, or a payment whose result is still being checked. Your XML login is what finishes them. Once it clears you can disconnect; if it is urgent, contact us.

The same applies to changing the merchant code on a connection.