Block an amount in an account

/v3/ledger/account/block/{id}

2 credits per API call.


Blocks an amount in an account. Any number of distinct amounts can be blocked in one account. Every new blockage has its own distinct ID, which is used as a reference. When the amount is blocked, it is debited from the available balance of the account. The account balance remains the same. The account balance represents the total amount of funds in the account. The available balance represents the total amount of funds that can be used to perform transactions. When an account is frozen, the available balance is set to 0 minus all blockages for the account.

Path Params
string
required

Account ID

Body Params
string
required
length ≤ 38

The amount to be blocked on the account

string
required
length between 1 and 100

The type of the blockage that you are applying; can be a code or an identifier from an external system or a short description of the blockage

string
length between 1 and 300

The description of the blockage that you are applying

boolean

Enable sufficient balance check. When set to true, blocking an amount greater than the account's available balance will throw an error.

Responses

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