Bank Accounts

Protect bank account funds

Protects funds in a trust bank account. Only trust accounts are supported.

post/bankaccounts/{id}/protect-funds

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/bankaccounts/{id}/protect-funds
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

Request body

matterIdstring required

Unique identifier of the associated matter. Required.

contactIdstring nullable

Unique identifier of the associated contact. Required in US only.

reasonstring nullable

Reason for protecting the funds.

effectiveDatestring date-time required

Date of protecting the funds.

amountnumber double required

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

Example request

{
  "matterId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "contactId": "18c05819-c321-4907-800c-d5a608729c5a",
  "reason": "Court order requiring protection of funds",
  "amount": 100.5
}

Response

When request is accepted. Returns a hypermedia 'Link' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.