余额查询

查询与 API Key 关联的银行账户余额。

端点

GET /api/v2/external/balance

请求头

请求头	类型	必填	描述
Authorization	String	是	Bearer {access_token}

示例

curl -X GET https://api.owem.com.br/api/v2/external/balance \
  -H "Authorization: Bearer $TOKEN"

成功响应 (200)

{
  "worked": true,
  "balance": 1500000,
  "available": 1450000,
  "pending": 50000,
  "currency": "BRL"
}

字段	类型	描述
worked	Boolean	true 表示操作成功
balance	Integer	账户总余额（分）
available	Integer	可用于操作的余额（分）
pending	Integer	待处理交易中的冻结金额（分）
currency	String	货币代码（始终为 BRL）

金额以分为单位

所有金额均为分的整数值。1500000 = R$ 15,000.00。除以 100 即可得到雷亚尔金额。

字段关系

• balance = available + pending
• available：可用于新的 PIX 转账的金额
• pending：尚未清算的交易金额总和

错误响应 (401)

{
  "worked": false,
  "detail": "Token 无效或已过期"
}