refundPaymentAndRecreatePaymentSessionWorkflow - Medusa Core Workflows Reference

v2.8.4

Help

Get Started
Product
Build
Tools
Reference
User Guide

Was this page helpful?

Input#

refundPaymentAndRecreatePaymentSessionWorkflowInputrefundPaymentAndRecreatePaymentSessionWorkflowInput

The data to create payment sessions.

payment_collection_idstring

The ID of the payment collection to create payment sessions for.

provider_idstring

The 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.

payment_idstring

The ID of the payment to refund.

amountBigNumberInput

The amount to refund.

customer_idstringOptional

The ID of the customer that the payment session should be associated with.

dataRecord<string, unknown>Optional

Custom data relevant for the payment provider to process the payment session. Learn more in this documentation.

contextRecord<string, unknown>Optional

Additional context that's useful for the payment provider to process the payment session. Currently all of the context is calculated within the workflow.

notestringOptional

The note to attach to the refund.

Output#

PaymentSessionDTOPaymentSessionDTO

The payment session details.

idstring

The ID of the payment session.

amountBigNumberValue

The amount to authorize.

currency_codestring

The 3 character currency code of the payment session.

provider_idstring

The ID of the associated payment provider.

dataRecord<string, unknown>

The data necessary for the payment provider to process the payment session.

statusPaymentSessionStatus

The status of the payment session.

created_atstring | Date

When the payment session was created

updated_atstring | Date

When the payment session was updated

payment_collection_idstring

The ID of the associated payment collection.

contextRecord<string, unknown>Optional

The context necessary for the payment provider.

authorized_atDateOptional

When the payment session was authorized.

payment_collectionPaymentCollectionDTOOptional

The payment collection the session is associated with.

paymentPaymentDTOOptional

The payment created from the session.

refundPaymentAndRecreatePaymentSessionWorkflow - Medusa Core Workflows Reference

Examples#

Steps#

Input#

Output#