Pular para o conteúdo principal
POST
/
v1
/
limits
Criar um 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": "Daily Corporate Limit",
  "description": "Daily spending limit for corporate segment",
  "limitType": "DAILY",
  "maxAmount": 5000000,
  "currency": "BRL",
  "scopes": [
    {
      "segmentId": "770e8400-e29b-41d4-a716-446655440002",
      "transactionType": "CARD"
    }
  ]
}
'
{
  "limitId": "ff1e8400-e29b-41d4-a716-446655440050",
  "name": "Daily Corporate Limit",
  "description": "Daily spending limit for corporate segment",
  "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"
}

Cabeçalhos

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

​
X-API-Key
string
obrigatório

A chave de API para autenticação. Este header é obrigatório para todos os endpoints, exceto verificações de integridade.

​
X-Request-Id
string<uuid>

Um identificador único usado para rastrear cada requisição.

Corpo

application/json

Entrada para criar um novo limite de gastos.

​
name
string
obrigatório

Nome legível do limite.

Required string length: 1 - 255
​
limitType
enum<string>
obrigatório

Tipo de limite (não pode ser alterado após a criação).

Opções disponíveis:
DAILY,
MONTHLY,
PER_TRANSACTION
​
maxAmount
integer
obrigatório

Valor máximo em centavos.

Intervalo obrigatório: x >= 1
​
currency
string
obrigatório

Código de moeda ISO 4217 (não pode ser alterado após a criação).

Required string length: 3
​
scopes
object[]
obrigatório

Pelo menos um escopo é obrigatório.

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

Resposta

Indica que o limite foi criado com sucesso com status DRAFT.

Limite de gastos.

​
limitId
string<uuid>

Identificador único do limite.

​
name
string

Nome legível do limite.

Maximum string length: 255
​
description
string

Propósito e explicação de uso do limite.

Maximum string length: 1000
​
limitType
enum<string>

Tipo de limite (imutável após a criação).

Opções disponíveis:
DAILY,
MONTHLY,
PER_TRANSACTION
​
maxAmount
integer

Valor máximo em centavos.

Intervalo obrigatório: x >= 1
​
currency
string

Código de moeda ISO 4217 (imutável após a criação).

Required string length: 3
​
scopes
object[]

Escopos que determinam a quais transações este limite se aplica.

​
status
enum<string>

Status do ciclo de vida do limite.

Opções disponíveis:
DRAFT,
ACTIVE,
INACTIVE,
DELETED
​
resetAt
string<date-time> | null

Quando o contador do limite é reiniciado (apenas DAILY/MONTHLY). Nulo para limites PER_TRANSACTION.

​
createdAt
string<date-time>

Quando o limite foi criado.

​
updatedAt
string<date-time>

Quando o limite foi modificado pela última vez.

​
deletedAt
string<date-time> | null

Quando o limite foi excluído (nulo se não excluído).