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 CodeWorkflow hook
Step conditioned by when
View step details
RefundPaymentWorkflowInput
RefundPaymentWorkflowInputpayment_id
stringcreated_by
stringOptionalThis section lists the events that are either triggered by the emitEventStep
in the workflow, or by another workflow executed within this workflow.
You can listen to these events in a subscriber, as explained in the Subscribers documentation.
Event | Description | Payload | Action |
---|---|---|---|
| Emitted when a payment is refunded. |
|