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

GOV.UK Pay Disputes API

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

GOV.UK Pay Disputes 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 Disputes. 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 1 operation across 1 path, and defines 8 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.

1 operations 1 paths 8 schemas 1 GET

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 Disputes 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Disputes 1
GET
/v1/disputes
Search disputes
Search disputes 7 params → 200401422429500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are DisputeDetailForSearch (11 properties), SearchNavigationLinks (5 properties), DisputesSearchResults (5 properties), RequestError (4 properties). Each schema is shown below with its type and property counts.

SettlementSummary
object
Contains information about when a lost dispute was settled. A dispute is settled when your payment service provider takes it from a payout to your bank account…
1 property
DisputesSearchResults
object
5 properties
DisputeDetailForSearch
object
Contains disputes matching your search criteria.
11 properties
ErrorResponse
object
An error response
2 properties
RequestError
object
A Request Error response
4 properties
DisputeLinksForSearch
object
links for search dispute resource
1 property
Link
object
A link related to a payment
2 properties
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-disputes-api-openapi.yml Raw ↑

Other APIs GOV.UK Pay publishes across the network.

GOV.UK Pay Agreements API
GOV.UK Pay Authorise card payments API
GOV.UK Pay Card payments API
GOV.UK Pay Refunding card payments API
Where this information came from

This is an independent, third-party profile of GOV.UK Pay Disputes 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.