Saltar al contenido principal
GET
/
v1
/
limits
Listar Limites
curl --request GET \
  --url https://tracer.lerian.io/v1/limits \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <x-api-key>'
{ "limits": [ { "limitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "description": "<string>", "limitType": "DAILY", "maxAmount": 2, "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", "transactionType": "CARD", "subType": "<string>" } ], "status": "DRAFT", "resetAt": "2023-11-07T05:31:56Z", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "deletedAt": "2023-11-07T05:31:56Z" } ], "hasMore": true, "nextCursor": "<string>" }

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 consulta

​
limit
integer
predeterminado:10

El numero maximo de elementos a incluir en la respuesta. Predeterminado: 10, Maximo: 100

Rango requerido: 1 <= x <= 100
​
cursor
string

Cursor de paginacion de la respuesta anterior.

​
status
enum<string>

Filtrar por estado (DRAFT, ACTIVE, INACTIVE). Los limites DELETED no son listables.

Opciones disponibles:
DRAFT,
ACTIVE,
INACTIVE
​
limitType
enum<string>

Filtrar por tipo de limite.

Opciones disponibles:
DAILY,
MONTHLY,
PER_TRANSACTION

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

Lista paginada de limites de gasto.

​
limits
object[]

Lista de registros de limites.

​
hasMore
boolean

Si hay mas resultados disponibles.

​
nextCursor
string | null

Cursor para obtener la siguiente pagina. Null si no hay mas resultados.