Skip to main content
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"
}

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

Body

application/json
​
accountId
string<uuid>
required

Account identifier for which the limit is being set.

Example:

"12345678-1234-1234-1234-123456789012"

​
amount
number<double>
required

New limit amount.

Example:

10000

​
periodType
enum<string>
required

Transaction limit period type. String values defining the time period for which transaction limits apply.

Valid values:

  • DAILY = Daily limit (resets every day at midnight)
  • NIGHTLY = Nightly period limit (typically 8 PM to 6 AM per Brazilian banking regulations)
  • MONTHLY = Monthly limit (resets on the first day of each month)
  • YEARLY = Yearly limit (resets on January 1st each year)
Available options:
DAILY,
NIGHTLY,
MONTHLY,
YEARLY
Example:

"DAILY"

​
limitType
enum<string>
required

Transaction limit direction type. String values specifying whether the limit applies to incoming or outgoing transactions.

Valid values:

  • DEBIT = Outgoing transaction limit (money leaving the account)
  • CREDIT = Incoming transaction limit (money entering the account)
Available options:
DEBIT,
CREDIT
Example:

"DEBIT"

Response

Limit updated

​
id
string
required

Unique limit identifier.

Example:

"limit_123"

​
accountId
string
required

Account identifier associated with the limit.

Example:

"acc_123456789"

​
transactionType
string
required

Transaction type string: TED, DOC, PIX, etc.

Example:

"PIX"

​
periodType
enum<string>
required

Transaction limit period type. String values defining the time period for which transaction limits apply.

Valid values:

  • DAILY = Daily limit (resets every day at midnight)
  • NIGHTLY = Nightly period limit (typically 8 PM to 6 AM per Brazilian banking regulations)
  • MONTHLY = Monthly limit (resets on the first day of each month)
  • YEARLY = Yearly limit (resets on January 1st each year)
Available options:
DAILY,
NIGHTLY,
MONTHLY,
YEARLY
Example:

"DAILY"

​
limitType
enum<string>
required

Transaction limit direction type. String values specifying whether the limit applies to incoming or outgoing transactions.

Valid values:

  • DEBIT = Outgoing transaction limit (money leaving the account)
  • CREDIT = Incoming transaction limit (money entering the account)
Available options:
DEBIT,
CREDIT
Example:

"DEBIT"

​
amount
number<double>
required

Limit amount.

Example:

5000

​
createdAt
string<date-time>
required

Limit creation timestamp.

Example:

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

​
updatedAt
string<date-time>
required

Limit last update timestamp.

Example:

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