PIpismo
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:

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

post/corporate/v1/restricted-funds

Request

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

Request body

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.
amountnumber float required

Amount requested by the operation

The final applied amount might vary (refer to applied_amount) based on execution rules and the available balance at the time of execution.<br>

Note:

  • For RESTRICT_FUNDS, this is the amount to be held.
  • For RELEASE_FUNDS, this is the amount to be released.
  • For EXECUTE_FUNDS, this is the amount to be debited from the held funds.
  • Precision follows the currency's minor units. For example:
    • Two decimals (USD, EUR): values use increments of 0.01
    • Three decimals (BHD, JOD, KWD, OMR, TND): values use increments of 0.001
    • Four‑decimal (CLF): values use increments of 0.0001
restricted_funds_idstring

Restricted funds ID. Only accepts letters, digits, periods, underscores and hyphens. maxLength: 60

soft_descriptorstring

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
metadataRestrictedFundsMainMetadata

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.

increase_datetime_limitstring 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_datetimestring 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.

Example request

{
  "hold_method": "STRICT",
  "operation": {
    "tracking_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
    "soft_descriptor": "FDIC 12 C.F.R. § 360.9",
    "metadata": {
      "my-id": 2932
    }
  },
  "restricted_funds_id": "e4adf199-c925-4d11-b002-c5bfd5679030",
  "soft_descriptor": "FDIC 12 C.F.R. § 360.9",
  "type": "REGULATORY",
  "increase_datetime_limit": "2026-12-31T23:59:59Z",
  "release_datetime": "2026-12-31T23:59:59Z"
}

Response

Created

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

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

held_amountnumber float required

Amount held by restriction

created_atstring date-time required

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

soft_descriptorstring

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
metadataRestrictedFundsMainMetadata

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.

increase_datetime_limitstring 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_datetimestring 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.

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": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
      "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": {
        "my-id": 2932
      }
    }
  ],
  "type": "REGULATORY",
  "increase_datetime_limit": "2026-12-31T23:59:59Z",
  "release_datetime": "2026-12-31T23:59:59Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.