# List fund restrictions

List all account fund restrictions.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Banking - Transaction banking",
    "version": "0.9.0",
    "description": "Transaction banking API",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "Sandbox API server for testing"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Restricted funds",
      "description": "Restricted funds endpoints"
    }
  ],
  "components": {
    "parameters": {
      "CursorQuery": {
        "name": "cursor",
        "in": "query",
        "description": "Cursor to the next page of results. If no value is specified, it fetches the first page.",
        "schema": {
          "type": "string"
        },
        "example": "1234"
      },
      "LimitQuery": {
        "name": "limit",
        "in": "query",
        "description": "Maximum number of items per page. Defaults to `10`",
        "schema": {
          "type": "integer",
          "format": "int32",
          "default": 10,
          "maximum": 20
        },
        "example": 20
      }
    },
    "schemas": {
      "Cursor": {
        "type": "string",
        "description": "Cursor pointing to the next page of results",
        "example": "eyJJRCI6IjBjOGVhMTA4LWNhZTYtNDA2Mi1iMmQzLTFhMTZkNmJiNGIyOCIsIk9yZ0lEIjoiMDllYThhMDQtNWY5My0xMWVkLTliNmEtMDI0MmFjMTIwMDAyIn0="
      },
      "ErrorCode": {
        "description": "Error code\n`minLength: 1`\n`maxLength: 12`\n",
        "type": "string",
        "minLength": 1,
        "maxLength": 12,
        "example": "WPMT0017"
      },
      "ErrorMessage": {
        "description": "Error message\n`minLength: 1`\n`maxLength: 1000`\n",
        "type": "string",
        "minLength": 1,
        "maxLength": 1000,
        "example": "Invalid JSON payload received: Error unmarshalling request"
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/ErrorCode"
          },
          "message": {
            "$ref": "#/components/schemas/ErrorMessage"
          }
        }
      },
      "ListRestrictedFundsResponse": {
        "type": "object",
        "properties": {
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          },
          "restricted_funds": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "restricted_funds_id": {
                  "$ref": "#/components/schemas/RestrictedFundsID"
                },
                "hold_method": {
                  "$ref": "#/components/schemas/RestrictedFundsHoldMethod"
                },
                "requested_amount": {
                  "$ref": "#/components/schemas/RestrictedFundsRequestedAmount"
                },
                "held_amount": {
                  "$ref": "#/components/schemas/RestrictedFundsHeldAmount"
                },
                "created_at": {
                  "$ref": "#/components/schemas/RestrictedFundsCreatedAt"
                },
                "soft_descriptor": {
                  "$ref": "#/components/schemas/RestrictedFundsSoftDescriptor"
                }
              },
              "required": [
                "restricted_funds_id",
                "hold_method",
                "requested_amount",
                "held_amount",
                "created_at"
              ]
            }
          }
        },
        "required": [
          "pagination",
          "restricted_funds"
        ]
      },
      "MaxItemsPerPage": {
        "type": "integer",
        "format": "int32",
        "description": "Maximum number of items per page",
        "example": 10
      },
      "Pagination": {
        "type": "object",
        "description": "Data related to list pagination using a cursor.",
        "properties": {
          "limit": {
            "$ref": "#/components/schemas/MaxItemsPerPage"
          },
          "cursor": {
            "$ref": "#/components/schemas/Cursor"
          }
        }
      },
      "RestrictedFundsRequestedAmount": {
        "type": "number",
        "format": "float",
        "description": "Amount originally requested at the time the restriction was created; remains unchanged after the initial request.",
        "minimum": 0.0001,
        "maximum": 100000000000000000
      },
      "RestrictedFundsHoldMethod": {
        "type": "string",
        "description": "Determines how the system processes the restriction request in relation to the available balance at the time of execution.\n\nNotes:\n  - `STRICT`: Applies to the full requested amount or fails (no partial holds).\n  - `FLEXIBLE`: Can apply only to the available portion, resulting in a partial hold.",
        "enum": [
          "STRICT",
          "FLEXIBLE"
        ],
        "example": "STRICT"
      },
      "RestrictedFundsHeldAmount": {
        "type": "number",
        "format": "float",
        "minimum": 0,
        "maximum": 100000000000000000
      },
      "RestrictedFundsID": {
        "type": "string",
        "format": "uuid",
        "maxLength": 36,
        "example": "e4adf199-c925-4d11-b002-c5bfd5679030"
      },
      "RestrictedFundsCreatedAt": {
        "type": "string",
        "format": "date-time",
        "minLength": 1,
        "maxLength": 30,
        "description": "Date and time when the restriction or operation was created, shown in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.<br>\n`minLength: 1`\n`maxLength: 30`\n",
        "example": "2023-04-27T12:01:24Z"
      },
      "RestrictedFundsSoftDescriptor": {
        "type": "string",
        "description": "Brief description that helps to identify a particular restriction or operation.",
        "example": "FDIC 12 C.F.R. § 360.9",
        "maxLength": 100,
        "minLength": 0
      }
    },
    "responses": {
      "500InternalServer": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "Generic internal error": {
                "value": {
                  "code": "ECMN9999",
                  "message": "Internal error"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "paths": {
    "/corporate/v1/restricted-funds": {
      "get": {
        "summary": "List fund restrictions",
        "description": "List all account fund restrictions.",
        "operationId": "list-corporate-v1-restricted-funds",
        "tags": [
          "Restricted funds"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/CursorQuery"
          },
          {
            "$ref": "#/components/parameters/LimitQuery"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListRestrictedFundsResponse"
                },
                "example": {
                  "pagination": {
                    "limit": 10,
                    "cursor": "eyJpZCI6MTMyfQ=="
                  },
                  "restricted_funds": [
                    {
                      "restricted_funds_id": "4a4060d5-3649-46e8-8d64-93949b212918",
                      "soft_descriptor": "FDIC 12 C.F.R. 360.9",
                      "hold_method": "FLEXIBLE",
                      "requested_amount": 100.99,
                      "held_amount": 90.22,
                      "created_at": "2025-05-29T11:33:22Z"
                    }
                  ]
                }
              }
            }
          },
          "500": {
            "$ref": "#/components/responses/500InternalServer"
          }
        },
        "security": [
          {
            "BearerAuth": []
          }
        ]
      }
    }
  }
}
```