Skip to main content
GET
/
bankaccounts
/
{id}
/
protected-balances
/
{protectionId}
Get a rotected bank account balance
curl --request GET \
  --url https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "p1",
  "bankAccount": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "matter": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "contact": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "amount": 100.5,
  "reason": "Court order requiring protection of funds",
  "effectiveDate": "2024-01-15T00:00:00Z",
  "timestamp": "2024-01-15T10:30:00Z",
  "isProtected": true,
  "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "unprotectingUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "lastUpdated": "2024-01-15T10:30:00Z"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string
required
​
protectionId
string
required

Response

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

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the protection record.

Example:

"p1"

​
bankAccount
object

The bank account where the protection was applied.

​
matter
object

The associated matter.

​
contact
object

The associated contact (US only).

​
amount
number<double>

The amount protected in dollars. Limited to 2 decimal places (cents).

Example:

100.5

​
reason
string | null

Reason for protecting the funds.

Example:

"Court order requiring protection of funds"

​
effectiveDate
string<date-time>

Date the protection took effect.

Example:

"2024-01-15T00:00:00Z"

​
timestamp
string<date-time>

Timestamp when the protection was created.

Example:

"2024-01-15T10:30:00Z"

​
isProtected
boolean

True if the funds are currently protected.

Example:

true

​
userId
string | null

Unique identifier of the user who protected the funds.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
unprotectingUserId
string | null

Unique identifier of the user who unprotected the funds (if applicable).

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
lastUpdated
string<date-time>

Timestamp when the protection was last updated (e.g. protected or unprotected).

Example:

"2024-01-15T10:30:00Z"