Adyen · Schema

PaymentRefundRequest

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
amount	object	The amount that you want to refund. The `currency` must match the currency used in authorisation, the `value` must be smaller than or equal to the authorised amount.
applicationInfo	object	Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
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.
merchantRefundReason	string	Your reason for the refund request
reference	string	Your reference for the refund 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
store	string	The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as th

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentRefundRequest",
  "title": "PaymentRefundRequest",
  "properties": {
    "amount": {
      "description": "The amount that you want to refund. 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"
    },
    "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"
    },
    "lineItems": {
      "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"
    },
    "merchantRefundReason": {
      "description": "Your reason for the refund request",
      "enum": [
        "FRAUD",
        "CUSTOMER REQUEST",
        "RETURN",
        "DUPLICATE",
        "OTHER"
      ],
      "type": "string"
    },
    "reference": {
      "description": "Your reference for the refund 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"
    },
    "store": {
      "description": "The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as the store name configured in your Customer Area.  Otherwise, you get an error and the refund fails.",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "amount"
  ],
  "type": "object"
}