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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
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.
Allowed:
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.

uuid
length ≤ 36
string
length between 0 and 100

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

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json