SMsmokeball
Bank Accounts

Unprotect bank account funds

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

post/bankaccounts/{id}/unprotect-funds/{protectionId}

Request

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

Path parameters

idstring required
protectionIdstring required

Request body

amountnumber double nullable

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

This value must exactly match the originally protected amount. Partial unprotect is not supported - the full protected amount must be unprotected.

If not specified, the full protected amount will be unprotected automatically. Specifying this value provides validation to ensure you're unprotecting the expected amount.

Example request

{
  "amount": 50.25
}

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.