Skip to main content
GET
/
v1
/
limits
Retrieve transaction limits
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/limits \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/limits"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-direct.api.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://plugin-pix-direct.api.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 => [
"Authorization: Bearer <token>"
],
]);

$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://plugin-pix-direct.api.lerian.net/v1/limits"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://plugin-pix-direct.api.lerian.net/v1/limits")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/limits")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "limit_123",
    "accountId": "acc_123456789",
    "transactionType": "Pix",
    "periodType": "DAILY",
    "limitType": "DEBIT",
    "amount": 5000,
    "createdAt": "2023-06-01T00:00:00Z",
    "updatedAt": "2023-06-01T00:00:00Z"
  }
]

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Query Parameters

account_id
string<uuid>

Account identifier.

Response

List of transaction limits retrieved successfully

id
string
required

Unique limit identifier.

Example:

"limit_123"

accountId
string
required

Account identifier associated with the limit.

Example:

"acc_123456789"

transactionType
string
required

Transaction type string: TED, DOC, Pix, etc.

Example:

"Pix"

periodType
enum<string>
required

Transaction limit period type. String values defining the time period for which transaction limits apply.

Valid values:

  • DAILY = Daily limit (resets every day at midnight)
  • NIGHTLY = Nightly period limit (typically 8 PM to 6 AM per Brazilian banking regulations)
  • MONTHLY = Monthly limit (resets on the first day of each month)
  • YEARLY = Yearly limit (resets on January 1st each year)
Available options:
DAILY,
NIGHTLY,
MONTHLY,
YEARLY
Example:

"DAILY"

limitType
enum<string>
required

Transaction limit direction type. String values specifying whether the limit applies to incoming or outgoing transactions.

Valid values:

  • DEBIT = Outgoing transaction limit (money leaving the account)
  • CREDIT = Incoming transaction limit (money entering the account)
Available options:
DEBIT,
CREDIT
Example:

"DEBIT"

amount
number<double>
required

Limit amount.

Example:

5000

createdAt
string<date-time>
required

Limit creation timestamp.

Example:

"2023-06-01T00:00:00Z"

updatedAt
string<date-time>
required

Limit last update timestamp.

Example:

"2023-06-01T00:00:00Z"