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

refundPaymentsWorkflow - Medusa Core Workflows Reference

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

This workflow refunds payments.

You can use this workflow within your customizations or your own custom workflows, allowing you to refund payments in your custom flow.

Source Code

Examples#

Steps#

useQueryGraphStep

validatePaymentsRefundStep

refundPaymentsStep

addOrderTransactionStep

Workflow Hook

Step conditioned by when

Input#

RefundPaymentsWorkflowInputRefundPaymentsWorkflowInput
The data to refund a payment.
payment_idstring
The ID of the payment to refund.
amountBigNumberInput
The amount to refund. Must be less than the refundable amount of the payment.
created_bystringOptional
The ID of the user that's refunding the payment.

Output#

PaymentDTO[]PaymentDTO[]
PaymentDTOPaymentDTO
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
⇧↵