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 Refunding card payments API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

GOV.UK Pay Refunding 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 Refunding 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 4 operations across 3 paths, and defines 12 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.

4 operations 3 paths 12 schemas 3 GET1 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 Refunding 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 4

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

Refunding card payments 4
GET
/v1/payments/{paymentId}/refunds
Get information about a payment’s refunds
Get all refunds for a payment 1 param → 200401404429500
POST
/v1/payments/{paymentId}/refunds
Refund a payment
Submit a refund for a payment 1 param body → 200202401404412429500
GET
/v1/payments/{paymentId}/refunds/{refundId}
Check the status of a refund
Get a payment refund 2 params → 200401404429500
GET
/v1/refunds
Search refunds
Search refunds 6 params → 200401422500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are RefundDetailForSearch (7 properties), Refund (7 properties), RefundSearchResults (5 properties), SearchNavigationLinks (5 properties). Each schema is shown below with its type and property counts.

PaymentRefundRequest
object
The Payment Refund Request Payload
2 properties 1 required
Refund
object
7 properties
EmbeddedRefunds
object
1 property
ErrorResponse
object
An error response
2 properties
RefundSearchResults
object
5 properties
RefundDetailForSearch
object
Contains the refunds matching your search criteria.
7 properties
RefundLinksForSearch
object
links for search refunds resource
2 properties
RefundForSearchResult
object
3 properties
RequestError
object
A Request Error response
4 properties
Link
object
A link related to a payment
2 properties
RefundSettlementSummary
object
A structure representing information about a settlement for refunds
1 property
SearchNavigationLinks
object
Links to navigate through pages of your search.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gov-uk-pay-refunding-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 Card payments API
AE Profile APIs.io
GOV.UK Pay Disputes API
AE Profile APIs.io
#Refunding card payments
← Back to G APIs
API Details
ID
gov-uk-pay:gov-uk-pay-refunding-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-refunding-card-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gov-uk-pay-refunding-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 Refunding 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.