Saltar al contenido principal
PATCH
/
v1
/
limits
/
{id}
Actualizar un Limite
curl --request PATCH \
  --url https://tracer.lerian.io/v1/limits/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "maxAmount": "75000.00"
}
'
{
  "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"
}

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.

Parámetros de ruta

​
id
string<uuid>
requerido

El identificador unico del limite que desea recuperar, actualizar o eliminar.

Cuerpo

application/json

Entrada para actualizar un limite. Al menos un campo debe ser proporcionado. limitType y currency son inmutables.

​
name
string
Required string length: 1 - 255
​
description
string
Maximum string length: 1000
​
maxAmount
string

Nuevo monto decimal maximo.

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

"1000.00"

​
scopes
object[]
Required array length: 1 - 100 elements
​
activeTimeStart
string

Nuevo inicio de la ventana diaria activa en formato HH:mm.

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

"09:00"

​
activeTimeEnd
string

Nuevo 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>

Nueva fecha inicial para limites CUSTOM.

​
customEndDate
string<date-time>

Nueva fecha final para limites CUSTOM.

Respuesta

Indica que el limite fue actualizado exitosamente.

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