Api/BlockchainOperationsApi

Blockchain operations API Reference

// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();

// MainNet API Call
$sdk->mainnet()->api()->blockchainOperations();

// TestNet API Call
$sdk->testnet()->api()->blockchainOperations();

Methods

bnbAssetOffchain()

Example

#️⃣ Execute command in terminal

✨ php -f bnbAssetOffchain.php

Request

POST /v3/offchain/bnb/asset

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->bnbAssetOffchain(
    \Tatum\Model\CreateBnbAsset $create_bnb_asset
)

Parameters

Return type

void (empty response body)

Description

Create a BNB-based asset

2 credits per API call.

Create a BNB-based asset in a virtual account. The asset must first be created and configured on BNB Beacon Chain blockhain.

This API call will create an internal virtual currency. You can create virtual accounts with off-chain support.

Back to top

deployAlgoErc20OffchainKMSAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployAlgoErc20OffchainKMSAddress.php

Request

POST /v3/offchain/algo/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployAlgoErc20OffchainKMSAddress(
    \Tatum\Model\DeployAlgoErc20OffchainKMSAddress $deploy_algo_erc20_offchain_kms_address
): \Tatum\Model\DeployAlgoErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployAlgoErc20OffchainMnemonicAddress200Response

Description

Deploy an Algorand ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

deployAlgoErc20OffchainMnemonicAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployAlgoErc20OffchainMnemonicAddress.php

Request

POST /v3/offchain/algo/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployAlgoErc20OffchainMnemonicAddress(
    \Tatum\Model\DeployAlgoErc20OffchainMnemonicAddress $deploy_algo_erc20_offchain_mnemonic_address
): \Tatum\Model\DeployAlgoErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployAlgoErc20OffchainMnemonicAddress200Response

Description

Deploy an Algorand ERC-20-equivalent smart contract to the blockchain and a virtual account

4 credits per API call

Deploy an Algorand ERC-20-equivalent smart contract. This is a helper method, which is combination of Register new Algorand ERC20 token in the ledger and Deploy blockchain ERC20.

After deploying a contract to blockchain, the contract address will become available and must be stored within Tatum. Otherwise, it will not be possible to interact with it and starts automatic blockchain synchronization.

Signing a transaction When deploying an Algorand ERC-20-equivalent smart contract to the blockchain and a virtual account, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

deployAlgoErc20OffchainPKAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployAlgoErc20OffchainPKAddress.php

Request

POST /v3/offchain/algo/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployAlgoErc20OffchainPKAddress(
    \Tatum\Model\DeployAlgoErc20OffchainPKAddress $deploy_algo_erc20_offchain_pk_address
): \Tatum\Model\DeployAlgoErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployAlgoErc20OffchainMnemonicAddress200Response

Description

Deploy an Algorand ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

deployCeloErc20OffchainKMSAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployCeloErc20OffchainKMSAddress.php

Request

