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.

NoteYou 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 order's details.
paymentPaymentDTO
The order's payment details.
amountBigNumberInputOptional
The amound to refund.
Was this page helpful?