Release restriction

patch

https://sandbox.pismolabs.io/corporate/v1/restricted-funds/{restrictedFundsId}

Releases all or part of the funds from an existing restriction by restricted funds ID.

NOTE:

This endpoint requires an account token - an access token encoded with a Pismo 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

restrictedFundsId

uuid

required

Restricted Funds ID

Body Params

amount

float

required

0.0001 to 100000000000000000

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

operation

object

required

Represents the data of the hold or release transaction.

soft_descriptor

string

length between 0 and 100

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

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Pismo is here to help