authorizePaymentSession - Payment Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method authorizes a payment session using its associated payment provider. This creates a payment that can later be captured.

Learn more about the payment flow in this guide

Example#

Code
1const payment =2  await paymentModuleService.authorizePaymentSession(3    "payses_123",4    {}5  )

Parameters#

idstring
The payment session's ID.
contextRecord<string, unknown>
Context data to pass to the associated payment provider.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<PaymentDTO>
The created payment.
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