Skip to main content
PATCH
/
hold
/
{id}
Update a Manual Hold
curl --request PATCH \
  --url https://api.treasuryprime.com/hold/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hold_release_description": "<string>",
  "status": "<string>"
}
'
{
  "account_id": "<string>",
  "amount": "<string>",
  "bank_id": "<string>",
  "expires_at": "<string>",
  "hold_description": "<string>",
  "hold_release_description": "<string>",
  "hold_transaction_id": "<string>",
  "id": "<string>",
  "org_id": "<string>",
  "release_transaction_id": "<string>",
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

Unique identifier for object

Body

application/json

The manual_hold to update

​
hold_release_description
string

New transaction description to use when releasing the hold

​
status
string

New status of hold (must be released)

Response

200 - application/json

The manual_hold updated

​
account_id
string

ID of the Account to place the hold. Filterable.

​
amount
string

Amount of money to hold, with two decimal precision

​
bank_id
string

ID of the bank with which the object is associated

​
expires_at
string

Optional timestamp to expire the hold

​
hold_description
string

Optional description for the hold transaction

​
hold_release_description
string

Optional description for the hold release transaction

​
hold_transaction_id
string

ID of the hold transaction

​
id
string

Unique identifier for object

​
org_id
string

ID of the organization with which the object is associated

​
release_transaction_id
string

ID of the hold release transaction

​
status
string

Status of the hold, one of active, released, or expired. Filterable.