Listar Limites

curl --request GET \
  --url https://tracer.sandbox.lerian.net/v1/limits \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://tracer.sandbox.lerian.net/v1/limits"

headers = {
    "Content-Type": "<content-type>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': '<content-type>', 'X-API-Key': '<api-key>'}
};

fetch('https://tracer.sandbox.lerian.net/v1/limits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tracer.sandbox.lerian.net/v1/limits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tracer.sandbox.lerian.net/v1/limits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://tracer.sandbox.lerian.net/v1/limits")
  .header("Content-Type", "<content-type>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://tracer.sandbox.lerian.net/v1/limits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "limits": [
    {
      "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"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

GET

limits

Listar Limites

curl --request GET \
  --url https://tracer.sandbox.lerian.net/v1/limits \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://tracer.sandbox.lerian.net/v1/limits"

headers = {
    "Content-Type": "<content-type>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': '<content-type>', 'X-API-Key': '<api-key>'}
};

fetch('https://tracer.sandbox.lerian.net/v1/limits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tracer.sandbox.lerian.net/v1/limits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tracer.sandbox.lerian.net/v1/limits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://tracer.sandbox.lerian.net/v1/limits")
  .header("Content-Type", "<content-type>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://tracer.sandbox.lerian.net/v1/limits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "limits": [
    {
      "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"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

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.

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.

name

string

Filtrar por nombre de límite (coincidencia exacta).

status

enum<string>

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

Opciones disponibles:

DRAFT,

ACTIVE,

INACTIVE

limit_type

enum<string>

Filtrar por tipo de limite.

Opciones disponibles:

DAILY,

WEEKLY,

MONTHLY,

CUSTOM,

PER_TRANSACTION

account_id

string<uuid>

Filtrar por ID de cuenta (UUID).

segment_id

string<uuid>

Filtrar por ID de segmento (UUID).

portfolio_id

string<uuid>

Filtrar por ID de portafolio (UUID).

merchant_id

string<uuid>

Filtrar por ID de comerciante (UUID).

transaction_type

enum<string>

Filtrar por tipo de transacción.

Opciones disponibles:

CARD,

WIRE,

PIX,

CRYPTO

sub_type

string

Filtrar por subtipo de transacción (p. ej., débito, crédito, prepago).

Maximum string length: 50

sort_by

enum<string>

predeterminado:created_at

El campo utilizado para ordenar los resultados.

Opciones disponibles:

created_at,

updated_at,

name,

max_amount

sort_order

enum<string>

predeterminado:DESC

El orden utilizado para ordenar los resultados.

Opciones disponibles:

ASC,

DESC

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.

Show child attributes

hasMore

boolean

Si hay mas resultados disponibles.

nextCursor

string | null

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

Crear un Limite

Recuperar un Limite

⌘I