查询余额

客户可通过 API Key(sk_live_ 开头)程序化查询组织余额,无需登录态。接口仅接受 API Key 鉴权,余额为组织级。

鉴权

在请求头携带 API Key:

Authorization: Bearer sk_live_YOUR_API_KEY

API Key 在控制台「API Keys」页面创建,绑定到某个组织与项目。

接口

GET/api/business/v1/customer/balance

查询余额

Return the current balance for the API key's organization. API key only.

Bearer API Key请求头使用 Authorization: Bearer sk_live_...,也支持 x-api-key。

请求结构

下方内容用于确认方法、地址和鉴权方式,属于 HTTP 结构片段,不是可独立执行示例。

HTTP
GET https://www.silvamux.com/api/business/v1/customer/balance
Authorization: Bearer $SILVAMUX_API_KEY

请求参数

参数类型与位置必填说明
Authorizationstring · headerBearer API Key (sk_live_...)
X-Organization-Idstring · headerNot required for API key auth

响应

200OK

application/json · CustomerBalanceResponse

字段类型必填说明
$schemastring (uri)A URL to the JSON Schema for this object.
balance_pointsstringCurrent balance in points

defaultError

application/problem+json · ErrorModel

字段类型必填说明
$schemastring (uri)A URL to the JSON Schema for this object.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorsarray<ErrorDetail>Optional list of individual error details
errors.locationstringWhere the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
errors.messagestringError message text
errors.valueanyThe value at the given location
instancestring (uri)A URI reference that identifies the specific occurrence of the problem.
statusinteger (int64)HTTP status code
titlestringA short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring (uri)A URI reference to human-readable documentation for the error.;默认值:about:blank

示例

curl https://www.silvamux.com/api/business/v1/customer/balance \
  -H "Authorization: Bearer $SILVAMUX_API_KEY"

响应:

{
  "balance_points": "42.5"
}
字段说明
balance_points当前余额(points)

错误处理

HTTP 状态错误码说明
401INVALID_TOKENAPI Key 缺失或无效