Skip to main content
GET
/
hold
List Manual Holds
curl --request GET \
  --url https://api.treasuryprime.com/hold \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "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.

Query Parameters

​
account_id
string

ID of the Account to place the hold. Filterable.

​
status
string

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

​
page_cursor
string

Pagination cursor, value is the object ID.

​
page_size
integer
default:100

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

Required range: x >= 1
​
from_date
string

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

​
to_date
string

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

200 - application/json

A dictionary with a data property that contains a list of up to page_size manual_hold elements, starting after the manual_hold described by page_cursor. If no more manual_holds are available, the resulting list will be empty.

​
data
object[]