You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/integrate_with_govuk_pay/index.html.md.erb
+5-12Lines changed: 5 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Integrate with the GOV.UK Pay API
3
-
last_reviewed_on: 2025-11-13
3
+
last_reviewed_on: 2026-03-02
4
4
review_in: 6 months
5
5
weight: 2050
6
6
---
@@ -78,20 +78,13 @@ The following example UML sequence diagram shows a typical happy-path payment jo
78
78
79
79
## Identifying your user when they return to your service
80
80
81
-
We recommend using a cookie-based session to identify your user when they
82
-
return to your service. You could use either encrypted client side sessions,
83
-
or server-side sessions using session store.
81
+
We recommend using a cookie-based session to identify users when they return to your service. You can use encrypted client-side sessions or server-side sessions with a session store.
84
82
85
-
We recommend that you do not encode any reference number or user-
86
-
specific information in the `return_url`. For example, do not use
87
-
`/payment_12345` at the end of your `return_url`.
83
+
Do not put any reference numbers or user-specific information in the `return_url`. For example, do not add `/payment_12345` at the end of your `return_url`.
88
84
89
-
If you do, an attacker may be able to guess the reference in your
90
-
`return_url` and gain access to another user's personal information displayed
91
-
on your confirmation screen.
85
+
If you do, an attacker may be able to guess the reference in your `return_url` and see another user’s personal information on the confirmation page.
92
86
93
-
You must [use HTTPS for your `return_url`](/security/#https), but you can use
94
-
HTTP when your service is in sandbox or 'not live yet' mode.
87
+
You must [use HTTPS for your `return_url`](/security/#https). You can use HTTP only when your service is in sandbox or ‘not live yet’ mode.
* both your organisation and any suppliers or delivery partners hold a valid AOC
51
51
* you would like to take MOTO payments on your live service
52
52
53
-
We’ll email you to let you know when we’ve turned on MOTO payments.
53
+
We will email you when we have enabled MOTO payments.
54
54
55
55
#### Worldpay - turn on MOTO payments on a live account
56
56
57
-
1. Create a new MOTO service that is separate from your online payments service - to do this, sign in to the [GOV.UK Pay admin tool](https://selfservice.payments.service.gov.uk) and select **Add a new service**.
57
+
1. Create a new MOTO service that is separate from your online payments service. To do this, sign in to the [GOV.UK Pay admin tool](https://selfservice.payments.service.gov.uk) and select **Add a new service**.
58
58
59
-
1. You need to process MOTO payments on a separate MOTO merchant code to the one you use for online (non-MOTO) payments. If you do not already have a merchant code for MOTO payments, ask for one by contacting Government Banking. You’ll use this merchant code when you [connect your new service to your PSP](https://docs.payments.service.gov.uk/switching_to_live/#go-live).
59
+
1. Get a MOTO merchant code for MOTO payments. Contact Government Banking if you need one. MOTO payments and online payments are processed with separate merchant codes.
60
60
61
-
1. Email [govuk-pay-support@digital.cabinet-office.gov.uk](mailto:govuk-pay-support@digital.cabinet-office.gov.uk) to confirm you and any suppliers or delivery partners comply with the latest version of PCI DSS. In the same email, let us know that would like to take MOTO payments on your account.
61
+
1. Use this MOTO merchant code when you [connect your new service to your PSP](/switching_to_live/#go-live).
62
62
63
-
We’ll email you to let you know we’ve turned on MOTO payments.
63
+
1. Email [govuk-pay-support@digital.cabinet-office.gov.uk](mailto:govuk-pay-support@digital.cabinet-office.gov.uk) to confirm PCI DSS compliance for you and any suppliers or delivery partners. In the same email, ask us to enable MOTO payments on your account.
64
+
65
+
We will email you when we have enabled MOTO payments.
64
66
65
67
You can still [take online payments](https://docs.payments.service.gov.uk/making_payments/) through your non-MOTO service.
Copy file name to clipboardExpand all lines: source/quick_start_guide/index.html.md.erb
+12-15Lines changed: 12 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Quick start
3
-
last_reviewed_on: 2025-11-13
3
+
last_reviewed_on: 2026-03-02
4
4
review_in: 6 months
5
5
weight: 1200
6
6
---
@@ -15,8 +15,7 @@ Read this section to learn about what to do to get started with GOV.UK Pay.
15
15
16
16
Before you start using GOV.UK Pay, you should:
17
17
18
-
* read how to [get started](https://www.payments.service.gov.uk/getstarted/) and decide if GOV.UK
19
-
Pay is right for your service
18
+
* read how to [get started](https://www.payments.service.gov.uk/getstarted/) and decide if GOV.UK Pay is right for your service
20
19
* sign up to the [GOV.UK Pay admin tool](https://selfservice.payments.service.gov.uk/register/email-address)
21
20
* create a service in the GOV.UK Pay admin tool
22
21
* read the GOV.UK Service Manual guidance on [deploying new
@@ -47,24 +46,24 @@ To set up a payment link, [create an account](https://selfservice.payments.servi
47
46
48
47
## The GOV.UK Pay API
49
48
50
-
The GOV.UK Pay API is based on REST principles with endpoints returning data
51
-
in JSON format, and standard HTTP error response codes. Our API
52
-
lets you:
49
+
You can use the GOV.UK Pay API to:
53
50
54
51
* begin and complete payments
55
52
* view the event history for individual payments
56
53
* view transactions, refunds, and disputes within a specified time period
57
54
* issue full or partial refunds
58
55
* create agreements to take recurring payments
59
56
60
-
You can create 2 types of API keys for your GOV.UK Pay service. These are:
57
+
The API follows REST principles. Endpoints return JSON data and use standard HTTP status codes for errors.
61
58
62
-
- test API keys, for [testing your service before it goes live and for testing in sandbox mode](/testing_govuk_pay)
63
-
- live API keys, for taking payments from your users after you [go live](/switching_to_live)
59
+
You can create 2 types of API keys for your GOV.UK Pay service. You can create:
64
60
65
-
If your payment service provider (PSP) is Stripe, you can test how [transaction fees](/reporting/#psp-fees) and payments to your bank account work.
61
+
* test API keys for a service that is [‘not live yet’](/testing_govuk_pay)
62
+
* live API keys after [go live](/switching_to_live)
66
63
67
-
When you've signed up for GOV.UK Pay and created a service, follow these instructions to get started with our API and make a test API request.
64
+
When you’ve signed up for GOV.UK Pay and created a service, create a test API key and make a test payment request.
65
+
66
+
You can still use test API keys for a service after it goes live.
68
67
69
68
## Test the API
70
69
@@ -117,17 +116,15 @@ Read more about [taking payments](/making_payments/#take-a-payment).
117
116
118
117
### Simulate your users' payment journey
119
118
120
-
Go to the ``next_url`` with a browser, and you’ll see the payment screen. Choose a [mock card number](/testing_govuk_pay/#mock-card-numbers) and enter it to simulate a payment. For the other required details, enter some test information which should have:
119
+
Go to the `next_url` with a browser, and you’ll see the payment page. Choose a [mock card number](/testing_govuk_pay/#use-mock-card-numbers) and enter it to simulate a payment. For the other required details, enter some test information, which should have:
121
120
122
121
* an expiry date that is in the future and in the format MM/YYYY or MM/YY
123
-
124
122
* a valid postcode
125
123
126
124
Submit the payment.
127
125
128
126
### View transactions at GOV.UK Pay admin tool
129
127
130
-
Select an account in the [GOV.UK Pay admin
131
-
tool](https://selfservice.payments.service.gov.uk/), then select __Transactions__.
128
+
Select an account in the [GOV.UK Pay admin tool](https://selfservice.payments.service.gov.uk/), then select **Transactions**.
132
129
133
130
You can also view test transactions using the API.
Copy file name to clipboardExpand all lines: source/recurring_payments/index.html.md.erb
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Take recurring payments
3
-
last_reviewed_on: 2025-11-13
3
+
last_reviewed_on: 2026-03-03
4
4
review_in: 6 months
5
5
weight: 2200
6
6
---
@@ -322,7 +322,7 @@ You can [read more about using webhooks to automatically receive updates](/webho
322
322
323
323
### Test your recurring payments integration
324
324
325
-
GOV.UK Pay have [mock card numbers for you to test your integration](/testing_govuk_pay/#mock-card-numbers), including a [mock card number for testing recurring payments](/testing_govuk_pay/#testing-recurring-payments-on-a-test-account). You can use this mock card number to set up an agreement with an initial payment, but further recurring payments will be declined.
325
+
GOV.UK Pay have [mock card numbers for you to test your integration](/testing_govuk_pay/#use-mock-card-numbers). You can also use specific mock card numbers to test recurring payments.
0 commit comments