Adyen · JSON Structure

Payments Modification Result Structure

ModificationResult schema from Adyen API

Type: object Properties: 3 Required: 2
PaymentsFinancial ServicesFintech

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

Properties

additionalData pspReference response

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/payments-modification-result-structure.json",
  "description": "ModificationResult schema from Adyen API",
  "type": "object",
  "properties": {
    "additionalData": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "This field contains additional data, which may be returned in a particular modification response.",
      "type": "object"
    },
    "pspReference": {
      "description": "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.",
      "type": "string"
    },
    "response": {
      "description": "Indicates if the modification request has been received for processing.",
      "enum": [
        "[capture-received]",
        "[cancel-received]",
        "[refund-received]",
        "[cancelOrRefund-received]",
        "[adjustAuthorisation-received]",
        "[donation-received]",
        "[technical-cancel-received]",
        "[voidPendingRefund-received]"
      ],
      "type": "string"
    }
  },
  "required": [
    "response",
    "pspReference"
  ],
  "name": "ModificationResult"
}