余额查询

用于查询当前 API Key 所属应用的可用余额。查询应用由 API Key 决定，无需在请求中传入应用 ID。

调用地址

GET https://otp.api.engagelab.cc/v1/balance

调用验证

请参考 调用验证 了解如何进行 API 鉴权。

请求示例

请求头

              
              GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

请求参数

无请求参数。

返回参数

成功返回

              
              {
    "currency": "USD",
    "balance": "123.4500",
    "gift_balance": "1.0000",
    "total_balance": "124.4500"
}

            

字段说明

1. 金额均为字符串小数，保留 4 位小数。这样设计是为了避免浮点数在传输与解析过程中产生精度误差，请使用高精度小数类型（如各语言的 BigDecimal / Decimal）解析，不要直接当浮点数运算。
2. 币种：当前所有应用均以美元（USD）结算。
3. 余额可能为负：开通了透支额度的应用，在透支后 balance / total_balance 可能返回负值（如 "-12.3400"），表示已欠费，请及时充值。
4. total_balance 由服务端在同一时刻一致计算得出，可直接用于展示与对账。

失败返回

http 状态码为 4xx 或者 5xx，响应体包含字段如下：

              
              {
    "code": 2001,
    "message": "invalid token"
}

            

错误码