Skip to main content
GET
Get account limits
Send x-environment to choose the environment: LIVE or TEST. Without it you get the TEST limits; any other value is rejected. The limits say how many wallets and cards the account can have, the highest TED and boleto transaction limit each of its wallets can be given, and whether it can send and receive PIX and pay and issue boletos — and up to which amount. Amounts are in cents. An account that has no limits of its own in the environment answers the default limits, with _id set to new. Any member of the organization can read them.

Headers

x-environment
enum<string>

Environment whose limits you read: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST limits; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the account belongs to.

Format: UUID

accountId
string
required

ID of the account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Response

Successful response

The limits of an account in one environment: how many wallets and cards it can have, the ceilings of its wallets' transaction limits, and which PIX and boleto operations it can perform. Read by account, every block is filled in (a block the account doesn't set carries the default); a list item carries only the blocks the account sets.

_id
string
required

ID of the limits record. new when the account has no limits of its own in the environment yet, in which case the response carries the default limits.

Example:

"66f2a1e3b4d3e80012c9a0c1"

environment
enum<string>
required

Environment these limits apply to: LIVE (production) or TEST (sandbox).

Available options:
LIVE,
TEST
Example:

"LIVE"

realmId
string<uuid>
required

ID of the realm the account belongs to.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organizationId
string<uuid>
required

ID of the organization that owns the account.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

accountId
string
required

ID of the account these limits apply to.

Example:

"66f2a1c7b4d3e80012c9a0b4"

transactionLimits
object[]
required

Ceilings of the wallets' transaction limits: for each product and period (DAY, NIGHT), the highest limit a wallet can be given. Setting a wallet's TED or BOLETO transaction limit above its ceiling is refused; the PIX entries are recorded but not applied.

walletLimits
object

How many wallets the account can have. Creating a wallet beyond it is refused. Absent when the account's limits don't set it — the default then applies: no limit.

cardLimits
object

How many cards the account can have, across all its wallets. Issuing a card beyond it is refused. Absent when the account's limits don't set it — the default then applies: no limit.

pixIn
object

Receiving through PIX charges: whether the account can create them, and their maximum amount. Absent when the account's limits don't set it — the default then applies: allowed, with no maximum.

pixOut
object

Sending PIX payments: whether the account can make them, and their maximum amount. Absent when the account's limits don't set it — the default then applies: allowed, with no maximum.

boletoIn
object

Receiving through boleto charges: whether the account can issue them, and their maximum amount. Absent when the account's limits don't set it — the default then applies: turned off.

boletoOut
object

Paying boletos: whether the account can pay them, and the maximum amount of one payment. Absent when the account's limits don't set it — the default then applies: allowed, with no maximum.

tedOut
object

Sending TED transfers. Recorded but not applied: TED transfers are limited only by the wallets' transaction limits.

createdAt
string<date-time>

When the limits were created. Absent in default limits.

Example:

"2024-09-24T13:20:46.000Z"

updatedAt
string<date-time>

When the limits last changed. Absent in default limits.

Example:

"2025-01-15T17:42:09.000Z"

__v
number

Internal revision counter of the record. Absent in default limits.

Example:

0