---
title: "List fund restrictions"
method: GET
path: "/corporate/v1/restricted-funds"
tags: ["Restricted funds"]
---

# List fund restrictions

`GET /corporate/v1/restricted-funds`

## Request

- Base URL: `https://sandbox.pismolabs.io`
- URL: `https://sandbox.pismolabs.io/corporate/v1/restricted-funds`
- Auth: HTTP bearer

List all account fund restrictions.

## Query parameters

- `cursor` string
- `limit` integer

## Response `200`

OK

- ListRestrictedFundsResponse
  - `pagination` Pagination, required: Data related to list pagination using a cursor.
    - `limit` integer: Maximum number of items per page
    - `cursor` string: Cursor pointing to the next page of results
  - `restricted_funds` object[], required
    - `restricted_funds_id` string, required: Restricted funds ID. Only accepts letters, digits, periods, underscores and hyphens. `maxLength: 60`
    - `hold_method` 'STRICT' | 'FLEXIBLE' | 'RECURRENT', required: Determines how the Pismo platform processes the restriction request in relation to the available balance at the time of execution. Notes: - `STRICT` applies the full requested amount or fails (no partial holds). - `FLEXIBLE` can apply only the available portion, resulting in a partial hold. - `RECURRENT` behaves like `FLEXIBLE` at creation time. After creation, the restriction automatically applies to each incoming credit, re-restricting funds whenever a credit is posted, until the restriction reaches its target amount or `increase_datetime_limit` is reached.
    - `requested_amount` number, float, required: Amount originally requested at the time the restriction was created; remains unchanged after the initial request.
    - `held_amount` number, float, required: Amount held by restriction
    - `created_at` string, date-time, required: Date and time when the restriction was created, displayed in ISO 8601 format.<br> `minLength: 1` `maxLength: 30`
    - `soft_descriptor` string: Brief description that helps identify a restriction
    - `type` 'REGULATORY' | 'JUDICIAL': The type/nature of the restriction. Notes: - `REGULATORY`: Restriction created for regulatory or operational reasons - `JUDICIAL`: Restriction created to comply with a judicial order
    - `metadata` RestrictedFundsMainMetadata: Key-value pairs containing data intended for storage in the Pismo system.<br> This metadata applies when you don't send metadata for the restricted‑funds operation. It covers cases such as automatic recurrent operations or held‑funds expiration. **Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](ref:get-started-with-pismo-apis#metadata).
    - `increase_datetime_limit` string, date-time: The date and time limit, in RFC 3339 format, up to which a `RECURRENT` restriction continues applying to incoming credits on the account. Notes: - Only accepted on creation when `hold_method` is `RECURRENT` - Must not be in the past
    - `release_datetime` string, date-time: Specifies the date and time when any remaining held funds will be automatically released to the account. The value must be provided in RFC 3339 format. **Note**: The specified date and time must be in the future.

## Other responses

- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/banking-transaction-banking.md) - [All operations](https://skmtc.dev/pismo/apis/banking-transaction-banking/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/banking-transaction-banking/revisions/1334306c9303?raw)