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

CreateAccountXpub

Model getters

Method name Return type Description Notes
getCurrency() string The currency for the virtual account Native blockchain assets: ALGO, BCH, BNB, BSC, BTC, CELO, DOGE, EGLD, ETH, FLOW, KCS, KLAY, LTC, MATIC, ONE, SOL, TRON, VET, XDC, XLM, XRP Digital assets: BADA, BAT, BBCH, BBTC, BDOT, BETH, BLTC, BUSD, BUSD_BSC, BXRP, CAKE, FREE, GMC, LEO, LINK, MKR, MMY, PAX, PAXG, TUSD, UNI, USD_BSC, USDC, USDC_MATIC, USDT, USDT_TRON, WBNB, WBTC, XCON Virtual currency registered on the Tatum platform and starting with the “VC_” prefix BNB assets, XLM assets, and XRP assets created via the Tatum platform Custom fungible tokens (ERC-20 or equivalent, such as BEP-20 or TRC-10/20) registered on the Tatum platform; for more information, see our user documentation
The fungible tokens do not have direct faucets on the testnet. To use them in a testnet environment, you have to register a new fungible token in a virtual account (use this API for TRON TRC-10/20 tokens and this API for any other tokens) and make sure that your tokens minted on the testnet are linked to the token smart contract.
Example: BTC
 
getXpub() string Extended public key to generate addresses from.
Example: xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
 
getCustomer() \Tatum\Model\CustomerRegistration
Example: null
[optional]
getCompliant() bool Enable compliant checks. If this is enabled, it is impossible to create account if compliant check fails.
Example: false
[optional]
getAccountCode() string For bookkeeping to distinct account purpose.
Example: AC_1011_B
[optional]
getAccountingCurrency() string All transaction will be accounted in this currency for all accounts. Currency can be overridden per account level. If not set, customer accountingCurrency is used or EUR by default. ISO-4217
Example: USD
[optional]
getAccountNumber() string Account number from external system.
Example: 123456
[optional]