GOV.UK Pay website screenshot

GOV.UK Pay

UK government digital payment service providing a REST API for accepting card payments, managing payment links, and processing refunds for government digital services. Built and operated by the Government Digital Service (GDS), GOV.UK Pay enables over 1,500 public sector organisations to take payments securely without managing their own PCI DSS compliance.

GOV.UK Pay publishes 5 APIs on the APIs.io network, including Agreements API, Authorise card payments API, Card payments API, and 2 more. Tagged areas include Payments, Government, UK, Public Sector, and REST.

The GOV.UK Pay catalog on APIs.io includes 2 JSON-LD contexts and 1 Spectral governance ruleset.

GOV.UK Pay’s developer surface includes authentication and 3 more developer resources.

40.2/100 thin ▬ flat Agent 41/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreeSelf serve⚡ Free to try
5 APIs
PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhooks

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 40.2/100 · thin
Contract Quality 16.2 / 25
Developer Ergonomics 2.2 / 20
Commercial Clarity 7.4 / 20
Operational Transparency 0.0 / 13
Governance 7.0 / 12
Discoverability 7.4 / 10
Agent readiness — 41/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 0 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/gov-uk-pay: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 5

Individual APIs this provider publishes, each with its own machine-readable definition.

GOV.UK Pay Agreements API

The Agreements API from GOV.UK Pay — 3 operation(s) for agreements.

GOV.UK Pay Authorise card payments API

The Authorise card payments API from GOV.UK Pay — 1 operation(s) for authorise card payments.

GOV.UK Pay Card payments API

The Card payments API from GOV.UK Pay — 5 operation(s) for card payments.

GOV.UK Pay Disputes API

The Disputes API from GOV.UK Pay — 1 operation(s) for disputes.

GOV.UK Pay Refunding card payments API

The Refunding card payments API from GOV.UK Pay — 3 operation(s) for refunding card payments.

Pricing Plans 1

Published pricing tiers and plan structures.

Plans

1 plans

PLANS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Finops

FINOPS

Semantic Vocabularies 2

JSON-LD contexts and semantic vocabularies used across these APIs.

Api Context

0 classes · 0 properties

JSON-LD

context Context

0 classes · 64 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

GOV.UK Pay API Rules

5 rules · 4 warnings 1 info

SPECTRAL

JSON Schema 46

Standalone JSON Schema definitions for this provider's data models.

Address

5 properties

JSON SCHEMA

Agreement

8 properties

JSON SCHEMA

AgreementSearchResults

5 properties

JSON SCHEMA

AuthorisationRequest

5 properties

JSON SCHEMA

AuthorisationSummary

1 properties

JSON SCHEMA

CardDetails

8 properties

JSON SCHEMA

CardDetailsFromResponse

7 properties

JSON SCHEMA

CreateAgreementRequest

3 properties

JSON SCHEMA

CreateCardPaymentRequest

14 properties

JSON SCHEMA

CreatePaymentResult

18 properties

JSON SCHEMA

DisputeDetailForSearch

11 properties

JSON SCHEMA

DisputeLinksForSearch

1 properties

JSON SCHEMA

DisputesSearchResults

5 properties

JSON SCHEMA

EmbeddedRefunds

1 properties

JSON SCHEMA

ErrorResponse

2 properties

JSON SCHEMA

Exemption

3 properties

JSON SCHEMA

ExternalMetadata

1 properties

JSON SCHEMA

Link

2 properties

JSON SCHEMA

Outcome

1 properties

JSON SCHEMA

PaymentDetailForSearch

27 properties

JSON SCHEMA

PaymentEvent

4 properties

JSON SCHEMA

PaymentEventLink

1 properties

JSON SCHEMA

PaymentEvents

3 properties

JSON SCHEMA

PaymentInstrument

3 properties

JSON SCHEMA

PaymentLinks

8 properties

JSON SCHEMA

PaymentLinksForEvents

1 properties

JSON SCHEMA

PaymentLinksForSearch

5 properties

JSON SCHEMA

PaymentRefundRequest

2 properties

JSON SCHEMA

PaymentSearchResults

5 properties

JSON SCHEMA

PaymentSettlementSummary

3 properties

JSON SCHEMA

PaymentState

5 properties

JSON SCHEMA

PaymentWithAllLinks

27 properties

JSON SCHEMA

PostLink

4 properties

JSON SCHEMA

PrefilledCardholderDetails

