validatePaymentsRefundStep - Medusa Core Workflows Reference

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

This step validates that the refund is valid for the payment. If the payment's refundable amount is less than the amount to be refunded, the step throws an error.

Example#

Code
1const data = validatePaymentsRefundStep({2  payment: [{3    id: "payment_123",4    // other payment details...5  }],6  input: [7    {8      payment_id: "payment_123",9      amount: 10,10    }11  ]12})

Input#