Saldo

Consulta o saldo da conta bancaria associada a API Key.

Endpoint

GET /api/external/balance

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	String	Sim	ApiKey {client_id}:{client_secret}

Exemplo

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

Resposta de Sucesso (200)

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

Campo	Tipo	Descricao
worked	Boolean	true indica sucesso na operacao
balance	Integer	Saldo total em unidades base (÷ 10.000 para reais). 3000000 = R$ 300,00
available	Integer	Saldo disponivel para operacoes em unidades base. 2700000 = R$ 270,00
pending	Integer	Valor retido em transacoes pendentes em unidades base. 300000 = R$ 30,00
currency	String	Codigo da moeda (sempre BRL)

Valores de resposta em unidades base

Todos os valores de resposta sao inteiros em unidades base. Para converter para reais, divida por 10.000. Exemplo: 3000000 ÷ 10.000 = R$ 300,00. Nunca use ponto flutuante.

Relacao entre os campos

• balance = available + pending
• available: valor que pode ser utilizado para novas transferencias PIX
• pending: soma dos valores em transacoes que ainda nao foram liquidadas

Resposta de Erro (401)

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