chore(docs): Generated API Reference (#4706)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions

View File

@@ -1,11 +1,12 @@
title: Payment Session
description: >-
Payment Sessions are created when a Customer initilizes the checkout flow, and
A Payment Session is created when a Customer initilizes the checkout flow, and
can be used to hold the state of a payment flow. Each Payment Session is
controlled by a Payment Provider, who is responsible for the communication
controlled by a Payment Provider, which is responsible for the communication
with external payment services. Authorized Payment Sessions will eventually
get promoted to Payments to indicate that they are authorized for
capture/refunds/etc.
get promoted to Payments to indicate that they are authorized for payment
processing such as capture or refund. Payment sessions can also be used as
part of payment collections.
type: object
required:
- amount
@@ -26,16 +27,17 @@ properties:
type: string
example: ps_01G901XNSRM2YS3ASN9H5KG3FZ
cart_id:
description: The id of the Cart that the Payment Session is created for.
description: The ID of the cart that the payment session was created for.
nullable: true
type: string
example: cart_01G8ZH853Y6TFXWPG5EYE81X63
cart:
description: A cart object. Available if the relation `cart` is expanded.
description: The details of the cart that the payment session was created for.
x-expandable: cart
nullable: true
$ref: ./Cart.yaml
provider_id:
description: The id of the Payment Provider that is responsible for the Payment Session
description: The ID of the Payment Provider that is responsible for the Payment Session
type: string
example: manual
is_selected: