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 CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
RefundPaymentsWorkflowInputRefundPaymentsWorkflowInputThe data to refund a payment.
RefundPaymentsWorkflowInputRefundPaymentsWorkflowInputpayment_idstringThe ID of the payment to refund.
payment_idstringamountBigNumberInputThe amount to refund. Must be less than the refundable amount of the payment.
amountBigNumberInputcreated_bystringOptionalThe ID of the user that's refunding the payment.
created_bystringOptionalnotestringOptionalThe note to attach to the refund.
notestringOptionalOutput#
PaymentDTO[]PaymentDTO[]
PaymentDTO[]PaymentDTO[]idstringThe ID of the payment.
idstringamountBigNumberValueThe payment's total amount.
amountBigNumberValuecurrency_codestringThe ISO 3 character currency code of the payment.
currency_codestringprovider_idstringThe ID of the associated payment provider.
provider_idstringpayment_collection_idstringThe ID of the associated payment collection.
payment_collection_idstringThe raw amount of the payment.
The authorized amount of the payment.
The raw authorized amount of the payment.
dataRecord<string, unknown>OptionalThe data relevant for the payment provider to process the payment.
dataRecord<string, unknown>Optionalcreated_atstring | DateOptionalWhen the payment was created.
created_atstring | DateOptionalupdated_atstring | DateOptionalWhen the payment was updated.
updated_atstring | DateOptionalcaptured_atstring | DateOptionalWhen the payment was captured.
captured_atstring | DateOptionalcanceled_atstring | DateOptionalWhen the payment was canceled.
canceled_atstring | DateOptionalThe sum of the associated captures' amounts.
The sum of the associated captures' raw amounts.
The sum of the associated refunds' amounts.
The sum of the associated refunds' raw amounts.
The associated captures.
The associated refunds.
The associated payment collection.
The payment session from which the payment is created.
Was this page helpful?