GOV.UK Pay · Schema

PaymentLinks

links for payment

PaymentsGovernmentUKPublic SectorRESTPCI DSSRefundsRecurring PaymentsWebhooks

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

{
  "$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"
    }
  }
}