GOV.UK Pay technical documentation

Use this technical documentation to find out how to:

use the GOV.UK Pay API
integrate your service with GOV.UK Pay

You can read non-technical information about:

creating a GOV.UK Pay service and selecting a payment service provider (PSP)
managing your account with Stripe, GOV.UK Pay’s PSP
using the Apple Pay and Google Pay digital wallets
security and compliance

How much GOV.UK Pay costs

There’s no charge to use the GOV.UK Pay API.

You’ll still need to pay your PSP’s transaction fees. If you use GOV.UK Pay’s PSP, we’ll automatically deduct the transaction fee from each payment.

Documentation updates

These are the most recent changes to this documentation.

Date	Update
27 October 2026	Updated Apple Pay testing guidance to explain how to test Apple Pay with Adyen using Apple’s sandbox test cards.
26 October 2026	Updated reconciliation and reporting guidance to explain payouts for payments processed by Adyen, delays in the availability of `settlement_summary.captured_date`, `fee` and `net_amount`, and the additional `Fee (gateway)` column in CSV downloads.
26 October 2026	Clarified in the recurring payments guidance that services using Adyen or Stripe do not need to take additional steps with their payment service provider before setting up recurring payments.
20 October 2026	Added guidance on connecting a live service to Adyen, including onboarding availability, Adyen checks and making a £1 payment to test the connection.
15 October 2026	Updated recurring payments guidance to explain how to check that a recurring payment agreement for Adyen is active before taking subsequent payments.
15 October 2026	Corrected wallet card expiry guidance to explain that `card_details.expiry_date` is returned as `null` when the value is unavailable for Adyen payments.
15 October 2026	Updated dispute guidance to explain how dispute fees differ for payments processed by Stripe and Adyen.
15 October 2026	Added mock card details for Adyen to support payment testing.
15 October 2026	Updated refund guidance and the API reference to explain refund statuses, fees and reconciliation for payments processed by Adyen.
13 October 2026	Updated the API reference to explain payment amount limits, response attributes and when values become available for payments processed by Adyen.
12 October 2026	Added notices to the API reference, integration and integration testing guidance about switching from Stripe to Adyen.
9 October 2026	Added guidance on switching a GOV.UK Pay service from Stripe to Adyen, including preparing for onboarding.
7 October 2026	Added guidance on how switching from Stripe to Adyen affects integrations with GOV.UK Pay.
10 September 2026	Expanded API key security guidance and added warnings and links from relevant pages.
2 September 2026	Clarified MOTO and PCI DSS guidance about the Attestation of Compliance requirement.
5 May 2026	Updated integration testing guidance to explain successful test outcomes and what to do after testing.
11 March 2026	Updated integration testing guidance to reflect the ‘not live yet’ and sandbox testing modes, with revised mock cards and payment service provider-specific guidance.
11 March 2026	Clarified the prerequisites for going live with Worldpay and grouped the requirements in one place.
17 February 2026	Corrected a Mastercard mock card number in the integration testing guidance.
27 January 2026	Updated MOTO guidance to emphasise PCI DSS compliance and the need for an Attestation of Compliance.