Adyen · JSON Structure

Transfer Webhooks Modification Structure

Modification schema from Adyen API

Type: object Properties: 5

PaymentsFinancial ServicesFintech

Modification is a JSON Structure definition published by Adyen, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

direction id reference status type

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/transfer-webhooks-modification-structure.json",
  "description": "Modification schema from Adyen API",
  "type": "object",
  "properties": {
    "direction": {
      "x-addedInVersion": "3",
      "description": "The direction of the money movement.",
      "type": "string"
    },
    "id": {
      "x-addedInVersion": "3",
      "description": "Our reference for the modification.",
      "type": "string"
    },
    "reference": {
      "x-addedInVersion": "3",
      "description": "Your reference for the modification, used internally within your platform.",
      "type": "string"
    },
    "status": {
      "x-addedInVersion": "3",
      "description": "The status of the transfer event.",
      "enum": [
        "approvalPending",
        "atmWithdrawal",
        "atmWithdrawalReversalPending",
        "atmWithdrawalReversed",
        "authAdjustmentAuthorised",
        "authAdjustmentError",
        "authAdjustmentRefused",
        "authorised",
        "bankTransfer",
        "bankTransferPending",
        "booked",
        "bookingPending",
        "cancelled",
        "capturePending",
        "captureReversalPending",
        "captureReversed",
        "captured",
        "capturedExternally",
        "chargeback",
        "chargebackExternally",
        "chargebackPending",
        "chargebackReversalPending",
        "chargebackReversed",
        "credited",
        "depositCorrection",
        "depositCorrectionPending",
        "dispute",
        "disputeClosed",
        "disputeExpired",
        "disputeNeedsReview",
        "error",
        "expired",
        "failed",
        "fee",
        "feePending",
        "internalTransfer",
        "internalTransferPending",
        "invoiceDeduction",
        "invoiceDeductionPending",
        "manualCorrectionPending",
        "manuallyCorrected",
        "matchedStatement",
        "matchedStatementPending",
        "merchantPayin",
        "merchantPayinPending",
        "merchantPayinReversed",
        "merchantPayinReversedPending",
        "miscCost",
        "miscCostPending",
        "paymentCost",
        "paymentCostPending",
        "received",
        "refundPending",
        "refundReversalPending",
        "refundReversed",
        "refunded",
        "refundedExternally",
        "refused",
        "reserveAdjustment",
        "reserveAdjustmentPending",
        "returned",
        "secondChargeback",
        "secondChargebackPending",
        "undefined"
      ],
      "type": "string"
    },
    "type": {
      "x-addedInVersion": "3",
      "description": "The type of transfer modification.",
      "type": "string"
    }
  },
  "name": "Modification"
}