> ## Documentation Index
> Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Get account limits

> Returns the limits of an account in one environment.

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.


## OpenAPI

````yaml /api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits
openapi: 3.0.3
info:
  title: Banking
  version: 1.0.0
  description: >-
    Portão 3 banking API. Every endpoint requires a bearer token in the
    Authorization header (Authorization: Bearer <token>) unless its page states
    otherwise; see the Authentication guide. That requirement is not repeated
    per endpoint. Generated by tools/openapi from code (routes + security) and
    the hand-written spec (request/response bodies). Banking attaches a zod
    validationSchema at the route; request bodies are resolved from it (object +
    array roots). Responses have no presenter layer, so they stay tier=unknown.
    Confidence tiers: generated:typed=215 copied:manual=4 unknown=52.
servers:
  - url: https://api.banking.v2.portao3.com.br/
    description: production
  - url: https://api.banking.dev.3pers.com.br/
    description: development
security: []
tags:
  - name: Accounts
  - name: Account Limits
  - name: Wallets
  - name: Cards
  - name: Card Limits
  - name: Cards 3DS
  - name: PIX
  - name: PIX Keys (DICT)
  - name: PIX Charges
  - name: PIX Automatic
  - name: PIX Initiation (Open Finance)
  - name: PIX Infractions (MED)
  - name: Boleto
  - name: Boleto Charges
  - name: TED
  - name: Transfers
  - name: Transactions
  - name: Cashback
  - name: Currency Codes
  - name: Reversals
