TAtatum
Account

Get blocked amounts in an account

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

1 credit per API call.

Gets blocked amounts for an account.

get/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

Query parameters

pageSizenumber required
Example:10

Max number of items per page is 50.

offsetnumber

Offset to obtain the next page of data.

Response

OK

idstring

The ID of the blockage

accountIdstring

The ID of the account where the amount is blocked

amountstring

The amount blocked on the account

typestring

The type of the blockage

descriptionstring

The description of the blockage

Example response

[
  {
    "id": "5e68c66581f2ee32bc354087",
    "accountId": "5e68c66581f2ee32bc354087",
    "amount": "5",
    "type": "DEBIT_CARD_OP",
    "description": "Card payment in the shop."
  }
]

Changes

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