余额查询

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

端点

GET /api/external/balance

请求头

头	类型	必填	描述
Authorization	String	是	ApiKey {client_id}:{client_secret}

示例

curl -X GET https://api.owem.com.br/api/external/balance \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

成功响应 (200)

{
  "worked": true,
  "balance": 3000000,
  "available": 2700000,
  "pending": 300000,
  "currency": "BRL"
}

字段	类型	描述
worked	Boolean	true 表示操作成功
balance	Integer	总余额，以基本单位为单位（/ 10,000 = 雷亚尔）。3000000 = R$ 300.00
available	Integer	可用于操作的余额，以基本单位为单位。2700000 = R$ 270.00
pending	Integer	待处理交易中的冻结金额，以基本单位为单位。300000 = R$ 30.00
currency	String	货币代码（始终为 BRL）

响应金额以基本单位表示

所有响应金额均为基本单位整数。要转换为雷亚尔，请除以 10,000。 示例：3000000 / 10,000 = R$ 300.00。切勿使用浮点数。

字段关系

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

错误响应 (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}