Saltar al contenido principal
PATCH
/
v1
/
limits
curl --request PATCH \ --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/limits \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "accountId": "12345678-1234-1234-1234-123456789012", "amount": 10000, "periodType": "DAILY", "limitType": "DEBIT" } '
{ "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" }

Autorizaciones

​
Authorization
string
header
requerido

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).

Cuerpo

application/json
​
accountId
string<uuid>
requerido

Identificador de la cuenta para la cual se establece el límite.

Ejemplo:

"12345678-1234-1234-1234-123456789012"

​
amount
number<double>
requerido

Nuevo monto del límite.

Ejemplo:

10000

​
periodType
enum<string>
requerido

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
Ejemplo:

"DAILY"

​
limitType
enum<string>
requerido

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
Ejemplo:

"DEBIT"

Respuesta

Límite actualizado

​
id
string
requerido

Identificador único del límite.

Ejemplo:

"limit_123"

​
accountId
string
requerido

Identificador de la cuenta asociada con el límite.

Ejemplo:

"acc_123456789"

​
transactionType
string
requerido

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

Ejemplo:

"PIX"

​
periodType
enum<string>
requerido

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
Ejemplo:

"DAILY"

​
limitType
enum<string>
requerido

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
Ejemplo:

"DEBIT"

​
amount
number<double>
requerido

Monto del límite.

Ejemplo:

5000

​
createdAt
string<date-time>
requerido

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

Ejemplo:

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

​
updatedAt
string<date-time>
requerido

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

Ejemplo:

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