English
Endpoint 目录

取消尚未进入不可逆支付阶段的托管结账

POST /api/v1/open/hosted/checkout/sessions/{sessionId}/cancel

POST /api/v1/open/hosted/checkout/sessions/{sessionId}/cancel

  • operationId: cancelHostedCheckoutSession
  • 稳定性: stable
  • 认证: Authorization header API Key;所需 scope:catalog:read
  • 幂等: required

参数

名称位置必需类型
sessionIdpathstring

请求体

  • 必需: 是
  • Schema: #/components/schemas/HostedCheckoutCancelRequest

响应与错误

状态说明Schema
200操作成功#/components/schemas/HostedCheckoutSessionResponse
400请求不符合公开契约#/components/schemas/PublicErrorResponse
401认证失败#/components/schemas/PublicErrorResponse
403授权 scope 不足#/components/schemas/PublicErrorResponse
404公开资源不存在#/components/schemas/PublicErrorResponse
409幂等或状态冲突#/components/schemas/PublicErrorResponse
429请求频率受限#/components/schemas/PublicErrorResponse

限流

spec 声明了 429 响应。 Retry-After header 未在 spec 中声明。

  • 顶层结构: { data: object }

成功响应 Schema

{
  "$ref": "#/components/schemas/HostedCheckoutSessionResponse"
}

错误响应 Schema

{
  "$ref": "#/components/schemas/PublicErrorResponse"
}

本页由已验证 public-only OpenAPI artifact 生成;未提供推测性请求示例。

Copyright © 2026