Skip to main content
GET
Get transaction limits
One limit per payment method (PIX, TED, BOLETO) and period (DAY, NIGHT): the highest total the wallet can send with that method in that period, in cents. A wallet still being created has no limits yet and answers an empty list. Use default as walletId for the organization’s main wallet, and send x-environment: LIVE for production wallets. Organization admins can read every wallet’s limits; other users only those of the wallets shared with them, in any role.

Headers

x-environment
enum<string>

Environment of the wallet: LIVE (production) or TEST (sandbox). When you omit it, the request runs in TEST; 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 wallet belongs to.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

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

ID of the wallet (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$

Response

Successful response

realmId
string<uuid>
required

ID of the realm the wallet belongs to.

Example:

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

organizationId
string<uuid>
required

ID of the organization the wallet belongs to.

Example:

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

accountId
string
required

ID of the account the wallet belongs to.

Example:

"66f2a1c7b4d3e80012c9a0b4"

walletId
string
required

ID of the wallet.

Example:

"66f2a3d1b4d3e80012c9a0d2"

environment
enum<string>
required

Environment of the wallet: LIVE or TEST.

Available options:
LIVE,
TEST
Example:

"LIVE"

currency
string
required

Currency of the limit, as an ISO 4217 numeric code: 986 (Brazilian real).

Example:

"986"

amount
number
required

Highest total the wallet can send with product during period, in cents.

Example:

1000000

external
object
required

Identifier of the limit. Send it back to change the limit.

period
enum<string>
required

Period the limit applies to: DAY (daytime) or NIGHT (nighttime).

Available options:
DAY,
NIGHT
Example:

"DAY"

product
enum<string>
required

Payment method the limit applies to: PIX, TED or BOLETO.

Available options:
PIX,
TED,
BOLETO
Example:

"PIX"

createdAt
string<date-time>
required

When the limit was created.

Example:

"2024-10-01T12:34:41.000Z"

updatedAt
string<date-time>
required

When the limit last changed.

Example:

"2026-10-28T17:02:13.000Z"

scheduledAmount
number | null

An amount the limit is scheduled to change to, in cents. null while no change is scheduled.

Example:

2000000

scheduledFor
string<date-time> | null

When the scheduled change takes effect. null while no change is scheduled.

Example:

"2026-11-03T12:00:00.000Z"