GET
/
v1
/
limits
Retrieve Transaction Limits
curl --request GET \
  --url http://localhost:4011/v1/limits \
  --header 'Authorization: Bearer <token>'
[
  {
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "transactionType": 1,
    "periodType": 1,
    "limitType": 1,
    "amount": 1000,
    "maxAmount": 5000,
    "status": 1
  }
]

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Query Parameters

​
account_id
string<uuid>
required

Account ID to get limits for

Response

Transaction limits retrieved successfully

​
accountId
string<uuid>

Account ID

Example:

"01989f9e-6508-79f8-9540-835be49fbd0d"

​
transactionType
enum<integer>

Transaction type enumeration (1- Pix).

Available options:
1
​
periodType
enum<integer>

Period type enumeration (1- DAILY, 2- NIGHTLY, 3- MONTHLY).

Available options:
1,
2,
3
​
limitType
enum<integer>

Transaction limit type enumeration (1- TRANSACTION, 2- PERIOD).

Available options:
1,
2
​
amount
number

Current limit amount

Example:

1000

​
maxAmount
number

Maximum allowed limit

Example:

5000

​
status
integer

Limit status (1 = active)

Example:

1