Account Limits
Read the per-transaction and monthly limits that apply to your account.
GET /api/account/limits
Returns your account's limits. Virtual accounts must be enabled (ask support).
Request
curl --request GET \
--url https://api.hodle.com.br/api/account/limits \
--header "Authorization: Bearer $API_KEY"const res = await fetch('https://api.hodle.com.br/api/account/limits', {
headers: { Authorization: `Bearer ${process.env.HODLE_API_KEY}` },
})
const data = await res.json()import os, requests
res = requests.get(
"https://api.hodle.com.br/api/account/limits",
headers={"Authorization": f"Bearer {os.environ['HODLE_API_KEY']}"},
)
data = res.json()Response
Amounts are integer BRL cents: 400000 means R$4,000.00.
{
"success": true,
"data": {
"limits": {
"pixDayLimit": 4000000,
"pixNightLimit": 100000,
"pixInSameHolderDayLimit": 300000,
"pixInDifferentHolderDayLimit": 300000,
"pixInSameHolderNightLimit": 300000,
"pixInDifferentHolderNightLimit": 300000,
"dayStartAt": "06:00",
"nightStartAt": "20:00",
"monthly": {
"limit": 12000000,
"used": 450000,
"remaining": 11550000
}
}
}
}Two ceilings, both enforced
Each inbound Pix must fit both the per-transaction limit and monthly.remaining.
Per transaction — pixIn*
All four fields report the same per-deposit limit, regardless of holder or time of day.
| Field | Description |
|---|---|
pixInSameHolderDayLimit | Per-transaction inbound limit |
pixInDifferentHolderDayLimit | Per-transaction inbound limit |
pixInSameHolderNightLimit | Per-transaction inbound limit |
pixInDifferentHolderNightLimit | Per-transaction inbound limit |
Monthly — monthly
Resets at the start of each calendar month. Only settled deposits count toward used.
| Field | Description |
|---|---|
limit | The monthly allowance |
used | Volume that settled so far this month |
remaining | limit - used, floored at 0 |
Account ceilings
pixDayLimit and pixNightLimit are the account's day and night ceilings. dayStartAt and nightStartAt are HH:mm window boundaries. Each field can be null if unconfigured.
const { monthly, pixInSameHolderDayLimit } = data.data.limits
const canDeposit = (amountInCents) =>
amountInCents <= pixInSameHolderDayLimit &&
amountInCents <= monthly.remaininglimits = data["data"]["limits"]
def can_deposit(amount_in_cents: int) -> bool:
return (
amount_in_cents <= limits["pixInSameHolderDayLimit"]
and amount_in_cents <= limits["monthly"]["remaining"]
)Not included
Pix-out and boleto limits are not part of this response.
Errors
| Status | When |
|---|---|
401 | Missing or invalid API key |
403 | Virtual accounts are not enabled for this account — ask support to enable them |
404 | No limits are available for this account |
502 | The limits could not be read at this time — retry shortly |