refundPaymentsStep - Medusa Core Workflows Reference

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

This step refunds one or more payments.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { refundPaymentsStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = refundPaymentsStep({8      "payment_id": "{value}",9      "amount": 2910    })11  }12)

Input#

RefundPaymentsStepInputRefundPaymentsStepInput
The data to refund one or more payments.
payment_idstring
The ID of the payment to refund.
The amount to refund.
created_bystringOptional
The ID of the user that refunded 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