Pular para o conteúdo principal
GET
/
v1
/
limits
/
available
Consultar limites disponiveis
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"
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de consulta

​
account_id
string<uuid>

Identificador da conta.

Resposta

Limites disponiveis recuperados com sucesso

​
limits
object[]
obrigatório

Lista de limites disponiveis para a conta.

​
currentPeriod
string<date>
obrigatório

Periodo atual dos limites (ex.: 2023-06 para limites mensais).

Exemplo:

"2023-06-15"