GOV.UK Pay · Schema

AuthorisationRequest

Contains the user's payment information. This information will be sent to the payment service provider to authorise the payment.

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhook

Properties

Name Type Description
card_number string The full card number from the paying user's card.
cardholder_name string The name on the paying user's card.
cvc string The card verification code (CVC) or card verification value (CVV) on the paying user's card.
expiry_date string The expiry date of the paying user's card. This value must be in `MM/YY` format.
one_time_token string This single use token authorises your request and matches it to a payment. GOV.UK Pay generated the `one_time_token` when the payment was created.
View JSON Schema on GitHub

JSON Schema

AuthorisationRequest.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/AuthorisationRequest.json",
  "title": "AuthorisationRequest",
  "type": "object",
  "description": "Contains the user's payment information. This information will be sent to the payment service provider to authorise the payment.",
  "properties": {
    "card_number": {
      "type": "string",
      "description": "The full card number from the paying user's card.",
      "example": "4242424242424242",
      "maxLength": 19,
      "minLength": 12
    },
    "cardholder_name": {
      "type": "string",
      "description": "The name on the paying user's card.",
      "example": "J. Citizen",
      "maxLength": 255,
      "minLength": 0
    },
    "cvc": {
      "type": "string",
      "description": "The card verification code (CVC) or card verification value (CVV) on the paying user's card.",
      "example": "123",
      "maxLength": 4,
      "minLength": 3
    },
    "expiry_date": {
      "type": "string",
      "description": "The expiry date of the paying user's card. This value must be in `MM/YY` format.",
      "example": "09/22",
      "maxLength": 5,
      "minLength": 5
    },
    "one_time_token": {
      "type": "string",
      "description": "This single use token authorises your request and matches it to a payment. GOV.UK Pay generated the `one_time_token` when the payment was created.",
      "example": "12345-edsfr-6789-gtyu",
      "minLength": 1
    }
  },
  "required": [
    "card_number",
    "cardholder_name",
    "cvc",
    "expiry_date",
    "one_time_token"
  ]
}

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