Adyen · JSON Structure

Funds Transaction Structure

Transaction schema from Adyen API

Type: object Properties: 16

PaymentsFinancial ServicesFintech

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

Properties

amount bankAccountDetail captureMerchantReference capturePspReference creationDate description destinationAccountCode disputePspReference disputeReasonCode merchantReference paymentPspReference payoutPspReference pspReference sourceAccountCode transactionStatus transferCode

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/funds-transaction-structure.json",
  "description": "Transaction schema from Adyen API",
  "type": "object",
  "properties": {
    "amount": {
      "description": "The amount of the transaction.",
      "$ref": "#/components/schemas/Amount"
    },
    "bankAccountDetail": {
      "description": "The details of the bank account to where a payout was made.",
      "$ref": "#/components/schemas/BankAccountDetail"
    },
    "captureMerchantReference": {
      "description": "The merchant reference of a related capture.",
      "type": "string"
    },
    "capturePspReference": {
      "description": "The psp reference of a related capture.",
      "type": "string"
    },
    "creationDate": {
      "description": "The date on which the transaction was performed.",
      "type": "datetime"
    },
    "description": {
      "description": "A description of the transaction.",
      "type": "string"
    },
    "destinationAccountCode": {
      "description": "The code of the account to which funds were credited during an outgoing fund transfer.",
      "type": "string"
    },
    "disputePspReference": {
      "description": "The psp reference of the related dispute.",
      "type": "string"
    },
    "disputeReasonCode": {
      "description": "The reason code of a dispute.",
      "type": "string"
    },
    "merchantReference": {
      "description": "The merchant reference of a transaction.",
      "type": "string"
    },
    "paymentPspReference": {
      "x-addedInVersion": "3",
      "description": "The psp reference of the related authorisation or transfer.",
      "type": "string"
    },
    "payoutPspReference": {
      "x-addedInVersion": "3",
      "description": "The psp reference of the related payout.",
      "type": "string"
    },
    "pspReference": {
      "description": "The psp reference of a transaction.",
      "type": "string"
    },
    "sourceAccountCode": {
      "description": "The code of the account from which funds were debited during an incoming fund transfer.",
      "type": "string"
    },
    "transactionStatus": {
      "description": "The status of the transaction.\n>Permitted values: `PendingCredit`, `CreditFailed`, `CreditClosed`, `CreditSuspended`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.",
      "enum": [
        "BalanceNotPaidOutTransfer",
        "BalancePlatformSweep",
        "BalancePlatformSweepReturned",
        "Chargeback",
        "ChargebackCorrection",
        "ChargebackCorrectionReceived",
        "ChargebackReceived",
        "ChargebackReversed",
        "ChargebackReversedCorrection",
        "ChargebackReversedCorrectionReceived",
        "ChargebackReversedReceived",
        "Converted",
        "CreditClosed",
        "CreditFailed",
        "CreditReversed",
        "CreditReversedReceived",
        "CreditSuspended",
        "Credited",
        "DebitFailed",
        "DebitReversedReceived",
        "Debited",
        "DebitedReversed",
        "DepositCorrectionCredited",
        "DepositCorrectionDebited",
        "Fee",
        "FundTransfer",
        "FundTransferReversed",
        "InvoiceDeductionCredited",
        "InvoiceDeductionDebited",
        "ManualCorrected",
        "ManualCorrectionCredited",
        "ManualCorrectionDebited",
        "MerchantPayin",
        "MerchantPayinReversed",
        "Payout",
        "PayoutReversed",
        "PendingCredit",
        "PendingDebit",
        "PendingFundTransfer",
        "ReCredited",
        "ReCreditedReceived",
        "SecondChargeback",
        "SecondChargebackCorrection",
        "SecondChargebackCorrectionReceived",
        "SecondChargebackReceived"
      ],
      "type": "string"
    },
    "transferCode": {
      "description": "The transfer code of the transaction.",
      "type": "string"
    }
  },
  "name": "Transaction"
}