Skip to main content
GET
List a card's limits
Each ACTIVE limit carries availableAmount (what the card can still spend under it) and pendingAmount (authorized purchases not yet settled), read live; EXPIRED and DELETED limits carry 0. The list is not paginated and not sorted. Send x-environment: LIVE for a production card. Any member of the organization can list a card’s limits.

Headers

x-environment
enum<string>

Environment of the card: 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 card 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 card's wallet (24 hexadecimal characters), or default for the organization's main wallet.

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

ID of the card (24 hexadecimal characters).

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

Response

Successful response

_id
string
required

ID of the card limit.

Example:

"66f2a5c2b4d3e80012c9a0f3"

realmId
string<uuid>
required

ID of the realm the limit belongs to.

Example:

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

organizationId
string<uuid>
required

ID of the organization the limit belongs to.

Example:

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

accountId
string
required

ID of the organization's account.

Example:

"66f2a1c7b4d3e80012c9a0b4"

environment
enum<string>
required

Environment of the limit: LIVE (production) or TEST (sandbox).

Available options:
LIVE,
TEST
Example:

"LIVE"

amount
number
required

Amount the cards can spend under this limit, in cents (BRL).

Example:

150000

startDate
string
required

First day of the limit, as YYYY-MM-DD.

Example:

"2026-11-01"

endDate
string
required

Last day of the limit, as YYYY-MM-DD. The limit stops applying when this day ends.

Example:

"2026-11-30"

cardIds
string[]
required

IDs of the cards the limit applies to.


Example: ["66f2a4b8b4d3e80012c9a0e1"]

ruleIds
string[]
required

IDs of the card limit rules the limit applies. A transaction is allowed when any one of them matches.


Example: ["66f2a5a0b4d3e80012c9a0f1"]

external
object
required

Identifier of the card limit at the card issuer.

status
enum<string>
required

Status of the limit: ACTIVE (it applies), EXPIRED (its endDate has passed) or DELETED (removed).

Available options:
ACTIVE,
EXPIRED,
DELETED
Example:

"ACTIVE"

availableAmount
number
required

Amount still available to spend under the limit, in cents (BRL). 0 when the limit is not ACTIVE.

Example:

98500

pendingAmount
number
required

Amount of authorized purchases not yet settled, in cents (BRL). 0 when the limit is not ACTIVE.

Example:

12000

name
string

Name of the limit. Absent when it was created without one.

Example:

"Campaign budget"