Balance

Queries the bank account balance associated with the API Key.

Endpoint

GET /api/external/balance

Headers

Header	Type	Required	Description
Authorization	String	Yes	ApiKey {client_id}:{client_secret}

Example

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

Success Response (200)

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

Field	Type	Description
worked	Boolean	true indicates operation success
balance	Integer	Total balance in base units (/ 10,000 for BRL). 3000000 = R$ 300.00
available	Integer	Available balance for operations in base units. 2700000 = R$ 270.00
pending	Integer	Amount held in pending transactions in base units. 300000 = R$ 30.00
currency	String	Currency code (always BRL)

Response values in base units

All response values are integers in base units. To convert to BRL, divide by 10,000. Example: 3000000 / 10,000 = R$ 300.00. Never use floating point.

Relationship between fields

• balance = available + pending
• available: amount that can be used for new PIX transfers
• pending: sum of amounts in transactions not yet settled

Error Response (401)

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