账户流水 ledger-entries

账户余额的每一笔变动,每条带记账后的余额快照。

点击任一接口,右侧显示对应的调用示例。

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

鉴权

请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。

X-API-Key

鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。

约定

分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。

时间一律 RFC 3339(UTC);金额单位为分。

写操作成功回 200/201/204;重复提交按资源唯一键回 409。

GET/api/v2/ledger-entries列出账户流水

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
kindstring 按流水类别过滤。
startstring 记账时间起(含),RFC 3339。
endstring 记账时间止(不含),RFC 3339。

账户流水对象

字段类型说明
amount_centsinteger 带符号:正为入账,负为扣款。
balance_after_centsinteger 记这一笔后的余额快照。
created_atstring 创建时间
currencystring 金额币种(ISO 4217)。
desstring 备注说明
idinteger 记录 ID
kindstring 流水类型,如充值、扣款。
order_idinteger 关联订单 ID;没有为空。
tenant_idinteger 所属租户(用户)ID

返回与错误

成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。

成功
{
  "id": 1,
  "name": "example"
}
列表
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
失败
{
  "code": "validation_failed",
  "detail": "请求参数不合法",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name 必填"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
开始使用

体验在线演示

访问在线演示,或联系我们获取报价与安装命令