Send Flow or FUSD from Tatum account to address

POST {{baseUrl}}/v3/offchain/flow/transfer

10 credits per API call.


Send Flow or FUSD from Tatum account to address. This will create Tatum internal withdrawal request with ID. If every system works as expected, withdrawal request is marked as complete and transaction id is assigned to it.

  • If Flow server connection is unavailable, withdrawal request is cancelled.
  • If blockchain transfer is successful, but is it not possible to reach Tatum, transaction id of blockchain transaction is returned and withdrawal request must be completed manually, otherwise all other withdrawals will be pending.
There are two possibilites how the transaction on the blockchain can be created:
  • Using mnemonic and index - private key is generated based on the index in the mnemonic.
  • Using secret - private keys is entered manually.
It is possible to perform ledger to blockchain transaction for ledger accounts without blockchain address assigned to them.
This method is a helper method, which internally wraps these steps:
  1. Store withdrawal - create a ledger transaction, which debits the assets on the sender account.
  2. Perform blockchain transaction -
  3. Complete withdrawal - move the withdrawal to the completed state, when all of the previous steps were successful.
This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Request Body

{"account"=>"0x955cd3f17b2fd8ad", "senderAccountId"=>"commodolaborum dolore in", "address"=>"nulla culpa occaec", "amount"=>"10000", "mnemonic"=>"urge pulp usage sister evidence arrest palm math please chief egg abuse", "index"=>49343835.71801832, "compliant"=>false, "paymentId"=>"1234", "senderNote"=>"Sender note"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"txId":"c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9","id":"5e68c66581f2ee32bc354087","completed":true}