Adyen · Schema

Modification

Modification schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
direction string The direction of the money movement.
id string Our reference for the modification.
reference string Your reference for the modification, used internally within your platform.
status string The status of the transfer event.
type string The type of transfer modification.
View JSON Schema on GitHub

JSON Schema

transfer-webhooks-modification-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/transfer-webhooks-modification-schema.json",
  "title": "Modification",
  "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"
    }
  }
}