接口端点
查询余额
概述
GET /api/accounts/balances 端点以 { data: [...] } 格式返回已认证账户的余额，兼容遵循巴西央行标准的集成。
端点
GET https://api.fypay.me/api/accounts/balances认证
通过 POST https://api.fypay.me/api/auth/token 获取的 Bearer 令牌。此路由不使用客户端证书。
为兼容起见接受查询参数，但会被忽略：响应始终是令牌所属账户的当前余额。
请求
curl -X GET https://api.fypay.me/api/accounts/balances \
-H "Authorization: Bearer <token>"const response = await fetch('https://api.fypay.me/api/accounts/balances', {
method: 'GET',
headers: {
'Authorization': `Bearer ${token}`,
},
});
const balance = await response.json();import requests
response = requests.get(
'https://api.fypay.me/api/accounts/balances',
headers={
'Authorization': f'Bearer {token}',
}
)
balance = response.json()响应
{
"data": [
{
"eventDate": "2025-01-15T10:30:00.000Z",
"balanceAmount": {
"available": 48734.90,
"blocked": 1500.00,
"overdraft": 0
}
}
]
}响应字段
dataarray余额列表。始终只包含一项。
总余额计算
saldoTotal = available + blocked与标准 API 的对比
标准 API（GET /api/balance） | BACEN API（GET /api/accounts/balances） |
|---|---|
grossBalance | available + blocked |
blockedBalance | blocked |
netBalance | available |
consultedAt | eventDate |
等价示例
// API Padrão
{
"grossBalance": 50234.90,
"blockedBalance": 1500.00,
"netBalance": 48734.90,
"consultedAt": "2025-01-15T10:30:00.000Z"
}
// API BACEN (equivalente)
{
"data": [{
"eventDate": "2025-01-15T10:30:00.000Z",
"balanceAmount": {
"available": 48734.90,
"blocked": 1500.00,
"overdraft": 0
}
}]
}最佳实践
常见错误
| HTTP 状态码 | 原因 | 解决方法 |
|---|---|---|
| 401 | 缺少 Authorization 请求头 | 添加 Authorization: Bearer <token> |
| 401 | 令牌无效或已过期 | 在 POST /api/auth/token 生成新令牌 |