Pular para o conteúdo principal
GET
/
v1
/
limits
/
{id}
Recuperar um Limite
curl --request GET \
  --url https://tracer.lerian.io/v1/limits/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'
{
  "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"
}

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.

Autorizações

​
X-API-Key
string
header
obrigatório

API Key authentication. Used by single-tenant deployments (MULTI_TENANT_ENABLED=false). Sent on every /v1/* request.

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.

Parâmetros de caminho

​
id
string<uuid>
obrigatório

O identificador único do limite que você deseja recuperar, atualizar ou excluir.

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

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,
WEEKLY,
MONTHLY,
CUSTOM,
PER_TRANSACTION
​
maxAmount
string

Valor decimal máximo.

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

"1000.00"

​
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
​
activeTimeStart
string

Início da janela diária ativa no formato HH:mm. Omitido quando o limite fica ativo o dia inteiro.

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

"09:00"

​
activeTimeEnd
string

Fim da janela diária ativa no formato HH:mm. Omitido quando o limite fica ativo o dia inteiro.

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

"17:00"

​
customStartDate
string<date-time>

Data inicial para limites CUSTOM.

​
customEndDate
string<date-time>

Data final para limites CUSTOM.

​
resetAt
string<date-time> | null

Quando o contador do limite é reiniciado. 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).