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: <x-api-key>' \
  --data '
{
  "name": "Limite Corporativo Diario",
  "description": "Limite de gasto diario para segmento corporativo",
  "limitType": "DAILY",
  "maxAmount": 5000000,
  "currency": "BRL",
  "scopes": [
    {
      "segmentId": "770e8400-e29b-41d4-a716-446655440002",
      "transactionType": "CARD"
    }
  ]
}
'
{
  "limitId": "ff1e8400-e29b-41d4-a716-446655440050",
  "name": "Limite Corporativo Diario",
  "description": "Limite de gasto diario para segmento corporativo",
  "limitType": "DAILY",
  "maxAmount": 5000000,
  "currency": "BRL",
  "scopes": [
    {
      "segmentId": "770e8400-e29b-41d4-a716-446655440002",
      "transactionType": "CARD"
    }
  ],
  "status": "DRAFT",
  "resetAt": "2026-01-31T00:00:00Z",
  "createdAt": "2026-01-30T10:00:00Z",
  "updatedAt": "2026-01-30T10:00:00Z"
}

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,
MONTHLY,
PER_TRANSACTION
maxAmount
integer
requerido

Monto maximo en centavos.

Rango requerido: x >= 1
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

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,
MONTHLY,
PER_TRANSACTION
maxAmount
integer

Monto maximo en centavos.

Rango requerido: x >= 1
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
resetAt
string<date-time> | null

Cuando el contador del limite se reinicia (solo DAILY/MONTHLY). 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).