版本 2.4.8 · 最新
我的账户 account
当前用户自己的余额与冻结状态;管理员改用户账户走用户管理下的账户接口。
点击任一接口,右侧显示对应的调用示例。
支付与账户鉴权: 用户2 个接口
鉴权
请求头带 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/account我的账户
鉴权: 用户
PUT
/api/v2/account/currency改我的账户货币
鉴权: 用户
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
currency必填 | string | 账户货币(ISO 4217);余额、充值与扣款都按它记。 |
我的账户对象
| 字段 | 类型 | 说明 |
|---|---|---|
active_packages | integer | 生效中套餐数(end_at 晚于现在,改账户货币的阻碍之一)。只有管理员 GET /users/{user_id}/account 带。 |
balance_cents | integer | 账户余额(分)。 |
currencies | AccountCurrencyOption[] | 可选的启用货币(基准在前,其余按 code);仅 currency_changeable 为 true 时带,只有 GET /account 与管理员 GET /users/{user_id}/account。 |
currency | string | 账户货币(ISO 4217);余额、充值与扣款都按它记。 |
currency_changeable | boolean | 租户自己现在能不能改账户货币(余额 0、无未付款订单、无生效中套餐)。只有 GET /account 与管理员 GET /users/{user_id}/account 带。 |
default_currency | string | 新用户默认的账户货币(ISO 4217);租户端判断「账户币没动过」用(现币 = 它才按界面语言预选)。与 currencies 同时带,仅 currency_changeable 为 true 时有,只有 GET /account 与管理员 GET /users/{user_id}/account。 |
freeze_reason | string | 冻结原因;未冻结为空。 |
frozen | boolean | 是否已冻结;冻结后扣款一律被拒。 |
unpaid_orders | integer | 未付款订单数(改账户货币的阻碍之一)。只有管理员 GET /users/{user_id}/account 带,其余读写接口不带。 |
updated_at | string | 更新时间 |
user_id | integer | 用户 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"
}