Beta privada · apertura 23 de diciembre
Consulta tu saldo
GET /v1/cuenta/saldo
Devuelve el saldo disponible y reservado en soles, el tope de la clave que pregunta y el enlace de recarga.
| Dato | Valor |
|---|---|
| Permiso | cuenta:leer |
| Cobro | No cobra. |
Idempotency-Key |
No aplica |
| Herramienta MCP | cuenta_saldo (Próximamente) |
Parámetros
Sección titulada «Parámetros»| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
X-Request-Id |
header | No | string | Identificador de la petición. Va en cada respuesta; menciónalo al escribir a soporte. |
Ejemplo
Sección titulada «Ejemplo»Contra el sandbox, con una clave onx_test_…:
curl "https://api-sandbox.opennexum.com/v1/cuenta/saldo" \ -H "Authorization: Bearer onx_test_…"Respuestas
Sección titulada «Respuestas»Saldo de la cuenta.
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
moneda |
“PEN” | Sí | |
disponible |
string | Sí | Lo que puedes gastar ahora. |
reservado |
string | Sí | Separado para operaciones en curso; se cobra solo si se completan. |
recarga_url |
string (uri) | Sí | Dónde recarga una persona de tu cuenta. |
tope_clave |
object | null | Sí | Tope de la clave con la que preguntas; null si no tiene. |
tope_clave.periodo |
“diario” | “semanal” | “mensual” | “total” | Sí | |
tope_clave.limite |
string | Sí | Monto como texto con dos decimales y punto decimal, sin separador de miles. “1250.50” es S/ 1,250.50. |
tope_clave.consumido |
string | Sí | Monto como texto con dos decimales y punto decimal, sin separador de miles. “1250.50” es S/ 1,250.50. |
tope_clave.renueva_en |
string (date-time) | null | Sí | Cuándo vuelve a cero lo consumido; null en un tope total. |
actualizado_en |
string (date-time) | Sí | Fecha y hora ISO 8601 con la zona de Lima (-05:00). |
Errores
Sección titulada «Errores»Cada código tiene su explicación en Errores.
- 401
clave_invalida - 403
permiso_faltante - 429
limite_uso - 500
error_interno - 501
operacion_no_disponible - 503
no_disponible