Adyen · JSON Structure

Payments Cancel Or Refund Request Structure

CancelOrRefundRequest schema from Adyen API

Type: object Properties: 9 Required: 2

PaymentsFinancial ServicesFintech

CancelOrRefundRequest is a JSON Structure definition published by Adyen, describing 9 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

additionalData merchantAccount mpiData originalMerchantReference originalReference platformChargebackLogic reference tenderReference uniqueTerminalId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/payments-cancel-or-refund-request-structure.json",
  "description": "CancelOrRefundRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "additionalData": {
      "additionalProperties": {
        "type": "string"
      },
      "x-anyOf": [
        {
          "$ref": "#/components/schemas/AdditionalData3DSecure"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataAirline"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataCarRental"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataCommon"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataLevel23"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataLodging"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataModifications"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataOpenInvoice"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataOpi"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataRatepay"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataRetry"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataRisk"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataRiskStandalone"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataSubMerchant"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataTemporaryServices"
        },
        {
          "$ref": "#/components/schemas/AdditionalDataWallets"
        }
      ],
      "description": "This field contains additional data, which may be required for a particular modification request.\n\nThe additionalData object consists of entries, each of which includes the key and value.",
      "type": "object"
    },
    "merchantAccount": {
      "description": "The merchant account that is used to process the payment.",
      "type": "string"
    },
    "mpiData": {
      "x-addedInVersion": "46",
      "description": "Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).",
      "$ref": "#/components/schemas/ThreeDSecureData"
    },
    "originalMerchantReference": {
      "x-addedInVersion": "30",
      "description": "The original merchant reference to cancel.",
      "type": "string"
    },
    "originalReference": {
      "description": "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n",
      "type": "string"
    },
    "platformChargebackLogic": {
      "x-addedInVersion": "68",
      "description": "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
      "$ref": "#/components/schemas/PlatformChargebackLogic"
    },
    "reference": {
      "description": "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.",
      "type": "string"
    },
    "tenderReference": {
      "x-addedInVersion": "25",
      "description": "The transaction reference provided by the PED. For point-of-sale integrations only.",
      "type": "string"
    },
    "uniqueTerminalId": {
      "x-addedInVersion": "25",
      "description": "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "originalReference"
  ],
  "name": "CancelOrRefundRequest"
}