Listar Limites

Use este endpoint para listar limites de gasto con paginacion basada en cursor y filtros opcionales. Los limites DELETED no se devuelven en los listados.

GET /v1/limits

Listar Limites

cURL

curl --request GET \
  --url https://tracer.lerian.io/v1/limits \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'

200

Example

{
  "limits": [
    {
      "limitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "maxAmount": "1000.00",
      "currency": "<string>",
      "scopes": [
        {
          "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "subType": "<string>"
        }
      ],
      "activeTimeStart": "09:00",
      "activeTimeEnd": "17:00",
      "customStartDate": "2023-11-07T05:31:56Z",
      "customEndDate": "2023-11-07T05:31:56Z",
      "resetAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Autorizaciones

ApiKeyAuthBearerAuth

X-API-Key · string · header · requerido

API Key authentication. Used by single-tenant deployments (MULTI_TENANT_ENABLED=false). Sent on every /v1/* request.

Encabezados

Content-Type · string · requerido

El tipo de medio del recurso. Debe ser application/json.

X-API-Key · string · requerido

La clave API para autenticacion. Este encabezado es requerido para todos los endpoints excepto verificaciones de salud.

X-Request-Id · string<uuid>

Un identificador unico usado para rastrear y seguir cada solicitud.

Parámetros de consulta

limit · integer · predeterminado: 10

El numero maximo de elementos a incluir en la respuesta. Predeterminado: 10, Maximo: 100

Rango requerido: 1 <= x <= 100

cursor · string

Cursor de paginacion de la respuesta anterior.

name · string

Filter by limit name (exact match).

status · enum<string>

Filtrar por estado (DRAFT, ACTIVE, INACTIVE). Los limites DELETED no son listables.

Opciones disponibles: DRAFT, ACTIVE, INACTIVE

limit_type · enum<string>

Filtrar por tipo de limite.

Opciones disponibles: DAILY, WEEKLY, MONTHLY, CUSTOM, PER_TRANSACTION

account_id · string<uuid>

Filter by account ID (UUID).

segment_id · string<uuid>

Filter by segment ID (UUID).

portfolio_id · string<uuid>

Filter by portfolio ID (UUID).

merchant_id · string<uuid>

Filter by merchant ID (UUID).

transaction_type · enum<string>

Filter by transaction type.

Opciones disponibles: CARD, WIRE, PIX, CRYPTO

sub_type · string

Filter by transaction subtype (e.g., debit, credit, prepaid).

Maximum string length: 50

sort_by · enum<string> · predeterminado: created_at

The field used to sort the results.

Opciones disponibles: created_at, updated_at, name, max_amount

sort_order · enum<string> · predeterminado: DESC

The order used to sort the results.

Opciones disponibles: ASC, DESC

Respuesta

200

application/json

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

Lista paginada de limites de gasto.

limits · object[]

Lista de registros de limites.

Show child attributes

hasMore · boolean

Si hay mas resultados disponibles.

nextCursor · string | null

Cursor para obtener la siguiente pagina. Null si no hay mas resultados.