createPaymentSession - Payment Module Reference

This documentation provides a reference to the createPaymentSession method. This belongs to the Payment Module.

This method creates a payment session in a payment collection.

Example

const paymentSession =
  await paymentModuleService.createPaymentSession(
    "pay_col_1",
    {
      provider_id: "stripe",
      currency_code: "usd",
      amount: 3000,
      data: {},
    }
  )

Parameters

paymentCollectionIdstringRequired

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

dataCreatePaymentSessionDTORequired

The details of the payment session.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<PaymentSessionDTO>Required

The payment collection's details.