Files
medusa-store/www/apps/resources/app/commerce-modules/payment/payment-collection/page.mdx
Shahed Nasser 4fe28f5a95 chore: reorganize docs apps (#7228)
* reorganize docs apps

* add README

* fix directory

* add condition for old docs
2024-05-03 17:36:38 +03:00

38 lines
1.9 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
export const metadata = {
title: `Payment Collection`,
}
# {metadata.title}
In this document, youll learn what a payment collection is and how to use it with the Cart Module.
## What's a Payment Collection?
A payment collection stores payment details related to a resource, such as a cart or an order. Its represented by the `PaymentCollection` data model.
Every purchase or request for payment starts with a payment collection. The collection holds details necessary to complete the payment, including:
- The payment sessions that represents the payment amount to authorize.
- The payments that are created when a payment session is authorized. They can be captured and refunded.
- The payment providers that handle the processing of each payment session, including the authorization, capture, and refund.
---
## Usage with the Cart Module
The Cart Module provides cart management features. However, it doesnt provide any features related to accepting payment.
With the Payment Module, you can create a payment collection for the cart and handle the payment functionalities.
The Medusa application creates a link between the `PaymentCollection` and `Cart` data models. It also implements the payment flow during checkout as explained in [this documentation](../payment-flow/page.mdx).
![Diagram showcasing the relation between the Payment and Cart modules](https://res.cloudinary.com/dza7lstvk/image/upload/v1711537849/Medusa%20Resources/cart-payment_ixziqm.jpg)
---
## Multiple Payments
The payment collection supports multiple payment sessions and payments. You can use this to accept payments in increments or split payments across payment providers.
![Diagram showcasing how a payment collection can have multiple payment sessions and payments](https://res.cloudinary.com/dza7lstvk/image/upload/v1711554695/Medusa%20Resources/payment-collection-multiple-payments_oi3z3n.jpg)