Adyen · JSON Structure

Transfers Platform Payment Structure

PlatformPayment schema from Adyen API

Type: object Properties: 6
PaymentsFinancial ServicesFintech

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

Properties

modificationMerchantReference modificationPspReference paymentMerchantReference platformPaymentType pspPaymentReference type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/transfers-platform-payment-structure.json",
  "description": "PlatformPayment schema from Adyen API",
  "type": "object",
  "properties": {
    "modificationMerchantReference": {
      "x-addedInVersion": "4",
      "description": "The capture's merchant reference included in the transfer.",
      "type": "string"
    },
    "modificationPspReference": {
      "x-addedInVersion": "4",
      "description": "The capture reference included in the transfer.",
      "type": "string"
    },
    "paymentMerchantReference": {
      "x-addedInVersion": "4",
      "description": "The payment's merchant reference included in the transfer.",
      "type": "string"
    },
    "platformPaymentType": {
      "x-addedInVersion": "4",
      "description": "The type of the related split.",
      "enum": [
        "AcquiringFees",
        "AdyenCommission",
        "AdyenFees",
        "AdyenMarkup",
        "BalanceAccount",
        "Commission",
        "Default",
        "Interchange",
        "PaymentFee",
        "Remainder",
        "SchemeFee",
        "TopUp",
        "VAT"
      ],
      "type": "string"
    },
    "pspPaymentReference": {
      "x-addedInVersion": "4",
      "description": "The payment reference included in the transfer.",
      "type": "string"
    },
    "type": {
      "default": "platformPayment",
      "description": "**platformPayment**",
      "enum": [
        "platformPayment"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false,
  "name": "PlatformPayment"
}