Saltar al contenido principal
POST
Crear un Limite

Autorizaciones

X-API-Key
string
header
requerido

Autenticación por API Key. Utilizada por los despliegues de inquilino único (MULTI_TENANT_ENABLED=false). Se envía en cada solicitud /v1/*.

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