- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
createPaymentSessionsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createPaymentSessionsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates payment sessions. It's used by the Initialize Payment Session Store API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to create payment sessions in your custom flows.
Source CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
CreatePaymentSessionsWorkflowInputCreatePaymentSessionsWorkflowInputThe data to create payment sessions.
CreatePaymentSessionsWorkflowInputCreatePaymentSessionsWorkflowInputpayment_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_idstringdataRecord<string, unknown>OptionalCustom data relevant for the payment provider to process the payment session.
Learn more in this documentation.
dataRecord<string, unknown>OptionalAdditional context that's useful for the payment provider to process the payment session.
Output#
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.
statusPaymentSessionStatuspayment_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?