Cuánto has consumido frente a tus límites

GET/limits/usageProbar

ServidorURL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

Parámetros de consultaassetPor defecto `BS`customerIdstringConsumo de un usuario tuyo

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

GET

/limits/usage

const url = 'http://localhost:3000/v1/limits/usage?asset=BS';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/v1/limits/usage?asset=BS' \
  --header 'x-api-key: <x-api-key>'

Scope payments:read. Tu consumo del día y del mes frente a la regla que se te aplica. Úsalo antes de lanzar un lote.

Al superar un límite la dispersión se rechaza con 422 limit_exceeded, y error.meta dice cuál (per_tx_max, daily_max, monthly_max o daily_count_max), el tope y el alcance.

Los límites tienen instrumento: un mismo importe puede caber por transferencia y no por pago móvil, cuyo tope por operación es 100.000,00 Bs. También hay límites por beneficiario.

Precedencia: beneficiary > customer > tenant > platform, y dentro de cada uno, instrumento concreto antes que *. El más específico gana ENTERO: no se intersecan los topes, se sustituyen.

OJO: esta consulta devuelve el acumulado del ACTIVO, sin separar por instrumento. La comprobación que hace la dispersión sí filtra por instrumento, así que si tienes topes distintos por instrumento usa esta cifra como orientación, no como cálculo exacto. Lo que quedó en failed o reversed no cuenta: se compensó y no salió dinero.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

asset

string

Allowed values: BS USD USDC VESC

Por defecto BS

customerId

string format: uuid

Consumo de un usuario tuyo

Responses

200

Consumo y límite aplicable

application/json

object

asset

string

Allowed values: BS USD USDC VESC

usage

object

day_amount

Importe dispersado hoy

string

day_count

Operaciones de hoy

string

month_amount

Importe dispersado este mes

string

limit

La regla aplicable. null si no hay ninguna configurada

object

scope

string

Allowed values: beneficiary customer tenant platform

method

Instrumento al que aplica, o *

string

per_tx_max

string

nullable

daily_max

string

nullable

monthly_max

string

nullable

daily_count_max

string

nullable

Example

{
  "asset": "BS",
  "usage": {
    "day_amount": "45371900",
    "day_count": "38",
    "month_amount": "912440000"
  },
  "limit": {
    "scope": "tenant",
    "method": "*",
    "per_tx_max": "10000000",
    "daily_max": "500000000",
    "monthly_max": null,
    "daily_count_max": null
  }
}