Pular para o conteúdo principal
GET
/
v1
/
limits
Consultar limites de transacao
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/limits \
  --header 'Authorization: Bearer <token>'
[
  {
    "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"
  }
]

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

Lista de limites de transacao recuperada com sucesso

​
id
string
obrigatório

Identificador unico do limite.

Exemplo:

"limit_123"

​
accountId
string
obrigatório

Identificador da conta associada ao limite.

Exemplo:

"acc_123456789"

​
transactionType
string
obrigatório

Tipo de transacao em string: TED, DOC, PIX, etc.

Exemplo:

"PIX"

​
periodType
enum<string>
obrigatório

Tipo de periodo do limite de transacao. Valores string que definem o periodo de tempo para o qual os limites de transacao se aplicam.

Valores validos:

  • DAILY = Limite diario (reinicia todo dia a meia-noite)
  • NIGHTLY = Limite do periodo noturno (normalmente das 20h as 6h conforme regulamentacao bancaria brasileira)
  • MONTHLY = Limite mensal (reinicia no primeiro dia de cada mes)
  • YEARLY = Limite anual (reinicia em 1 de janeiro de cada ano)
Opções disponíveis:
DAILY,
NIGHTLY,
MONTHLY,
YEARLY
Exemplo:

"DAILY"

​
limitType
enum<string>
obrigatório

Tipo de direcao do limite de transacao. Valores string que especificam se o limite se aplica a transacoes de entrada ou saida.

Valores validos:

  • DEBIT = Limite de transacoes de saida (dinheiro saindo da conta)
  • CREDIT = Limite de transacoes de entrada (dinheiro entrando na conta)
Opções disponíveis:
DEBIT,
CREDIT
Exemplo:

"DEBIT"

​
amount
number<double>
obrigatório

Valor do limite.

Exemplo:

5000

​
createdAt
string<date-time>
obrigatório

Data e hora de criacao do limite.

Exemplo:

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

​
updatedAt
string<date-time>
obrigatório

Data e hora da ultima atualizacao do limite.

Exemplo:

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