createPaymentSessionStep - Medusa Core Workflows Reference

This documentation provides a reference to the createPaymentSessionStep. It belongs to the @medusajs/medusa/core-flows package.

This step creates a payment session.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { createPaymentSessionStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = createPaymentSessionStep({8      "payment_collection_id": "{value}",9      "provider_id": "{value}",10      "amount": 25,11      "currency_code": "zar"12    })13  }14)

Input#

CreatePaymentSessionStepInputCreatePaymentSessionStepInput
The data to create a payment session.
payment_collection_idstring
The ID of the payment collection that the session belongs to.
provider_idstring
The ID of the payment provider that the payment session is associated with.
The payment session's amount.
currency_codestring
The currency code of the payment session.
contextPaymentProviderContextOptional
Additional context that's useful for the payment provider to process the payment session.
dataRecord<string, unknown>Optional
Custom data relevant for the payment provider to process the payment session. Learn more in this documentation.

Output#

PaymentSessionDTOPaymentSessionDTO
The payment session details.
idstring
The ID of the payment session.
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.
The status of the payment session.
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.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break