> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pague.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List Balance Blocks

> Returns the account's balance blocks (MED, judicial, or administrative). Optionally filter by block status.

**Required permission:** `BALANCE_BLOCK:READ` or `FULL_ACCESS`



## OpenAPI

````yaml openapi.en.json GET /balance-blocks
openapi: 3.0.0
info:
  title: pague.dev API
  description: pague.dev Payment API documentation
  version: '1.0'
  contact: {}
servers:
  - url: https://api-gateway.pague.dev/v2
security: []
paths:
  /balance-blocks:
    get:
      tags:
        - External API - Balance Blocks
      summary: List balance blocks
      description: >-
        Returns the account's balance blocks (MED, judicial, or administrative).
        Optionally filter by block status.


        **Required permission:** `BALANCE_BLOCK:READ` or `FULL_ACCESS`
      operationId: ExternalBalanceBlocksController_findAll
      parameters:
        - name: status
          in: query
          required: false
          description: >-
            Filters blocks by status. If omitted, returns all blocks on the
            account.
          schema:
            type: string
            enum:
              - awaiting_response
              - defended
              - approved
              - rejected
        - $ref: '#/components/parameters/SubAccount'
      responses:
        '200':
          description: List of the account's balance blocks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllExternalBalanceBlocksOutput'
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
        - bearerAuth: []
components:
  parameters:
    SubAccount:
      name: X-Sub-Account
      in: header
      required: false
      description: >-
        Reference of the sub-account the operation runs against. When omitted,
        the operation happens on the main account; the reserved value
        `principal` also resolves to the main account and is equivalent to
        omitting the header. Accepted on every endpoint except `POST /auth` and
        the `/sub-accounts` endpoints themselves, which always operate on the
        main account.


        Possible errors: `404 SUB_ACCOUNT_NOT_FOUND`, `403
        SUB_ACCOUNT_FORBIDDEN`, `403 SUB_ACCOUNT_SUSPENDED`.


        Requires the credential to have **sub-account access** enabled (Settings
        → Integration → API Credentials). It starts turned off and is not
        replaced by any permission, not even `FULL_ACCESS`: without it the
        response is `403 SUB_ACCOUNT_FORBIDDEN`.
      schema:
        type: string
        pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
        example: loja-centro
  schemas:
    GetAllExternalBalanceBlocksOutput:
      type: object
      properties:
        items:
          description: List of the account's balance blocks
          type: array
          items:
            $ref: '#/components/schemas/ExternalBalanceBlockOutput'
        total:
          type: integer
          description: Total number of blocks returned
          example: 3
      required:
        - items
        - total
    UnauthorizedErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication token is required
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
      required:
        - statusCode
        - error
        - message
        - timestamp
    InternalServerErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: InternalError
        message:
          type: string
          example: An unexpected error occurred
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
          example: 2771463d58840c8e116dc6dda1e1e5d0
      required:
        - statusCode
        - error
        - message
        - timestamp
    ExternalBalanceBlockOutput:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Block ID
        transactionId:
          type: string
          format: uuid
          description: ID of the blocked transaction
        externalReference:
          type: string
          nullable: true
          example: 3c90c3cc-0d44-4b50-8888-8dd25736052a
          description: External reference of the original transaction (if any)
        e2eId:
          type: string
          nullable: true
          description: PIX network end-to-end ID of the original transaction (if any)
        amount:
          type: number
          description: Blocked amount in BRL
          example: 150.5
        status:
          type: string
          enum:
            - awaiting_response
            - defended
            - approved
            - rejected
          description: Block status
          example: awaiting_response
        blockType:
          type: string
          enum:
            - med
            - judicial
            - administrative
          description: Block type
          example: med
        referenceNumber:
          type: string
          description: Block reference number
        reason:
          type: string
          description: Block reason
        resolutionReason:
          type: string
          nullable: true
          description: Resolution reason (present once the block has been resolved)
        resolvedAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            Resolution date/time in ISO 8601 (present once the block has been
            resolved)
        createdAt:
          type: string
          format: date-time
          description: Creation date/time in ISO 8601
      required:
        - id
        - transactionId
        - amount
        - status
        - blockType
        - referenceNumber
        - reason
        - createdAt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token obtained from POST /auth (client_id + client_secret). Valid
        for 300 seconds.

````