POST
/
hold
curl --request POST \
  --url https://api.treasuryprime.com/hold \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": "acct_1234567890",
  "amount": "10.00",
  "expires_at": "2023-11-09T22:39:48Z",
  "hold_description": "Hold description",
  "hold_release_description": "Released description"
}'
{
  "account_id": "acct_1234567890",
  "amount": "10.00",
  "bank_id": "bank_treasuryprime",
  "expires_at": "2023-11-09T22:39:48Z",
  "hold_description": "Hold description",
  "hold_release_description": "Released description",
  "hold_transaction_id": "ttx_1234567890",
  "id": "hold_1234567890",
  "org_id": "org_fintech",
  "release_transaction_id": null,
  "status": "active"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
The manual_hold to create
​
account_id
string
required

ID of the Account to place the hold. Filterable.

​
amount
string
required

Amount of money to hold, with two decimal precision

​
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

Response

200 - application/json
The manual_hold created
​
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.