GET
/
reserve
List Reserve Accounts
curl --request GET \
  --url https://api.treasuryprime.com/reserve \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "account_id": "acct_1234567890",
      "amount": "0.00",
      "id": "reserve_1029384756",
      "reserve_account_id": "acct_0987654321",
      "upper_limit": "100.00",
      "userdata": null
    }
  ]
}

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 target Account that has an added reserve limit. Filterable.

​
reserve_account_id
string

ID of the Account that holds the reserve. 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 reserve elements, starting after the reserve described by page_cursor. If no more reserves are available, the resulting list will be empty.

The response is of type object.