Saltar al contenido principal
POST
/
v1
/
limits
Crear un Limite
curl --request POST \
  --url https://tracer.lerian.io/v1/limits \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Limite Corporativo Diario",
  "description": "Limite de gasto diario para segmento corporativo",
  "limitType": "DAILY",
  "maxAmount": "50000.00",
  "currency": "BRL",
  "scopes": [
    {
      "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f",
      "transactionType": "CARD"
    }
  ]
}
'
{ "limitId": "019c96a0-0c0d-7915-84b9-e497bfee9916", "name": "Limite Corporativo Diario", "description": "Limite de gasto diario para segmento corporativo", "limitType": "DAILY", "maxAmount": "50000.00", "currency": "BRL", "scopes": [ { "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f", "transactionType": "CARD" } ], "status": "DRAFT", "resetAt": "2026-01-31T00:00:00Z", "createdAt": "2026-01-30T10:00:00Z", "updatedAt": "2026-01-30T10:00:00Z" }

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Autorizaciones

​
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.

Cuerpo

application/json

Entrada para crear un nuevo limite de gasto.

​
name
string
requerido

Nombre de limite legible para humanos.

Required string length: 1 - 255
​
limitType
enum<string>
requerido

Tipo de limite (no puede ser cambiado despues de la creacion).

Opciones disponibles:
DAILY,
WEEKLY,
MONTHLY,
CUSTOM,
PER_TRANSACTION
​
maxAmount
string
requerido

Monto decimal maximo.

Pattern: ^(?:[1-9]\d*(?:\.\d{1,2})?|0\.(?:0[1-9]|[1-9]\d))$
Ejemplo:

"1000.00"

​
currency
string
requerido

Codigo de moneda ISO 4217 (no puede ser cambiado despues de la creacion).

Required string length: 3
​
scopes
object[]
requerido

Al menos un alcance es requerido.

Required array length: 1 - 100 elements
​
description
string
Maximum string length: 1000
​
activeTimeStart
string

Inicio de la ventana diaria activa en formato HH:mm.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
Ejemplo:

"09:00"

​
activeTimeEnd
string

Fin de la ventana diaria activa en formato HH:mm.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
Ejemplo:

"17:00"

​
customStartDate
string<date-time>

Fecha inicial para limites CUSTOM. Requerida cuando limitType es CUSTOM.

​
customEndDate
string<date-time>

Fecha final para limites CUSTOM. Requerida cuando limitType es CUSTOM.

Respuesta

Indica que el limite fue creado exitosamente en estado DRAFT.

Limite de gasto.

​
limitId
string<uuid>

Identificador unico del limite.

​
name
string

Nombre de limite legible para humanos.

Maximum string length: 255
​
description
string

Proposito y explicacion de uso del limite.

Maximum string length: 1000
​
limitType
enum<string>

Tipo de limite (inmutable despues de la creacion).

Opciones disponibles:
DAILY,
WEEKLY,
MONTHLY,
CUSTOM,
PER_TRANSACTION
​
maxAmount
string

Monto decimal maximo.

Pattern: ^(?:[1-9]\d*(?:\.\d{1,2})?|0\.(?:0[1-9]|[1-9]\d))$
Ejemplo:

"1000.00"

​
currency
string

Codigo de moneda ISO 4217 (inmutable despues de la creacion).

Required string length: 3
​
scopes
object[]

Alcances que determinan a que transacciones aplica este limite.

​
status
enum<string>

Estado del ciclo de vida del limite.

Opciones disponibles:
DRAFT,
ACTIVE,
INACTIVE,
DELETED
​
activeTimeStart
string

Inicio de la ventana diaria activa en formato HH:mm. Omitido cuando el limite esta activo todo el dia.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
Ejemplo:

"09:00"

​
activeTimeEnd
string

Fin de la ventana diaria activa en formato HH:mm. Omitido cuando el limite esta activo todo el dia.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
Ejemplo:

"17:00"

​
customStartDate
string<date-time>

Fecha inicial para limites CUSTOM.

​
customEndDate
string<date-time>

Fecha final para limites CUSTOM.

​
resetAt
string<date-time> | null

Cuando el contador del limite se reinicia. Null para limites PER_TRANSACTION.

​
createdAt
string<date-time>

Cuando se creo el limite.

​
updatedAt
string<date-time>

Cuando se modifico el limite por ultima vez.

​
deletedAt
string<date-time> | null

Cuando se elimino el limite (null si no fue eliminado).