Table of contents

Set up a live Worldpay account

Please read the guidance on what to do before you switch to live first.

Worldpay uses the term “production” for live accounts.

You should follow these instructions in order.

You can also read about setting up live ePDQ and Smartpay accounts.

Prerequisites

Before you begin, make sure you have an admin account with both Worldpay and GOV.UK Pay. You need an account with the Worldpay Corporate Gateway. GOV.UK Pay does not support the Worldpay Business Gateway.

Set up your merchant code

Sign in to your Worldpay account and use Select MerchantCode to find your merchant code.

If Switch to Production is at the bottom of the left-hand menu, toggle it on.

Set up your profile

To set up your profile, you need to copy credentials from your Worldpay account into your GOV.UK Pay account.

You must separately sign in to both your Worldpay account and your GOV.UK Pay account. You should have both accounts open, in different web browser tabs.

  1. In your Worldpay browser tab, select Profile in the left-hand menu. If you are prompted to choose a merchant code, select the appropriate one.

  2. In your GOV.UK Pay browser tab, go to My services to select the live service you want to set up. Select Settings, then Account credentials, then Edit credentials.

  3. In Worldpay, copy the Worldpay Merchant Code from Identification into the GOV.UK Pay Merchant code field.

  4. Copy the Worldpay New Username into the GOV.UK Pay Username field. You should see the option Enable Original XML Username. If you see the option Disable Original XML Username, you must select the checkbox and then the Save Profile button at the bottom of the page)

  5. Change the Worldpay XML password:


    select the pencil icon next to XML Password

    change the password and select Add new Password

    select OK to go back to the Profile page

    select the pencil icon again, then Complete then OK

    If you’re setting up another GOV.UK Pay service using the same Worldpay merchant code, you should not need to change your XML password again. If you do change it in this situation, you will need to update your other services with the new XML password.


  6. Enter the Worldpay XML password into the GOV.UK Pay Password field.

  7. In your GOV.UK Pay browser tab, select Save credentials to go back to the Account credentials page.

  8. In your Worldpay browser tab, go to the Profile page. Go to the Payment service section and set Capture delay (days) to 0ff (not 0).

Set up “Merchant Channel”

In the left-hand menu of your Worldpay account, select Merchant Channel.

You must edit the content in the http row, under Protocol.

For Merchant Channels (Production) and Merchant Channels (Test), check the following:

  1. Under Active, select yes.

  2. Set Content to xml

  3. Set Address to https://notifications.payments.service.gov.uk/v1/api/notifications/worldpay.

  4. Set Method to POST.

  5. Set Client certificate to no.

  6. Set the email and shopper email protocols to no.

For Merchant Channel Events (Production) and Merchant Channel Events (Test), check the following in the http row only:


SIGNED_FORM_RECEIVED

SHOPPER_REDIRECTED

SENT_FOR_AUTHORISATION

AUTHORISED

ERROR

CANCELLED

CAPTURED

CAPTURE_FAILED

SETTLED

SETTLED_BY_MERCHANT

CHARGED_BACK

CHARGEBACK_REVERSED

INFORMATION_REQUESTED

INFORMATION_SUPPLIED

EXPIRED

SENT_FOR_REFUND

REFUNDED

REFUNDED_BY_MERCHANT

REFUSED

REFUSED_BY_BANK

REFUND_FAILED

REVOKE_REQUESTED

REVOKE_FAILED

REVOKED

Test your configuration

  1. Sign into the GOV.UK Pay admin tool and confirm that the payment cards you want to accept are enabled.

    Non-American Express cards are enabled on your Worldpay account by default. If you want to accept American Express cards, you must also contact:

    • the Government Banking Service (GBS) if your Worldpay contract is through the GBS
    • your Worldpay account manager if your Worldpay contract is not through the GBS

    You must send your American Express merchant ID to GBS or Worldpay if you’re a non-Crown merchant.

  2. Make a test transaction on your live account. You can use the GOV.UK Pay API to do this.

    Make sure you use a live API key, not a test one. Use payment links if your service is not yet connected to GOV.UK Pay.

    If the test transaction fails, check that you have entered the correct credentials into the GOV.UK Pay admin tool.

  3. Sign in to your GOV.UK Pay account.

  4. Go to the Transactions page and check your test transaction is in the list of transactions.

  5. Select the test transaction and check if you can refund it.

  6. Delete the payments link you created to make the test payment.

    The refund option may take up to 20 minutes to appear after submitting the transaction.

    If the refund option does not appear, check you have set up notifications correctly.

If you are testing your integration with a payment link, you should open it in a separate browser tab to avoid confusion.

Set up 3D Secure

Ask your Worldpay account manager to configure your merchant code to enable 3D Secure for all payments.

When this is available, sign in to your GOV.UK Pay account. Go to My services to select the live service you want to set up. Select Settings, then 3D Secure and then select Turn 3D Secure on.