版本 2.1.1792967583 · 最新 下载 OpenAPI Markdown 版

订单

充值、扣款、在线支付与套餐购买产生的订单;租户只见本租户,管理员可跨租户,订单只许改备注。

orders支付与账户鉴权: 用户(部分参数仅管理员)4 个接口

列出订单

GET/api/v2/orders
鉴权: 用户(部分参数仅管理员)

查询参数

字段类型必填说明
pageinteger— 页码,从 1 开始。
默认 1
page_sizeinteger— 每页条数。
默认 20
sortstring— 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
tenant_idinteger— 仅管理员可用:按租户过滤。租户凭据调用时忽略,只返回本租户数据。
typestring— 按订单类型过滤(recharge/deduct/payment/package 等)。
statusstring— 按状态过滤。
可选值 ["unpaid","paid"]
startstring— 下单时间起(含),RFC 3339。
endstring— 下单时间止(不含),RFC 3339。

订单金额统计

GET/api/v2/orders/stats
鉴权: 用户(部分参数仅管理员)

查询参数

字段类型必填说明
tenant_idinteger— 仅管理员可用:按租户过滤。租户凭据调用时忽略,只返回本租户数据。
typestring— 按订单类型过滤(recharge/deduct/payment/package 等)。
statusstring— 按状态过滤。
可选值 ["unpaid","paid"]
startstring— 下单时间起(含),RFC 3339。
endstring— 下单时间止(不含),RFC 3339。
group_bystring— 汇总粒度,缺省 day。
可选值 ["day","month","year"]
utc_offset_minutesinteger— 已废弃,仅为兼容旧调用方保留(仍校验取值范围)。日/月/年恒按平台时区(Asia/Shanghai)切分,与今日流量同一日界,不再随此参数平移。

获取订单

GET/api/v2/orders/{id}
鉴权: 用户(部分参数仅管理员)

改订单备注

PUT/api/v2/orders/{id}
鉴权: 仅管理员

请求体 application/json

字段类型必填说明
desstring必填 备注说明

订单对象

字段类型必填说明
amount_centsinteger— 金额(分),扣款单为负。
archivedboolean— 已被归档任务搬进档案表(只读)。
created_atstring— 创建时间
只读
dataobject— 附加数据(如套餐购买明细)。
desstring— 备注说明
group_bystring— 汇总粒度:day、month 或 year。
可选值 ["day","month","year"]
idinteger— 记录 ID
只读
itemsOrderStatsItem[]— 本页条目
ledger_idinteger— 关联的账户流水 ID;没有则为空。
mch_order_nostring— 商户订单号(网关侧订单号);非在线支付为空。
paid_atstring— 付款时间;未付款为空。
pay_typestring— admin/balance/alipay/wxpay 等;空 = 未付款。
statusstring— 订单状态:unpaid 待付款、paid 已付款。
可选值 ["unpaid","paid"]
tenant_idinteger— 所属租户(用户)ID
只读
transaction_idstring— 网关侧交易号;未付款为空。
typestring— recharge(管理员充值)/deduct(管理员扣款)/payment(在线支付)/package(套餐)等。
updated_atstring— 更新时间
只读