Sign in
Accounts

List Account Reserves

Lists what the account's held balance is made of, one entry per currency: the total held, why each part is held, and the days it unlocks.

get/accounts/{account_id}/reserves

Path parameters

account_idstring required

Account ID, prefixed biz_.

Headers

Api-Version-Datestring
Example:2026-09-25

Pins the request to a dated API version.

Response

empty when nothing is held

Example response

{
  "data": [
    {
      "amount": "125.5",
      "by_type": [
        {
          "amount": "100.0",
          "hold_period_days": 90,
          "percentage": 25,
          "type": "regular"
        }
      ],
      "currency": "usd",
      "unlocks_by_date": [
        {
          "amount": "100.0",
          "date": "2026-01-01"
        }
      ]
    }
  ]
}

Changes

Changed in 2 of the 74 revisions of this API.4

  • f1020c3ecda43See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 72ff51b37dc41See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 74 revisions, 1 has no diff computed.