Logo Site EngageLab Mark Colored Transparent文档
搜索

查询余额

查询账户余额

调用地址

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
}

            
此代码块在浮窗中显示

建议调用方优先使用 balance10000gift_balance10000total_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 商户已被删除
Icon Solid Transparent White Qiyu
联系销售