GOV.UK Pay · Schema

PaymentLinks

links for payment

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhook

Properties

Name Type Description
auth_url_post object
cancel object
capture object
events object
next_url object
next_url_post object
refunds object
self object
View JSON Schema on GitHub

JSON Schema

PaymentLinks.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/PaymentLinks.json",
  "title": "PaymentLinks",
  "type": "object",
  "description": "links for payment",
  "properties": {
    "auth_url_post": {
      "$ref": "#/components/schemas/PostLink"
    },
    "cancel": {
      "$ref": "#/components/schemas/PostLink"
    },
    "capture": {
      "$ref": "#/components/schemas/PostLink"
    },
    "events": {
      "$ref": "#/components/schemas/Link"
    },
    "next_url": {
      "$ref": "#/components/schemas/Link"
    },
    "next_url_post": {
      "$ref": "#/components/schemas/PostLink"
    },
    "refunds": {
      "$ref": "#/components/schemas/Link"
    },
    "self": {
      "$ref": "#/components/schemas/Link"
    }
  }
}

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/PaymentLinks"
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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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