2 properties

JSON SCHEMA

Refund

7 properties

JSON SCHEMA

RefundDetailForSearch

7 properties

JSON SCHEMA

RefundForSearchResult

3 properties

JSON SCHEMA

RefundLinksForSearch

2 properties

JSON SCHEMA

RefundSearchResults

5 properties

JSON SCHEMA

RefundSettlementSummary

1 properties

JSON SCHEMA

RefundSummary

3 properties

JSON SCHEMA

RefundsResponse

2 properties

JSON SCHEMA

RequestError

4 properties

JSON SCHEMA

SearchNavigationLinks

5 properties

JSON SCHEMA

SettlementSummary

1 properties

JSON SCHEMA

ThreeDSecure

1 properties

JSON SCHEMA

Scroll for all 46

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Gov Uk Pay Authentication

http · 1 scheme

SECURITY

Gov Uk Pay Domain Security

TLSv1.3 · DMARC

SECURITY

Gov Uk Pay Trust Center

PCI DSS

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Gov Uk Pay Agentic Access

16 operations · 7 acting

16 operations · 7 acting

AGENTIC

Resources

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Access & Security 3

Authentication, authorization, and security posture

Source (apis.yml)

apis.yml Raw ↑
name: GOV.UK Pay
description: UK government digital payment service providing a REST API for accepting card payments, managing payment links,
  and processing refunds for government digital services. Built and operated by the Government Digital Service (GDS), GOV.UK
  Pay enables over 1,500 public sector organisations to take payments securely without managing their own PCI DSS compliance.
accessModel:
  pricing: free
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Free · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://www.payments.service.gov.uk/assets/images/govuk-pay-logo.png
tags:
- Payments
- Government
- UK
- Public Sector
- REST
- PCI DSS
- Refunds
- Recurring Payments
- Webhooks
created: '2026-06-13'
modified: '2026-06-13'
url: https://github.com/api-evangelist/gov-uk-pay/blob/main/apis.yml
specificationVersion: '0.19'
apis:
- aid: gov-uk-pay:gov-uk-pay-agreements-api
  name: GOV.UK Pay Agreements API
  description: The Agreements API from GOV.UK Pay — 3 operation(s) for agreements.
  humanURL: https://docs.payments.service.gov.uk/
  baseURL: https://publicapi.payments.service.gov.uk/
  tags:
  - Agreements
  properties:
  - type: OpenAPI
    url: openapi/gov-uk-pay-agreements-api-openapi.yml
  - type: Documentation
    url: https://docs.payments.service.gov.uk/
  - type: Authentication
    url: https://docs.payments.service.gov.uk/api_reference/#authentication
  - type: Webhooks
    url: https://docs.payments.service.gov.uk/webhooks/
  - type: RateLimits
    url: rate-limits/rate-limits.yml
  - type: Plans
    url: plans/plans.yml
  - type: FinOps
    url: finops/finops.yml
  - type: GitHubRepository
    url: https://github.com/alphagov/pay-publicapi
  - type: StatusPage
    url: https://payments.statuspage.io/
  - type: TermsOfService
    url: https://www.payments.service.gov.uk/terms/
  - type: PrivacyPolicy
    url: https://www.payments.service.gov.uk/privacy/
- aid: gov-uk-pay:gov-uk-pay-authorise-card-payments-api
  name: GOV.UK Pay Authorise card payments API
  description: The Authorise card payments API from GOV.UK Pay — 1 operation(s) for authorise card payments.
  humanURL: https://docs.payments.service.gov.uk/
  baseURL: https://publicapi.payments.service.gov.uk/
  tags:
  - Authorise card payments
  properties:
  - type: OpenAPI
    url: openapi/gov-uk-pay-authorise-card-payments-api-openapi.yml
  - type: Documentation
    url: https://docs.payments.service.gov.uk/
  - type: Authentication
    url: https://docs.payments.service.gov.uk/api_reference/#authentication
  - type: Webhooks
    url: https://docs.payments.service.gov.uk/webhooks/
  - type: RateLimits
    url: rate-limits/rate-limits.yml
  - type: Plans
    url: plans/plans.yml
  - type: FinOps
    url: finops/finops.yml
  - type: GitHubRepository
    url: https://github.com/alphagov/pay-publicapi
  - type: StatusPage
    url: https://payments.statuspage.io/
  - type: TermsOfService
    url: https://www.payments.service.gov.uk/terms/
  - type: PrivacyPolicy
    url: https://www.payments.service.gov.uk/privacy/
