Adyen · JSON Structure

Payments Donation Request Structure

DonationRequest schema from Adyen API

Type: object Properties: 6 Required: 3
PaymentsFinancial ServicesFintech

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

Properties

donationAccount merchantAccount modificationAmount originalReference platformChargebackLogic reference

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/payments-donation-request-structure.json",
  "description": "DonationRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "donationAccount": {
      "description": "The Adyen account name of the charity.",
      "type": "string"
    },
    "merchantAccount": {
      "description": "The merchant account that is used to process the payment.",
      "type": "string"
    },
    "modificationAmount": {
      "description": "The amount to be donated.The `currency` must match the currency used in authorisation, the `value` must be smaller than or equal to the authorised amount.",
      "$ref": "#/components/schemas/Amount"
    },
    "originalReference": {
      "description": "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n",
      "type": "string"
    },
    "platformChargebackLogic": {
      "x-addedInVersion": "68",
      "description": "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
      "$ref": "#/components/schemas/PlatformChargebackLogic"
    },
    "reference": {
      "description": "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "donationAccount",
    "modificationAmount"
  ],
  "name": "DonationRequest"
}