Update a Limit

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

import requests

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

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

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': '<content-type>', 'X-API-Key': '<api-key>'},
  body: JSON.stringify({maxAmount: '75000.00'})
};

fetch('https://tracer.sandbox.lerian.net/v1/limits/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'maxAmount' => '75000.00'
  ]),
  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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"maxAmount\": \"75000.00\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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.patch("https://tracer.sandbox.lerian.net/v1/limits/{id}")
  .header("Content-Type", "<content-type>")
  .header("X-API-Key", "<api-key>")
  .body("{\n  \"maxAmount\": \"75000.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Key"] = '<api-key>'
request.body = "{\n  \"maxAmount\": \"75000.00\"\n}"

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

PATCH

limits

{id}

Update a Limit

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

import requests

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

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

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': '<content-type>', 'X-API-Key': '<api-key>'},
  body: JSON.stringify({maxAmount: '75000.00'})
};

fetch('https://tracer.sandbox.lerian.net/v1/limits/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'maxAmount' => '75000.00'
  ]),
  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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"maxAmount\": \"75000.00\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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.patch("https://tracer.sandbox.lerian.net/v1/limits/{id}")
  .header("Content-Type", "<content-type>")
  .header("X-API-Key", "<api-key>")
  .body("{\n  \"maxAmount\": \"75000.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Key"] = '<api-key>'
request.body = "{\n  \"maxAmount\": \"75000.00\"\n}"

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

Authorizations

X-API-Key

string

header

required

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

Headers

Content-Type

string

required

The type of media of the resource. Must be application/json.

X-API-Key

string

required

The API Key for authentication. This header is required for all endpoints except health checks.

X-Request-Id

string<uuid>

A unique identifier used to trace and track each request.

Path Parameters

string<uuid>

required

The unique identifier of the limit that you want to retrieve, update or delete.

Body

application/json

Input for updating a limit. At least one field must be provided. limitType and currency are immutable.

name

string

Required string length: 1 - 255

description

string

Maximum string length: 1000

maxAmount

string

New maximum decimal amount.

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

Example:

"1000.00"

scopes

object[]

Required array length: 1 - 100 elements

Show child attributes

activeTimeStart

string

Updated start of the daily active time window in HH:mm format.

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

Example:

"09:00"

activeTimeEnd

string

Updated end of the daily active time window in HH:mm format.

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

Example:

"17:00"

customStartDate

string<date-time>

Updated start date for CUSTOM limits.

customEndDate

string<date-time>

Updated end date for CUSTOM limits.

Response

Indicates that the limit was successfully updated.

Spending limit.

limitId

string<uuid>

Unique identifier for the limit.

name

string

Human-readable limit name.

Maximum string length: 255

description

string

Limit purpose and usage explanation.

Maximum string length: 1000

limitType

enum<string>

Type of limit (immutable after creation).

Available options:

DAILY,

WEEKLY,

MONTHLY,

CUSTOM,

PER_TRANSACTION

maxAmount

string

Maximum decimal amount.

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

Example:

"1000.00"

currency

string

ISO 4217 currency code (immutable after creation).

Required string length: 3

scopes

object[]

Scopes that determine which transactions this limit applies to.

Show child attributes

status

enum<string>

Limit lifecycle status.

Available options:

DRAFT,

ACTIVE,

INACTIVE,

DELETED

activeTimeStart

string

Start of the daily active time window in HH:mm format. Omitted when the limit is active all day.

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

Example:

"09:00"

activeTimeEnd

string

End of the daily active time window in HH:mm format. Omitted when the limit is active all day.

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

Example:

"17:00"

customStartDate

string<date-time>

Start date for CUSTOM limits.

customEndDate

string<date-time>

End date for CUSTOM limits.

resetAt

string<date-time> | null

When the limit counter resets. Null for PER_TRANSACTION limits.

createdAt

string<date-time>

When the limit was created.

updatedAt

string<date-time>

When the limit was last modified.

deletedAt

string<date-time> | null

When the limit was deleted (null if not deleted).

Retrieve a Limit

Delete a Limit

⌘I

Getting started

Validations API

Rules API

Limits API

Reservations API

Audit Events API

Error handling

Update a Limit

Authorizations

Headers

Path Parameters

Body

Response