- aid: gov-uk-pay:gov-uk-pay-card-payments-api
  name: GOV.UK Pay Card payments API
  description: The Card payments API from GOV.UK Pay — 5 operation(s) for card payments.
  humanURL: https://docs.payments.service.gov.uk/
  baseURL: https://publicapi.payments.service.gov.uk/
  tags:
  - Card payments
  properties:
  - type: OpenAPI
    url: openapi/gov-uk-pay-card-payments-api-openapi.yml
  - type: Documentation
    url: https://docs.payments.service.gov.uk/
  - type: Authentication
    url: https://docs.payments.service.gov.uk/api_reference/#authentication
  - type: Webhooks
    url: https://docs.payments.service.gov.uk/webhooks/
  - type: RateLimits
    url: rate-limits/rate-limits.yml
  - type: Plans
    url: plans/plans.yml
  - type: FinOps
    url: finops/finops.yml
  - type: GitHubRepository
    url: https://github.com/alphagov/pay-publicapi
  - type: StatusPage
    url: https://payments.statuspage.io/
  - type: TermsOfService
    url: https://www.payments.service.gov.uk/terms/
  - type: PrivacyPolicy
    url: https://www.payments.service.gov.uk/privacy/
- aid: gov-uk-pay:gov-uk-pay-disputes-api
  name: GOV.UK Pay Disputes API
  description: The Disputes API from GOV.UK Pay — 1 operation(s) for disputes.
  humanURL: https://docs.payments.service.gov.uk/
  baseURL: https://publicapi.payments.service.gov.uk/
  tags:
  - Disputes
  properties:
  - type: OpenAPI
    url: openapi/gov-uk-pay-disputes-api-openapi.yml
  - type: Documentation
    url: https://docs.payments.service.gov.uk/
  - type: Authentication
    url: https://docs.payments.service.gov.uk/api_reference/#authentication
  - type: Webhooks
    url: https://docs.payments.service.gov.uk/webhooks/
  - type: RateLimits
    url: rate-limits/rate-limits.yml
  - type: Plans
    url: plans/plans.yml
  - type: FinOps
    url: finops/finops.yml
  - type: GitHubRepository
    url: https://github.com/alphagov/pay-publicapi
  - type: StatusPage
    url: https://payments.statuspage.io/
  - type: TermsOfService
    url: https://www.payments.service.gov.uk/terms/
  - type: PrivacyPolicy
    url: https://www.payments.service.gov.uk/privacy/
- aid: gov-uk-pay:gov-uk-pay-refunding-card-payments-api
  name: GOV.UK Pay Refunding card payments API
  description: The Refunding card payments API from GOV.UK Pay — 3 operation(s) for refunding card payments.
  humanURL: https://docs.payments.service.gov.uk/
  baseURL: https://publicapi.payments.service.gov.uk/
  tags:
  - Refunding card payments
  properties:
  - type: OpenAPI
    url: openapi/gov-uk-pay-refunding-card-payments-api-openapi.yml
  - type: Documentation
    url: https://docs.payments.service.gov.uk/
  - type: Authentication
    url: https://docs.payments.service.gov.uk/api_reference/#authentication
  - type: Webhooks
    url: https://docs.payments.service.gov.uk/webhooks/
  - type: RateLimits
    url: rate-limits/rate-limits.yml
  - type: Plans
    url: plans/plans.yml
  - type: FinOps
    url: finops/finops.yml
  - type: GitHubRepository
    url: https://github.com/alphagov/pay-publicapi
  - type: StatusPage
    url: https://payments.statuspage.io/
  - type: TermsOfService
    url: https://www.payments.service.gov.uk/terms/
  - type: PrivacyPolicy
    url: https://www.payments.service.gov.uk/privacy/
maintainers:
- FN: Government Digital Service
  url: https://www.gov.uk/government/organisations/government-digital-service
  email: govuk-pay-support@digital.cabinet-office.gov.uk
common:
- type: AgenticAccess
  url: agentic-access/gov-uk-pay-agentic-access.yml
- type: TrustCenter
  url: security/gov-uk-pay-trust-center.yml
- type: DomainSecurity
  url: security/gov-uk-pay-domain-security.yml
- type: Authentication
  url: authentication/gov-uk-pay-authentication.yml