Account

Unblock an amount in an account and perform a transaction

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

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

Blockage ID

Request body

recipientAccountIdstring required

Internal recipient account ID within Tatum platform

amountstring required

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

anonymousboolean

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

compliantboolean

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

transactionCodestring

For bookkeeping to distinct transaction purpose.

paymentIdstring

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

recipientNotestring

Note visible to both, sender and recipient

baseRatenumber

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

senderNotestring

Note visible to sender

Example request

{
  "recipientAccountId": "5e6645712b55823de7ea82f2",
  "amount": "5",
  "transactionCode": "1_01_EXTERNAL_CODE",
  "paymentId": "9625",
  "recipientNote": "Private note",
  "baseRate": 1,
  "senderNote": "Sender note"
}

Response

referencestring

The internal reference to the transaction (a unique identifier of the transaction within the virtual account); if the transaction fails, use this reference to search through the logs

Example response

{
  "reference": "0c64cc04-5412-4e57-a51c-ee5727939bcb"
}

Changes

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