Skip to main content
POST
/
bankaccounts
/
{id}
/
unprotect-funds
/
{protectionId}
Unprotect bank account funds
curl --request POST \
  --url https://api.smokeball.com/bankaccounts/{id}/unprotect-funds/{protectionId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reason": "Court order has been satisfied",
  "amount": 50.25
}
'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

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

Path Parameters

​
id
string
required
​
protectionId
string
required

Body

​
reason
string | null

Reason for unprotected the funds (if applicable).

Example:

"Court order has been satisfied"

​
amount
number<double> | null

The amount to unprotect in dollars. Limited to 2 decimal places (cents). If not specified, the full protected amount will be unprotected.

Required range: x >= 0.01
Example:

50.25

Response

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

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