API Reference
API Reference

业务对象

结账会话(Checkout Session)业务对象字段说明

属性名类型描述
idintcheckout session id
access_nostring接入方编号
merchant_idstring商户唯一标识
order_idstring接入方订单号
trade_idstring交易单ID
customerCustomer顾客信息
statusstringcheckout session 状态:
  • open: 创建成功
  • expire: 过期
  • complete: 交易完成
expire_timeint有效期(秒), 使用创建时间加上有效期可计算过期时间
return_urlstring支付成功跳转地址
cancel_urlstring取消支付跳转地址
callback_urlstringwebhook 通知地址
session_urlstringCheckout页面URL
modestring支付模式,用于判断是否校验商品信息:
  • checkout:校验商品数据,默认值
  • payment:不校验商品数据
total_amountstring总金额
integration_methodstring集成模式:
  • hosted:托管式,默认为该模式
  • embedded :嵌入式集成
redirect_on_completionstring嵌入式ui模式的重定向行为
  • always: 支付成功后,会自动重定向到 return_url
  • if_required: 仅在有重定向的付款方式才会重定向到return_url
created_atstring创建时间
payment_tokenstring订阅支付时,返回的支付凭证,用于后续订阅续费
metadatamap[string]string一组可附加到对象上的键值对,允许您以结构化格式存储附加信息。

Customer

属性名类型描述
idstring顾客iD
payer_idstring接入方顾客的ID
emailstring顾客邮箱
These developer docs retire on 2026-08-30. Visit the new docs: NEW DOCS本开发者文档将于 2026-08-30下线,请访问新版文档: 新文档