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

TransferAdaKeyPair

Model getters

Method name Return type Description Notes
getSenderAccountId() string Sender account ID
Example: 5e68c66581f2ee32bc354087
 
getAddress() string Blockchain address to send assets to.
Example: mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7
 
getAmount() string Amount to be withdrawn to blockchain.
Example: 0.001
 
getCompliant() bool Compliance check, if withdrawal is not compliant, it will not be processed.
Example: false
[optional]
getFee() string Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.5 ADA is used.
Example: 0.5
[optional]
getKeyPair() \Tatum\Model\TransferAdaKeyPairKeyPairInner[] Array of assigned blockchain addresses with their private keys. Either mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub. Tatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.
Example: null
 
getAttr() string Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.
Example: null
 
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]