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

# Get a protected bank account balance

> Retrieves a specified protected account balance record.



## OpenAPI

````yaml /openapi.json get /bankaccounts/{id}/protected-balances/{protectionId}
openapi: 3.0.1
info:
  title: API
  version: '1.0'
servers:
  - url: https://api.smokeball.com
  - url: https://api.smokeball.com.au
  - url: https://api.smokeball.co.uk
  - url: https://stagingapi.smokeball.com
  - url: https://stagingapi.smokeball.com.au
  - url: https://stagingapi.smokeball.co.uk
security:
  - api-key: []
    token: []
paths:
  /bankaccounts/{id}/protected-balances/{protectionId}:
    get:
      tags:
        - Bank Accounts
      summary: Get a protected bank account balance
      description: Retrieves a specified protected account balance record.
      operationId: GetProtectedAccountBalanceById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: protectionId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            When request is successful. Returns a 'ProtectedAccountBalance'
            object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectedAccountBalance'
        '400':
          description: When an unsupported request is made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: >-
            When protected balance record is not associated with authenticated
            client.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: When protected balance record does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    ProtectedAccountBalance:
      type: object
      properties:
        href:
          type: string
          nullable: true
        relation:
          type: string
          nullable: true
        method:
          type: string
          default: GET
          nullable: true
        self:
          allOf:
            - $ref: '#/components/schemas/Link'
          nullable: true
        id:
          type: string
          description: Unique identifier of the protection record.
          nullable: true
          example: p1
        bankAccount:
          allOf:
            - $ref: '#/components/schemas/Link'
          description: The bank account where the protection was applied.
          nullable: true
        matter:
          allOf:
            - $ref: '#/components/schemas/Link'
          description: The associated matter.
          nullable: true
        contact:
          allOf:
            - $ref: '#/components/schemas/Link'
          description: The associated contact (US only).
          nullable: true
        amount:
          type: number
          description: >-
            The amount protected in dollars. Limited to 2 decimal places
            (cents).
          format: double
          example: 100.5
        reason:
          type: string
          description: Reason for protecting the funds.
          nullable: true
          example: Court order requiring protection of funds
        effectiveDate:
          type: string
          description: Date the protection took effect.
          format: date-time
          example: '2024-01-15T00:00:00Z'
        timestamp:
          type: string
          description: Timestamp when the protection was created.
          format: date-time
          example: '2024-01-15T10:30:00Z'
        isProtected:
          type: boolean
          description: True if the funds are currently protected.
          example: true
        userId:
          type: string
          description: Unique identifier of the user who protected the funds.
          nullable: true
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        unprotectingUserId:
          type: string
          description: >-
            Unique identifier of the user who unprotected the funds (if
            applicable).
          nullable: true
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        lastUpdated:
          type: string
          description: >-
            Timestamp when the protection was last updated (e.g. protected or
            unprotected).
          format: date-time
          example: '2024-01-15T10:30:00Z'
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    Link:
      type: object
      properties:
        id:
          type: string
          nullable: true
        href:
          type: string
          nullable: true
        relation:
          type: string
          nullable: true
        method:
          type: string
          default: GET
          nullable: true
      additionalProperties: false
  securitySchemes:
    api-key:
      type: apiKey
      name: x-api-key
      in: header
    token:
      type: apiKey
      name: Authorization
      in: header
      x-amazon-apigateway-authtype: cognito_user_pools

````