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

Erc20

Model getters

Method name Return type Description Notes
getSymbol() string The name of the token; used as an identifier within the Tatum platform and as a currency symbol on the blockchain
The token name that you specify here must be the same as the token name in the symbol parameter of the smart contract that you are going to deploy or have already deployed for this token.
Example: MY_TOKEN
 
getSupply() string The supply of the token
Example: 1000000.0
 
getDecimals() float The number of decimal places that the token has
Example: 8
 
getDescription() string The description of the token; used as a description within the Tatum platform and as a currency name on the blockchain
Example: My Public Token
 
getXpub() string The extended public key of the wallet from which a deposit address for the virtual account will be generated
NOTE: On Solana, you only can assign an existing address to the virtual account; use the Erc20Address schema of this API.
Example: xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
 
getDerivationIndex() int The derivation index to use together with the extended public key to generate the deposit address
Example: 0
 
getBasePair() string The base pair for the virtual currency that represents the token; used to calculate the value of a transaction
Example: EUR
 
getBaseRate() float The exchange rate for the base pair; one unit of the created virtual currency equals 1 unit of basePair*baseRate
Example: 1
[optional] [default to 1]
getCustomer() \Tatum\Model\CustomerRegistration
Example: null
[optional]
getAccountingCurrency() string The ISO 4217 code of the currency in which all transactions for the created virtual account will be billed
Example: USD
[optional] [default to ‘EUR’]