Unprotect bank account funds

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

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

Unprotect bank account funds

cURL

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 '
{
  "amount": 50.25
}
'

202

{
  "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

application/json-patch+jsonapplication/jsonapplication/*+json

amount · number<double> | null

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.

Required range: x >= 0.01

Example:

50.25

Response

202

application/json

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

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET