> ## 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 a card limit rule

> Returns a card limit rule of the account.

Also returns any of the rules of the default rule sets, which are shared: their IDs are what a card limit's `ruleIds` holds after you create it with a set's name. Send `x-environment: LIVE` for a production rule.

Any member of the organization can read it.


## OpenAPI

````yaml /api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}
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}/card-limit-rule/{cardLimitRuleId}:
    get:
      tags:
        - Card Limits
      summary: Get a card limit rule
      description: Returns a card limit rule of the account.
      operationId: >-
        getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdCardLimitRuleByCardLimitRuleId
      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 organization's account (24 hexadecimal characters).
          schema:
            type: string
            pattern: ^[0-9a-fA-F]{24}$
          example: 66f2a1c7b4d3e80012c9a0b4
        - name: cardLimitRuleId
          in: path
          required: true
          description: ID of the card limit rule (24 hexadecimal characters).
          schema:
            type: string
            pattern: ^[0-9a-fA-F]{24}$
          example: 66f2a5a0b4d3e80012c9a0f1
        - name: x-environment
          in: header
          required: false
          description: >-
            Environment of the rule: `LIVE` (production) or `TEST` (sandbox).
            When you omit it, the request runs in `TEST`; 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 rule. Use it in a card limit's `ruleIds`.
                    example: 66f2a5a0b4d3e80012c9a0f1
                  realmId:
                    type: string
                    description: >-
                      ID of the realm the rule belongs to. Absent on the default
                      rules, which are shared.
                    example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
                    format: uuid
                  organizationId:
                    type: string
                    description: >-
                      ID of the organization the rule belongs to. Absent on the
                      default rules.
                    example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
                    format: uuid
                  accountId:
                    type: string
                    description: >-
                      ID of the account the rule belongs to. Absent on the
                      default rules.
                    example: 66f2a1c7b4d3e80012c9a0b4
                  environment:
                    type: string
                    enum:
                      - LIVE
                      - TEST
                    description: >-
                      Environment of the rule: `LIVE` (production) or `TEST`
                      (sandbox). Absent on a few default rules.
                    example: LIVE
                  description:
                    type: string
                    description: Name of the rule.
                    example: Ads platforms only
                  rules:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                          description: ID of the condition.
                          example: 66f2a5a0b4d3e80012c9a0f2
                        property:
                          type: string
                          description: >-
                            Attribute of the card transaction the condition
                            tests, such as `mcc`, `merchantName` or
                            `billingAmount` — the values accepted when you
                            create a rule.
                          example: mcc
                        operator:
                          type: string
                          description: >-
                            How `property` is compared with `comparative`, such
                            as `EQUALS`, `NOT_IN` or `BETWEEN` — the values
                            accepted when you create a rule. Some default rules
                            use the lower-case form (`in`, `equals`) together
                            with `negate`.
                          example: IN
                        comparative:
                          type: string
                          description: Value the attribute is compared with.
                          example: 7311, 5968
                        negate:
                          type: boolean
                          description: >-
                            Only on some default rules: `true` inverts the
                            lower-case `operator`.
                          example: false
                      required:
                        - _id
                        - property
                        - operator
                        - comparative
                      description: A condition of a card limit rule.
                    description: >-
                      Conditions of the rule. A transaction matches the rule
                      only when it meets every condition.
                  external:
                    type: object
                    properties:
                      ruleId:
                        type: string
                        description: Identifier of the rule at the card issuer.
                        example: a41c2e7d-90b3-4f5a-8c6d-1e2f3a4b5c6d
                    description: >-
                      Identifier of the rule at the card issuer. Absent on a
                      default rule.
                  createdAt:
                    type: string
                    description: When the rule was created.
                    example: '2026-11-02T12:40:03.000Z'
                    format: date-time
                  updatedAt:
                    type: string
                    description: When the rule last changed.
                    example: '2026-11-02T12:40:03.000Z'
                    format: date-time
                  __v:
                    type: number
                    description: Version of the record, incremented by some updates.
                    example: 0
                required:
                  - _id
                  - description
                  - rules
                  - createdAt
                  - updatedAt
                  - __v
                description: >-
                  A reusable set of conditions a card transaction must meet,
                  applied through card limits.
        '404':
          description: >-
            `CARD_LIMIT_RULE_NOT_FOUND` — No rule with this ID exists in the
            account and environment.
          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:
                      - CARD_LIMIT_RULE_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: CARD_LIMIT_RULE_NOT_FOUND
                origin: BANKING
                message: Card Limit Rule not found
        '422':
          description: >-
            `BAD_REQUEST` — A path parameter is not a valid ID; `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.