Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

validateRefundStep - Medusa Core Workflows Reference

This documentation provides a reference to the validateRefundStep. It belongs to the @medusajs/medusa/core-flows package.

This step validates that the refund is valid for the order. If the order does not have an outstanding balance to refund, the step throws an error.

Note: You can retrieve an order or payment's details using Query, or useQueryGraphStep.

Example#

Code
1const data = validateRefundStep({2  order: {3    id: "order_123",4    // other order details...5  },6  payment: {7    id: "payment_123",8    // other payment details...9  },10  amount: 1011})

Input#

ValidateRefundStepInputValidateRefundStepInput
The data to validate whether the refund is valid for the order.
orderOrderDTO
The order's details.
paymentPaymentDTO
The order's payment details.
amountBigNumberInputOptional
The amound to refund.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