查询余额
使用此端点查询钱包的当前余额。
可用环境
- 生产环境
https://api.gateway.com.br/core
端点
- 方法：
GET - 端点：
/wallet/balance - 认证方式：Bearer token
请求示例
- cURL
- JavaScript
curl --request GET \
--url https://api.gateway.com.br/core/wallet/balance \
--header 'Authorization: Bearer your-jwt-token'
const response = await fetch('https://api.gateway.com.br/core/wallet/balance', {
method: 'GET',
headers: {
'Authorization': 'Bearer your-jwt-token'
}
});
const data = await response.json();
成功响应
⚠️ 重要：金额以分为单位
所有金额均以分返回。由于手续费的计算方式，余额保留五位小数，因此以分
为单位时可能带有小数部分：余额 R$ 8,488.15900 会返回 848815.9。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
amount | number | 是 | 钱包可用余额。已废弃，仅为兼容保留，请使用 balance |
balance | number | 是 | 钱包可用余额 |
reserve | number | 是 | 处于准备金中的金额 |
pendingDebit | number | 是 | 待处理的扣款 |
frozen | number | 是 | 被冻结的金额 |
响应示例
{
"amount": 10000,
"balance": 10000,
"reserve": 2500,
"pendingDebit": 800,
"frozen": 1200
}
用余额发起提现
提现只接受整数分。若要提出全部余额，请舍去小数部分，不要四舍五入：向上 取整会申请超过钱包实际持有的金额，操作会因余额不足被拒绝。
GET /wallet/balance
{ "balance": 848815.9 }
| 请求 | 结果 | |
|---|---|---|
| 正确 | { "amount": 848815 } | 提现成功 |
| 错误 | { "amount": 848816 } | 余额不足 |
| 错误 | { "amount": 848815.9 } | 400，该字段要求整数 |
在 JavaScript 中使用 Math.floor(balance)。
舍去的小数部分仍留在钱包里，凑满一整分后会计入下一次提现。
可能的错误
| 状态码 | 说明 | 处理方式 |
|---|---|---|
| 401 | 凭据无效 | 请检查您的凭据 |
| 403 | 无权限或未授权 | 请联系技术支持 |
| 404 | 未找到钱包 | 请联系技术支持 |
| 500 | 内部错误 | 请联系技术支持 |