0462cc5acf
- Change existing data model guides and add new ones for DML - Change module's docs around service factory + remove guides that are now necessary - Hide/remove all mentions of module relationships, or label them as coming soon. - Change all data model creation snippets to use DML - use `property` instead of `field` when referring to a data model's properties. - Fix all snippets in commerce module guides to use new method suffix (no more main model methods) - Rework recipes, removing/hiding a lot of sections as a lot of recipes are incomplete with the current state of DML. ### Other changes - Highlight fixes in some guides - Remove feature flags guide - Fix code block styles when there are no line numbers. ### Upcoming changes in other PRs - Re-generate commerce module references (for the updates in the method names) - Ensure that the data model references are generated correctly for models using DML. - (probably at a very later point) revisit recipes
36 lines
1.5 KiB
Plaintext
36 lines
1.5 KiB
Plaintext
export const metadata = {
|
||
title: `Payment Session`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
In this document, you’ll learn what a payment session is.
|
||
|
||
## What's a Payment Session?
|
||
|
||
A payment session, represented by the [PaymentSession data model](/references/payment/modules/PaymentSession), is a payment amount to be authorized. It’s associated with a payment provider that handles authorizing it.
|
||
|
||
A payment collection can have multiple payment sessions. For example, during checkout, when a customer chooses between paying with Stripe or PayPal, each of these payment options is a payment session associated with a payment provider (Stripe or PayPal).
|
||
|
||
|
||
|
||
---
|
||
|
||
## data Property
|
||
|
||
Payment providers may need additional data to process the payment later. The `PaymentSession` data model has a `data` property used to store that data.
|
||
|
||
For example, the customer's ID in Stripe is stored in the `data` property.
|
||
|
||
---
|
||
|
||
## Payment Session Status
|
||
|
||
The `status` property of a payment session indicates its current status. Its value can be:
|
||
|
||
- `pending`: The payment session is awaiting authorization.
|
||
- `requires_more`: The payment session requires an action before it’s authorized. For example, to enter a 3DS code.
|
||
- `authorized`: The payment session is authorized.
|
||
- `error`: An error occurred while authorizing the payment.
|
||
- `canceled`: The authorization of the payment session has been canceled.
|