POST /v3/offchain/celo/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployCeloErc20OffchainKMSAddress(
    \Tatum\Model\DeployCeloErc20OffchainKMSAddress $deploy_celo_erc20_offchain_kms_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Celo ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

deployCeloErc20OffchainKMSXpub()

Example

#️⃣ Execute command in terminal

✨ php -f deployCeloErc20OffchainKMSXpub.php

Request

POST /v3/offchain/celo/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployCeloErc20OffchainKMSXpub(
    \Tatum\Model\DeployCeloErc20OffchainKMSXpub $deploy_celo_erc20_offchain_kms_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Celo ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

deployCeloErc20OffchainMnemXpub()

Example

#️⃣ Execute command in terminal

✨ php -f deployCeloErc20OffchainMnemXpub.php

Request

POST /v3/offchain/celo/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployCeloErc20OffchainMnemXpub(
    \Tatum\Model\DeployCeloErc20OffchainMnemXpub $deploy_celo_erc20_offchain_mnem_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Celo ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

deployCeloErc20OffchainMnemonicAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployCeloErc20OffchainMnemonicAddress.php

Request

POST /v3/offchain/celo/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployCeloErc20OffchainMnemonicAddress(
    \Tatum\Model\DeployCeloErc20OffchainMnemonicAddress $deploy_celo_erc20_offchain_mnemonic_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Celo ERC-20-equivalent smart contract to the blockchain and a virtual account

4 credits per API call

Deploy a Celo ERC-20-equivalent smart contract. This is a helper method, which is combination of Register new Celo ERC-20 token in the ledger and Deploy blockchain ERC20.

After deploying a contract to blockchain, the contract address will become available and must be stored within Tatum. Otherwise, it will not be possible to interact with it and starts automatic blockchain synchronization.

Signing a transaction When deploying a Celo ERC-20-equivalent smart contract to the blockchain and a virtual account, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

deployCeloErc20OffchainPKAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployCeloErc20OffchainPKAddress.php

Request

POST /v3/offchain/celo/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployCeloErc20OffchainPKAddress(
    \Tatum\Model\DeployCeloErc20OffchainPKAddress $deploy_celo_erc20_offchain_pk_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Celo ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

deployCeloErc20OffchainPKXpub()

Example

#️⃣ Execute command in terminal

✨ php -f deployCeloErc20OffchainPKXpub.php

Request

POST /v3/offchain/celo/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployCeloErc20OffchainPKXpub(
    \Tatum\Model\DeployCeloErc20OffchainPKXpub $deploy_celo_erc20_offchain_pk_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Celo ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

deployErc20OffchainKMSAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployErc20OffchainKMSAddress.php

Request

POST /v3/offchain/ethereum/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployErc20OffchainKMSAddress(
    \Tatum\Model\DeployErc20OffchainKMSAddress $deploy_erc20_offchain_kms_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy an Ethereum ERC-20 smart contract to the blockchain and a virtual account

Back to top

deployErc20OffchainKMSXpub()

Example

#️⃣ Execute command in terminal

✨ php -f deployErc20OffchainKMSXpub.php

Request

POST /v3/offchain/ethereum/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployErc20OffchainKMSXpub(
    \Tatum\Model\DeployErc20OffchainKMSXpub $deploy_erc20_offchain_kms_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy an Ethereum ERC-20 smart contract to the blockchain and a virtual account

Back to top

deployErc20OffchainMnemXpub()

Example

#️⃣ Execute command in terminal

✨ php -f deployErc20OffchainMnemXpub.php

Request

POST /v3/offchain/ethereum/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployErc20OffchainMnemXpub(
    \Tatum\Model\DeployErc20OffchainMnemXpub $deploy_erc20_offchain_mnem_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy an Ethereum ERC-20 smart contract to the blockchain and a virtual account

Back to top

deployErc20OffchainMnemonicAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployErc20OffchainMnemonicAddress.php

Request

POST /v3/offchain/ethereum/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployErc20OffchainMnemonicAddress(
    \Tatum\Model\DeployErc20OffchainMnemonicAddress $deploy_erc20_offchain_mnemonic_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy an Ethereum ERC-20 smart contract to the blockchain and a virtual account

4 credits per API call

Deploy an Ethereum ERC-20 smart contract. This is a helper method, which is combination of Register new ERC20 token in the ledger and Deploy blockchain ERC20.

After deploying a contract to blockchain, the contract address will become available and must be stored within Tatum. Otherwise, it will not be possible to interact with it and starts automatic blockchain synchronization.

Signing a transaction When deploying an Ethereum ERC-20 smart contract to the blockchain and a virtual account, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

deployErc20OffchainPKAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployErc20OffchainPKAddress.php

Request

POST /v3/offchain/ethereum/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployErc20OffchainPKAddress(
    \Tatum\Model\DeployErc20OffchainPKAddress $deploy_erc20_offchain_pk_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy an Ethereum ERC-20 smart contract to the blockchain and a virtual account

Back to top

deployErc20OffchainPKXpub()

Example

#️⃣ Execute command in terminal

✨ php -f deployErc20OffchainPKXpub.php

Request

POST /v3/offchain/ethereum/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployErc20OffchainPKXpub(
    \Tatum\Model\DeployErc20OffchainPKXpub $deploy_erc20_offchain_pk_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy an Ethereum ERC-20 smart contract to the blockchain and a virtual account

Back to top

deployTrcOffchainKMSAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployTrcOffchainKMSAddress.php

Request

POST /v3/offchain/tron/trc/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployTrcOffchainKMSAddress(
    \Tatum\Model\DeployTrcOffchainKMSAddress $deploy_trc_offchain_kms_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a TRON TRC-10 or TRC-20 smart contract to the blockchain and a virtual account

Back to top

deployTrcOffchainKMSXpub()

Example

#️⃣ Execute command in terminal

✨ php -f deployTrcOffchainKMSXpub.php

Request

POST /v3/offchain/tron/trc/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployTrcOffchainKMSXpub(
    \Tatum\Model\DeployTrcOffchainKMSXpub $deploy_trc_offchain_kms_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a TRON TRC-10 or TRC-20 smart contract to the blockchain and a virtual account

Back to top

deployTrcOffchainMnemXpub()

Example

#️⃣ Execute command in terminal

✨ php -f deployTrcOffchainMnemXpub.php

Request

POST /v3/offchain/tron/trc/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployTrcOffchainMnemXpub(
    \Tatum\Model\DeployTrcOffchainMnemXpub $deploy_trc_offchain_mnem_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a TRON TRC-10 or TRC-20 smart contract to the blockchain and a virtual account

Back to top

deployTrcOffchainMnemonicAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployTrcOffchainMnemonicAddress.php

Request

POST /v3/offchain/tron/trc/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployTrcOffchainMnemonicAddress(
    \Tatum\Model\DeployTrcOffchainMnemonicAddress $deploy_trc_offchain_mnemonic_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a TRON TRC-10 or TRC-20 smart contract to the blockchain and a virtual account

10 credits per API call

Deploy a TRON TRC-10 or TRC-20 smart contract. This is a helper method, which is combination of Register new TRC-10/20 token in the ledger and Deploy blockchain TRC20 or Deploy blockchain TRC10.

After deploying a contract to blockchain, the contract address will become available and must be stored within Tatum. Otherwise, it will not be possible to interact with it and starts automatic blockchain synchronization.

Signing a transaction When deploying a TRON TRC-10 or TRC-20 smart contract to the blockchain and a virtual account, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

deployTrcOffchainPKAddress()

Example

#️⃣ Execute command in terminal

✨ php -f deployTrcOffchainPKAddress.php

Request

POST /v3/offchain/tron/trc/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployTrcOffchainPKAddress(
    \Tatum\Model\DeployTrcOffchainPKAddress $deploy_trc_offchain_pk_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a TRON TRC-10 or TRC-20 smart contract to the blockchain and a virtual account

Back to top

deployTrcOffchainPKXpub()

Example

#️⃣ Execute command in terminal

✨ php -f deployTrcOffchainPKXpub.php

Request

POST /v3/offchain/tron/trc/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->deployTrcOffchainPKXpub(
    \Tatum\Model\DeployTrcOffchainPKXpub $deploy_trc_offchain_pk_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a TRON TRC-10 or TRC-20 smart contract to the blockchain and a virtual account

Back to top

erc20()

Example

#️⃣ Execute command in terminal

✨ php -f erc20.php

Request

POST /v3/offchain/token/{chain}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->erc20(
    string $chain,
    \Tatum\Model\Erc20 $erc20
): \Tatum\Model\Erc20Response

Parameters

Return type

\Tatum\Model\Erc20Response

Description

Register a new ERC-20 or ERC-20-equivalent token in the virtual account

2 credits per API call.

This is the first step to create a new ERC-20 or ERC-20 equivalent token with some supply in a virtual account. This method only creates Tatum Private ledger virtual currency with predefined parameters. It will not generate any blockchain smart contract. The whole supply of token is stored in the customer’s newly created account. Then it is possible to create new Tatum accounts with token name as account’s currency. Newly created account is frozen until the specific smart contract address is linked with the Tatum virtual currency, representing the token. Order of the steps to create smart contract with Tatum private ledger support:

1. Register token (this API) - creates a virtual currency within Tatum
2. Deploy smart contract - create new smart contract on the blockchain
3. Store smart contract address - link newly created smart contract address with Tatum virtual currency - this operation enables frozen account and enables ledger synchronization for Tatum accounts Blockchain address will be assigned to the virtual account as a deposit address. It can be defined via the address explicitly or by using xpub and derivationIndex.

Back to top

erc20Address()

Example

#️⃣ Execute command in terminal

✨ php -f erc20Address.php

Request

POST /v3/offchain/token/{chain}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->erc20Address(
    string $chain,
    \Tatum\Model\Erc20Address $erc20_address
): \Tatum\Model\Erc20Response

Parameters

Return type

\Tatum\Model\Erc20Response

Description

Register a new ERC-20 or ERC-20-equivalent token in the virtual account

Back to top

offBscDeployErc20OffchainKMSAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offBscDeployErc20OffchainKMSAddress.php

Request

POST /v3/offchain/bsc/bep20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offBscDeployErc20OffchainKMSAddress(
    \Tatum\Model\DeployErc20OffchainKMSAddress $deploy_erc20_offchain_kms_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a BNB Smart Chain BEP-20 smart contract to the blockchain and a virtual account

Back to top

offBscDeployErc20OffchainKMSXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offBscDeployErc20OffchainKMSXpub.php

Request

POST /v3/offchain/bsc/bep20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offBscDeployErc20OffchainKMSXpub(
    \Tatum\Model\DeployErc20OffchainKMSXpub $deploy_erc20_offchain_kms_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a BNB Smart Chain BEP-20 smart contract to the blockchain and a virtual account

Back to top

offBscDeployErc20OffchainMnemXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offBscDeployErc20OffchainMnemXpub.php

Request

POST /v3/offchain/bsc/bep20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offBscDeployErc20OffchainMnemXpub(
    \Tatum\Model\DeployErc20OffchainMnemXpub $deploy_erc20_offchain_mnem_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a BNB Smart Chain BEP-20 smart contract to the blockchain and a virtual account

Back to top

offBscDeployErc20OffchainMnemonicAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offBscDeployErc20OffchainMnemonicAddress.php

Request

POST /v3/offchain/bsc/bep20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offBscDeployErc20OffchainMnemonicAddress(
    \Tatum\Model\DeployErc20OffchainMnemonicAddress $deploy_erc20_offchain_mnemonic_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a BNB Smart Chain BEP-20 smart contract to the blockchain and a virtual account

4 credits per API call

Deploy a BNB Smart Chain BEP-20 smart contract. This is a helper method, which is combination of Register new BEP20 token in the ledger and Deploy blockchain ERC20.

After deploying a contract to blockchain, the contract address will become available and must be stored within Tatum. Otherwise, it will not be possible to interact with it and starts automatic blockchain synchronization.

Signing a transaction When deploying a BNB Smart Chain BEP-20 smart contract to the blockchain and a virtual account, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

offBscDeployErc20OffchainPKAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offBscDeployErc20OffchainPKAddress.php

Request

POST /v3/offchain/bsc/bep20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offBscDeployErc20OffchainPKAddress(
    \Tatum\Model\DeployErc20OffchainPKAddress $deploy_erc20_offchain_pk_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a BNB Smart Chain BEP-20 smart contract to the blockchain and a virtual account

Back to top

offBscDeployErc20OffchainPKXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offBscDeployErc20OffchainPKXpub.php

Request

POST /v3/offchain/bsc/bep20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offBscDeployErc20OffchainPKXpub(
    \Tatum\Model\DeployErc20OffchainPKXpub $deploy_erc20_offchain_pk_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a BNB Smart Chain BEP-20 smart contract to the blockchain and a virtual account

Back to top

offEglTransferEth()

Example

#️⃣ Execute command in terminal

✨ php -f offEglTransferEth.php

Request

POST /v3/offchain/egld/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offEglTransferEth(
    \Tatum\Model\TransferEth $transfer_eth
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send EGLD from a virtual account to the blockchain

4 credits per API call.

Send EGLD from a virtual account to the blockchain. This will create Tatum internal withdrawal request with ID. If every system works as expected, withdrawal request is marked as complete and transaction id is assigned to it.

• If server connection is unavailable, withdrawal request is cancelled.
• If blockchain transfer is successful, but is it not possible to reach Tatum, transaction id of blockchain transaction is returned and withdrawal request must be completed manually, otherwise all other withdrawals will be pending. It is possible to perform ledger to blockchain transaction for ledger accounts without blockchain address assigned to them. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Back to top

offEglTransferEthKMS()

Example

#️⃣ Execute command in terminal

✨ php -f offEglTransferEthKMS.php

Request

POST /v3/offchain/egld/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offEglTransferEthKMS(
    \Tatum\Model\TransferEthKMS $transfer_eth_kms
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send EGLD from a virtual account to the blockchain

Back to top

offEglTransferEthMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f offEglTransferEthMnemonic.php

Request

POST /v3/offchain/egld/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offEglTransferEthMnemonic(
    \Tatum\Model\TransferEthMnemonic $transfer_eth_mnemonic
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send EGLD from a virtual account to the blockchain

Back to top

offKcsDeployErc20OffchainKMSAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offKcsDeployErc20OffchainKMSAddress.php

Request

POST /v3/offchain/kcs/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKcsDeployErc20OffchainKMSAddress(
    \Tatum\Model\DeployErc20OffchainKMSAddress $deploy_erc20_offchain_kms_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a KuCoin Community Chain (KCC) ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKcsDeployErc20OffchainKMSXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offKcsDeployErc20OffchainKMSXpub.php

Request

POST /v3/offchain/kcs/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKcsDeployErc20OffchainKMSXpub(
    \Tatum\Model\DeployErc20OffchainKMSXpub $deploy_erc20_offchain_kms_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a KuCoin Community Chain (KCC) ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKcsDeployErc20OffchainMnemXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offKcsDeployErc20OffchainMnemXpub.php

Request

POST /v3/offchain/kcs/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKcsDeployErc20OffchainMnemXpub(
    \Tatum\Model\DeployErc20OffchainMnemXpub $deploy_erc20_offchain_mnem_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a KuCoin Community Chain (KCC) ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKcsDeployErc20OffchainMnemonicAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offKcsDeployErc20OffchainMnemonicAddress.php

Request

POST /v3/offchain/kcs/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKcsDeployErc20OffchainMnemonicAddress(
    \Tatum\Model\DeployErc20OffchainMnemonicAddress $deploy_erc20_offchain_mnemonic_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a KuCoin Community Chain (KCC) ERC-20-equivalent smart contract to the blockchain and a virtual account

4 credits per API call

Deploy a KuCoin Community Chain (KCC) ERC-20-equivalent smart contract. This is a helper method, which is combination of Register new Kcs ERC20 token in the ledger and Deploy blockchain ERC20.

After deploying a contract to blockchain, the contract address will become available and must be stored within Tatum. Otherwise, it will not be possible to interact with it and starts automatic blockchain synchronization.

Signing a transaction When deploying a KCC ERC-20-equivalent smart contract to the blockchain and a virtual account, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

offKcsDeployErc20OffchainPKAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offKcsDeployErc20OffchainPKAddress.php

Request

POST /v3/offchain/kcs/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKcsDeployErc20OffchainPKAddress(
    \Tatum\Model\DeployErc20OffchainPKAddress $deploy_erc20_offchain_pk_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a KuCoin Community Chain (KCC) ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKcsDeployErc20OffchainPKXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offKcsDeployErc20OffchainPKXpub.php

Request

POST /v3/offchain/kcs/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKcsDeployErc20OffchainPKXpub(
    \Tatum\Model\DeployErc20OffchainPKXpub $deploy_erc20_offchain_pk_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a KuCoin Community Chain (KCC) ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKlaDeployErc20OffchainKMSAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offKlaDeployErc20OffchainKMSAddress.php

Request

POST /v3/offchain/klaytn/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKlaDeployErc20OffchainKMSAddress(
    \Tatum\Model\DeployErc20OffchainKMSAddress $deploy_erc20_offchain_kms_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Klaytn ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKlaDeployErc20OffchainKMSXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offKlaDeployErc20OffchainKMSXpub.php

Request

POST /v3/offchain/klaytn/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKlaDeployErc20OffchainKMSXpub(
    \Tatum\Model\DeployErc20OffchainKMSXpub $deploy_erc20_offchain_kms_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Klaytn ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKlaDeployErc20OffchainMnemXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offKlaDeployErc20OffchainMnemXpub.php

Request

POST /v3/offchain/klaytn/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKlaDeployErc20OffchainMnemXpub(
    \Tatum\Model\DeployErc20OffchainMnemXpub $deploy_erc20_offchain_mnem_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Klaytn ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKlaDeployErc20OffchainMnemonicAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offKlaDeployErc20OffchainMnemonicAddress.php

Request

POST /v3/offchain/klaytn/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKlaDeployErc20OffchainMnemonicAddress(
    \Tatum\Model\DeployErc20OffchainMnemonicAddress $deploy_erc20_offchain_mnemonic_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Klaytn ERC-20-equivalent smart contract to the blockchain and a virtual account

4 credits per API call

Deploy a Klaytn ERC-20-equivalent smart contract. This is a helper method, which is combination of Register new ERC20 token in the ledger and Deploy blockchain ERC20.

After deploying a contract to blockchain, the contract address will become available and must be stored within Tatum. Otherwise, it will not be possible to interact with it and starts automatic blockchain synchronization.

Signing a transaction When deploying a Klaytn ERC-20-equivalent smart contract to the blockchain and a virtual account, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

offKlaDeployErc20OffchainPKAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offKlaDeployErc20OffchainPKAddress.php

Request

POST /v3/offchain/klaytn/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKlaDeployErc20OffchainPKAddress(
    \Tatum\Model\DeployErc20OffchainPKAddress $deploy_erc20_offchain_pk_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Klaytn ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKlaDeployErc20OffchainPKXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offKlaDeployErc20OffchainPKXpub.php

Request

POST /v3/offchain/klaytn/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKlaDeployErc20OffchainPKXpub(
    \Tatum\Model\DeployErc20OffchainPKXpub $deploy_erc20_offchain_pk_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Klaytn ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offKlaTransferEth()

Example

#️⃣ Execute command in terminal

✨ php -f offKlaTransferEth.php

Request

POST /v3/offchain/klaytn/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKlaTransferEth(
    \Tatum\Model\TransferEth $transfer_eth
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send KLAY from a virtual account to the blockchain

4 credits per API call.

Send KLAY or ERC-20-equivalent tokens from a virtual account to the blockchain. This will create Tatum internal withdrawal request with ID. If every system works as expected, withdrawal request is marked as complete and transaction id is assigned to it.

• If KLAY server connection is unavailable, withdrawal request is cancelled.
• If blockchain transfer is successful, but is it not possible to reach Tatum, transaction id of blockchain transaction is returned and withdrawal request must be completed manually, otherwise all other withdrawals will be pending. It is possible to perform ledger to blockchain transaction for ledger accounts without blockchain address assigned to them. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Back to top

offKlaTransferEthKMS()

Example

#️⃣ Execute command in terminal

✨ php -f offKlaTransferEthKMS.php

Request

POST /v3/offchain/klaytn/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKlaTransferEthKMS(
    \Tatum\Model\TransferEthKMS $transfer_eth_kms
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send KLAY from a virtual account to the blockchain

Back to top

offKlaTransferEthMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f offKlaTransferEthMnemonic.php

Request

POST /v3/offchain/klaytn/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offKlaTransferEthMnemonic(
    \Tatum\Model\TransferEthMnemonic $transfer_eth_mnemonic
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send KLAY from a virtual account to the blockchain

Back to top

offOneDeployErc20OffchainKMSAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offOneDeployErc20OffchainKMSAddress.php

Request

POST /v3/offchain/one/hrm20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offOneDeployErc20OffchainKMSAddress(
    \Tatum\Model\DeployErc20OffchainKMSAddress $deploy_erc20_offchain_kms_address,
    [ float $shard_id = 0 ]
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Harmony HRM-20 smart contract to the blockchain and a virtual account

Back to top

offOneDeployErc20OffchainKMSXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offOneDeployErc20OffchainKMSXpub.php

Request

POST /v3/offchain/one/hrm20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offOneDeployErc20OffchainKMSXpub(
    \Tatum\Model\DeployErc20OffchainKMSXpub $deploy_erc20_offchain_kms_xpub,
    [ float $shard_id = 0 ]
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Harmony HRM-20 smart contract to the blockchain and a virtual account

Back to top

offOneDeployErc20OffchainMnemXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offOneDeployErc20OffchainMnemXpub.php

Request

POST /v3/offchain/one/hrm20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offOneDeployErc20OffchainMnemXpub(
    \Tatum\Model\DeployErc20OffchainMnemXpub $deploy_erc20_offchain_mnem_xpub,
    [ float $shard_id = 0 ]
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Harmony HRM-20 smart contract to the blockchain and a virtual account

Back to top

offOneDeployErc20OffchainMnemonicAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offOneDeployErc20OffchainMnemonicAddress.php

Request

POST /v3/offchain/one/hrm20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offOneDeployErc20OffchainMnemonicAddress(
    \Tatum\Model\DeployErc20OffchainMnemonicAddress $deploy_erc20_offchain_mnemonic_address,
    [ float $shard_id = 0 ]
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Harmony HRM-20 smart contract to the blockchain and a virtual account

4 credits per API call

Deploy a Harmony HRM-20 smart contract. This is a helper method, which is combination of Register new HRM20 token in the ledger and Deploy blockchain ERC20.

After deploying a contract to blockchain, the contract address will become available and must be stored within Tatum. Otherwise, it will not be possible to interact with it and starts automatic blockchain synchronization.

Signing a transaction When deploying a Harmony HRM-20 smart contract to the blockchain and a virtual account, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

offOneDeployErc20OffchainPKAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offOneDeployErc20OffchainPKAddress.php

Request

POST /v3/offchain/one/hrm20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offOneDeployErc20OffchainPKAddress(
    \Tatum\Model\DeployErc20OffchainPKAddress $deploy_erc20_offchain_pk_address,
    [ float $shard_id = 0 ]
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Harmony HRM-20 smart contract to the blockchain and a virtual account

Back to top

offOneDeployErc20OffchainPKXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offOneDeployErc20OffchainPKXpub.php

Request

POST /v3/offchain/one/hrm20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offOneDeployErc20OffchainPKXpub(
    \Tatum\Model\DeployErc20OffchainPKXpub $deploy_erc20_offchain_pk_xpub,
    [ float $shard_id = 0 ]
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a Harmony HRM-20 smart contract to the blockchain and a virtual account

Back to top

offOneTransferEth()

Example

#️⃣ Execute command in terminal

✨ php -f offOneTransferEth.php

Request

POST /v3/offchain/one/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offOneTransferEth(
    \Tatum\Model\TransferEth $transfer_eth,
    [ float $shard_id = 0 ]
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send ONE from a virtual account to the blockchain

4 credits per API call.

Send ONE (Harmony) or HRM-20 tokens from a virtual account to the blockchain. This will create Tatum internal withdrawal request with ID. If every system works as expected, withdrawal request is marked as complete and transaction id is assigned to it.

• If ONE server connection is unavailable, withdrawal request is cancelled.
• If blockchain transfer is successful, but is it not possible to reach Tatum, transaction id of blockchain transaction is returned and withdrawal request must be completed manually, otherwise all other withdrawals will be pending. It is possible to perform ledger to blockchain transaction for ledger accounts without blockchain address assigned to them. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Back to top

offOneTransferEthKMS()

Example

#️⃣ Execute command in terminal

✨ php -f offOneTransferEthKMS.php

Request

POST /v3/offchain/one/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offOneTransferEthKMS(
    \Tatum\Model\TransferEthKMS $transfer_eth_kms,
    [ float $shard_id = 0 ]
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send ONE from a virtual account to the blockchain

Back to top

offOneTransferEthMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f offOneTransferEthMnemonic.php

Request

POST /v3/offchain/one/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offOneTransferEthMnemonic(
    \Tatum\Model\TransferEthMnemonic $transfer_eth_mnemonic,
    [ float $shard_id = 0 ]
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send ONE from a virtual account to the blockchain

Back to top

offPolTransferEth()

Example

#️⃣ Execute command in terminal

✨ php -f offPolTransferEth.php

Request

POST /v3/offchain/polygon/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offPolTransferEth(
    \Tatum\Model\TransferEth $transfer_eth
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send MATIC from a virtual account to the blockchain

4 credits per API call.

Send MATIC (Polygon) or ERC-20-equivalent Polygon tokens from a virtual account to the blockchain. This will create Tatum internal withdrawal request with ID. If every system works as expected, withdrawal request is marked as complete and transaction id is assigned to it.

• If Polygon server connection is unavailable, withdrawal request is cancelled.
• If blockchain transfer is successful, but is it not possible to reach Tatum, transaction id of blockchain transaction is returned and withdrawal request must be completed manually, otherwise all other withdrawals will be pending. It is possible to perform ledger to blockchain transaction for ledger accounts without blockchain address assigned to them. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Back to top

offPolTransferEthKMS()

Example

#️⃣ Execute command in terminal

✨ php -f offPolTransferEthKMS.php

Request

POST /v3/offchain/polygon/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offPolTransferEthKMS(
    \Tatum\Model\TransferEthKMS $transfer_eth_kms
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send MATIC from a virtual account to the blockchain

Back to top

offPolTransferEthMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f offPolTransferEthMnemonic.php

Request

POST /v3/offchain/polygon/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offPolTransferEthMnemonic(
    \Tatum\Model\TransferEthMnemonic $transfer_eth_mnemonic
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send MATIC from a virtual account to the blockchain

Back to top

offXdcDeployErc20OffchainKMSAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offXdcDeployErc20OffchainKMSAddress.php

Request

POST /v3/offchain/xdc/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offXdcDeployErc20OffchainKMSAddress(
    \Tatum\Model\DeployErc20OffchainKMSAddress $deploy_erc20_offchain_kms_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a XinFin ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offXdcDeployErc20OffchainKMSXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offXdcDeployErc20OffchainKMSXpub.php

Request

POST /v3/offchain/xdc/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offXdcDeployErc20OffchainKMSXpub(
    \Tatum\Model\DeployErc20OffchainKMSXpub $deploy_erc20_offchain_kms_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a XinFin ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offXdcDeployErc20OffchainMnemXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offXdcDeployErc20OffchainMnemXpub.php

Request

POST /v3/offchain/xdc/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offXdcDeployErc20OffchainMnemXpub(
    \Tatum\Model\DeployErc20OffchainMnemXpub $deploy_erc20_offchain_mnem_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a XinFin ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offXdcDeployErc20OffchainMnemonicAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offXdcDeployErc20OffchainMnemonicAddress.php

Request

POST /v3/offchain/xdc/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offXdcDeployErc20OffchainMnemonicAddress(
    \Tatum\Model\DeployErc20OffchainMnemonicAddress $deploy_erc20_offchain_mnemonic_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a XinFin ERC-20-equivalent smart contract to the blockchain and a virtual account

4 credits per API call

Deploy a XinFin ERC-20-equivalent smart contract. This is a helper method, which is combination of Register new ERC20 token in the ledger and Deploy blockchain ERC20.

After deploying a contract to blockchain, the contract address will become available and must be stored within Tatum. Otherwise, it will not be possible to interact with it and starts automatic blockchain synchronization.

Signing a transaction When deploying a XinFin ERC-20-equivalent smart contract to the blockchain and a virtual account, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

offXdcDeployErc20OffchainPKAddress()

Example

#️⃣ Execute command in terminal

✨ php -f offXdcDeployErc20OffchainPKAddress.php

Request

POST /v3/offchain/xdc/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offXdcDeployErc20OffchainPKAddress(
    \Tatum\Model\DeployErc20OffchainPKAddress $deploy_erc20_offchain_pk_address
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a XinFin ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offXdcDeployErc20OffchainPKXpub()

Example

#️⃣ Execute command in terminal

✨ php -f offXdcDeployErc20OffchainPKXpub.php

Request

POST /v3/offchain/xdc/erc20/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offXdcDeployErc20OffchainPKXpub(
    \Tatum\Model\DeployErc20OffchainPKXpub $deploy_erc20_offchain_pk_xpub
): \Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Parameters

Return type

\Tatum\Model\DeployErc20OffchainMnemonicAddress200Response

Description

Deploy a XinFin ERC-20-equivalent smart contract to the blockchain and a virtual account

Back to top

offXdcTransferEth()

Example

#️⃣ Execute command in terminal

✨ php -f offXdcTransferEth.php

Request

POST /v3/offchain/xdc/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offXdcTransferEth(
    \Tatum\Model\TransferEth $transfer_eth
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send XDC from a virtual account to the blockchain

4 credits per API call.

Send XDC (XinFin) or ERC-20-equivalent XinFin tokens from a virtual account to the blockchain. This will create Tatum internal withdrawal request with ID. If every system works as expected, withdrawal request is marked as complete and transaction id is assigned to it.

• If XDC server connection is unavailable, withdrawal request is cancelled.
• If blockchain transfer is successful, but is it not possible to reach Tatum, transaction id of blockchain transaction is returned and withdrawal request must be completed manually, otherwise all other withdrawals will be pending. It is possible to perform ledger to blockchain transaction for ledger accounts without blockchain address assigned to them. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and losing funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Back to top

offXdcTransferEthKMS()

Example

#️⃣ Execute command in terminal

✨ php -f offXdcTransferEthKMS.php

Request

POST /v3/offchain/xdc/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offXdcTransferEthKMS(
    \Tatum\Model\TransferEthKMS $transfer_eth_kms
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send XDC from a virtual account to the blockchain

Back to top

offXdcTransferEthMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f offXdcTransferEthMnemonic.php

Request

POST /v3/offchain/xdc/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->offXdcTransferEthMnemonic(
    \Tatum\Model\TransferEthMnemonic $transfer_eth_mnemonic
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send XDC from a virtual account to the blockchain

Back to top

storeTokenAddress()

Example

#️⃣ Execute command in terminal

✨ php -f storeTokenAddress.php

Request

POST /v3/offchain/token/{name}/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->storeTokenAddress(
    string $address,
    string $name
)

Parameters

Return type

void (empty response body)

Description

Set the contract address of an ERC-20, ERC-20-equivalent, or TRC-10 token

2 credits per API call

Set the contract address of an ERC-20, ERC-20-equivalent (for example, BEP-20, HRM-20, and so on), or TRC-10 token to be able to communicate with the smart contract.

After creating and deploying the token to the blockchain, the smart contract address is generated and must be set within Tatum. If the address is not set, the Tatum platform will not be able to detect incoming deposits of the tokens and transfer the tokens from virtual accounts to blockchain addresses.

NOTE:

• For Algorand, the contract address is the asset ID (assetId), for example, 55351976.
• For TRON, the contract address is the token ID (tokenId), for example, 1234567.

Back to top

transferAlgo()

Example

#️⃣ Execute command in terminal

✨ php -f transferAlgo.php

Request

POST /v3/offchain/algorand/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->transferAlgo(
    \Tatum\Model\TransferAlgo $transfer_algo
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send ALGO from a virtual account to the blockchain

4 credits per API call

Send Algos or ERC-20-equivalent Algorand tokens from a virtual account (even from a virtual account without deposit addresses adssigned) to the Algorand blockchain.

The recipient has to agree in advance to receive assets because Algorand charges users for storing assets on their addresses, and an Algorand blockchain address by default does not receive assets unless explicitly agreed. Before sending any asset from a virtual account to the blockchain, make sure that the recipient has agreed to receive the assets to their address.

Sending Algorand assets creates an internal Tatum withdrawal request with an ID. If everything works as expected, the withdrawal request is marked as complete and a transaction ID is assigned to it.

• If a server connection is unavailable, the withdrawal request is cancelled.
• If the transfer to the blockchain is successful, but the Tatum infrastructure cannot be accesses, the ID of the blockchain transaction is returned and you have to complete the withdrawal request manually. Otherwise, all other withdrawals will be pending.

Signing a transaction When sending Algos or ERC-20-equivalent Algorand tokens, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

transferAlgoErc20()

Example

#️⃣ Execute command in terminal

✨ php -f transferAlgoErc20.php

Request

POST /v3/offchain/algorand/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->transferAlgoErc20(
    \Tatum\Model\TransferAlgoErc20 $transfer_algo_erc20
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send ALGO from a virtual account to the blockchain

Back to top

transferAlgoKMS()

Example

#️⃣ Execute command in terminal

✨ php -f transferAlgoKMS.php

Request

POST /v3/offchain/algorand/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->transferAlgoKMS(
    \Tatum\Model\TransferAlgoKMS $transfer_algo_kms
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send ALGO from a virtual account to the blockchain

Back to top

transferBchKMS()

Example

#️⃣ Execute command in terminal

✨ php -f transferBchKMS.php

Request

POST /v3/offchain/bcash/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->transferBchKMS(
    \Tatum\Model\TransferBchKMS $transfer_bch_kms
): \Tatum\Model\TransferBtcMnemonic200Response

Parameters

Return type

\Tatum\Model\TransferBtcMnemonic200Response

Description

Send BCH from a virtual account to the blockchain

Back to top

transferBchKeyPair()

Example

#️⃣ Execute command in terminal

✨ php -f transferBchKeyPair.php

Request

POST /v3/offchain/bcash/transfer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->blockchainOperations()->transferBchKeyPair(
    \Tatum\Model\TransferBchKeyPair $transfer_bch_key_pair
): \Tatum\Model\TransferBtcMnemonic200Response