Saltar al contenido principal
GET
/
v1
/
limits
Recuperar límites de transacción
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"
  }
]

Authorizations

​
Authorization
string
header
required

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Query Parameters

​
account_id
string<uuid>

Identificador de la cuenta.

Response

Lista de límites de transacción recuperada correctamente

​
id
string
required

Identificador único del límite.

Example:

"limit_123"

​
accountId
string
required

Identificador de la cuenta asociada con el límite.

Example:

"acc_123456789"

​
transactionType
string
required

Cadena del tipo de transacción: TED, DOC, PIX, etc.

Example:

"PIX"

​
periodType
enum<string>
required

Tipo de periodo del límite de transacción. Valores en texto que definen el periodo de tiempo al que aplican los límites.

Valores válidos:

  • DAILY = Límite diario (se restablece cada día a medianoche)
  • NIGHTLY = Límite nocturno (generalmente de 20:00 a 6:00, según la regulación bancaria brasileña)
  • MONTHLY = Límite mensual (se restablece el primer día de cada mes)
  • YEARLY = Límite anual (se restablece el 1 de enero de cada año)
Opciones disponibles:
DAILY,
NIGHTLY,
MONTHLY,
YEARLY
Example:

"DAILY"

​
limitType
enum<string>
required

Tipo de dirección del límite de transacción. Valores en texto que especifican si el límite aplica a transacciones entrantes o salientes.

Valores válidos:

  • DEBIT = Límite de transacciones salientes (dinero que sale de la cuenta)
  • CREDIT = Límite de transacciones entrantes (dinero que entra a la cuenta)
Opciones disponibles:
DEBIT,
CREDIT
Example:

"DEBIT"

​
amount
number
required

Monto del límite.

Example:

5000

​
createdAt
string<date-time>
required

Marca de tiempo de creación del límite.

Example:

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

​
updatedAt
string<date-time>
required

Marca de tiempo de la última actualización del límite.

Example:

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