GOV.UK Pay · Schema

RefundSummary

A structure representing the refunds availability

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhook

Properties

Name Type Description
amount_available integer How much you can refund to the user, in pence.
amount_submitted integer How much you’ve already refunded to the user, in pence.
status string Whether you can [refund the payment](https://docs.payments.service.gov.uk/refunding_payments/#checking-the-status-of-a-refund-status).
View JSON Schema on GitHub

JSON Schema

RefundSummary.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/RefundSummary.json",
  "title": "RefundSummary",
  "type": "object",
  "description": "A structure representing the refunds availability",
  "properties": {
    "amount_available": {
      "type": "integer",
      "format": "int64",
      "description": "How much you can refund to the user, in pence.",
      "example": 100,
      "readOnly": true
    },
    "amount_submitted": {
      "type": "integer",
      "format": "int64",
      "description": "How much you\u2019ve already refunded to the user, in pence.",
      "readOnly": true
    },
    "status": {
      "type": "string",
      "description": "Whether you can [refund the payment](https://docs.payments.service.gov.uk/refunding_payments/#checking-the-status-of-a-refund-status).",
      "example": "available"
    }
  }
}

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/RefundSummary"
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.

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