GOV.UK Pay · Schema

Refund

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhook

Properties

Name Type Description
_links object
amount integer The amount refunded to the user in pence.
created_date string The date and time you created this refund. This value uses Coordinated Universal Time (UTC) and ISO 8601 format - `YYYY-MM-DDThh:mm:ss.SSSZ`.
payment_id string The unique ID GOV.UK Pay automatically associated with this payment when you created it.
refund_id string The unique ID GOV.UK Pay automatically associated with this refund when you created it.
settlement_summary object
status string The [status of the refund](https://docs.payments.service.gov.uk/refunding_payments/#checking-the-status-of-a-refund-status).
View JSON Schema on GitHub

JSON Schema

Refund.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/Refund.json",
  "title": "Refund",
  "type": "object",
  "properties": {
    "_links": {
      "$ref": "#/components/schemas/RefundLinksForSearch"
    },
    "amount": {
      "type": "integer",
      "format": "int64",
      "description": "The amount refunded to the user in pence.",
      "example": 120,
      "readOnly": true
    },
    "created_date": {
      "type": "string",
      "description": "The date and time you created this refund. This value uses Coordinated Universal Time (UTC) and ISO 8601 format - `YYYY-MM-DDThh:mm:ss.SSSZ`.",
      "example": "2017-01-10T16:52:07.855Z",
      "readOnly": true
    },
    "payment_id": {
      "type": "string",
      "description": "The unique ID GOV.UK Pay automatically associated with this payment when you created it.",
      "example": "hu20sqlact5260q2nanm0q8u93",
      "readOnly": true
    },
    "refund_id": {
      "type": "string",
      "description": "The unique ID GOV.UK Pay automatically associated with this refund when you created it.",
      "example": "act4c33g40j3edfmi8jknab84x",
      "readOnly": true
    },
    "settlement_summary": {
      "$ref": "#/components/schemas/RefundSettlementSummary"
    },
    "status": {
      "type": "string",
      "description": "The [status of the refund](https://docs.payments.service.gov.uk/refunding_payments/#checking-the-status-of-a-refund-status).",
      "enum": [
        "submitted",
        "success",
        "error"
      ],
      "example": "success",
      "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/Refund"
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.