OpenAPI 接口文档
OpenAPI 接口文档
查询钱包余额
查询当前调用身份可用于 Open API 购买的 USD 余额。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/wallet/balance |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
请求参数
无 Query 和请求体。发送任何 Query 参数都会返回 400009。
请求示例
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/wallet/balance' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>'
响应参数
| 字段 | 类型 | 必定返回 | 说明 |
|---|---|---|---|
available_balance |
string | 是 | 当前可用余额,USD 十进制字符串 |
currency |
string | 是 | 固定为 USD |
成功响应示例
{
"code": 0,
"msg": "success",
"data": {
"available_balance": "125.5000",
"currency": "USD"
},
"next": null
}
可能的错误码
code |
说明 |
|---|---|
400001 |
认证失败 |
400009 |
请求包含不支持的参数 |
500000 |
系统处理失败,请求未完成 |
余额响应不得缓存,也不要写入公开日志或监控标签。