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

TransferCustodialWalletKMS

Model getters

Method name Return type Description Notes
getChain() string The blockchain to work with
Example: ETH
 
getCustodialAddress() string The gas pump address that transfers the asset; this is the address that you precalculated and activated earlier and that is assigned to a customer in your custodial application; this is not the “master address”
Example: 0x687422eEA2cB73B5d3e242bA5456b782919AFc85
 
getRecipient() string The blockchain address that receives the asset
Example: 0xe242bA5456b782919AFc85687422eEA2cB73B5d3
 
getContractType() float The type of the asset to transfer. Set 0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), 2 for Multi Tokens (ERC-1155 or equivalent), or 3 for native blockchain currencies.
Example: 0
 
getTokenAddress() string (Only if the asset is a fungible token, NFT, or Multi Token) The address of the token to transfer. Do not use if the asset is a native blockchain currency.
Example: 0x782919AFc85eEA2cB736874225456bB5d3e242bA
[optional]
getAmount() string (Only if the asset is a fungible token, Multi Token, or native blockchain currency) The amount of the asset to transfer. Do not use if the asset is an NFT.
Example: 100000
[optional]
getTokenId() string (Only if the asset is a Multi Token or NFT) The ID of the token to transfer. Do not use if the asset is a fungible token or native blockchain currency.
Example: 100000
[optional]
getSignatureId() string The KMS identifier of the private key of the blockchain address that owns the gas pump address key (“master address”)
Example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
 
getIndex() float (Only if the signature ID is mnemonic-based) The index of the “master address”
Example: null
[optional]
getNonce() float The nonce to be set to the transfer transaction; if not present, the last known nonce will be used
Example: 1
[optional]
getFee() \Tatum\Model\CustomFee
Example: null
[optional]