GOV.UK Pay · Schema

PaymentSettlementSummary

A structure representing information about a settlement

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhook

Properties

Name Type Description
capture_submit_time string The date and time GOV.UK Pay asked your payment service provider to take the payment from your user’s account. This value uses Coordinated Universal Time (UTC) and ISO 8601 format - `YYYY-MM-DDThh:mm:
captured_date string The date your payment service provider took the payment from your user. This value uses ISO 8601 format - `YYYY-MM-DD`
settled_date string The date that the transaction was paid into the service's account.
View JSON Schema on GitHub

JSON Schema

PaymentSettlementSummary.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/PaymentSettlementSummary.json",
  "title": "PaymentSettlementSummary",
  "type": "object",
  "description": "A structure representing information about a settlement",
  "properties": {
    "capture_submit_time": {
      "type": "string",
      "description": "The date and time GOV.UK Pay asked your payment service provider to take the payment from your user\u2019s account. This value uses Coordinated Universal Time (UTC) and ISO 8601 format - `YYYY-MM-DDThh:mm:ss.SSSZ`",
      "example": "2016-01-21T17:15:00.000Z",
      "readOnly": true
    },
    "captured_date": {
      "type": "string",
      "description": "The date your payment service provider took the payment from your user. This value uses ISO 8601 format - `YYYY-MM-DD`",
      "example": "2016-01-21",
      "readOnly": true
    },
    "settled_date": {
      "type": "string",
      "description": "The date that the transaction was paid into the service's account.",
      "example": "2016-01-21",
      "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/PaymentSettlementSummary"
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.