Balance

Queries the bank account balance associated with the API Key.

Endpoint

GET /api/v2/external/balance

Headers

Header	Type	Required	Description
Authorization	String	Yes	Bearer {access_token}

Example

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

Success Response (200)

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

Field	Type	Description
worked	Boolean	true indicates operation success
balance	Integer	Total account balance in cents
available	Integer	Available balance for operations in cents
pending	Integer	Amount held in pending transactions in cents
currency	String	Currency code (always BRL)

Values in cents

All values are integers in cents. 1500000 = BRL 15,000.00. Divide by 100 to get the value in BRL.

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)

{
  "worked": false,
  "detail": "Invalid or expired token"
}