GOV.UK Pay · Schema

PaymentEvent

A List of Payment Events information

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhook

Properties

Name	Type	Description
_links	object
payment_id	string	The unique ID GOV.UK Pay automatically associated with this payment when you created it.
state	object
updated	string	When this payment’s state changed. This value uses Coordinated Universal Time (UTC) and ISO-8601 format - `YYYY-MM-DDThh:mm:ss.SSSZ`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/PaymentEvent.json",
  "title": "PaymentEvent",
  "type": "object",
  "description": "A List of Payment Events information",
  "properties": {
    "_links": {
      "$ref": "#/components/schemas/PaymentEventLink"
    },
    "payment_id": {
      "type": "string",
      "description": "The unique ID GOV.UK Pay automatically associated with this payment when you created it.",
      "example": "hu20sqlact5260q2nanm0q8u93",
      "readOnly": true
    },
    "state": {
      "$ref": "#/components/schemas/PaymentState"
    },
    "updated": {
      "type": "string",
      "description": "When this payment\u2019s state changed. This value uses Coordinated Universal Time (UTC) and ISO-8601 format - `YYYY-MM-DDThh:mm:ss.SSSZ`.",
      "example": "2017-01-10T16:44:48.646Z",
      "readOnly": true
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/PaymentEvent"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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