Skip to main content Link Menu Expand (external link) Document Search Copy Copied

TransferSol

Model getters

Method name Return type Description Notes
getSenderAccountId() string Sender account ID
Example: 61b3bffddfb389cde19c73be
 
getFrom() string Blockchain account to send from
Example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
 
getAddress() string Blockchain address to send assets
Example: 9B5XszUGdMaxCZ7uSQhPzdks5ZQSmWxrmzCSvtJ6Ns6g
 
getAmount() string Amount to be sent, in SOL / USDC_SOL or custom SPL token based on the senderAccountId currency type.
Example: 10000
 
getPrivateKey() string Private key for account. Private key, or signature Id must be present.
Example: zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
 
getFee() string Fee to be charged for the operation. For SOL, fee is decided by the blockchain, but default SOL fee is 0.000005. This fee will be only charged on top of the withdrawal amount to the virtual account.
Example: 10000
[optional]
getCompliant() bool Compliance check, if withdrawal is not compliant, it will not be processed.
Example: false
[optional]
getPaymentId() string Identifier of the payment, shown for created Transaction within Tatum sender account.
Example: 1234
[optional]
getSenderNote() string Note visible to owner of withdrawing account.
Example: Sender note
[optional]