Skip to main content
GET
/
v1
/
limits
/
available
Retrieve available limits
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/limits/available \
  --header 'Authorization: Bearer <token>'
{
  "limits": [
    {
      "limitType": "DEBIT",
      "periodType": "DAILY",
      "totalLimit": 5000,
      "usedAmount": 1250.5,
      "availableAmount": 3749.5
    }
  ],
  "currentPeriod": "2023-06-15"
}

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

Available limits retrieved successfully

​
limits
object[]
required

List of available limits for the account.

​
currentPeriod
string<date>
required

Current period for the limits (e.g., "2023-06" for monthly limits).

Example:

"2023-06-15"