docs: general updates and fixes (#13374)

* docs: general updates and fixes

* fix lint errors
This commit is contained in:
Shahed Nasser
2025-09-02 09:07:07 +03:00
committed by GitHub
parent c717535ca2
commit 24199fa47a
25 changed files with 477 additions and 396 deletions
@@ -10,7 +10,7 @@ export const metadata = {
# {metadata.title}
In this document, you'll learn about the options of the Payment Module.
In this document, you'll learn about the options you can pass to the Payment Module.
## All Module Options
@@ -97,7 +97,7 @@ In this document, you'll learn about the options of the Payment Module.
## providers Option
The `providers` option is an array of payment module providers.
The `providers` option is an array of payment module providers to be registered in your Medusa application.
When the Medusa application starts, these providers are registered and can be used to process payments.
@@ -131,6 +131,8 @@ module.exports = defineConfig({
The `providers` option is an array of objects that accept the following properties:
- `resolve`: A string indicating the package name of the module provider or the path to it relative to the `src` directory.
- `resolve`: A string indicating the package name of the module provider or the path to it.
- `id`: A string indicating the provider's unique name or ID.
- `options`: An optional object of the module provider's options.
- `options`: An optional object of the module provider's options.
Refer to the [Payment Module Providers](../payment-provider/page.mdx) documentation to learn more.
@@ -12,7 +12,7 @@ A payment collection stores payment details related to a resource, such as a car
Every purchase or request for payment starts with a payment collection. The collection holds details necessary to complete the payment, including:
- The [payment sessions](../payment-session/page.mdx) that represents the payment amount to authorize.
- The [payment sessions](../payment-session/page.mdx) that represent the payment amount to authorize.
- The [payments](../payment/page.mdx) that are created when a payment session is authorized. They can be captured and refunded.
- The [payment providers](../payment-provider/page.mdx) that handle the processing of each payment session, including the authorization, capture, and refund.
@@ -32,8 +32,6 @@ You can use this to accept payments in increments or split payments across payme
The Cart Module provides cart management features. However, it doesnt provide any features related to accepting payment.
During checkout, the Medusa application links a cart to a payment collection, which will be used for further payment processing.
It also implements the payment flow during checkout as explained in [this documentation](../payment-flow/page.mdx).
During checkout, the Medusa application links a cart to a payment collection, which will be used for further payment processing. It also implements the [payment flow](../payment-flow/page.mdx) during checkout.
![Diagram showcasing the relation between the Payment and Cart modules](https://res.cloudinary.com/dza7lstvk/image/upload/v1711537849/Medusa%20Resources/cart-payment_ixziqm.jpg)