Adyen · Schema

PlatformPayment

PlatformPayment schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
modificationMerchantReference	string	The capture's merchant reference included in the transfer.
modificationPspReference	string	The capture reference included in the transfer.
paymentMerchantReference	string	The payment's merchant reference included in the transfer.
platformPaymentType	string	The type of the related split.
pspPaymentReference	string	The payment reference included in the transfer.
type	string	platformPayment

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/transfers-platform-payment-schema.json",
  "title": "PlatformPayment",
  "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
}