v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Restricted funds

Create fund restriction

Create fund restriction. You can move funds from the available_balance to the restricted_funds balance.

For details, refer to Restrict funds.

NOTE:

This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. This endpoint generates the following events:
Platform authorization created
Account balance changed
Restricted Funds created or released
Account balance changed

See Data and reporting for more information on events and setting up event notifications.

post/corporate/v1/restricted-funds

Request body

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.

amountnumber 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

restricted_funds_idstring uuid

soft_descriptorstring

Brief description that helps to identify a particular restriction or operation.

Example request

{
  "hold_method": "STRICT",
  "operation": {
    "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
    "soft_descriptor": "FDIC 12 C.F.R. § 360.9",
    "metadata": "{ \"key\": \"value\"}"
  },
  "restricted_funds_id": "e4adf199-c925-4d11-b002-c5bfd5679030",
  "soft_descriptor": "FDIC 12 C.F.R. § 360.9"
}

Response

Created

restricted_funds_idstring 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_amountnumber float required

Amount originally requested at the time the restriction was created; remains unchanged after the initial request.

held_amountnumber float required

created_atstring date-time required

Date and time when the restriction or operation was created, shown in ISO 8601 format.<br> minLength: 1 maxLength: 30

soft_descriptorstring

Brief description that helps to identify a particular restriction or operation.

Example response

{
  "restricted_funds_id": "e4adf199-c925-4d11-b002-c5bfd5679030",
  "hold_method": "STRICT",
  "created_at": "2023-04-27T12:01:24Z",
  "soft_descriptor": "FDIC 12 C.F.R. § 360.9",
  "operations": [
    {
      "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
      "type": "RELEASE_FUNDS",
      "status": "SUCCEEDED",
      "processing_code": "PSM045",
      "applied_amount": 800.22,
      "created_at": "2023-04-27T12:01:24Z",
      "soft_descriptor": "FDIC 12 C.F.R. § 360.9",
      "applied_at": "2023-04-27T12:01:24Z",
      "metadata": "{ \"key\": \"value\"}"
    }
  ]
}