Adyen · JSON Structure

Transfers Transaction Structure

Transaction schema from Adyen API

Type: object Properties: 10 Required: 8

PaymentsFinancial ServicesFintech

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

Properties

accountHolder amount balanceAccount balancePlatform bookingDate creationDate id status transfer valueDate

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/transfers-transaction-structure.json",
  "description": "Transaction schema from Adyen API",
  "type": "object",
  "properties": {
    "accountHolder": {
      "x-addedInVersion": "4",
      "description": "Contains information about the account holder associated with the `balanceAccount`.",
      "$ref": "#/components/schemas/ResourceReference"
    },
    "amount": {
      "x-addedInVersion": "1",
      "description": "Contains information about the amount of the transaction.",
      "$ref": "#/components/schemas/Amount"
    },
    "balanceAccount": {
      "x-addedInVersion": "4",
      "description": "Contains information about the balance account involved in the transaction.",
      "$ref": "#/components/schemas/ResourceReference"
    },
    "balancePlatform": {
      "x-addedInVersion": "1",
      "description": "The unique identifier of the balance platform.",
      "type": "string"
    },
    "bookingDate": {
      "x-addedInVersion": "1",
      "description": "The date the transaction was booked into the balance account.",
      "type": "datetime"
    },
    "creationDate": {
      "description": "The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.",
      "type": "datetime"
    },
    "id": {
      "x-addedInVersion": "1",
      "description": "The unique identifier of the transaction.",
      "type": "string"
    },
    "status": {
      "x-addedInVersion": "1",
      "description": "The status of the transaction.\n\n Possible values:\n\n* **pending**: The transaction is still pending.\n\n* **booked**: The transaction has been booked to the balance account.\n\n",
      "enum": [
        "booked",
        "pending"
      ],
      "type": "string"
    },
    "transfer": {
      "x-addedInVersion": "4",
      "description": "Contains information about the transfer related to the transaction.",
      "$ref": "#/components/schemas/TransferData"
    },
    "valueDate": {
      "x-addedInVersion": "1",
      "description": "The date the transfer amount becomes available in the balance account.",
      "type": "datetime"
    }
  },
  "required": [
    "id",
    "accountHolder",
    "balanceAccount",
    "amount",
    "status",
    "bookingDate",
    "valueDate",
    "balancePlatform"
  ],
  "name": "Transaction"
}