Saldo

Consulta el saldo de la cuenta bancaria asociada a la API Key.

Endpoint

GET /api/external/balance

Headers

Header	Tipo	Obligatorio	Descripcion
Authorization	String	Si	ApiKey {client_id}:{client_secret}

Ejemplo

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

Respuesta de Exito (200)

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

Campo	Tipo	Descripcion
worked	Boolean	true indica exito en la operacion
balance	Integer	Saldo total en unidades base (/ 10.000 para reales). 3000000 = R$ 300,00
available	Integer	Saldo disponible para operaciones en unidades base. 2700000 = R$ 270,00
pending	Integer	Valor retenido en transacciones pendientes en unidades base. 300000 = R$ 30,00
currency	String	Codigo de la moneda (siempre BRL)

Valores de respuesta en unidades base

Todos los valores de respuesta son enteros en unidades base. Para convertir a reales, divida por 10.000. Ejemplo: 3000000 / 10.000 = R$ 300,00. Nunca use punto flotante.

Relacion entre los campos

• balance = available + pending
• available: valor que puede utilizarse para nuevas transferencias PIX
• pending: suma de los valores en transacciones que aun no han sido liquidadas

Respuesta de Error (401)

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