Skip to content

Saldo

Consulta o saldo da conta bancaria associada a API Key.

Endpoint

GET /api/v2/external/balance

Headers

HeaderTipoObrigatorioDescricao
AuthorizationStringSimBearer {access_token}

Exemplo

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

Resposta de Sucesso (200)

json
{
  "worked": true,
  "balance": 1500000,
  "available": 1450000,
  "pending": 50000,
  "currency": "BRL"
}
CampoTipoDescricao
workedBooleantrue indica sucesso na operacao
balanceIntegerSaldo total da conta em centavos
availableIntegerSaldo disponivel para operacoes em centavos
pendingIntegerValor retido em transacoes pendentes em centavos
currencyStringCodigo da moeda (sempre BRL)

Valores em centavos

Todos os valores sao inteiros em centavos. 1500000 = R$ 15.000,00. Divida por 100 para obter o valor em reais.

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)

json
{
  "worked": false,
  "detail": "Token invalido ou expirado"
}

Owem Pay Instituição de Pagamento — ISPB 37839059