刷新支付会话

正式环境

POST

/store/payment-collections/{id}/sessions/{session_id}

Store API/Payment CollectionsPayment Collections

刷新支付会话的数据以确保其与支付集合同步。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://apifoxmock.com/m1/4997831-4656773-default/store/payment-collections//sessions/'

响应示例

200 - 示例 1

请求参数

Path 参数

string

必需

PaymentCollection 的 ID。

session_id

string

必需

要刷新的支付会话的 ID。

返回响应

🟢200正常

application/json

Body

payment_session

object (Payment Session)

必需

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, 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 payment processing such as capture or refund. Payment sessions can also be used as part of payment collections.

string

支付会话的 ID

必需

示例值:

ps_01G901XNSRM2YS3ASN9H5KG3FZ

cart_id

string | null

必需

为其创建支付会话的购物车的 ID。

示例值:

cart_01G8ZH853Y6TFXWPG5EYE81X63

provider_id

string

必需

负责支付会话的支付提供程序的 ID

示例值:

manual

is_selected

boolean | null

必需

一个标志，指示支付会话是否已被选为将用于完成购买的方法。

示例值:

true

is_initiated

boolean

必需

一个标志，指示是否已启动与第三方提供程序的通信。

默认值:

false

示例值:

true

amount

integer | null

必需

支付会话已授权的金额。

示例值:

100

payment_authorized_at

string <date-time> | null

必需

支付会话获得授权的日期和时区。

created_at

string <date-time>

必需

资源创建时间（含时区）。

updated_at

string <date-time>

必需

资源更新时间（含时区）。

status

enum<string>

必需

指示支付会话的状态。默认为 pending，最终将变为 authorized。支付会话可能具有 requires_more 的状态，以指示客户要完成进一步的操作。

枚举值:

authorizedpendingrequires_moreerrorcanceled

示例值:

pending

data

object

必需

支付提供程序识别、修改和处理支付会话所需的数据。通常，这将是一个保存外部支付会话 ID 的对象，但如果支付提供程序不保存任何状态，则可以为空对象。

示例值:

{}

idempotency_key

string | null

必需

随机生成的密钥，用于在发生故障时继续完成购物车。

cart

object (Cart)

可选

购物车代表一个虚拟购物袋。它可用于完成订单、交换或索赔。

🟠400客户端错误或多个错误

🟠404未找到错误

🟠409无效状态错误

🟠422无效请求错误

🔴500服务器错误

修改于 2024-09-20 08:34:42

授权支付会话

获取支付集合