Adyen · Schema

TransferEvent

PaymentsFinancial ServicesFintech

Properties

Name Type Description
amountAdjustments array The amount adjustments in this transfer.
bookingDate string The date when the transfer request was sent.
id string The unique identifier of the transfer event.
mutations array The list of the balance mutation per event.
originalAmount object The amount in the original currency.
reason string The reason for the transfer status.
status string The status of the transfer event.
transactionId string The id of the transaction that is related to this accounting event. Only sent for events of type **accounting** where the balance changes.
type string The type of the transfer event. Possible values: **accounting**, **tracking**.
updateDate string The date when the tracking status was updated.
valueDate string A future date, when the funds are expected to be deducted from or credited to the balance account.
View JSON Schema on GitHub

JSON Schema

adyen-transferevent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransferEvent",
  "title": "TransferEvent",
  "properties": {
    "amountAdjustments": {
      "x-addedInVersion": "3",
      "description": "The amount adjustments in this transfer.",
      "items": {
        "$ref": "#/components/schemas/AmountAdjustment"
      },
      "type": "array"
    },
    "bookingDate": {
      "x-addedInVersion": "3",
      "description": "The date when the transfer request was sent.",
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "x-addedInVersion": "3",
      "description": "The unique identifier of the transfer event.",
      "type": "string"
    },
    "mutations": {
      "x-addedInVersion": "3",
      "description": "The list of the balance mutation per event.",
      "items": {
        "$ref": "#/components/schemas/BalanceMutation"
      },
      "type": "array"
    },
    "originalAmount": {
      "x-addedInVersion": "3",
      "description": "The amount in the original currency.",
      "$ref": "#/components/schemas/Amount"
    },
    "reason": {
      "x-addedInVersion": "3",
      "description": "The reason for the transfer status.",
      "enum": [
        "amountLimitExceded",
        "approved",
        "counterpartyAccountBlocked",
        "counterpartyAccountClosed",
        "counterpartyAccountNotFound",
        "counterpartyAddressRequired",
        "counterpartyBankTimedOut",
        "counterpartyBankUnavailable",
        "error",
        "notEnoughBalance",
        "refusedByCounterpartyBank",
        "routeNotFound",
        "unknown"
      ],
      "type": "string"
    },
    "status": {
      "x-addedInVersion": "3",
      "description": "The status of the transfer event.",
      "enum": [
        "atmWithdrawal",
        "atmWithdrawalReversalPending",
        "atmWithdrawalReversed",
        "authAdjustmentAuthorised",
        "authAdjustmentError",
        "authAdjustmentRefused",
        "authorised",
        "bankTransfer",
        "bankTransferPending",
        "booked",
        "bookingPending",
        "cancelled",
        "capturePending",
        "captureReversalPending",
        "captureReversed",
        "captured",
        "chargeback",
        "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",
        "refused",
        "reserveAdjustment",
        "reserveAdjustmentPending",
        "returned",
        "secondChargeback",
        "secondChargebackPending",
        "undefined"
      ],
      "type": "string"
    },
    "transactionId": {
      "x-addedInVersion": "3",
      "description": "The id of the transaction that is related to this accounting event. Only sent for events of type **accounting** where the balance changes.",
      "type": "string"
    },
    "type": {
      "x-addedInVersion": "3",
      "description": "The type of the transfer event. Possible values: **accounting**, **tracking**.",
      "enum": [
        "accounting",
        "tracking"
      ],
      "type": "string"
    },
    "updateDate": {
      "x-addedInVersion": "3",
      "description": "The date when the tracking status was updated.",
      "format": "date-time",
      "type": "string"
    },
    "valueDate": {
      "x-addedInVersion": "3",
      "description": "A future date, when the funds are expected to be deducted from or credited to the balance account.",
      "format": "date-time",
      "type": "string"
    }
  }
}