StandalonePaymentCancelRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-standalone-payment-cancel-request-schema.json",
  "title": "StandalonePaymentCancelRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adyen-cancels-api-openapi.yml#/components/schemas/StandalonePaymentCancelRequest",
  "properties": {
    "applicationInfo": {
      "description": "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).",
      "$ref": "#/$defs/ApplicationInfo"
    },
    "merchantAccount": {
      "description": "The merchant account that is used to process the payment.",
      "type": "string"
    },
    "paymentReference": {
      "description": "The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) of the payment that you want to cancel.",
      "type": "string"
    },
    "reference": {
      "description": "Your reference for the cancel request. Maximum length: 80 characters.",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "paymentReference"
  ],
  "type": "object",
  "$defs": {
    "ApplicationInfo": {
      "properties": {
        "adyenLibrary": {
          "description": "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.",
          "$ref": "#/$defs/CommonField"
        },
        "adyenPaymentSource": {
          "description": "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.",
          "$ref": "#/$defs/CommonField"
        },
        "externalPlatform": {
          "description": "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.",
          "$ref": "#/$defs/ExternalPlatform"
        },
        "merchantApplication": {
          "description": "Merchant developed software, such as cashier application, used to interact with the Adyen API.",
          "$ref": "#/$defs/CommonField"
        },
        "merchantDevice": {
          "description": "Merchant device information.",
          "$ref": "#/$defs/MerchantDevice"
        },
        "shopperInteractionDevice": {
          "description": "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.",
          "$ref": "#/$defs/ShopperInteractionDevice"
        }
      },
      "type": "object"
    },
    "CommonField": {
      "properties": {
        "name": {
          "description": "Name of the field. For example, Name of External Platform.",
          "type": "string"
        },
        "version": {
          "description": "Version of the field. For example, Version of External Platform.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ExternalPlatform": {
      "properties": {
        "integrator": {
          "description": "External platform integrator.",
          "type": "string"
        },
        "name": {
          "description": "Name of the field. For example, Name of External Platform.",
          "type": "string"
        },
        "version": {
          "description": "Version of the field. For example, Version of External Platform.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "MerchantDevice": {
      "properties": {
        "os": {
          "description": "Operating system running on the merchant device.",
          "type": "string"
        },
        "osVersion": {
          "description": "Version of the operating system on the merchant device.",
          "type": "string"
        },
        "reference": {
          "description": "Merchant device reference.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ShopperInteractionDevice": {
      "properties": {
        "locale": {
          "description": "Locale on the shopper interaction device.",
          "type": "string"
        },
        "os": {
          "description": "Operating system running on the shopper interaction device.",
          "type": "string"
        },
        "osVersion": {
          "description": "Version of the operating system on the shopper interaction device.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}