Account

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.

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

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/ledger/account/block/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required
Example:5e6be89ee6aa436299950c3f

Account ID

Request body

amountstring required

The amount to be blocked on the account

typestring required

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

descriptionstring

The description of the blockage that you are applying

ensureSufficientBalanceboolean

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

Example request

{
  "amount": "5",
  "type": "DEBIT_CARD_OP",
  "description": "Card payment in the shop."
}

Response

OK

idstring

ID of the entity.

Example response

{
  "id": "5e68c66581f2ee32bc354087"
}

Changes

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