§ API REFERENCE

查询供应积分摘要

GET/credit-balancescope: usage:read

读取当前 APP 绑定机构的可用与冻结供应积分,用于容量预警;不返回账户ID或流水。

鉴权:Authorization: Bearer <access_token>。
§ 1

请求信息

GET https://api.lingxiguangnian.com/api/open/v1/credit-balance

请求头

参数类型必填说明
AuthorizationstringBearer <access_token>。由 POST /token 换取,有效期 2 小时;api_secret 不得直连业务端点(→ 401)。
§ 2

调用示例

curl "https://api.lingxiguangnian.com/api/open/v1/credit-balance" -H "Authorization: Bearer oat_xxxxxxxxxxxxxxxx"
§ 3

返回结果

返回字段

参数类型必填说明
account_statusstring机构B账户状态;未开户为 NOT_OPENED。
available_creditsnumber数据库正式派生的当前可用积分。
frozen_creditsnumber当前冻结积分。
updated_atdatetime | null额度桶最近更新时间。
{
  "success": true,
  "data": { "account_status": "ACTIVE", "available_credits": 815, "frozen_credits": 5, "updated_at": "2026-08-14T10:00:00Z" }
}
§ 4

端点错误码

通用鉴权、scope 与限流错误见「使用概述」;下表为本端点专属错误。

HTTPerror_code触发条件
500open_api.credit_balance_query_failed供应积分查询失败。

契约真源:apps/m-master/src/app/api/open/v1/credit-balance/route.ts