---
displayed_sidebar: homepage
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# AdminPostPaymentRefundsReq

## Properties

<ParameterTypes parameters={[
  {
    "name": "amount",
    "type": "`number`",
    "description": "The amount to refund.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "note",
    "type": "`string`",
    "description": "A note with additional details about the Refund.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "reason",
    "type": "[RefundReason](../../entities/enums/entities.RefundReason.mdx)",
    "description": "The reason for the Refund.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "CLAIM",
        "type": "`\"claim\"`",
        "description": "The refund is applied because of a created claim.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "DISCOUNT",
        "type": "`\"discount\"`",
        "description": "The refund is applied as a discount.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "OTHER",
        "type": "`\"other\"`",
        "description": "The refund is created for a custom reason.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "RETURN",
        "type": "`\"return\"`",
        "description": "The refund is applied because of a created return.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "SWAP",
        "type": "`\"swap\"`",
        "description": "The refund is applied because of a created swap.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
