Connect your live account to Worldpay

This is part of going live. You need to complete the steps on that page before continuing here.

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.

1. Check your Worldpay account

Make sure your Worldpay account is both:

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

2. Switch to Production Mode for 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.

3. Connect your Worldpay account to GOV.UK Pay

How you connect your Worldpay account to your GOV.UK Pay service depends on the type of payment you are going to take. There are different processes for:

one-off online payments and mail order / telephone order (MOTO) payments
recurring payments

3a. Connect your one-off or MOTO payments service to your Worldpay account

You need to open both the GOV.UK Pay admin tool and your Worldpay account to complete this step.

Select your live account from My services in the GOV.UK Pay admin tool.
Select Settings.
Under Payment provider, select Worldpay details.
Select Link your Worldpay account with GOV.UK Pay.
In your Worldpay account, select Account and the Profile tab, then your merchant code if you’re asked for one.
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.
In your Worldpay account, copy the New Username value. Paste this value into the Username field in your GOV.UK Pay account.
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.
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).
Confirm your password by selecting Add new password, then OK.
Save the password by selecting the pencil icon again, then Complete, then OK.
In your Worldpay account, copy your XML password. Paste this password into the Password field in your GOV.UK Pay account.
Go to the Payment service section of your Worldpay account.
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.
Contact Worldpay if you want to take payments higher than the amount in Maximum Transaction Amount.
In your GOV.UK Pay account, select Save credentials.

Continue to step 4 to turn on 3DS Flex.

3b. Connect your recurring payments service to your Worldpay account

You need to open both the GOV.UK Pay admin tool and your Worldpay account to complete this step.

Select your live account from My services in the GOV.UK Pay admin tool.
Select Settings.
Under Payment provider, select Worldpay details.
Select Link your Worldpay account with GOV.UK Pay.
Select Change in the Recurring customer initiated transaction (CIT) credentials table.
In your Worldpay account, select your customer initiated transaction (CIT) merchant code. Your CIT merchant code ends in ECOMGBP.

If you’re unsure which merchant code is your CIT, contact either Government Banking or your Worldpay account manager.
In your Worldpay account, select Account and the Profile tab.
In your Worldpay account, copy the Merchant Code value from the Identification section. Paste this value into the CIT merchant code field in the GOV.UK Pay admin tool.
In your Worldpay account, copy the New Username value. Paste this value into the Username field in the GOV.UK Pay admin tool.
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).
Confirm your password by selecting Add new password, then OK.
Save the password by selecting the pencil icon again, then Complete, then OK.
In your Worldpay account, copy your XML password. Paste this password into the Password field in your GOV.UK Pay account.
Go to the Payment service section of your Worldpay account.
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.
Contact Worldpay if you want to take payments higher than the amount in Maximum Transaction Amount.
In the GOV.UK Pay admin tool, select Save credentials.
Select Change in the Recurring merchant initiated transaction (MIT) credentials table.
In your Worldpay account, select your merchant initiated transaction (MIT) merchant code from the navigation panel on the left. Your MIT merchant code ends in RECGBP.

If you’re unsure which merchant code is your MIT, contact either Government Banking or your Worldpay account manager.
Repeat steps 6 to 15 to link your MIT merchant code to your recurring payment service.

Continue to step 4 to turn on 3DS Flex.

4. Turn on 3DS2 (3DS Flex)

3DS Flex is a Worldpay product that turns on 3DS2 payment authentication. You must turn on 3DS Flex to take payments using GOV.UK Pay.

If you are setting up a MOTO service, you do not need to turn on 3DS Flex.

As part of your onboarding, Worldpay should have sent you your 3DS Flex credentials. You can also find your 3DS credentials in Worldpay’s Merchant Admin Interface by selecting INTEGRATION and then 3DS Flex.

Select the service you are making live from My services in the GOV.UK Pay admin tool.
Select Settings.
Under Payment provider, select Worldpay details.
Select Configure 3DS.
Enter your 3DS Flex credentials in the Organisational unit ID, Issuer (API ID), and JWT MAC key (API key) fields.
Select Save credentials.

5. Set up your Worldpay ‘Merchant Channels’

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

If you’re setting up a recurring payments service, you must make these changes for both your customer initiated transaction and your merchant initiated transaction merchant codes.

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

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

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

Once you’ve set up your Worldpay ‘Merchant Channels’, your live account is connected to Worldpay. Continue with the next steps to going live.