---
title: "Get a protected bank account balance"
method: GET
path: "/bankaccounts/{id}/protected-balances/{protectionId}"
tags: ["Bank Accounts"]
---

# Get a protected bank account balance

`GET /bankaccounts/{id}/protected-balances/{protectionId}`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Retrieves a specified protected account balance record.

## Path parameters

- `id` string, required
- `protectionId` string, required

## Response `200`

When request is successful. Returns a 'ProtectedAccountBalance' object.

- ProtectedAccountBalance
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `id` string, nullable: Unique identifier of the protection record.
  - `bankAccount` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `matter` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `contact` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `amount` number, double: The amount protected in dollars. Limited to 2 decimal places (cents).
  - `reason` string, nullable: Reason for protecting the funds.
  - `effectiveDate` string, date-time: Date the protection took effect.
  - `timestamp` string, date-time: Timestamp when the protection was created.
  - `isProtected` boolean: True if the funds are currently protected.
  - `userId` string, nullable: Unique identifier of the user who protected the funds.
  - `unprotectingUserId` string, nullable: Unique identifier of the user who unprotected the funds (if applicable).
  - `lastUpdated` string, date-time: Timestamp when the protection was last updated (e.g. protected or unprotected).

## Other responses

- `400`: When an unsupported request is made.
- `403`: When protected balance record is not associated with authenticated client.
- `404`: When protected balance record does not exist.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)