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

refundPaymentWorkflow - Medusa Core Workflows Reference

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

This workflow refunds a payment. It's used by the Refund Payment Admin API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to refund a payment in your custom flows.

Source Code

Examples#

Steps#

useRemoteQueryStep

useRemoteQueryStep

useRemoteQueryStep

validateRefundStep

refundPaymentStep

addOrderTransactionStep

emitEventStep

Workflow Hook

Step conditioned by when

Input#

RefundPaymentWorkflowInputRefundPaymentWorkflowInput
The data to refund a payment.
payment_idstring
The ID of the payment to refund.
created_bystringOptional
The ID of the user that refunded the payment.
amountBigNumberInputOptional
The amount to refund. If not provided, the full payment amount will be refunded.
Was this page helpful?