查詢餘額
查詢賬戶餘額
調用地址
GET /v1/balance
調用驗證
採用 HTTP 基本認證 的驗證方式，在 HTTP Header（頭）裡加 Authorization：
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
此代碼塊在浮窗中顯示
上述 base64_auth_string 的生成算法為：base64(dev_key:dev_secret)
請求示例
請求頭
GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
此代碼塊在浮窗中顯示
請求體
無
請求參數
無
返回參數
成功返回
| 字段 | 類型 | 選項 | 描述 |
|---|---|---|---|
| balance10000 | Integer | 必填 | 普通餘額，乘以 10000 後的整型值 |
| gift_balance10000 | Integer | 必填 | 贈送餘額，乘以 10000 後的整型值 |
| balance | Number | 必填 | 普通餘額，浮點型 |
| gift_balance | Number | 必填 | 贈送餘額，浮點型 |
| total_balance10000 | Integer | 必填 | 總餘額，等於普通餘額與贈送餘額之和，乘以 10000 後的整型值 |
| total_balance | Number | 必填 | 總餘額，等於普通餘額與贈送餘額之和，浮點型 |
{
"balance10000": 123456,
"gift_balance10000": 20000,
"balance": 12.3456,
"gift_balance": 2,
"total_balance10000": 143456,
"total_balance": 14.3456
}
{
"balance10000": 123456,
"gift_balance10000": 20000,
"balance": 12.3456,
"gift_balance": 2,
"total_balance10000": 143456,
"total_balance": 14.3456
}
此代碼塊在浮窗中顯示
建議調用方優先使用 balance10000、gift_balance10000 和 total_balance10000 字段自行格式化餘額，避免浮點精度問題。
失敗返回
HTTP 狀態碼為 4xx 或者 5xx，響應體包含字段如下：
| 字段 | 類型 | 選項 | 描述 |
|---|---|---|---|
| code | int | 必填 | 錯誤碼，詳見 錯誤碼 說明 |
| message | String | 必填 | 錯誤詳情 |
{
"code": 2001,
"message": "invalid token"
}
{
"code": 2001,
"message": "invalid token"
}
此代碼塊在浮窗中顯示
錯誤碼
| 錯誤碼 | HTTP Code | 說明 |
|---|---|---|
| 1000 | 500 | 內部錯誤，請稍後重試 |
| 2001 | 401 | 鑒權失敗，未攜帶正確的 token，或 token 對應的商戶不存在 |
| 2002 | 401 | 鑒權失敗，token 已過期或已被禁用 |
| 2002 | 403 | 商戶已被刪除 |
