跳到主要内容

查询用户余额

GET /api/openapi/user/balance

请求说明

无需额外参数,仅需要在请求头中携带 X-Api-AccountX-Api-Key

返回示例

{
"code": 200,
"msg": "查询成功",
"data": {
"userId": 123,
"userName": "partner01",
"nickName": "合作伙伴01",
"balance": 100.50,
"giveBalance": 50.00,
"totalBalance": 150.50
}
}

返回字段说明

字段名称类型说明
userIdLong用户 ID
userNameString用户账号
nickNameString用户昵称
balanceDecimal充值余额(可用于下单)
giveBalanceDecimal赠送余额(可用于下单)
totalBalanceDecimal总余额(充值余额 + 赠送余额)

使用场景

  • 在创建任务前查询余额,确保余额充足
  • 定期监控账户余额,及时充值
  • 对账和财务统计

错误返回示例

{
"code": 500,
"msg": "无效的API密钥"
}