Skip to navigation

Get limits

Canonical read of cashout limits (PIX, TED, boleto, internal) in the four windows (singleTransfer, daytime, nighttime, monthly), with used and remaining amounts. GET /v1/accounts/{accountId}/pix/limits is deprecated and stays a partner-only PIX ceiling list.

PIX used comes from the local per-window counter (completed payments and, when the partner refuses with Limite restante: R$ X, an alignment of that window).

Each window is fail-open until a ceiling exists. A cell without an account ceiling inherits the tenant default, then the global default. source on the window is account, tenant_default or global_default. A local PIX ceiling does not replace the settlement bank cap.

When the account has no ceiling of its own in the current store, the operation comes from the previous store (source: legacy). A tenant or global default does not hide that store. On legacy, singleTransfer is the per-transaction ceiling (PIX), daytime is 07:00–22:00 and nighttime is 22:00–07:00 (America/Sao_Paulo). monthly stays empty. For TED, boleto and internal transfers, daytime.usedBrl is the calendar-day total; nighttime usage is not tracked, so nighttime.usedBrl is 0. The current store uses 06:00–20:00 and 20:00–06:00 once the account has its own ceiling.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.

Query parameters

actingDocumentstringOptional

Operator CPF. When set, available is min(account, operator).

Response

Available limits.
accountIdstringOptional
asOfdatetimeOptional
timezonestringOptional
currencyenumOptional
Allowed values:
itemslist of objectsOptional

Errors

404
Not Found Error