Release restriction

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

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…
Path Params
string
required
length ≤ 60
^[A-Za-z0-9._-]+$

Restricted funds ID

Body Params

Create funds restriction request body

float
required
0.0001 to 100000000000000000

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.

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
operation
object
required

Represents the data of the hold or release transaction.

string
length between 0 and 100

Brief description that helps identify a restriction

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