跳转到主要内容
1签 (OneSign)

AccountOrders

本页内容

自己账号的订单列表。通过游标分页,并留意历史记录的完整性说明。

如何阅读本模型

先从下方相关接口确认该模型用于请求还是响应,再按字段层级读取。请求模型由调用方填写,响应模型由平台返回;同名字段在不同模型中可能含义不同。

应用、版本、任务和回执的区别见基本概念。需要一份可跟做的示例时,从相关接口进入对应产品指南。

字段定义

“必需”指字段所在的对象出现时,该字段是否必须存在。类型中含 null 表示值允许为空;未返回、null、空字符串和零分别处理。

字段必需说明
items 是

与当前请求条件匹配的记录。数组元素的字段见下方各行。

类型:object[]

items[].id 是

该条记录的公开标识。调用后续接口时请完整保留,包括前缀。

类型:string

items[].app_id 是

业务应用的完整 ID,来自列出应用或预留新应用的响应。

类型:string | null

查看取值约束
  • 格式 ^A[a-f0-9]{32}$
items[].order_number 是

供业务对账的订单编号。退款路径请使用 order_id。

类型:string

items[].description 是

订单的商品或交易说明。

类型:string

items[].amount 是

以站内单位表示的金额,小数字符串应原样传递。

类型:string

查看取值约束
  • 格式 ^-?[0-9]{1,11}\.[0-9]{2}$
items[].status 是

业务状态,请按本字段列出的取值处理。

类型:string

查看取值约束
  • 可选值 paid / pending / closed / refunded / unknown
  • paid — 订单已支付
  • pending — 订单待支付
  • closed — 订单已关闭
  • refunded — 订单已退款
  • unknown — 暂无法识别状态
items[].payment_method 是

付款方式或订单来源。余额支付用 balance,历史订单中的 admin 表示后台充值。

类型:string

查看取值约束
  • 可选值 alipay / wechat / balance / admin / usdt_gateway / usdt_tron / other
  • alipay — 支付宝
  • wechat — 微信
  • balance — 站内余额
  • admin — 后台充值记录
  • usdt_gateway — USDT 支付网关
  • usdt_tron — TRON USDT
  • other — 其他来源
items[].created_at 是

记录创建时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0
items[].paid_at 是

支付成功时间,Unix 秒。允许为空时表示暂无支付记录。

类型:integer | null

查看取值约束
  • 最小值 0
next_cursor 是

传给下一次请求的 cursor。为 null 表示已到末页。

类型:string | null

查看取值约束
  • 格式 ^O[a-f0-9]{32}$
currency 是

站内金额单位及展示信息,按本站配置解释所有金额。

类型:object

currency.code 是

站内金额单位代码,例如 CNY、USD 或 POINT。

类型:string

currency.unit 是

站点配置的金额单位显示名称。

类型:string

currency.external_settlement 是

外部支付的结算币种以支付渠道为准。

类型:string

historical_complete 是

该列表是否覆盖完整历史,false 时只展示实际留存记录。

类型:boolean

相关接口

下面根据接口定义列出使用本模型的操作,包括嵌套在其他对象中的情况。接口示例展示完整请求和响应;模型本身不会增加任何权限。

作为成功响应