Ativar um Limite

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

import requests

url = "https://tracer.sandbox.lerian.net/v1/limits/{id}/activate"

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

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

print(response.text)

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

fetch('https://tracer.sandbox.lerian.net/v1/limits/{id}/activate', 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/{id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/{id}/activate"

	req, _ := http.NewRequest("POST", 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.post("https://tracer.sandbox.lerian.net/v1/limits/{id}/activate")
  .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/{id}/activate")

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

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

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

{
  "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"
}

POST

limits

{id}

activate

Ativar um Limite

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

import requests

url = "https://tracer.sandbox.lerian.net/v1/limits/{id}/activate"

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

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

print(response.text)

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

fetch('https://tracer.sandbox.lerian.net/v1/limits/{id}/activate', 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/{id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/{id}/activate"

	req, _ := http.NewRequest("POST", 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.post("https://tracer.sandbox.lerian.net/v1/limits/{id}/activate")
  .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/{id}/activate")

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

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

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

{
  "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"
}

Autorizações

X-API-Key

string

header

obrigatório

Autenticação por API Key. Usada por implantações single-tenant (MULTI_TENANT_ENABLED=false). Enviada em todas as requisições /v1/*.

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

string<uuid>

obrigatório

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

Resposta

Indica que o limite foi ativado com sucesso.

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.

Show child attributes

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

Excluir um Limite

Desativar um Limite

⌘I