Skip to content

Saldo

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

Endpoint

GET /api/v2/external/balance

Encabezados

EncabezadoTipoObligatorioDescripcion
AuthorizationStringSiBearer {access_token}

Ejemplo

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

Respuesta Exitosa (200)

json
{
  "worked": true,
  "balance": 1500000,
  "available": 1450000,
  "pending": 50000,
  "currency": "BRL"
}
CampoTipoDescripcion
workedBooleantrue indica exito en la operacion
balanceIntegerSaldo total de la cuenta en centavos
availableIntegerSaldo disponible para operaciones en centavos
pendingIntegerValor retenido en transacciones pendientes en centavos
currencyStringCodigo de la moneda (siempre BRL)

Valores en centavos

Todos los valores son enteros en centavos. 1500000 = R$ 15.000,00. Divida entre 100 para obtener el valor en reales.

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)

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

Owem Pay Instituição de Pagamento — ISPB 37839059