How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GOV.UK Pay

GOV.UK Pay Card payments API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

GOV.UK Pay Card payments API is one of 5 APIs that GOV.UK Pay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Card Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a GitHub repository.

This API exposes 6 operations across 5 paths, and defines 28 schemas. It is described by OpenAPI 3.0.1, at version 1.0.3.

Requests are made against a single base URL, https://publicapi.payments.service.gov.uk.

6 operations 5 paths 28 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.3
Base URL
https://publicapi.payments.service.gov.uk/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

GOV.UK Pay Card payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

  • BearerAuth — GOV.UK Pay authenticates API calls with [OAuth2 HTTP bearer tokens](http://tools.ietf.org/html/rfc6750). You need to use an "Authorization" HTTP header to prov…

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Card payments 6
GET
/v1/payments
Search payments
Search payments 14 params → 200401422429500
POST
/v1/payments
Create a payment
Create a payment 1 param body → 201400401422429500
GET
/v1/payments/{paymentId}
Get information about a single payment
Get a payment 1 param → 200401404429500
POST
/v1/payments/{paymentId}/cancel
Cancel payment
Cancel a payment 1 param → 204400401404409429500
POST
/v1/payments/{paymentId}/capture
Take a delayed payment
Capture a payment 1 param → 204400401404409429500
GET
/v1/payments/{paymentId}/events
Get a payment's events
Get events for a payment 1 param → 200401404429500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are PaymentWithAllLinks (27 properties), PaymentDetailForSearch (27 properties), CreatePaymentResult (18 properties), CreateCardPaymentRequest (14 properties). Each schema is shown below with its type and property counts.

AuthorisationSummary
object
Object containing information about the authentication of the payment.
1 property
RefundSummary
object
A structure representing the refunds availability
3 properties
PaymentLinksForEvents
object
links for events resource
1 property
CardDetails
object
A structure representing the payment card
8 properties
PaymentSearchResults
object
5 properties
SearchNavigationLinks
object
Links to navigate through pages of your search.
5 properties
PaymentWithAllLinks
object
27 properties
PaymentState
object
A structure representing the current state of the payment in its lifecycle.
5 properties
PaymentSettlementSummary
object
A structure representing information about a settlement
3 properties
PrefilledCardholderDetails
object
prefilledcardholderdetails
2 properties
PostLink
object
A POST link related to a payment
4 properties
PaymentEvent
object
A List of Payment Events information
4 properties
ErrorResponse
object
An error response
2 properties
PaymentLinksForSearch
object
links for search payment resource
5 properties
RequestError
object
A Request Error response
4 properties
PaymentEventLink
object
Resource link for a payment of a payment event
1 property
ExternalMetadata
object
1 property
CreateCardPaymentRequest
object
The create payment request body
14 properties 4 required
Address
object
A structure representing the billing address of a card
5 properties
PaymentEvents
object
A List of Payment Events information
3 properties
Exemption
object
A structure representing that 3DS exemption was requested and the outcome of the exemption, if applicable.
3 properties
PaymentLinks
object
links for payment
8 properties
Link
object
A link related to a payment
2 properties
CardDetailsFromResponse
object
7 properties
ThreeDSecure
object
Object containing information about the 3D Secure authentication of the payment.
1 property
CreatePaymentResult
object
18 properties
Outcome
object
A structure representing the outcome of a 3DS exemption, if known.
1 property
PaymentDetailForSearch
object
Contains payments matching your search criteria.
27 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gov-uk-pay-card-payments-api-openapi.yml Raw ↑

Other APIs GOV.UK Pay publishes across the network.

GOV.UK Pay Agreements API
AE Profile APIs.io
GOV.UK Pay Authorise card payments API
AE Profile APIs.io
GOV.UK Pay Disputes API
AE Profile APIs.io
GOV.UK Pay Refunding card payments API
AE Profile APIs.io
#Card Payments
← Back to G APIs
API Details
ID
gov-uk-pay:gov-uk-pay-card-payments-api
Base URL
https://publicapi.payments.service.gov.uk/
Docs
https://docs.payments.service.gov.uk/
Provider
GOV.UK Pay
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gov-uk-pay-card-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gov-uk-pay-card-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of GOV.UK Pay Card payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.