Logo Site EngageLab Mark Colored Transparent文件
搜尋

餘額查詢

用於查詢當前 API Key 所屬應用的可用餘額。查詢應用由 API Key 決定,無需在請求中傳入應用 ID。

調用地址

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

調用驗證

請參考 調用驗證 了解如何進行 API 鑑權。

請求示例

請求頭

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

            
此代碼塊在浮窗中顯示

請求參數

無請求參數。

返回參數

成功返回

字段 類型 選項 描述
currency String 必填 結算幣種,當前固定為 USD(美元)
balance String 必填 普通餘額(充值所得)
gift_balance String 必填 贈送餘額(活動 / 贈送所得,可能帶有效期,過期不計入)
total_balance String 必填 總餘額,等於 balance + gift_balance
{ "currency": "USD", "balance": "123.4500", "gift_balance": "1.0000", "total_balance": "124.4500" }
              
              {
    "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 int 必填 錯誤碼,詳見錯誤碼說明
message String 必填 錯誤詳情
{ "code": 2001, "message": "invalid token" }
              
              {
    "code": 2001,
    "message": "invalid token"
}

            
此代碼塊在浮窗中顯示

錯誤碼

錯誤碼 http code 說明
1000 500 內部錯誤,請稍後重試
2001 401 鑑權失敗,未攜帶正確的 token
2002 401 鑑權失敗,token 已過期或已被禁用
2002 403 應用不可用(已刪除或被禁用)
Icon Solid Transparent White Qiyu
聯繫銷售