Skip to main content

Connect your live account to Worldpay

This is part of going live.

From 1 August 2020, you must connect your live GOV.UK Pay account either the GOV.UK’s contracted payment service provider (PSP) or Government Banking’s contracted PSP.

Government Banking’s contracted payment service provider (PSP) is currently Worldpay. You must be a central government or health sector organisation to use Government Banking’s contracted PSP.

You must be an admin on your GOV.UK Pay account to connect to Worldpay.

Check your Worldpay account

Make sure your Worldpay account is both:

  • an admin account
  • using the Worldpay Corporate Gateway, not the Worldpay Business Gateway

Switch to Production Mode for your merchant code

Sign in to your Worldpay account and select your merchant code.

If Test Mode is at the bottom of the left-hand menu, switch to Production Mode. Worldpay uses the term ‘production’ for live accounts.

Connect your Worldpay account to GOV.UK Pay

  1. Select your live account from the My services page in the GOV.UK Pay admin tool.

  2. Select Your PSP - Worldpay.

  3. In your Worldpay account, select Account and the Profile tab, then your merchant code if you’re asked for one.

  4. In your Worldpay account, copy the Merchant Code value from the Identification section. Paste this value into the Merchant code field in your GOV.UK Pay account.

  5. In your Worldpay account, copy the New Username value. Paste this value into the Username field in your GOV.UK Pay account.

  6. In your Worldpay account, if you see a checkbox labelled Disable Original XML Username, select the checkbox and then select Save Profile at the bottom.

  7. In your Worldpay account, if you have not set your XML password for this merchant code before, set it by selecting the pencil icon next to XML Password and choosing a password.

    If you’ve set your XML password before but you cannot remember it, you can set a new password. But you must add the new password to your other services that use this Worldpay account, or they’ll stop working.

    You should follow the guidance about choosing and storing passwords from the National Cyber Security Centre (NCSC).

  8. Confirm your password by selecting Add new password, then OK.

  9. Save the password by selecting the pencil icon again, then Complete, then OK.

  10. In your Worldpay account, copy your XML password. Paste this password into the Password field in your GOV.UK Pay account.

  11. Go to the Payment service section of your Worldpay account.

  12. Set Capture delay (days) to Off (not 0).

    If you do not do this, you may take money from your users before they’ve confirmed their payment.

  13. Contact Worldpay if you want to take payments higher than the amount in Maximum Transaction Amount.

  14. In your GOV.UK Pay account, select Save credentials.

Set up your Worldpay ‘Merchant Channels’

You must set up your Worldpay ‘Merchant Channels’ so Worldpay can notify GOV.UK Pay about payment events.

In your Worldpay account, select Integration then the Merchant Channel tab.

Set up ‘Merchant Channels’

You must make the following changes in both the Merchant Channels (Production) and Merchant Channels (Test) sections.

Set Active to:

  • no in the email row
  • yes in the http row
  • no in the shopper email row

In the http row, set:

  • Content to xml
  • Address to https://notifications.payments.service.gov.uk/v1/api/notifications/worldpay
  • Method to POST
  • Client certificate to no

Set up ‘Merchant Channel Events’

In both the Merchant Channel Events (Production) and Merchant Channel Events (Test) sections, select the following in the http row.

  • SHOPPER_REDIRECTED
  • SENT_FOR_AUTHORISATION
  • AUTHORISED
  • ERROR
  • CANCELLED
  • CAPTURED
  • CAPTURE_FAILED
  • SETTLED
  • SETTLED_BY_MERCHANT
  • SENT_FOR_REFUND
  • REFUNDED
  • REFUNDED_BY_MERCHANT
  • REFUSED
  • REFUSED_BY_BANK (production only)
  • REFUND_FAILED