Unblock an amount in an account and perform a transaction

put

https://api.tatum.io/v3/ledger/account/block/{id}

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

2 credits per API call.

Unblocks a previously blocked amount in an account and invokes a ledger transaction from that account to a different recipient. If the request fails, the amount is not unblocked.

Path Params

string

required

Blockage ID

Body Params

recipientAccountId

string

required

length between 24 and 24

Internal recipient account ID within Tatum platform

amount

string

required

length ≤ 38

Amount to be sent. Amount can be smaller then the blocked amount.

anonymous

boolean

Defaults to false

Anonymous transaction does not show sender account to recipient, default is false

compliant

boolean

Enable compliant checks. Transaction will not be processed, if compliant check fails.

transactionCode

string

length between 1 and 100

For bookkeeping to distinct transaction purpose.

paymentId

string

length between 1 and 100

Payment ID, External identifier of the payment, which can be used to pair transactions within Tatum accounts.

recipientNote

string

length between 1 and 500

Note visible to both, sender and recipient

baseRate

number

≥ 0

Defaults to 1

Exchange rate of the base pair. Only applicable for Tatum's Virtual currencies Ledger transactions. Override default exchange rate for the Virtual Currency.

senderNote

string

length between 1 and 500

Note visible to sender

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500Internal server error. There was an error on the server during the processing of the request.