paths:
  /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits:
    get:
      tags:
        - Account Limits
      summary: Get account limits
      description: Returns the limits of an account in one environment.
      operationId: >-
        getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdAccountLimits
      parameters:
        - name: realmId
          in: path
          required: true
          description: |-
            ID of your realm.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
        - name: organizationId
          in: path
          required: true
          description: |-
            ID of the organization the account belongs to.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
        - name: accountId
          in: path
          required: true
          description: ID of the account (24 hexadecimal characters).
          schema:
            type: string
            pattern: ^[0-9a-fA-F]{24}$
          example: 66f2a1c7b4d3e80012c9a0b4
        - name: x-environment
          in: header
          required: false
          description: >-
            Environment whose limits you read: `LIVE` (production) or `TEST`
            (sandbox). When you omit it, you get the `TEST` limits; any other
            value is rejected.
          schema:
            type: string
            enum:
              - LIVE
              - TEST
          example: LIVE
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  _id:
                    type: string
                    description: >-
                      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:
                    type: string
                    enum:
                      - LIVE
                      - TEST
                    description: >-
                      Environment these limits apply to: `LIVE` (production) or
                      `TEST` (sandbox).
                    example: LIVE
                  realmId:
                    type: string
                    description: ID of the realm the account belongs to.
                    example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
                    format: uuid
                  organizationId:
                    type: string
                    description: ID of the organization that owns the account.
                    example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
                    format: uuid
                  accountId:
                    type: string
                    description: ID of the account these limits apply to.
                    example: 66f2a1c7b4d3e80012c9a0b4
                  walletLimits:
                    type: object
                    properties:
                      quantity:
                        type: number
                        nullable: true
                        description: >-
                          Maximum number allowed. `null`, `0` or absent means no
                          limit.
                        example: 20
                    description: >-
                      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:
                    type: object
                    properties:
                      quantity:
                        type: number
                        nullable: true
                        description: >-
                          Maximum number allowed. `null`, `0` or absent means no
                          limit.
                        example: 20
                    description: >-
                      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.
                  transactionLimits:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                          description: >-
                            Internal identifier of this entry. Absent in default
                            limits.
                          example: 66f2a1e3b4d3e80012c9a0c2
                        product:
                          type: string
                          enum:
                            - PIX
                            - TED
                            - BOLETO
                          description: >-
                            Payment product of the entry: `PIX`, `TED` or
                            `BOLETO`. Only the `TED` and `BOLETO` entries are
                            applied.
                          example: TED
                        period:
                          type: string
                          enum:
                            - DAY
                            - NIGHT
                          description: >-
                            Period the ceiling applies to: `DAY` (daytime) or
                            `NIGHT` (nighttime).
                          example: DAY
                        amount:
                          type: number
                          nullable: true
                          description: >-
                            Highest limit, in cents (BRL), that a wallet's own
                            transaction limit for this product and period can be
                            set to. `null`, `0` or absent means no ceiling.
                          example: 1000000
                      required:
                        - product
                        - period
                      description: >-
                        The highest transaction limit a wallet of the account
                        may be given, for one product and period.
                    description: >-
                      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.
                  pixIn:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                        nullable: true
                        description: >-
                          `false` when the operation is turned off for the
                          account. `true`, `null` or absent allows it.
                        example: true
                      maxAmount:
                        type: number
                        nullable: true
                        description: >-
                          Maximum amount of a single operation, in cents (BRL).
                          `null`, `0` or absent means no maximum.
                        example: null
                    description: >-
                      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:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                        nullable: true
                        description: >-
                          `false` when the operation is turned off for the
                          account. `true`, `null` or absent allows it.
                        example: true
                      maxAmount:
                        type: number
                        nullable: true
                        description: >-
                          Maximum amount of a single operation, in cents (BRL).
                          `null`, `0` or absent means no maximum.
                        example: null
                    description: >-
                      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:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                        nullable: true
                        description: >-
                          `false` when the operation is turned off for the
                          account. `true`, `null` or absent allows it.
                        example: true
                      maxAmount:
                        type: number
                        nullable: true
                        description: >-
                          Maximum amount of a single operation, in cents (BRL).
                          `null`, `0` or absent means no maximum.
                        example: null
                    description: >-
                      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:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                        nullable: true
                        description: >-
                          `false` when the operation is turned off for the
                          account. `true`, `null` or absent allows it.
                        example: true
                      maxAmount:
                        type: number
                        nullable: true
                        description: >-
                          Maximum amount of a single operation, in cents (BRL).
                          `null`, `0` or absent means no maximum.
                        example: null
                    description: >-
                      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:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                        nullable: true
                        description: >-
                          `false` when the operation is turned off for the
                          account. `true`, `null` or absent allows it.
                        example: true
                      maxAmount:
                        type: number
                        nullable: true
                        description: >-
                          Maximum amount of a single operation, in cents (BRL).
                          `null`, `0` or absent means no maximum.
                        example: null
                    description: >-
                      Sending TED transfers. Recorded but not applied: TED
                      transfers are limited only by the wallets' transaction
                      limits.
                  createdAt:
                    type: string
                    description: When the limits were created. Absent in default limits.
                    example: '2024-09-24T13:20:46.000Z'
                    format: date-time
                  updatedAt:
                    type: string
                    description: When the limits last changed. Absent in default limits.
                    example: '2025-01-15T17:42:09.000Z'
                    format: date-time
                  __v:
                    type: number
                    description: >-
                      Internal revision counter of the record. Absent in default
                      limits.
                    example: 0
                required:
                  - _id
                  - environment
                  - realmId
                  - organizationId
                  - accountId
                  - transactionLimits
                description: >-
                  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.
        '404':
          description: >-
            `ACCOUNT_NOT_FOUND` — No account with this ID exists in the
            organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - ACCOUNT_NOT_FOUND
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - BANKING
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: ACCOUNT_NOT_FOUND
                origin: BANKING
                message: Account not found
        '422':
          description: >-
            `BAD_REQUEST` — A path parameter is not a valid ID — the account ID
            must be 24 hexadecimal characters; `fields` lists each one.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - BAD_REQUEST
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - BANKING
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                  fields:
                    type: array
                    description: >-
                      One entry per invalid request field (validation errors
                      only).
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          description: >-
                            Path of the invalid field, e.g. `label` or
                            `values[0].value`.
                          example: label
                        message:
                          type: string
                          description: Why the field was rejected.
                          example: label is required
                        code:
                          type: string
                          description: >-
                            `<FIELD>_<REASON>` — e.g. `LABEL_REQUIRED`,
                            `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.
                          example: LABEL_REQUIRED
                        values:
                          type: array
                          items:
                            type: string
                          description: >-
                            The accepted values, when the field is an
                            enumeration.
                      required:
                        - field
                        - message
                        - code
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: BAD_REQUEST
                origin: BANKING
                message: >-
                  Bad Request: Your request is invalid or incomplete. Please
                  make sure you are requesting with the right fields.
                fields:
                  - field: organizationId
                    message: Invalid UUID
                    code: ORGANIZATIONID_UUID

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.