Adyen · JSON Structure

Checkout Payment Amount Update Request Structure

PaymentAmountUpdateRequest schema from Adyen API

Type: object Properties: 7 Required: 2
PaymentsFinancial ServicesFintech

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

Properties

amount applicationInfo industryUsage lineItems merchantAccount reference splits

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/checkout-payment-amount-update-request-structure.json",
  "description": "PaymentAmountUpdateRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "amount": {
      "description": "The updated amount. The `currency` must match the currency used in authorisation.",
      "$ref": "#/components/schemas/Amount"
    },
    "applicationInfo": {
      "description": "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).",
      "$ref": "#/components/schemas/ApplicationInfo"
    },
    "industryUsage": {
      "x-addedInVersion": "70",
      "description": "The reason for the amount update. Possible values: \n* **delayedCharge** \n* **noShow** \n* **installment**",
      "enum": [
        "delayedCharge",
        "installment",
        "noShow"
      ],
      "type": "string"
    },
    "lineItems": {
      "x-addedInVersion": "70",
      "description": "Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).\n> This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.",
      "items": {
        "$ref": "#/components/schemas/LineItem"
      },
      "type": "array"
    },
    "merchantAccount": {
      "description": "The merchant account that is used to process the payment.",
      "type": "string"
    },
    "reference": {
      "description": "Your reference for the amount update request. Maximum length: 80 characters.",
      "type": "string"
    },
    "splits": {
      "description": "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).",
      "items": {
        "$ref": "#/components/schemas/Split"
      },
      "type": "array"
    }
  },
  "required": [
    "merchantAccount",
    "amount"
  ],
  "name": "PaymentAmountUpdateRequest"
}