- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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.
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#
RefundPaymentsStepInput
RefundPaymentsStepInputThe data to refund one or more payments.
RefundPaymentsStepInput
RefundPaymentsStepInputpayment_id
stringThe ID of the payment to refund.
payment_id
stringamount
BigNumberInputThe amount to refund.
amount
BigNumberInputcreated_by
stringOptionalThe ID of the user that refunded the payment.
created_by
stringOptionalOutput#
PaymentDTO[]
PaymentDTO[]
PaymentDTO[]
PaymentDTO[]PaymentDTO
PaymentDTO
PaymentDTO
PaymentDTOWas this page helpful?