API Reference
API Reference

创建结账会话

创建结账会话

Body Params

创建 checkout session 的请求

string
required

接入方订单号

string

Subotiz 平台顾客唯一标识,需提前在 Subotiz 创建。payer_id 、customer_id 和 email 必须存在其一

string

顾客邮箱

line_items
array of objects
required

本次结账包含的商品定价数组(目前仅支持一个 lineItem)

line_items*
string

顾客支付成功之后跳转的 URL。若调用时传入了 URL,则优先使用传入值。若未传入,则自动使用开发者信息中的默认配置。

string

顾客取消支付之后跳转的 URL。若调用时传入了 URL,则优先使用传入值。若未传入,则自动使用开发者信息中的默认配置。

string

支付模式,用于判断是否校验商品信息:

  • checkout:校验商品数据,默认值
  • payment:不校验商品数据
string

接入方的顾客 ID,如果传入的 ID 不存在与 Subotiz 系统中,那么会自动创建顾客,每个商户下的 payer_id 是唯一的。

string

集成模式:

  • hosted:托管式,默认为该模式
  • embedded :嵌入式集成
string

支付金额,当 mode 选择 payment 模式时必填金额。

string

嵌入式ui模式的重定向行为

  • always: 支付成功后,会自动重定向到 return_url
  • if_required: 仅在有重定向的付款方式才会重定向到return_url
string

指定结账会话所使用的语言,默认根据浏览器语言确定。
可选值:

  • ar-SA:阿拉伯语(沙特阿拉伯)
  • de-DE:德语(德国)
  • en-US:英语(美国)
  • es-ES:西班牙语(西班牙)
  • fr-FR:法语(法国)
  • id-ID:印尼语(印度尼西亚)
  • it-IT:意大利语(意大利)
  • ja-JP:日语(日本)
  • ko-KR:韩语(韩国)
  • nl-NL:荷兰语(荷兰)
  • pl-PL:波兰语(波兰)
  • pt-PT:葡萄牙语(葡萄牙)
  • ru-RU:俄语(俄罗斯)
  • th-TH:泰语(泰国)
  • zh-CN:中文(中国大陆)
  • zh-TW:中文(中国台湾)
string

指定结账会话的订单结算币种,传入平台支持的 ISO 4217 货币代码,如 USD、CNY。系统会以店铺主货币为基准,将订单金额换算为该币种进行展示与计价;未传 merchant_rate 时,系统默认按当日实时汇率完成换算。

string

指定店铺主货币兑换 target_currency 的自定义汇率,传入值须为大于 0 的数字,且必须与 target_currency 同时传入。该字段仅在订单结算币种与店铺主货币不一致时使用。汇率方向为“1 单位店铺主货币可兑换的 target_currency 金额”。例如:店铺主货币为 USD,target_currency 为 CNY,传入 7.999 表示 1 USD = 7.999 CNY,系统将按该汇率计算订单金额。

metadata
object

一组可附加到对象上的键值对,允许您以结构化格式存储附加信息。

subscription_data
object

传递给结账会话中订阅创建的子集参数

trade_data
object

传递给结账会话中交易创建的子集参数

string

首次交易来源渠道识别,用于交易归因统计,长度限制为 50 个字符。

billing_address_data
object

账单地址信息

string

支付业务模式:

  • onetime_payment:一次性支付模式。仅处理单次支付交易,不创建任何重复支付令牌。
  • subscription:订阅支付模式。处理初始支付,并生成用于自动重复支付的支付令牌。后续的续费费用将根据订阅计划配置使用此令牌进行处理。
int32

试用期定价限制试用 1 次. 1: 不限制, 2:限制试用一

int32

订阅固定期限,取值正整数

boolean

是否支持固定期限转为持续订阅

Headers
string
required
Defaults to 008e3967-a1b5-48bb-be14-d5bff5092e61

请求的唯一标识符

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json