Adyen · Schema

Split

Split schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
account string Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.
amount object The amount of this split.
description string A description of this split.
reference string Your reference for the split, which you can use to link the split to other operations such as captures and refunds. This is required if `type` is **MarketPlace** or **BalanceAccount**. For the other t
type string The type of split. Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.
View JSON Schema on GitHub

JSON Schema

notifications-split-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/notifications-split-schema.json",
  "title": "Split",
  "description": "Split schema from Adyen API",
  "type": "object",
  "properties": {
    "account": {
      "description": "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
      "type": "string"
    },
    "amount": {
      "description": "The amount of this split.",
      "$ref": "#/components/schemas/SplitAmount"
    },
    "description": {
      "description": "A description of this split.",
      "type": "string"
    },
    "reference": {
      "description": "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
      "type": "string"
    },
    "type": {
      "description": "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.",
      "enum": [
        "BalanceAccount",
        "Commission",
        "Default",
        "MarketPlace",
        "PaymentFee",
        "PaymentFeeAcquiring",
        "PaymentFeeAdyen",
        "PaymentFeeAdyenCommission",
        "PaymentFeeAdyenMarkup",
        "PaymentFeeInterchange",
        "PaymentFeeSchemeFee",
        "Remainder",
        "Surcharge",
        "Tip",
        "VAT",
        "Verification"
      ],
      "type": "string"
    }
  },
  "required": [
    "amount",
    "type"
  ]
}