refundPaymentAndRecreatePaymentSessionWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the refundPaymentAndRecreatePaymentSessionWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow refunds a payment and creates a new payment session.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
refundPaymentAndRecreatePaymentSessionWorkflowInputrefundPaymentAndRecreatePaymentSessionWorkflowInputThe data to create payment sessions.
refundPaymentAndRecreatePaymentSessionWorkflowInputrefundPaymentAndRecreatePaymentSessionWorkflowInputpayment_collection_idstringThe ID of the payment collection to create payment sessions for.
payment_collection_idstringprovider_idstringThe ID of the payment provider that the payment sessions are associated with.
This provider is used to later process the payment sessions and their payments.
provider_idstringpayment_idstringThe ID of the payment to refund.
payment_idstringamountBigNumberInputThe amount to refund.
amountBigNumberInputcustomer_idstringOptionalThe ID of the customer that the payment session should be associated with.
customer_idstringOptionaldataRecord<string, unknown>OptionalCustom data relevant for the payment provider to process the payment session.
Learn more in this documentation.
dataRecord<string, unknown>OptionalcontextRecord<string, unknown>OptionalAdditional context that's useful for the payment provider to process the payment session.
Currently all of the context is calculated within the workflow.
contextRecord<string, unknown>OptionalnotestringOptionalThe note to attach to the refund.
notestringOptionalOutput#
PaymentSessionDTOPaymentSessionDTOThe payment session details.
PaymentSessionDTOPaymentSessionDTOidstringThe ID of the payment session.
idstringamountBigNumberValueThe amount to authorize.
amountBigNumberValuecurrency_codestringThe 3 character currency code of the payment session.
currency_codestringprovider_idstringThe ID of the associated payment provider.
provider_idstringdataRecord<string, unknown>The data necessary for the payment provider to process the payment session.
dataRecord<string, unknown>statusPaymentSessionStatusThe status of the payment session.
statusPaymentSessionStatuscreated_atstring | DateWhen the payment session was created
created_atstring | Dateupdated_atstring | DateWhen the payment session was updated
updated_atstring | Datepayment_collection_idstringThe ID of the associated payment collection.
payment_collection_idstringcontextRecord<string, unknown>OptionalThe context necessary for the payment provider.
contextRecord<string, unknown>Optionalauthorized_atDateOptionalWhen the payment session was authorized.
authorized_atDateOptionalThe payment collection the session is associated with.
The payment created from the session.
Was this page helpful?