PostLink

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/PostLink.json",
  "title": "PostLink",
  "type": "object",
  "description": "A POST link related to a payment",
  "properties": {
    "href": {
      "type": "string",
      "description": "A URL that lets you perform additional actions to this payment when combined with the associated `method`.",
      "example": "https://an.example.link/from/payment/platform",
      "readOnly": true
    },
    "method": {
      "type": "string",
      "example": "POST",
      "readOnly": true
    },
    "params": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "example": {
          "description": "This is a value for a parameter called description"
        }
      },
      "example": {
        "description": "This is a value for a parameter called description"
      }
    },
    "type": {
      "type": "string",
      "example": "application/x-www-form-urlencoded"
    }
  }
}