查询用户余额
GET /api/openapi/user/balance
请求说明
无需额外参数,仅需要在请求头中携带 X-Api-Account 和 X-Api-Key。
返回示例
{
"code": 200,
"msg": "查询成功",
"data": {
"userId": 123,
"userName": "partner01",
"nickName": "合作伙伴01",
"balance": 100.50,
"giveBalance": 50.00,
"totalBalance": 150.50
}
}
返回字段说明
| 字段名称 | 类型 | 说明 |
|---|---|---|
| userId | Long | 用户 ID |
| userName | String | 用户账号 |
| nickName | String | 用户昵称 |
| balance | Decimal | 充值余额(可用于下单) |
| giveBalance | Decimal | 赠送余额(可用于下单) |
| totalBalance | Decimal | 总余额(充值余额 + 赠送余额) |
使用场景
- 在创建任务前查询余额,确保余额充足
- 定期监控账户余额,及时充值
- 对账和财务统计
错误返回示例
{
"code": 500,
"msg": "无效的API密钥"
}