Skip to content

PP-14127: Documentation changes to reflect the new GOV.UK Pay admin tool designs#1028

Merged
sjzarb merged 28 commits intomainfrom
PP-14127-simplifyAdminTool
Nov 26, 2025
Merged

PP-14127: Documentation changes to reflect the new GOV.UK Pay admin tool designs#1028
sjzarb merged 28 commits intomainfrom
PP-14127-simplifyAdminTool

Conversation

@NathanD-GDS
Copy link
Contributor

Context

In November 2025, GOV.UK Pay changed the design of their admin tool. These design changes had knock-on effects for the documentation.

Changes proposed in this pull request

This PR:

  • removes references to 'test accounts' as the concept no longer exists
  • added references to 'sandbox mode' and 'not live yet mode' to replace test accounts
  • removed references to selecting Settings because this is now a non-selectable element of the left-hand navigation
  • changed the title of Enter payment details to Enter card details
  • updated the names of pages within the admin tool
  • added a warning banner to the 'Test your integration' page, which is not yet updated

Guidance to review

My main concern with this PR is the framing of sandbox mode and 'not live yet' mode. I worry it reads as clunky but I'm struggling to think of something more elegant for now.

Next steps

This PR does not touch the 'Test your integration' page in the documentation. This page needs a larger rewrite due to how testing on GOV.UK Pay has changed.

Copy link
Contributor

@claire-cheuk claire-cheuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments and inconsistencies, but this is really good! Also must have taken forever to do - well done!

To test Google Pay:

1. In your test service, [create a payment through the API](https://docs.payments.service.gov.uk/making_payments/#creating-a-payment) or create a payment link through the GOV.UK Pay admin tool.
1. [Create a payment through the API with a test API key](https://docs.payments.service.gov.uk/making_payments/#creating-a-payment) or create a payment link with your service in either sandbox or 'not live yet' mode.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks odd to me that only 'not live yet' mode is in quotes. Would it be neater to say 'sandbox' or 'not live yet' mode?
(I understand that you've done it because 'not live yet' is a feature name with multiple words though, so feel free to ignore this if my suggestion doesn't work)

NathanD-GDS and others added 2 commits November 17, 2025 08:58
Applies suggestions from tech writer review

Co-authored-by: Claire Cheuk <167882832+claire-cheuk@users.noreply.github.com>
Comment on lines 70 to +71
1. Select **Settings**.
1. Under **Payments**, select **Card payments**.
1. Select **Payments**, then select **Card payments**.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be correct until the new sidebar navigation is live, at which point there won't be a settings link, just a settings heading in the sidebar nav with the individual settings links

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I've got a list of everywhere that will need changes once that goes live. I've tried to write it in a way that, once that change happens, it should just be a case of deleting Select **Settings**.

---
title: Connect your live account to Stripe
last_reviewed_on: 2025-03-26
title: Connect your live service to Stripe

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is sort of out of line with the idea that services aren't "live" until they've fully set up with the PSP and are able to take payments, so in that sense you can't connect a live service to Stripe, as you would have to have already connected the service to Stripe for it to be live

Stripe is GOV.UK Pay's contracted PSP.

After you request a live GOV.UK Pay account and confirm you will connect it to Stripe, we'll review your request to go live. After we approve your request, you need to add more details about your service and organisation in the GOV.UK Pay admin tool.
After you request a live GOV.UK Pay service, we'll review your request to go live. After we approve your request, you need to add more details about your service and organisation in the GOV.UK Pay admin tool.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might "request a live GOV.UK Pay service" be confusing, as even to users it's the same service, just being put into live mode?

You need to open both the [GOV.UK Pay admin tool](https://selfservice.payments.service.gov.uk/my-services) and your [Worldpay account](https://secure.worldpay.com/sso/public/auth/login.html) to complete this step.

1. Select your live account from [**My services**](https://selfservice.payments.service.gov.uk/my-services) in the GOV.UK Pay admin tool.
1. Select your live service from [**My services**](https://selfservice.payments.service.gov.uk/my-services) in the GOV.UK Pay admin tool.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the "live" part of this may be redundant as you will no longer get a choice of test or live in the my services page, if the service has a live account it defaults to that

1. Select **Configure 3DS**.
1. Enter your 3DS Flex credentials in the **Organisational unit ID**, **Issuer (API ID)**, and **JWT MAC key (API key)** fields.
1. Select **Payment provider**, then select **Worldpay details**.
1. In the **3DS Flex credentials** table, select **Change**.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this isn't correct if it's for onboarding, when onboarding there is a "Configure 3DS" task for setting up 3DS, the table with the change link is only shown after you've entered a set of credentials

Select your service from **My services**, then select **Request a live account** or **Ask to go live**.

Your live account will appear in **My services** in the GOV.UK Pay admin tool.
When your service is live, the **Not live yet** label will disappear from your service in the GOV.UK Pay admin tool.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could be annoyingly confusing for users as (as currently implemented) the Not live yet tag disappears from the My Services page when the service has a live account, regardless of whether the service is live (in the "can take payments" sense), however the header when viewing that service will still show the Not live yet tag until the service is live

## 2. Connect your live service to your PSP

Once you have a GOV.UK Pay live account, you must connect that account to your payment service provider (PSP).
Once your GOV.UK Pay service is live, you must connect that service to your payment service provider (PSP).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this may also be confusing as the service is supposed to still show as Not live yet until the service is able to take payments

@sjzarb sjzarb merged commit d11b4f5 into main Nov 26, 2025
3 checks passed
@sjzarb sjzarb deleted the PP-14127-simplifyAdminTool branch November 26, 2025 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants