Adyen · Schema

PaymentAmountUpdateResponse

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
amount	object	The updated amount.
industryUsage	string	The reason for the amount update. Possible values: * delayedCharge * noShow * installment
lineItems	array	Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3
merchantAccount	string	The merchant account that is used to process the payment.
paymentPspReference	string	The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to update.
pspReference	string	Adyen's 16-character reference associated with the amount update request.
reference	string	Your reference for the amount update request. Maximum length: 80 characters.
splits	array	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-a
status	string	The status of your request. This will always have the value received.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentAmountUpdateResponse",
  "title": "PaymentAmountUpdateResponse",
  "properties": {
    "amount": {
      "description": "The updated amount.",
      "$ref": "#/components/schemas/Amount"
    },
    "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": "71",
      "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"
    },
    "paymentPspReference": {
      "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to update. ",
      "type": "string"
    },
    "pspReference": {
      "description": "Adyen's 16-character reference associated with the amount update request.",
      "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"
    },
    "status": {
      "description": "The status of your request. This will always have the value **received**.",
      "enum": [
        "received"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "merchantAccount",
    "amount",
    "reference",
    "pspReference",
    "paymentPspReference"
  ],
  "type": "object"
}