---
title: "Get fund restriction"
method: GET
path: "/corporate/v1/restricted-funds/{restrictedFundsId}"
tags: ["Restricted funds"]
---

# Get fund restriction

`GET /corporate/v1/restricted-funds/{restrictedFundsId}`

## Request

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

Get details of a specific fund restriction by `restricted_funds_id`.

## Path parameters

- `restrictedFundsId` string, uuid, required

## Response `200`

OK

- RestrictedFunds
  - `restricted_funds_id` string, uuid, required
  - `hold_method` 'STRICT' | 'FLEXIBLE', required: Determines how the system processes the restriction request in relation to the available balance at the time of execution. Notes: - `STRICT`: Applies to the full requested amount or fails (no partial holds). - `FLEXIBLE`: Can apply only to the available portion, resulting in a partial hold.
  - `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
  - `created_at` string, date-time, required: Date and time when the restriction or operation was created, shown in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.<br> `minLength: 1` `maxLength: 30`
  - `soft_descriptor` string: Brief description that helps to identify a particular restriction or operation.
  - `operations` RestrictedFundsOperation[]: List of operations performed to restrict or release funds.
    - `tracking_id` string, required: Customer created tracking ID. Must consist of alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), and colons (:), with a length from 1 to 128. The Pismo platform uses this field to implement idempotency and prevent duplicates.
    - `type` 'RESTRICT_FUNDS' | 'RELEASE_FUNDS', required: Represents the kind of financial operation being performed. Indicates whether the operation is creating a funds restriction or releasing funds.
    - `status` 'PROCESSING' | 'SUCCEEDED' | 'FAILED' | 'TIMED_OUT', required: Indicates the current execution state of the operation.
    - `processing_code` string, required: Processing code used to create the underlying transaction. Each operation type uses a default processing code.<br> `minLength: 1` `maxLength: 6`
    - `requested_amount` number, float, required: Amount requested by the operation. The final applied amount may differ (see applied_amount) depending on execution rules and available balance at execution time. Notes: - For `RESTRICT_FUNDS`, this is the amount to be held. - For `RELEASE_FUNDS`, this is the amount to be released. - Precision depends on the currency's minor units. For example: - 2 decimals (USD, EUR) → multiples of 0.01 - 3 decimals (BHD, JOD, KWD, OMR, TND) → multiples of 0.001 - 4 decimals (CLF) → multiples of 0.0001
    - `applied_amount` number, float, required: Amount actually executed by the operation at the time it was applied. Depending on the `hold_method`, this value may be different from the requested_amount. Hold Method: - STRICT holds either apply the full requested amount or fail - FLEXIBLE may apply only the available portion Type: - For RESTRICT_FUNDS, it is the portion of the requested amount that was successfully held. - For RELEASE_FUNDS, it is the portion that was actually released back to the available balance.
    - `created_at` string, date-time, required: Date and time when the restriction or operation was created, shown in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.<br> `minLength: 1` `maxLength: 30`
    - `soft_descriptor` string: Brief description that helps to identify a particular restriction or operation.
    - `applied_at` string, date-time: Date and time when the financial operation was actually executed, shown in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.<br> `minLength: 1` `maxLength: 30`
    - `metadata` string: Any data object with key/value pairs. No limit on length. **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](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).

## Other responses

- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/pismo/apis/platform-authentication.md) - [All operations](https://skmtc.dev/pismo/apis/platform-authentication/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/platform-authentication/revisions/935b62e16de4?raw)