PaymentRefundRequest is a JSON Structure definition published by Adyen, describing 8 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/checkout-payment-refund-request-structure.json",
"description": "PaymentRefundRequest schema from Adyen API",
"type": "object",
"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"
],
"name": "PaymentRefundRequest"
}