Interact with the blockchain directly by connecting to the blockchain node and communicating with it through JSON-RPC.
\nEach node-related API supports its own set of the blockchains. The list of the supported blockchains is provided in the API description further in this section.
\n", "name": "Node RPC" }, { "description": "A Tatum Account is the primary building block of Tatum-powered applications. It is an envelope that holds essential information about balances, the state of the account or customer, and to whom the account belongs.
\nAccounts in Tatum are stored within Tatum Private Ledger. Tatum Private Ledger contains information about accounts, the customers that own the accounts, transactions that affect the accounts or virtual currencies present in the ledger.
\nBy default, the private ledger is not connected to any blockchain. It is possible to create an application on it without any blockchain at all. Using Tatum Private Ledger and the building blocks included within it, it is possible to quickly swap the whole application from the ledger to any blockchain supported by Tatum. All of the API calls will remain the same, the only thing that changes is the blockchain the application lives on.
\nMost blockchains do not have any compliance layer at all. It is not possible to freeze funds at a blockchain address or deactivate an address. The Tatum Account has built-in compliance, and it is possible to block funds in the account, freeze outgoing transactions from the account or even completely deactivate the account.\n
An endpoint used to create and list transactions within Tatum Private Ledger. A transaction is performed between 2 accounts with the same currency. To perform an exchange operation between accounts with different currencies, API calls from Order Book sections are available. Transactions in the ledger are instant, with a settlement time of below 200ms.
\nTatum Private Ledger supports microtransactions - a transaction of an amount as little as 1e-30 (30 decimal places). Transactions are atomic.
\nWhen there is an insufficient balance in the sender account, or recipient account cannot receive funds, the transaction is not settled.
An endpoint used to handle customer operations, like updating customer information, enabling/disabling etc.\nWithin Tatum API, a customer represents a client of the entity that communicates with Tatum.
\nCustomers cannot be created via any other operation than Create Ledger Account.
\nDue to compliance restrictions, it is recommended to enter the country of residence of the customer and the country of the provider. The Tatum compliance engine operates based on this information.\n
Register and use Tatum Private Ledger's virtual currencies. You can create your own virtual currency and distribute it amongst your customers.
\nVirtual currencies are used to support FIAT currencies. When a virtual currency is created with basePair of the FIAT currency, it is possible to perform transactions in the private ledger in FIAT.\n
The gas pump is Tatum's feature that helps you manage gas fees in a custodial application. When you use the gas pump, gas fees for any transaction made by your customers (users of your custodial application) are automatically deducted from the master address instead of the customer's address. This eliminates the need to send crypto to each customer's address to pay for gas fees.
\nEach API related to the gas pump supports its own set of the blockchains. The list of the supported blockchains is provided in the API description further in this section.
\n", "name": "Gas pump" }, { "description": "Endpoints to handle subscriptions to the Tatum Platform. Subscriptions allow users to enable some additional features or reports that are not enabled by default,\nlike outgoing off-chain transaction scanning, accounts with balances above the limit, etc.
\n", "name": "Notification subscriptions" }, { "description": "Endpoint to handle Order book operations like creating BID / ASK trades between Tatum Private Virtual accounts, obtaining trade histories, creating futures etc. It is possible to build an exchange based on the Ledger Accounts.
", "name": "Order Book" }, { "description": "Key Management System (KMS) is a comprehensive solution for building custodial applications. KMS runs locally on your server and provides security for generating wallets, addresses, and private keys, and for signing transactions.
\nKMS builds a list of pending transaction to sign and provides the options to complete a transaction after it has been signed and to obtain transaction details with the result of the blockchain operation via the transaction ID.
\nIn KMS, each managed wallet or private key is assigned a unique signature ID (signatureId) that represents that wallet or private key. This signature ID is then used in an API request to identify the wallet.
Depending on the API, you can use the signature ID in an API call request in the following ways:
\ntransferBtcKMS request schema).BtcTransactionFromAddressKMS and BtcTransactionFromUTXOKMS request schemas).transferEthKMS request schema).You can run KMS on the following operating systems:
\n\nFor more information about KMS, see the KMS GitHub repository and the user documentation.
\n\n", "name": "Key Management System" }, { "description": "An endpoint to check if the blockchain address is safe to work with or not.
\n", "name": "Malicious address" }, { "description": "Manage deposit addresses associated with your virtual account.
\nDepending on how virtual accounts are connected to the blockchain, the virtual accounts can be:
\nAn endpoint to handle operations between Tatum Private Ledger and the blockchain, e.g. to create blockchain transactions from ledger accounts,\ncreate custom Ethereum ERC20 tokens, Stellar XLM, or Ripple XRP custom assets and register them as regular currency into the Tatum Private Ledger.
\n", "name": "Blockchain operations" }, { "description": "An endpoint used to create, cancel, or complete withdrawals by customers from Tatum to supported blockchains.\nWithdrawals are always multi-step operations that consist of the following steps:\n
Bitcoin Blockchain enables access to the most commonly used Bitcoin methods. These methods bring a small level of abstraction\nand are used for applications that communicate with the blockchain directly. Some of the methods are used alongside Tatum Private Ledger\nto connect the blockchain and the private ledger, like wallet generation or getting information about transactions.
\nTatum supports 2 chains:\n
Ethereum is a decentralized, open-source blockchain. With Tatum, you can access the most commonly used Ethereum methods. These methods bring a certain level of abstraction and are used for applications that communicate with the blockchain directly. Some of the methods are used alongside virtual accounts to connect the blockchain and a virtual account, like generating a wallet or getting information about transactions.
\nTatum supports the following Ethereum networks:
\nIPFS is a distributed file storage. You can store data to IPFS and read from them.
\n", "name": "IPFS" }, { "description": "Bitcoin Cash Blockchain enables access to the most commonly used Bitcoin Cash methods. These methods bring a small level of abstraction\n and are used for applications that communicate with the blockchain directly. Some of the methods are used alongside Tatum Private Ledger\n to connect the blockchain and the private ledger, like wallet generation or getting information about transactions.
\nTatum supports 2 chains:\n
Build a peer-to-peer NFT marketplace and allow your customers to sell and buy assets. When an asset is sold, the creator is automatically paid, the asset is instantly transferred to the buyer, and you as the owner of the marketplace automatically receive a percentage of the transaction.
\nEach marketplace-related API supports its own set of the blockchains. The list of the supported blockchains is provided in the API description further in this section.
\n", "name": "Marketplace" }, { "description": "Endpoints for leveraging some native blockchain features like transaction fee estimation, custodial onchain wallet for paying gas on behalf of customers or other ready made smart contracts.
\n", "name": "Blockchain utils" }, { "description": "Litecoin Blockchain enables access to the most commonly used Litecoin methods. These methods bring a small level of abstraction and are used for applications that communicate with the blockchain directly. Some of the methods are used alongside Tatum Private Ledger\n to connect the blockchain and the private ledger, like wallet generation or getting information about transactions.
\nTatum supports 2 chains:\n
Dogecoin Blockchain enables access to the most commonly used Dogecoin methods. These methods bring a small level of abstraction\n and are used for applications that communicate with the blockchain directly. Some of the methods are used alongside Tatum Private Ledger\n to connect the blockchain and the private ledger, like wallet generation or getting information about transactions.
\nTatum supports 2 chains:\n
Flow Blockchain enables access to the most commonly used Flow methods. These methods bring a small level of abstraction\n and are used for applications that communicate with the blockchain directly. Some of the methods are used alongside Tatum Private Ledger\n to connect the blockchain and the private ledger, like wallet generation or getting information about transactions.
\nTatum supports FLOW and FUSD stable coin.
\nTatum supports 2 chains:\n
XRP Blockchain enables access to the most commonly used XRP methods. These methods bring a small level of abstraction\n and are used for applications that communicate with the blockchain directly. Some of the methods are used alongside Tatum Private Ledger\n to connect the blockchain and the private ledger, like wallet generation or getting information about transactions.
\n Tatum supports 2 chains:\n
In order to start using the XRP blockchain, we first need to create an XRP account. In XRP, the same account is used for the Mainnet and the Test chain. In order to have the account activated, it must be credited with 20 XRP. Because of this requirement, it is common to use one account for all customers and differentiate them via Destination tags, i.e. a number included in every transaction as an account distinguisher.
\nWhen an off-chain deposit address is created for the ledger account, a Destination tag is generated, e.g. 12345 for that account. When a transaction to the blockchain is performed, it should contain the address of the recipient and the Destination tag as an account distinguisher.
XLM Blockchain enables access to the most commonly used XLM methods. These methods bring a small level of abstraction\nand are used for applications that communicate with the blockchain directly. Some of the methods are used alongside Tatum Private Ledger\nto connect the blockchain and the private ledger, like wallet generation or getting information about transactions.
\nTatum supports 2 chains:\n
The Record section enables the storing of records on the blockchain. A record is stored permanently: it cannot be changed,\ndeleted, or modified by anyone and will be stored on the blockchain forever. Tatum supports storing data on the following blockchains:
\nBinance Blockchain enables access to most commonly used Binance methods.
\nTatum supports 2 chains:\n
VeChain Blockchain enables access to the most commonly used VeChain methods. Tatum does not support off-chain capabilities for the VET blockchain.\nTatum KMS is not supported for VET transactions. VET supports 2 native assets - VET and VTHO. VTHO is used for paying transaction fees.\n
\nTatum supports 2 chains:\n
Support for Cardano is deprecated.
\nCardano is in maintenance mode.
\nCardano is a decentralized, open-source blockchain. With Tatum, you can access the most commonly used Cardano methods. These methods bring a certain level of abstraction and are used for applications that communicate with the blockchain directly. Some of the methods are used alongside virtual accounts to connect the blockchain and a virtual account, like generating a wallet or getting information about transactions.
\nTatum supports only the Cardano mainnet.
\n", "name": "Cardano" }, { "description": "Custodial API is a set of operatinos, which allows you to work with managed blockchain addresses without having its private key.\nYou can easily create new managed address and export its details - with private key as well - once required.
\nThis features are currently in Alpha version.
\"NFT\" stands for \"Non-Fungible Token\", which means that each token is unique and irreplaceable. NFTs are described by the ERC-721 standard on the Ethereum blockchain or by the equivalent standard on the other blockchains.
\nNFTs can be used for nearly any digital asset or good to ensure authenticity and scarcity, for example:
\n
Each NFT-related operation API its own set of the blockchains. The list of the supported blockchains is provided in the API description further in this section.
\n", "name": "NFT (ERC-721 or compatible)" }, { "description": "Fungible tokens are interchangeable and are used as a blockchain representation of the currency. Fungible tokens are described by the ERC-20 standard on the Ethereum blockchain or by the equivalent standard on the other blockchains.
\nEach operation related to fungible tokens supports its own set of the blockchains. The list of the supported blockchains is provided in the operation description further in this section.
\n", "name": "Fungible Tokens (ERC-20 or compatible)" }, { "description": "A Multi Token combines characteristics of fungible and non-fungible tokens. A single Multi Token smart contract allows you to mint fungible, non-fungible, and semi-fungible tokens and process different types of the tokens in a single transaction. Multi Tokens are described by the ERC-1155 standard on the Ethereum blockchain or by the equivalent standard on the other blockchains.
\nMulti Tokens can be used for nearly any digital asset or good to ensure authenticity and scarcity, for example:
\n
Each Multi Token-related operation API its own set of the blockchains. The list of the supported blockchains is provided in the API description further in this section.
\n", "name": "Multi Tokens (ERC-1155 or compatible)" }, { "description": "Solana is a blockchain network focused on fast transactions and high throughput. It uses a unique method of ordering transactions to improve its speed. Users can pay their transaction fees and interact with smart contracts with SOL, the network's native cryptocurrency.
\nFor now, Solana is in BETA and there is a rate limitation applied for all projects for Solana to 40 req/s on the platform.
\nTatum supports 2 chains:\n
Binance Smart Chain is an Ethereum EVM 100% compatible blockchain, and is very good for decentralized application (Dapp) development within many possible verticals including DeFi, NFT, Gaming, and many others.
\nTatum supports 2 chains:\n
Polygon (Matic) is an Ethereum EVM 100% compatible blockchain, and is very good for decentralized application (Dapp) development within many possible verticals including DeFi, NFT, Gaming, and many others.
\nTatum supports 2 chains:\n
Celo is fork of Celo with more than 1000 tps and possibility to pay for\ntransactions in it's own stable coin, cUSD. Celo Blockchain enables access to most commonly used Celo methods.\nThese methods bring small level of abstraction,\n and are used for the type of applications that want to communicate with blockchain directly. Some of the methods are used alongside Tatum Private Ledger\n to connect blockchain and private ledger together, like wallet generation or getting information about transactions.
\n Tatum supports 2 chains:\n
Elrond (EGLD) is a distributed transactional computation protocol which relies on a sharded state architecture and a secure Proof of Stake consensus mechanism.\n
\nTatum supports 2 chains:\n
Algorand is a decentralized blockchain technology network. Algorand is enabling the simple creation of next generation financial products, protocols and exchange of value across defi, financial institutions and governments.
\nTatum supports 2 chains:\n
Tron Blockchain enables access to most commonly used Tron methods. It's possible to generate TRON account, send TRX, TRC10 and TRC20 assets. It's also possible to generate custom TRC10 or TRC20 tokens using API.
\nTatum supports 2 chains:\n
Klaytn is an Ethereum EVM 100% compatible blockchain, and is very good for decentralized application (Dapp) development within many possible verticals including DeFi, NFT, Gaming, and many others.
\nTatum supports 2 chains:\n
Harmony.ONE is an Oneeum L2 scaling solution 100% EVM compatible, and is very good for decentralized application (Dapp) development within many possible verticals including DeFi, NFT, Gaming, and many others.
\nTatum supports 2 chains:\n
XDC Network (XinFin) is enterprise ready hybrid blockchain for global trade and finance, combining the power of Public & Private blockchains with interoperable Smart Contracts.\n
\nTatum supports 2 chains:\n
Kcs (KCS) is an Ethereum EVM 100% compatible blockchain, and is very good for decentralized application (Dapp) development within many possible verticals including DeFi, NFT, Gaming, and many others.
\nTatum supports 2 chains:\n
2 credits per API call
\nCreate a new virtual account for a customer.
\nYou can create a virtual account for any supported cryptocurrency, fiat currency, Tatum virtual currency, or fungible tokens created within Tatum. Once the currency/asset is set for a virtual account, it cannot be changed.
\nVirtual account balance
\nA virtual account has its own balance. The balance can be logically presented by the account balance and available balance:
\naccountBalance) represents all assets on the account, both available and blocked.availableBalance) represents the account balance minus the blocked assets. Use the available balance to determine how much a customer can send or withdraw from their virtual account.Cryptocurrency virtual accounts
\nWhen you create a virtual account based on a cryptocurrency (for example, BTC or ETH), you have to provide the extended public key (xpub) of the blockchain wallet that will be connected to this account.
NOTE: Adding xpub to the virtual account does not connect any specific blockchain address to this account. xpub is a generator of addresses, not an address itself.
Not all blockchains provide xpub for wallets, or Tatum may not support wallets on some blockchains. In such cases, use the wallet address or the account address instead.
xpub provided; use address from the generated wallet instead.xpub from the generated wallet.xpub provided; use address from the generated wallet instead.xpub from the generated wallet instead.xpub from the generated wallet instead.xpub from the generated wallet.xpub from the generated wallet.xpub provided; use address from the generated blockchain address instead.xpub from the generated wallet.xpub from the generated wallet.xpub from the generated wallet.xpub from the generated wallet.xpub from the generated wallet.xpub from the generated wallet.xpub provided; use address from the generated wallet instead.xpub from the generated wallet.xpub from the generated wallet.xpub provided; use address from the generated account instead.xpub provided; use address from the generated account instead.Connect a virtual account to the blockchain
\nxpub, generate a new blockchain address for this account.xpub, assign an existing blockchain address to this account.You can connect multiple blockchain addresses to one virtual account.
\n", "operationId": "createAccount", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateAccountXpub" }, { "$ref": "#/components/schemas/CreateAccount" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403ComplianceBtc" }, { "$ref": "#/components/schemas/Error403ComplianceEth" }, { "$ref": "#/components/schemas/Error403AccountTestnet" }, { "$ref": "#/components/schemas/Error403AccountXpub" }, { "$ref": "#/components/schemas/Error403AccountCurrency" }, { "$ref": "#/components/schemas/Error403AccountIncompatibleXpub" }, { "$ref": "#/components/schemas/Error403AccountIncompatibleXpubBtc" }, { "$ref": "#/components/schemas/Error403AccountAddressGeneral" }, { "$ref": "#/components/schemas/Error403CustomerNotExists" }, { "$ref": "#/components/schemas/Error403CustomerNotActive" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Create a virtual account", "tags": ["Account"] }, "get": { "description": "Lists all accounts. Inactive accounts are also visible.
", "operationId": "getAccounts", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 20, "maximum": 50, "minimum": 1 }, "required": false }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "number", "example": 0 } }, { "description": "Direction of sorting. Can be asc or desc", "in": "query", "name": "sort", "schema": { "type": "string", "enum": ["asc", "desc"], "example": "asc" } }, { "description": "Sort by", "in": "query", "name": "sortBy", "schema": { "type": "string", "example": "_id", "enum": ["_id", "account_number", "account_balance", "available_balance"] } }, { "description": "Filter only active or non active accounts", "in": "query", "name": "active", "schema": { "type": "boolean", "example": true } }, { "description": "Filter only accounts with non zero balances", "in": "query", "name": "onlyNonZeroBalance", "schema": { "type": "boolean", "example": true } }, { "description": "Filter only frozen or non frozen accounts", "in": "query", "name": "frozen", "schema": { "type": "boolean", "example": true } }, { "description": "Filter by currency", "in": "query", "name": "currency", "schema": { "type": "string", "example": "BTC" } }, { "description": "Filter by account number", "in": "query", "name": "accountNumber", "schema": { "maxLength": 50, "example": "AC_1011_B", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Account" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all accounts", "tags": ["Account"] } }, "/v3/ledger/account/count": { "get": { "description": "Count of accounts that were found from /v3/ledger/account
", "operationId": "getAccountsCount", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 20, "maximum": 50, "minimum": 1 }, "required": false }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "number", "example": 0 } }, { "description": "Direction of sorting. Can be asc or desc", "in": "query", "name": "sort", "schema": { "type": "string", "enum": ["asc", "desc"] } }, { "description": "Sort by", "in": "query", "name": "sortBy", "schema": { "type": "string", "example": "_id", "enum": ["_id", "account_number", "account_balance", "available_balance"] } }, { "description": "Filter only active or non active accounts", "in": "query", "name": "active", "schema": { "type": "boolean", "example": true } }, { "description": "Filter only accounts with non zero balances", "in": "query", "name": "onlyNonZeroBalance", "schema": { "type": "boolean", "example": true } }, { "description": "Filter only frozen or non frozen accounts", "in": "query", "name": "frozen", "schema": { "type": "boolean", "example": true } }, { "description": "Filter by currency", "in": "query", "name": "currency", "schema": { "type": "string", "example": "BTC" } }, { "description": "Filter by account number", "in": "query", "name": "accountNumber", "schema": { "maxLength": 50, "example": "AC_1011_B", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesCount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Count of found entities for get accounts request", "tags": ["Account"] } }, "/v3/ledger/account/batch": { "post": { "description": "Creates new accounts for the customer in a batch call.
\n", "operationId": "createAccountBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountBatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403ComplianceBtc" }, { "$ref": "#/components/schemas/Error403ComplianceEth" }, { "$ref": "#/components/schemas/Error403AccountTestnet" }, { "$ref": "#/components/schemas/Error403AccountXpub" }, { "$ref": "#/components/schemas/Error403AccountCurrency" }, { "$ref": "#/components/schemas/Error403AccountIncompatibleXpub" }, { "$ref": "#/components/schemas/Error403AccountIncompatibleXpubBtc" }, { "$ref": "#/components/schemas/Error403AccountAddressGeneral" }, { "$ref": "#/components/schemas/Error403CustomerNotExists" }, { "$ref": "#/components/schemas/Error403CustomerNotActive" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Create multiple accounts in a batch call", "tags": ["Account"] } }, "/v3/ledger/account/customer/{id}": { "get": { "description": "Lists all accounts associated with a customer. Only active accounts are visible.
", "operationId": "getAccountsByCustomerId", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain the next page of data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Internal customer ID", "in": "path", "name": "id", "required": true, "schema": { "example": "5e68c66581f2ee32bc354087", "type": "string" } }, { "description": "For bookkeeping to distinct account purpose.", "in": "query", "name": "accountCode", "schema": { "maxLength": 50, "example": "AC_1011_B", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Account" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all customer accounts", "tags": ["Account"] } }, "/v3/ledger/account/{id}": { "get": { "description": "Gets active account by ID. Displays all information regarding the given account.
", "operationId": "getAccountByAccountId", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403AccountNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get account by ID", "tags": ["Account"] }, "put": { "description": "Update account by ID. Only a small number of fields can be updated.
", "operationId": "updateAccountByAccountId", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccount" } } }, "required": true }, "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403AccountNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Update account", "tags": ["Account"] } }, "/v3/ledger/account/{id}/balance": { "get": { "description": "Get balance for the account.
", "operationId": "getAccountBalance", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountBalance" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403AccountNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get account balance", "tags": ["Account"] } }, "/v3/ledger/account/block/{id}": { "post": { "description": "Blocks an amount in an account. Any number of distinct amounts can be blocked in one account.\nEvery new blockage has its own distinct ID, which is used as a reference. When the amount is blocked, it is debited from the available balance of the account.\nThe account balance remains the same. The account balance represents the total amount of funds in the account. The available balance represents the total amount of funds that can be used to perform transactions. When an account is frozen, the available balance is set to 0 minus all blockages for the account.
\n", "operationId": "blockAmount", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e6be89ee6aa436299950c3f" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockAmount" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403CustomerNotExists" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Block an amount in an account", "tags": ["Account"] }, "put": { "description": "Unblocks a previously blocked amount in an account and invokes a ledger transaction from that account to a different recipient.\nIf the request fails, the amount is not unblocked.
\n", "operationId": "unblockAmountWithTransaction", "parameters": [ { "description": "Blockage ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e6be89ee6aa436299950c3f" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnblockAmount" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionResult" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BlockageNotExists" }, { "$ref": "#/components/schemas/Error403BlockageAmount" }, { "$ref": "#/components/schemas/Error403AmountFormat" }, { "$ref": "#/components/schemas/Error403TxSenderNotFound" }, { "$ref": "#/components/schemas/Error403ComplianceBtc" }, { "$ref": "#/components/schemas/Error403ComplianceEth" }, { "$ref": "#/components/schemas/Error403RateNotFound" }, { "$ref": "#/components/schemas/Error403VCNotFound" }, { "$ref": "#/components/schemas/Error403TxSenderFrozen" }, { "$ref": "#/components/schemas/Error403TxSenderCustomerDisabled" }, { "$ref": "#/components/schemas/Error403TxRecipientNotFound" }, { "$ref": "#/components/schemas/Error403TxCurrency" }, { "$ref": "#/components/schemas/Error403TxBalance" }, { "$ref": "#/components/schemas/Error403TxAmountBtc" }, { "$ref": "#/components/schemas/Error403TxAmountEth" }, { "$ref": "#/components/schemas/Error403TxNotCompliant" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Unblock an amount in an account and perform a transaction", "tags": ["Account"] }, "delete": { "description": "Unblocks a previously blocked amount in an account. Increases the available balance in the account where the amount was blocked.
", "operationId": "deleteBlockAmount", "parameters": [ { "description": "Blockage ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e6be89ee6aa436299950c3f" } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Unblock a blocked amount in an account", "tags": ["Account"] }, "get": { "description": "Gets blocked amounts for an account.
", "operationId": "getBlockAmount", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e6be89ee6aa436299950c3f" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain the next page of data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockage" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get blocked amounts in an account", "tags": ["Account"] } }, "/v3/ledger/account/block/{id}/detail": { "get": { "description": "Gets blocked amount by id.
", "operationId": "getBlockAmountById", "parameters": [ { "description": "Blocked amount ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e6be89ee6aa436299950c3f" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blockage" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get blocked amount by ID", "tags": ["Account"] } }, "/v3/ledger/account/block/account/{id}": { "delete": { "description": "Unblocks previously blocked amounts in an account. Increases the available balance in the account where the amount was blocked.
", "operationId": "deleteAllBlockAmount", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e6be89ee6aa436299950c3f" } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403CustomerNotExists" }, { "$ref": "#/components/schemas/Error403BlockDelete" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Unblock all blocked amounts in an account", "tags": ["Account"] } }, "/v3/ledger/account/{id}/activate": { "put": { "description": "Activates an account.
", "operationId": "activateAccount", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due a to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403AccountActive" }, { "$ref": "#/components/schemas/Error403CustomerNotExists" }, { "$ref": "#/components/schemas/Error403AccountCustomerInactive" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Activate account", "tags": ["Account"] } }, "/v3/ledger/account/{id}/deactivate": { "put": { "description": "Deactivates an account. Only accounts with account and available balances of zero can be deactivated. Deactivated accounts are not visible in the list of accounts, it is not possible to send funds to these accounts or perform transactions. However, they are still present in the ledger and all transaction histories.
", "operationId": "deactivateAccount", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403AccountInactive" }, { "$ref": "#/components/schemas/Error403AccountBalanceNonZero" }, { "$ref": "#/components/schemas/Error403TradeBalanceNonZero" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Deactivate account", "tags": ["Account"] } }, "/v3/ledger/account/{id}/freeze": { "put": { "description": "Disables all outgoing transactions. Incoming transactions to the account are available. When an account is frozen, its available balance is set to 0. This operation will create a new blockage of type ACCOUNT_FROZEN, which is automatically deleted when the account is unfrozen.
", "operationId": "freezeAccount", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403AccountFrozen" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Freeze account", "tags": ["Account"] } }, "/v3/ledger/account/{id}/unfreeze": { "put": { "description": "Unfreezes a previously frozen account. Unfreezing a non-frozen account not affect the account.
", "operationId": "unfreezeAccount", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403AccountNotFrozen" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Unfreeze account", "tags": ["Account"] } }, "/v3/ledger/transaction": { "post": { "description": "Sends a payment within Tatum Private Ledger. All assets are settled instantly.
\nWhen a transaction is settled, 2 transaction records are created, 1 for each of the participants. These 2 records are connected via a transaction reference, which is the same for both of them.
\nThis method is only used for transferring assets between accounts within Tatum and will not send any funds to blockchain addresses.
\nIf there is an insufficient balance in the sender account, no transaction is recorded.
\nIt is possible to perform an anonymous transaction where the sender account is not visible for the recipient.
\nThe FIAT currency value of every transaction is calculated automatically. The FIAT value is based on the accountingCurrency of the account connected to the transaction and is available in the marketValue parameter of the transaction.
Sends the N payments within Tatum Private Ledger. All assets are settled instantly.
\nWhen a transaction is settled, 2 transaction records are created, 1 for each of the participants. These 2 records are connected via a transaction reference, which is the same for both of them.
\nThis method is only used for transferring assets between accounts within Tatum and will not send any funds to blockchain addresses.
\nIf there is an insufficient balance in the sender account, no transaction is recorded.
\nIt is possible to perform an anonymous transaction where the sender account is not visible for the recipient.
\nThe FIAT currency value of every transaction is calculated automatically. The FIAT value is based on the accountingCurrency of the account connected to the transaction and is available in the marketValue parameter of the transaction.
Finds transactions for the account identified by the given account ID.
", "operationId": "getTransactionsByAccountId", "parameters": [ { "description": "Max number of items per page is 50. Either count or pageSize is accepted.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 } }, { "description": "Offset to obtain the next page of data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Get the total transaction count based on the filter. Either count or pageSize is accepted.", "in": "query", "name": "count", "example": true, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionFilter" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "items": { "$ref": "#/components/schemas/Transaction" }, "type": "array" }, { "type": "number", "description": "Total transaction count.", "example": 20 } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Find transactions for account.", "tags": ["Transaction"] } }, "/v3/ledger/transaction/customer": { "post": { "description": "Finds transactions for all accounts of the customer identified by the given internal customer ID.
", "operationId": "getTransactionsByCustomerId", "parameters": [ { "description": "Max number of items per page is 50. Either count or pageSize is accepted.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 } }, { "description": "Offset to obtain the next page of data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Get total transaction count based on the filter. Either count or pageSize is accepted.", "in": "query", "name": "count", "example": true, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionFilterCustomer" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "items": { "$ref": "#/components/schemas/Transaction" }, "type": "array" }, { "type": "number", "description": "Total transaction count.", "example": 20 } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Find transactions for a customer across all of the customer's accounts.", "tags": ["Transaction"] } }, "/v3/ledger/transaction/ledger": { "post": { "description": "Find transactions across whole ledger.
", "operationId": "getTransactions", "parameters": [ { "description": "Max number of items per page is 50. Either count or pageSize is accepted.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 } }, { "description": "Offset to obtain the next page of data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Get the total transaction count based on the filter. Either count or pageSize is accepted.", "in": "query", "name": "count", "example": true, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionFilterLedger" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "items": { "$ref": "#/components/schemas/Transaction" }, "type": "array" }, { "type": "number", "description": "Total transaction count.", "example": 20 } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Find transactions within the ledger.", "tags": ["Transaction"] } }, "/v3/ledger/transaction/reference/{reference}": { "get": { "description": "Finds transactions for all accounts with the given reference.
", "operationId": "getTransactionsByReference", "parameters": [ { "in": "path", "name": "reference", "required": true, "schema": { "maxLength": 100, "minLength": 20, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Transaction" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Find transactions with a given reference across all accounts.", "tags": ["Transaction"] } }, "/v3/ledger/deposits": { "get": { "description": "Lists all deposits for API key.
", "operationId": "getDeposits", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 20, "maximum": 50, "minimum": 1 }, "required": false }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "number", "example": 0 } }, { "description": "Direction of sorting. Can be asc or desc", "in": "query", "name": "sort", "schema": { "type": "string", "enum": ["asc", "desc"], "example": "asc" } }, { "description": "Status of the deposit", "in": "query", "name": "status", "schema": { "type": "string", "enum": ["Done", "InProgress"], "example": "Done" } }, { "description": "Filter by currency", "name": "currency", "in": "query", "schema": { "type": "string", "example": "BTC" } }, { "description": "Filter by txId", "name": "txId", "in": "query", "schema": { "type": "string", "example": 2.0589336591536965e76, "maxLength": 80, "minLength": 10 } }, { "description": "Filter by to address", "name": "to", "in": "query", "schema": { "type": "string", "example": 9.557027372635822e47 } }, { "description": "Filter by account id", "name": "accountId", "in": "query", "schema": { "type": "string", "example": "628bae6095e9ad06b52eb229" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Deposit" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all deposits for product", "tags": ["Deposit"] } }, "/v3/ledger/deposits/count": { "get": { "description": "Counts total entities found by get deposits request.
", "operationId": "getDepositsCount", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 20, "maximum": 50, "minimum": 1 }, "required": false }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "number", "example": 0 } }, { "description": "Direction of sorting. Can be asc or desc", "in": "query", "name": "sort", "schema": { "type": "string", "enum": ["asc", "desc"], "example": "asc" } }, { "description": "Type of the deposit", "in": "query", "name": "status", "schema": { "type": "string", "enum": ["Done", "InProgress"], "example": "Done" } }, { "description": "Filter by currency", "name": "currency", "in": "query", "schema": { "type": "string", "example": "BTC" } }, { "description": "Filter by txId", "name": "txId", "in": "query", "schema": { "type": "string", "example": 2.0589336591536965e76, "maxLength": 80, "minLength": 10 } }, { "description": "Filter by to address", "name": "to", "in": "query", "schema": { "type": "string", "example": 9.557027372635822e47 } }, { "description": "Filter by account id", "name": "accountId", "in": "query", "schema": { "type": "string", "example": "628bae6095e9ad06b52eb229" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesCount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Count of found entities for get deposits request", "tags": ["Deposit"] } }, "/v3/record": { "post": { "description": "Stores record data on blockchain. Tatum currently supports the Ethereum, CELO, MATIC, ONE, XDC, BSC, KLAY and EGLD to store data.
\nThe total cost of the transaction (in credits) on the Ethereum blockchain is dependent on the size of the data. Data are stored as a HEX string and the maximum data size is approximatelly 130 kB on mainnet, 30 kB on testnet.
\nEvery 5 characters of data costs 1 credit, so an API call with a data of length 1 kB = 1024 characters and would cost 205 credits.\n
Gets log data from the Ethereum blockchain.
", "operationId": "GetLog", "parameters": [ { "description": "The blockchain to get the log record from", "in": "query", "name": "chain", "required": true, "schema": { "type": "string", "example": "ETH", "enum": ["ETH"] } }, { "description": "ID of the log record / transaction on the blockchain", "in": "query", "name": "id", "required": true, "schema": { "type": "string", "example": "0x94Ce79B9F001E25BBEbE7C01998A78F7B27D1326", "minLength": 1, "maxLength": 100 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "string", "description": "Data stored in the record.", "example": "My log record data." } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get log record", "tags": ["Blockchain storage"] } }, "/v3/ipfs/{id}": { "get": { "description": "Gets data from the IPFS.
", "operationId": "GetIPFSData", "parameters": [ { "description": "IPFS CID of the file", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj" } } ], "responses": { "200": { "content": { "*": { "schema": { "type": "string", "format": "binary" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get file from IPFS", "tags": ["IPFS"] } }, "/v3/ipfs": { "post": { "description": "Stores file on the IPFS. We are leveraging nft.storage from Protocol Labs for free storage on the IPFS.
\n", "operationId": "StoreIPFS", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "example": 127654187631872620, "description": "Your file to store" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ipfsHash": { "type": "string", "description": "IPFS CID identifier of the stored file." } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Store data to IPFS", "tags": ["IPFS"] } }, "/v3/bitcoin/wallet": { "get": { "description": "1 credit per API call
\nTatum supports BIP44 HD wallets. Because they can generate 2^31 addresses from 1 mnemonic phrase, they are very convenient and secure. A mnemonic phrase consists of 24 special words in a defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Bitcoin wallet with derivation path m'/44'/0'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Bitcoin wallet.
\n", "operationId": "BtcGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate a Bitcoin wallet", "tags": ["Bitcoin"] } }, "/v3/bitcoin/address/{xpub}/{index}": { "get": { "description": "1 credit per API call
\nGenerate a Bitcoin address from the extended public key of the wallet. The address is generated for the specific index - each extended public key can generate up to 2^32 addresses with the index starting from 0 up to 2^31 - 1.
\n", "operationId": "BtcGenerateAddress", "parameters": [ { "description": "Extended public key of a wallet.", "in": "path", "name": "xpub", "required": true, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "schema": { "type": "string" } }, { "description": "Derivation index of the desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 0, "schema": { "type": "number", "minimum": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Bitcoin address", "example": "n36h3pAH7sC3z8KMB47BjbqvW2aJd2oTi7" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountIncompatibleXpubBtc" }, { "$ref": "#/components/schemas/Error403AccountAddressGeneral" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate a Bitcoin address from the wallet's extended public key", "tags": ["Bitcoin"] } }, "/v3/bitcoin/wallet/priv": { "post": { "description": "1 credit per API call
\nGenerates a private key for an address from a mnemonic for a given derivation path index. The private key is generated for the specific index - each mnemonic can generate up to 2^32 private keys starting from index 0 until 2^31 - 1.
\n", "operationId": "BtcGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BlockchainPrivateFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate the private key for a Bitcoin address", "tags": ["Bitcoin"] } }, "/v3/bitcoin/info": { "get": { "description": "1 credit per API call
\nGets Bitcoin blockchain information. Obtains basic info like the testnet / mainnet version of the chain, the current block number and its hash.
\n", "operationId": "BtcGetBlockChainInfo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BtcInfo" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Bitcoin blockchain information", "tags": ["Bitcoin"] } }, "/v3/bitcoin/block/hash/{i}": { "get": { "description": "1 credit per API call
\nGets a Bitcoin block hash. Returns the hash of the block to get the block's details.
\n", "operationId": "BtcGetBlockHash", "parameters": [ { "description": "The number of blocks preceding a particular block on a blockchain.", "in": "path", "name": "i", "required": true, "schema": { "type": "number", "example": 1580117 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "hash": { "type": "string", "description": "Block hash", "example": "0000000053f225e202cf27fe3046e06719efd3b31b5ab75fc5ef7f853c8b246f" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get the hash of a Bitcoin block", "tags": ["Bitcoin"] } }, "/v3/bitcoin/block/{hash}": { "get": { "description": "1 credit per API call
\nGets Bitcoin block detail by block hash or height.
\n", "operationId": "BtcGetBlock", "parameters": [ { "description": "Block hash or height.", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "00000000ca231a439a5c0a86a5a5dd6dc1918a8e897b96522fa9499288e70183" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BtcBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "404": { "description": "Block not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404BlockNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get a Bitcoin block by its hash or height", "tags": ["Bitcoin"] } }, "/v3/bitcoin/address/balance/{address}": { "get": { "description": "1 credit per API call
\nGet the balance of a Bitcoin address.
\n", "operationId": "BtcGetBalanceOfAddress", "parameters": [ { "description": "The blockchain address to get the balance for", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "2MsM67NLa71fHvTUBqNENW15P68nHB2vVXb" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BtcBasedBalance" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get the balance of a Bitcoin address", "tags": ["Bitcoin"] } }, "/v3/bitcoin/transaction/address/{address}": { "get": { "description": "1 credit per API call
\nGet all transactions for a Bitcoin address.
\n", "operationId": "BtcGetTxByAddress", "parameters": [ { "description": "Address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "2MsM67NLa71fHvTUBqNENW15P68nHB2vVXb" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain the next page of data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BtcTx" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get all transactions for a Bitcoin address", "tags": ["Bitcoin"] } }, "/v3/bitcoin/transaction": { "post": { "description": "2 credits per API call
\nSend BTC to blockchain addresses. It is possible to build a blockchain transaction in 2 ways:
\nIn bitcoin-like blockchains, a transaction is created from the list of previously unspent UTXOs. Every UTXO contains the amount of funds that can be spent.
\nWhen the UTXO is entered into the transaction, the whole amount is included and must be spent. For example, address A receives 2 transactions, T1 with 1 BTC and T2 with 2 BTC. The transaction, which will consume the UTXOs for T1 and T2, will have an available amount to spend of 3 BTC = 1 BTC (T1) + 2 BTC(T2).
\nThere can be multiple recipients of the transactions. In the to section, every recipient address has its own corresponding amount. When the amount of funds that the recipient should receive is lower than the amount of funds from the UTXOs, the difference is used as a transaction fee.
\nSigning a transaction
\nWhen sending BTC, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "BtcTransferBlockchain", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BtcTransactionFromAddress" }, { "$ref": "#/components/schemas/BtcTransactionFromAddressKMS" }, { "$ref": "#/components/schemas/BtcTransactionFromUTXO" }, { "$ref": "#/components/schemas/BtcTransactionFromUTXOKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcTx" }, { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403BtcUTXO" }, { "$ref": "#/components/schemas/Error403BtcTxFailed" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send BTC to Bitcoin addresses", "tags": ["Bitcoin"] } }, "/v3/bitcoin/transaction/{hash}": { "get": { "description": "1 credit per API call
\nGet Bitcoin Transaction detail by transaction hash.
\n", "operationId": "BtcGetRawTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "1451692ebbfbea1a2d2ec6fe6782596b6aa2e46c0589d04c406f491b5b46bc6a" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BtcTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403TxNotFound" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get a Bitcoin transaction by its hash", "tags": ["Bitcoin"] } }, "/v3/bitcoin/utxo/{hash}/{index}": { "get": { "description": "1 credit per API call
\nGet information about a transaction output in a transaction and check whether this output is a UTXO or has been spent.
\n\"UTXO\" stands for \"Unspent Transaction Output\". A UTXO is the amount of BTC/satoshis that remains at a Bitcoin address after a cryptocurrency transaction involving this address has been performed. The UTXO can then be used as input for a new cryptocurrency transaction. For more information about Bitcoin transactions and UTXO, see the Bitcoin user documentation.
\n404 response code.1 credit per API call
\nGets Bitcoin transaction IDs in the mempool.
\n", "operationId": "BtcGetMempool", "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "description": "TX ID of the transaction in mempool", "example": "4c7846a8ff8415945e96937dea27bdb3144c15d793648d725602784826052586" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403BtcBlockchain" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get transactions from the Bitcoin mempool", "tags": ["Bitcoin"] } }, "/v3/bitcoin/broadcast": { "post": { "description": "2 credits per API call
\nBroadcasts a signed transaction to the Bitcoin blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum Client Libraries.\nIt is possible to create a custom signing mechanism and only use this method for broadcasting data to the blockchain.
\n", "operationId": "BtcBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403Broadcast" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast a signed Bitcoin transaction", "tags": ["Bitcoin"] } }, "/v3/bitcoin/node": { "post": { "description": "This endpoint is deprecated. Do not use it.
\nInstead, use this API.
2 credits per API call
\nUse this endpoint URL as an http-based JSON RPC driver to connect directly to the node provided by Tatum.\nTo learn more about JSON RPC, visit the Bitcoin developers' guide.
\n", "deprecated": true, "operationId": "BtcRpcDriver", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid JSON RPC method content body.", "properties": { "jsonrpc": { "type": "string", "description": "Version of the JSON RPC.", "example": "1.0" }, "id": { "type": "string", "description": "ID of the request, could be any arbitrary identifier.", "example": "test" }, "method": { "type": "string", "description": "Method to invoke on the node.", "example": "getblockcount" }, "params": { "type": "array", "description": "Params to the method call, if required.", "example": [] } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid RPC response.", "example": { "jsonrpc": "1.0", "id": "test", "result": 654321 } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "x-codeSamples": [], "summary": "Connect to a Bitcoin node through an RPC driver", "tags": ["Bitcoin"] } }, "/v3/blockchain/estimate": { "post": { "description": "Estimate current transaction fee for different operations.
\nSupported blockchains:\n
Estimate gasLimit and gasPrice of the Ethereum transaction. Gas price is obtained from multiple sources + calculated based on the latest N blocks and the current mempool state. The fast one is used by default.\n
\n", "operationId": "EthEstimateGas", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthEstimateGas" } } }, "required": true }, "responses": { "200": { "headers": { "x-current-block": { "schema": { "type": "number" }, "description": "Current block of the blockchain." }, "x-current-block-time": { "schema": { "type": "string", "format": "date-time", "example": "2021-11-11T11:54:49.000Z" }, "description": "Current block time." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthGasEstimation" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403EthTxBody" }, { "$ref": "#/components/schemas/Error403EthGasCalculation" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Estimate Ethereum transaction fees", "tags": ["Blockchain fees"] } }, "/v3/ethereum/gas/batch": { "post": { "description": "Estimate gasLimit and gasPrice of the Ethereum transaction. Gas price is obtained from multiple sources + calculated based on the latest N blocks and the current mempool state.\nThe fast one is used by default.
\nResult is calculated in the order of the request array items.\n
Estimate gasLimit and gasPrice of the Polygon transaction. Gas price is obtained from https://gasstation-mainnet.matic.network/.\n
\n", "operationId": "PolygonEstimateGas", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolygonEstimateGas" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in wei.", "example": "20" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403PolygonTxBody" }, { "$ref": "#/components/schemas/Error403PolygonGasCalculation" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Estimate Polygon transaction fees", "tags": ["Blockchain fees"] } }, "/v3/celo/gas": { "post": { "description": "Estimate gasLimit and gasPrice of the CELO transaction. Gas price is obtained from https://explorer.bitquery.io/celo_rc1/gas.\n
\n", "operationId": "CeloEstimateGas", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CeloEstimateGas" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "number", "description": "Gas limit for transaction in gas price.", "example": 40000 }, "gasPrice": { "type": "string", "description": "Gas price in wei.", "example": "20" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403CeloTxBody" }, { "$ref": "#/components/schemas/Error403CeloGasCalculation" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Estimate Celo Chain transaction fees", "tags": ["Blockchain fees"] } }, "/v3/bsc/gas": { "post": { "description": "Estimate gasLimit and gasPrice of the BSC transaction. Gas price is obtained from https://explorer.bitquery.io/bsc/gas.\n
\n", "operationId": "BscEstimateGas", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BscEstimateGas" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in wei.", "example": "20" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BscTxBody" }, { "$ref": "#/components/schemas/Error403BscGasCalculation" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Estimate BNB Smart Chain transaction fees", "tags": ["Blockchain fees"] } }, "/v3/klaytn/gas": { "post": { "description": "Estimate gasLimit and gasPrice of the Klaytn transaction. Gas price is obtained from https://explorer.bitquery.io/klaytn/gas.\n
\n", "operationId": "KlaytnEstimateGas", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KlaytnEstimateGas" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in peb.", "example": "20" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403KlaytnTxBody" }, { "$ref": "#/components/schemas/Error403KlaytnGasCalculation" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Estimate Klaytn transaction fees", "tags": ["Blockchain fees"] } }, "/v3/xdc/gas": { "post": { "description": "Estimate gasLimit and gasPrice of the XDC transaction. Gas price is obtained from https://rpc.xinfin.network/gasPrice.\n
\n", "operationId": "XdcEstimateGas", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XdcEstimateGas" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in wei.", "example": "5" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403XdcGasCalculation" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Estimate XinFin transaction fees", "tags": ["Blockchain fees"] } }, "/v3/kcs/gas": { "post": { "description": "Estimate gasLimit and gasPrice of the Kcs transaction.\n
\n", "operationId": "KcsEstimateGas", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KcsEstimateGas" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in wei.", "example": "20" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403KcsTxBody" }, { "$ref": "#/components/schemas/Error403KcsGasCalculation" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Estimate KuCoin Community Chain transaction fees", "tags": ["Blockchain fees"] } }, "/v3/vet/transaction/gas": { "post": { "description": "Estimate gas required for transaction.
", "operationId": "VetEstimateGas", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VetEstimateGas" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 21000 } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VetFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Estimate VeChain Gas for transaction", "tags": ["Blockchain fees"] } }, "/v3/egld/gas": { "post": { "description": "Estimate gasLimit and gasPrice of the EGLD transaction. Gas limit is obtained from https://gateway.elrond.com/transaction/cost.\nGas price is obtained from https://gateway.elrond.com/network/config.\n
\n", "operationId": "EgldEstimateGas", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionFeeEgldBlockchain" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "number", "description": "Gas limit for transaction in gas price.", "example": 77000 }, "gasPrice": { "type": "number", "description": "Gas price.", "example": 1000000000 } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403EgldGasCalculation" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Estimate EGLD transaction fees", "tags": ["Blockchain fees"] } }, "/v3/blockchain/sc/address/{chain}/{hash}": { "get": { "description": "Get smart contract address from deploy transaction.
", "operationId": "SCGetContractAddress", "parameters": [ { "description": "Blockchain to work with", "in": "path", "name": "chain", "required": true, "schema": { "type": "string", "enum": ["ETH", "ONE", "CELO", "TRON", "MATIC", "BSC"] } }, { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Address of the smart contract.", "example": "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get contract address from transaction", "tags": ["Blockchain utils"] } }, "/v3/gas-pump": { "post": { "summary": "Precalculate gas pump addresses", "description": "2 credits per API call
\nPrecalculate (generate) gas pump addresses that you can assign to the customers of your custodial application.
\nThis API does not make any changes on the blockchain itself, just generates addresses that follow the blockchain's requirements for the address format; therefore, no gas fee is applied.
\nThis API is supported for the following blockchains:
\nAddress index
\nEach address should be associated with its own index. Use the from and to request body parameters to set a range of index values for the addresses to precalculate. You can start with any number, but we recommend that you start from 0.
In one API call, you can precalculate:
\nIf you need more addresses than one API call can precalculate, make several API calls. For example, if you need 10,000 addresses on Ethereum, make an API call with an index range from 0 through 4,999 and then make another API call with an index range from 5,000 through 9,999.
\nThe owner of the gas pump addresses
\nThe owner (also referred to as \"master address\") is the blockchain address that will own the precalculated gas pump addresses. The owner will also be paying gas fees for operations made on the gas pump addresses. You have to make sure that the owner always has enough funds to cover these gas fees.
Activated and not activated addresses
\nThe precalculated addresses can be immediately assigned to customers and can receive funds. However, they cannot be used to send funds to other addresses. This is because the addresses are not activated. To make the addresses be able to send funds, activate them.
2 credits per API call
\nActivate the precalulated gas pump addresses. Activating a gas pump address allows this address to send funds to other addresses.
\nYou can activate up to 270 addresses in one call. If you need to activate more than 270 addresses, make several API calls. For example, if you need to activate 500 addresses, make an API call with 270 addresses (set up the range of their index values accordingly in the from and to request body parameters) and then make another API call with the remaining 230 addresses.
When to activate a gas pump address
\nBecause activating a gas pump address costs some amount of gas on a blockchain, you want to activate only those addresses that will be used for sending funds to other addresses. If you know that a gas pump address will not be used for sending funds, you can leave this address not activated. The customer who uses this address will still be able to receive funds.
Depending on your business needs and requirements, you can choose when to activate the gas pump addresses. If you know for sure that all the precalculated addresses will be sending funds, you can activate all the addresses right after they have been precalculated.
\nAlternatively, you can set up the activation in such a way so that a gas pump address gets activated only when a specific event is triggered. For example, you can activate a gas pump address:
\nAfter you make an API call to activate gas pump addresses, use the API for getting the results of the address activation transaction.
\nSigning a transaction
\nWhen activating gas pump addresses, 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.
\nFor 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.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet the results of the activation transaction after activating gas pump addresses.
\nIf the activation transaction got recorded into a block, the API returns two arrays:
\nvalid, with the activated gas pump addressesinvalid, with the gas pump addresses that for some reason did not get activated together with the reason whyIf the transaction is still being processed, the API returns an error message. In this case, repeat the call later.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nCheck whether the gas pump address with a specified index is activated and can send funds to other addresses.
\nYou can use this API when a customer initiates a fund transfer and you need to check whether their gas pump address is allowed to send funds.
\nThis API is supported for the following blockchains:
\n2 credits per API call
\nTransfer (send) an asset from a gas pump address to the other address. The gas fee for sending the asset will be covered by crypto funds on the master address. Make sure that the master address always has enough funds to cover gas fees.
\nWith this API, you can send only one asset per API call. If you want to send multiple assets, use the API for transferring multiple assets from a gas pump account.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen transferring an asset, 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.
\nFor 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.
\n", "operationId": "TransferCustodialWallet", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferCustodialWallet" }, { "$ref": "#/components/schemas/TransferCustodialWalletKMS" }, { "$ref": "#/components/schemas/TransferCustodialWalletCelo" }, { "$ref": "#/components/schemas/TransferCustodialWalletCeloKMS" }, { "$ref": "#/components/schemas/TransferCustodialWalletTron" }, { "$ref": "#/components/schemas/TransferCustodialWalletTronKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Transfer an asset from a gas pump address", "tags": ["Gas pump"] } }, "/v3/blockchain/sc/custodial/transfer/batch": { "post": { "description": "2 credits per API call
\nTransfer (send) multiple assets from a gas pump address to the other address. The gas fee for sending the assets will be covered by crypto funds on the master address. Make sure that the master address always has enough funds to cover gas fees.
\nIf you want to send only one asset, you can also use the API for transferring an asset from a gas pump account.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen transferring assets, 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.
\nFor 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.
\n", "operationId": "TransferCustodialWalletBatch", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferCustodialWalletBatch" }, { "$ref": "#/components/schemas/TransferCustodialWalletBatchKMS" }, { "$ref": "#/components/schemas/TransferCustodialWalletBatchCelo" }, { "$ref": "#/components/schemas/TransferCustodialWalletBatchCeloKMS" }, { "$ref": "#/components/schemas/TransferCustodialWalletBatchTron" }, { "$ref": "#/components/schemas/TransferCustodialWalletBatchTronKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Transfer multiple assets from a gas pump address", "tags": ["Gas pump"] } }, "/v3/blockchain/sc/custodial/approve": { "post": { "description": "2 credits per API call
\nAllow another blockchain address (the spender parameter in the request body) to transfer the asset from a gas pump address on behalf of the master address.
Use this API when the customer using the gas pump address sells assets on a marketplace or auction. After the customer creates a listing of the asset, they have to allow the marketplace/auction smart contract to transfer the asset to the buyer after the asset has been bought.
\nThe asset can be one of the following types:
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen approving the transfer of an asset, 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.
\nFor 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.
\n", "operationId": "ApproveTransferCustodialWallet", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ApproveTransferCustodialWallet" }, { "$ref": "#/components/schemas/ApproveTransferCustodialWalletKMS" }, { "$ref": "#/components/schemas/ApproveTransferCustodialWalletCelo" }, { "$ref": "#/components/schemas/ApproveTransferCustodialWalletCeloKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Approve the transfer of an asset from a gas pump address", "tags": ["Gas pump"] } }, "/v3/blockchain/sc/custodial/batch": { "post": { "deprecated": true, "description": "This API is deprecated.
To start with the gas pump, use the API for precalculating the gas pump addresses.
2 credits per API call
\nGenerate new gas pump smart contract address on the blockchain. This address enables custodial providers to\nreceive native assets, ERC20 / ERC721 / ERC1155 tokens on behalf of their customers on dedicated blockchain address, but in the same time it can initiate transfer of those assets away.\nGas required for the transfer from that address is going to be deducted from the providers address - the one, which was used to generate the address on the blockchain.
\nThis operation deploys a smart contract on the blockchain.
\nFor paid plans, it is possible to pay for the gas costs - you don't have to provide private key or signatureId. Blockchain fees will be covered by your credits.\n
This API is supported for the following blockchains:
\nThis API is deprecated.
To start with the gas pump, use the API for precalculating the gas pump addresses.
If you built your gas pump solution using this API and the API for generating a gas pump wallet address, you can still use this API for creating more custodial addresses for your solution. However, we recommend that you switch to the API for precalculating the gas pump addresses.
2 credits per API call
\nGenerate new gas pump smart contract address on the blockchain. It's possible to enable tokens, which should be detected and supported on that address. This address enables custodial providers to\nreceive native assets, ERC20 / ERC721 / ERC1155 tokens on behalf of their customers on dedicated blockchain address, but in the same time it can initiate transfer of those assets away.
\nGas required for the transfer from that address is going to be deducted from the providers address - the one, which was used to generate the address on the blockchain.
\nThere are multiple options, how this address can be setup - it cannot be changed in the future:
\nAll of these options could be enabled with a batch mode as well - in 1 transaction, it is possible to transfer multiple different assets from that address, e.g. ETH + USDC + ERC721 token.\nWithout batch mode, 3 separate transaction must have been performed.
\nThis operation deploys a smart contract on the blockchain. More assets you will support, more intial gas will be used for address creation. Batch mode adds more gas for every type.
\nThis API is supported for the following blockchains:
\nThis API is deprecated.
To start with the gas pump, use the API for precalculating the gas pump addresses.
If you built your gas pump solution using the API for generating a gas pump wallet address and API for generating a custodial wallet address, you can still use this API for getting the custodial wallet address from the transaction. However, we recommend that you switch to the API for precalculating the gas pump addresses.
1 credit per API call
\nGet gas pump smart contract addresses from deploy transaction.
\nThis API is supported for the following blockchains:
\n2 credits per API call
\nDeploy an NFT marketplace smart contract on the blockchain. With a deployed marketplace smart contract, you and your customers can create new listings for assets such as non-fungible tokens and combinations of token types as described by the ERC-721 and ERC-1155 standards on the Ethereum blockchain or by the equivalent standards on the other blockchains. As the marketplace operator, you can set a fee as a percentage of the asset price that will be paid on top of the asset price.
\nThe purchase process looks like the following:
\nbuyAssetFromListing() method is called against the marketplace smart contract) and send the required amount of the native assets to the marketplace smart contract.buyAssetFromListing() method is called against the marketplace smart contract).This API is supported for the following blockchains:
\nSigning a transaction
\nWhen deploying an NFT marketplace smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "GenerateMarketplace", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/GenerateMarketplace" }, { "$ref": "#/components/schemas/GenerateMarketplaceKMS" }, { "$ref": "#/components/schemas/GenerateMarketplaceCelo" }, { "$ref": "#/components/schemas/GenerateMarketplaceCeloKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Create an NFT marketplace", "tags": ["Marketplace"] } }, "/v3/blockchain/marketplace/listing/sell": { "post": { "description": "2 credits per API call
\nCreate a new listing for an asset on the NFT marketplace. The listing can be offered for the native blockchain assets (for example, ETH, BSC, and so on) or for any fungible tokens.
\nAfter the listing is created, allow the marketplace smart contract to transfer the asset that you are selling.
\nYou can create a listing only for an existing asset that you own (you must be the owner of the asset).
\nThis API is supported for the following blockchains:
\nNOTE: When making this API call, you may get the following message:
\nAlthough one or more Error Occurred [execution reverted] Contract Execution Completed
\nThis message is a result of the marketplace version check and has no impact on completing the API call. You can safely ignore it.
Signing a transaction
\nWhen creating a new listing on the NFT marketplace, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "SellAssetOnMarketplace", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SellAssetOnMarketplace" }, { "$ref": "#/components/schemas/SellAssetOnMarketplaceKMS" }, { "$ref": "#/components/schemas/SellAssetOnMarketplaceCelo" }, { "$ref": "#/components/schemas/SellAssetOnMarketplaceCeloKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Sell an asset on the NFT marketplace", "tags": ["Marketplace"] } }, "/v3/blockchain/marketplace/listing/buy": { "post": { "description": "2 credits per API call
\nBuy an asset listed on the NFT marketplace.
\nYou can buy the asset either for the native blockchain assets (for example, ETH, BSC, and so on) or for the fungible tokens of the blockchain.
\nThis API is supported for the following blockchains:
\nNOTE: When making this API call, you may get the following message:
\nAlthough one or more Error Occurred [execution reverted] Contract Execution Completed
\nThis message is a result of the marketplace version check and has no impact on completing the API call. You can safely ignore it.
Signing a transaction
\nWhen buying an asset on the NFT marketplace, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "BuyAssetOnMarketplace", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BuyAssetOnMarketplace" }, { "$ref": "#/components/schemas/BuyAssetOnMarketplaceKMS" }, { "$ref": "#/components/schemas/BuyAssetOnMarketplaceCelo" }, { "$ref": "#/components/schemas/BuyAssetOnMarketplaceCeloKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Buy an asset on the NFT marketplace", "tags": ["Marketplace"] } }, "/v3/blockchain/marketplace/listing/cancel": { "post": { "description": "2 credits per API call
\nCancel the selling of an asset on the NFT marketplace.
\nYou can cancel the selling only if you are the seller of the asset or the marketplace operator. Once the selling is canceled, the asset is returned to the seller.
\nYou cannot cancel the selling if the asset has already been purchased.
\nThis API is supported for the following blockchains:
\nNOTE: When making this API call, you may get the following message:
\nAlthough one or more Error Occurred [execution reverted] Contract Execution Completed
\nThis message is a result of the marketplace version check and has no impact on completing the API call. You can safely ignore it.
Signing a transaction
\nWhen cancelling the selling of an asset, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "CancelSellMarketplaceListing", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CancelSellAssetOnMarketplace" }, { "$ref": "#/components/schemas/CancelSellAssetOnMarketplaceKMS" }, { "$ref": "#/components/schemas/CancelSellAssetOnMarketplaceCelo" }, { "$ref": "#/components/schemas/CancelSellAssetOnMarketplaceCeloKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Cancel the selling of an asset on the NFT marketplace", "tags": ["Marketplace"] } }, "/v3/blockchain/marketplace/listing/{chain}/{contractAddress}/{type}": { "get": { "description": "1 credit per API call
\nGet the open, sold, or cancelled listings from the NFT marketplace.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet information about a specific listing on the NFT marketplace.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet the NFT marketplace fee.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet the recipient of the NFT marketplace fee.
\nThis API is supported for the following blockchains:
\n2 credits per API call
\nUpdate the recepient of the NFT marketplace fee.
\nYou can update the fee recepient only if you are the marketplace operator.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen updating the recepient of the NFT marketplace fee, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "UpdateFeeRecipient", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UpdateFeeRecipient" }, { "$ref": "#/components/schemas/UpdateFeeRecipientKMS" }, { "$ref": "#/components/schemas/UpdateFeeRecipientCelo" }, { "$ref": "#/components/schemas/UpdateFeeRecipientCeloKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Update the recepient of the NFT marketplace fee", "tags": ["Marketplace"] } }, "/v3/blockchain/marketplace/listing/fee": { "put": { "description": "2 credits per API call
\nUpdate the NFT marketplace fee.
\nYou can update the marketplace fee only if you are the marketplace operator.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen updating the NFT marketplace fee, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "UpdateFee", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UpdateFee" }, { "$ref": "#/components/schemas/UpdateFeeKMS" }, { "$ref": "#/components/schemas/UpdateFeeCelo" }, { "$ref": "#/components/schemas/UpdateFeeCeloKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Update the NFT marketplace fee", "tags": ["Marketplace"] } }, "/v3/blockchain/auction": { "post": { "description": "Deploy new smart contract for NFT auction logic. Smart contract enables auction operator to create new auction for NFT (ERC-721/1155).\nOperator can set a fee in percentage, which will be paid on top of the price of the asset.\ncan be offered for native asset - ETH, BSC, etc. - or any ERC20 token - this is configurable during auction creation.\nBefore auction is created, seller must approve transfer of the NFT to the auction contract.\nBuyer will bid for the asset from the auction using native asset - send assets along the gid() smart contract call, or via ERC20 token.\nBuyer of the auction must perform approval for the smart contract to access ERC20 token, before the actual bid() method is called.\nOnce there is higher bid then the actual one, the previous bidder's funds will be returned to him and new bidder will be the current winning one.\nWhen auction ends, anyone can settle the auction - NFT will be sent to the bidder, assets to the seller and fee to the operator.
\nThis operation deploys a smart contract on the blockchain.
\nSupported blockchains:\n
Create new auction on the auction contract. Before operation, seller must approve spending of the NFT token for the Auction contract using Approve NFT.\nAfter auction is created, auction contract transfers the asset to the auction smart contract.\nOnly auction for existing NFTs can be created - seller must be owner of the NFT asset.
\nSupported blockchains:\n
Bid on the auction. Buyer must either send native assets with this operation, or approve ERC20 token spending in advance.
\nAfter auction is sold, it's in a pending state to be processed by the auction. Noone receives the assets unless the auction operator processes that.
\nSupported blockchains:\nNOTE: When making this API call, you may get the following message:
\nAlthough one or more Error Occurred [execution reverted] Contract Execution Completed
\nThis message is a result of the auction version check and has no impact on completing the API call. You can safely ignore it.
Cancel auction on the auction. Only possible for the seller or the operator. There must be no buyer present for that auction. NFT asset is sent back to the seller.
\nSupported blockchains:\n
NOTE: When making this API call, you may get the following message:
\nAlthough one or more Error Occurred [execution reverted] Contract Execution Completed
\nThis message is a result of the auction version check and has no impact on completing the API call. You can safely ignore it.
Settle auction. There must be buyer present for that auction. NFT will be sent to the bidder, assets to the seller and fee to the operator.
\nSupported blockchains:\n
NOTE: When making this API call, you may get the following message:
\nAlthough one or more Error Occurred [execution reverted] Contract Execution Completed
\nThis message is a result of the auction version check and has no impact on completing the API call. You can safely ignore it.
Approve NFT transfer for auction to perform listing of the asset.
\nSupported blockchains:\n
Get detail of the specific auction.
", "operationId": "GetAuction", "parameters": [ { "description": "Blockchain to work with", "in": "path", "name": "chain", "required": true, "schema": { "type": "string", "enum": ["ETH", "ONE", "CELO", "MATIC", "BSC"] } }, { "description": "Contract address", "in": "path", "name": "contractAddress", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc4" } }, { "description": "Auction ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "123456" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount of NFTs to sold in this auction. Valid only for ERC1155 listings.", "example": "1" }, "bidder": { "type": "string", "description": "Address of the highest buyer, if exists.", "example": "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8" }, "erc20Address": { "type": "string", "description": "Address of the ERC20 token smart contract, which should be used for paying for the asset..", "example": "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8" }, "isErc721": { "type": "boolean", "description": "If the listing is for ERC721 or ERC1155 token.", "example": true }, "startedAt": { "type": "string", "description": "Block height this auction started at.", "example": "12345" }, "endedAt": { "type": "string", "description": "Block height this auction ended at.", "example": "12349" }, "nftAddress": { "type": "string", "description": "Address of the NFT smart contract.", "example": "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8" }, "endingPrice": { "type": "string", "description": "Final auction price of the NFT asset in native currency or ERC20 token based on the presence of erc20Address field.", "example": "1.234" }, "seller": { "type": "string", "description": "Address of the seller.", "example": "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8" }, "highestBid": { "type": "string", "description": "Current highest bid of the NFT asset in native currency or ERC20 token based on the presence of erc20Address field.", "example": "1.234" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get auction details from the NFT Auction", "tags": ["Auction"] } }, "/v3/blockchain/auction/{chain}/{contractAddress}/fee": { "get": { "description": "Get fee of the auction.
", "operationId": "GetAuctionFee", "parameters": [ { "description": "Blockchain to work with", "in": "path", "name": "chain", "required": true, "schema": { "type": "string", "enum": ["ETH", "ONE", "CELO", "MATIC", "BSC"] } }, { "description": "Contract address", "in": "path", "name": "contractAddress", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc4" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Fee in percents.", "example": 2.25 } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get NFT Auction fee", "tags": ["Auction"] } }, "/v3/blockchain/auction/{chain}/{contractAddress}/recipient": { "get": { "description": "Get fee recipient of the auction.
", "operationId": "GetAuctionFeeRecipient", "parameters": [ { "description": "Blockchain to work with", "in": "path", "name": "chain", "required": true, "schema": { "type": "string", "enum": ["ETH", "ONE", "CELO", "MATIC", "BSC"] } }, { "description": "Contract address", "in": "path", "name": "contractAddress", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc4" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Address of the auction fee recipient.", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc4" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get NFT Auction fee recipient", "tags": ["Auction"] } }, "/v3/blockchain/auction/recipient": { "put": { "description": "Update fee recipient of the auction.
\nSupported blockchains:\n
Update fee of the auction.
\nSupported blockchains:\n
Get estimated block height at given time. This is estimation, not an exact block height.
\nSupported blockchains:\n
The number of credits consumed depends on the number of methods submitted in an API call:
\n* 50 credits per debug*/trace* method (for EVM-based blockchains)
\n* 5 credits per eth_call method (for EVM-based blockchains)
\n* 2 credits per any other RPC method
Connect directly to the blockchain node provided by Tatum.
\nThe POST method is used. The API endpoint URL acts as an HTTP-based RPC driver.
In the request body, provide valid Web3 RPC method content, for example:
\n\n{\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"method\": \"method_name\",\n \"params\": []\n}\n\nFor the blockchains using the JSON-RPC 2.0 specification, you can submit multiple RPC methods in one API call:
\n\n[\n {\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"method\": \"method_1_name\",\n \"params\": []\n },\n {\n \"jsonrpc\": \"2.0\",\n \"id\": 2,\n \"method\": \"method_2_name\",\n \"params\": []\n },\n ...\n]\n\nThis API is supported for the following blockchains:
\n2 credits per RPC method in an API call
\nConnect directly to the blockchain node provided by Tatum.
\nThe PUT method is used. The API endpoint URL acts as an HTTP-based RPC driver.
In the request body, provide valid Web3 RPC method content, for example:
\n\n{\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"method\": \"method_name\",\n \"params\": []\n}\n\nFor the blockchains using the JSON-RPC 2.0 specification, you can submit multiple RPC methods in one API call:
\n\n[\n {\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"method\": \"method_1_name\",\n \"params\": []\n },\n {\n \"jsonrpc\": \"2.0\",\n \"id\": 2,\n \"method\": \"method_2_name\",\n \"params\": []\n },\n ...\n]\n\nThis API is supported for the following blockchains:
\n\n", "operationId": "NodeJsonRpcPutDriver", "parameters": [ { "description": "Tatum X-API-Key used for authorization. You can omit this path parameter and either use the X-Api-Key header, or the API key tied to your IP address without any header.", "in": "path", "name": "xApiKey", "required": false, "schema": { "type": "string", "example": "ea8ce228-6ca3-465c-abb0-fd3c5d35c0d5" } }, { "description": "Blockchain to communicate with.", "in": "path", "name": "chain", "required": true, "schema": { "type": "string", "example": "ALGO", "enum": ["ALGO", "EGLD", "XLM"] } }, { "description": "Type of the node to access for Algorand.", "in": "query", "name": "nodeType", "required": false, "schema": { "type": "string", "enum": ["ALGOD", "INDEXER"] } }, { "description": "Optional path of rpc call for non EVM nodes, e.g. Algorand or Stellar.", "in": "path", "name": "rpcPath", "required": false, "schema": { "type": "string", "example": "v2/accounts" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "A valid Web3 RPC method content body with one or multiple RPC methods", "example": { "jsonrpc": "2.0", "method": "web3_clientVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "A valid RPC response", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid RPC error response.", "example": null } } }, "description": "Internal server error" } }, "x-codeSamples": [], "summary": "Connect to the blockchain node through an RPC driver", "tags": ["Node RPC"] }, "get": { "description": "2 credits per RPC method in an API call
\nConnect directly to the blockchain node provided by Tatum.
\nThe GET method is used. The API endpoint URL acts as an HTTP-based RPC driver.
This API is supported for the following blockchains:
\n\n", "operationId": "NodeJsonRpcGetDriver", "parameters": [ { "description": "Tatum X-API-Key used for authorization. You can omit this path parameter and either use the X-Api-Key header, or the API key tied to your IP address without any header.", "in": "path", "name": "xApiKey", "required": false, "schema": { "type": "string", "example": "ea8ce228-6ca3-465c-abb0-fd3c5d35c0d5" } }, { "description": "Blockchain to communicate with.", "in": "path", "name": "chain", "required": true, "schema": { "type": "string", "example": "ALGO", "enum": ["ALGO", "EGLD", "LISK", "XLM", "TEZOS", "TRON"] } }, { "description": "Type of the node to access for Algorand.", "in": "query", "name": "nodeType", "required": false, "schema": { "type": "string", "enum": ["ALGOD", "INDEXER"] } }, { "description": "Optional path of rpc call for non EVM nodes, e.g. Algorand or Stellar.", "in": "path", "name": "rpcPath", "required": false, "schema": { "type": "string", "example": "v2/accounts" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "A valid RPC response", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid RPC error response." } } }, "description": "Internal server error" } }, "x-codeSamples": [], "summary": "Connect to the blockchain node through an RPC driver", "tags": ["Node RPC"] } }, "/v3/ethereum/wallet": { "get": { "description": "Tatum supports BIP44 HD wallets. Because they can generate 2^31 addresses from 1 mnemonic phrase, they are very convenient and secure. A mnemonic phrase consists of 24 special words in a defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows the BIP44 specification and generates for Ethereum wallets with the derivation path m/44'/60'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerates a BIP44 compatible Ethereum wallet.
\n", "operationId": "EthGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generating extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } }, { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Ethereum wallet", "tags": ["Ethereum"] } }, "/v3/ethereum/address/{xpub}/{index}": { "get": { "description": "Generates an Ethereum account deposit address from an Extended public key. The deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31 - 1.
\n", "operationId": "EthGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "schema": { "type": "string", "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid" } }, { "description": "Derivation index of the address to be generated.", "in": "path", "name": "index", "required": true, "schema": { "type": "number", "example": 0 } }, { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedAddress" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Ethereum account address from Extended public key", "tags": ["Ethereum"] } }, "/v3/ethereum/wallet/priv": { "post": { "description": "Generates the private key of an address from a mnemonic for a given derivation path index. The private key is generated for the specific index - each mnemonic\ncan generate up to 2^32 private keys starting from index 0 until 2^31 - 1.
\n", "operationId": "EthGenerateAddressPrivateKey", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Ethereum private key", "tags": ["Ethereum"] } }, "/v3/ethereum/web3/{xApiKey}": { "post": { "deprecated": true, "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as an http-based web3 driver to connect directly to the Ethereum node provided by Tatum.\nTo learn more about Ethereum Web3, visit the Ethereum developers' guide.
\n", "operationId": "EthWeb3Driver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } }, { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "query", "name": "testnetType", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 method content body.", "example": { "jsonrpc": "2.0", "method": "web3_clientVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 response.", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "x-codeSamples": [], "summary": "Web3 HTTP driver", "tags": ["Ethereum"] } }, "/v3/ethereum/block/current": { "get": { "description": "Gets the current Ethereum block number. This is the number of the latest block in the blockchain.
", "operationId": "EthGetCurrentBlock", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 6491272 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["Ethereum"] } }, "/v3/ethereum/block/{hash}": { "get": { "description": "Gets an Ethereum block-by-block hash or block number.
", "operationId": "EthGetBlock", "parameters": [ { "description": "Block hash or block number", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "6470657" } }, { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Ethereum block by hash", "tags": ["Ethereum"] } }, "/v3/ethereum/account/balance/{address}": { "get": { "description": "Gets an Ethereum account balance in ETH. This method does not display the balance of ERC20 or ERC721 tokens in the account.
", "operationId": "EthGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" } }, { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthBalance" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Ethereum account balance", "tags": ["Ethereum"] } }, "/v3/ethereum/transaction/{hash}": { "get": { "description": "Get Ethereum transaction by transaction hash.
", "operationId": "EthGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } }, { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "404": { "description": "Transaction not found.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error404TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Ethereum Transaction", "tags": ["Ethereum"] } }, "/v3/ethereum/transaction/count/{address}": { "get": { "description": "Get a number of outgoing Ethereum transactions for the address. When a transaction is sent, there can be multiple outgoing transactions,\nwhich are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents\nthe order of the transaction in the list of outgoing transactions.
\n", "operationId": "EthGetTransactionCount", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 42, "minLength": 42, "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } }, { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 5, "description": "Number of transactions, that were made from this address. Can be used as a nonce parameter in send transaction calls." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing Ethereum transactions", "tags": ["Ethereum"] } }, "/v3/ethereum/account/transaction/{address}": { "get": { "description": "Get Ethereum transactions by address. This includes incoming and outgoing transactions for the address.
", "operationId": "EthGetTransactionByAddress", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x8ce4e40889a13971681391aad29e88efaf91f784" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Transactions from this block onwards will be included.", "in": "query", "name": "from", "schema": { "type": "number", "minimum": 1, "example": 1087623 } }, { "description": "Transactions up to this block will be included.", "in": "query", "name": "to", "schema": { "type": "number", "minimum": 1, "example": 1087823 } }, { "description": "Sorting of the data. ASC - oldest first, DESC - newest first.", "in": "query", "name": "sort", "schema": { "type": "string", "default": "DESC", "example": "ASC", "enum": ["ASC", "DESC"] } }, { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EthTx" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Ethereum transactions by address", "tags": ["Ethereum"] } }, "/v3/ethereum/transaction": { "post": { "description": "2 credits per API call
\nSend Ethereum or Tatum supported ERC20 token from account to account.
\n
Signing a transaction
\nWhen sending ETH, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "EthBlockchainTransfer", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferEthBlockchain" }, { "$ref": "#/components/schemas/TransferEthBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403EthBroadcast" }, { "$ref": "#/components/schemas/Error403EthGasPrice" }, { "$ref": "#/components/schemas/Error403EthTxBody" }, { "$ref": "#/components/schemas/Error403EthGasCalculation" }, { "$ref": "#/components/schemas/Error403EthTxHash" }, { "$ref": "#/components/schemas/Error403EthTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send Ethereum / ERC20 from account to account", "tags": ["Ethereum"] } }, "/v3/ethereum/smartcontract": { "post": { "description": "2 credits per API call
\nInvoke a method in an existing smart contract on Ethereum.
\nYou can call a read-only or write method.
\nSigning a transaction
\nWhen invoking a method in a smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "EthBlockchainSmartContractInvocation", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CallSmartContractMethod" }, { "$ref": "#/components/schemas/CallReadSmartContractMethod" }, { "$ref": "#/components/schemas/CallSmartContractMethodKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" }, { "$ref": "#/components/schemas/Data" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403EthBroadcast" }, { "$ref": "#/components/schemas/Error403EthGasPrice" }, { "$ref": "#/components/schemas/Error403EthScBody" }, { "$ref": "#/components/schemas/Error403EthGasCalculation" }, { "$ref": "#/components/schemas/Error403EthTxHash" }, { "$ref": "#/components/schemas/Error403EthTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Invoke a method in a smart contract on Ethereum", "tags": ["Ethereum"] } }, "/v3/ethereum/account/transaction/erc20/internal/{address}": { "get": { "description": "Get Ethereum internal transactions by address.
2 credits per API call
\nBroadcast signed transaction to Ethereum blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.
\n", "operationId": "EthBroadcast", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to ethereum-sepolia.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403EthBroadcast" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Ethereum transaction", "tags": ["Ethereum"] } }, "/v3/kms/pending/{chain}": { "get": { "description": "1 credit per API call
\nGet the list of pending transactions to sign and broadcast using KMS.
\n", "operationId": "GetPendingTransactionsToSign", "parameters": [ { "description": "Blockchain to get pending transactions for.", "in": "path", "name": "chain", "required": true, "schema": { "type": "string", "maxLength": 24, "minLength": 24, "enum": [ "BNB", "BTC", "ETH", "XLM", "XRP", "BCH", "LTC", "DOGE", "VET", "BSC", "MATIC", "CELO", "FLOW", "TRON", "ONE", "XDC", "EGLD", "KLAY", "SOL" ] } }, { "description": "Signature IDs of the KMS which invokes this endpoint. If multiple, they should be separated by comma.", "in": "query", "name": "signatures", "required": false, "schema": { "type": "string", "example": "6d78dad2-518f-4e76-8255-8f1df0de6884,6d78dad2-518f-4e76-8255-8f1df0de6885,6d78dad2-518f-4e76-8255-8f1df0de6886" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PendingTransaction" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get pending transactions to sign", "tags": ["Key Management System"] }, "post": { "description": "1 credit for every 500 signature IDs per API call
\nGet the list of pending transactions to sign and broadcast using KMS.
\nNOTE: This API works only in KMS v5.0 or later. If you use KMS older than v5.0, use this API instead.
\n", "operationId": "ReceivePendingTransactionsToSign", "parameters": [ { "description": "Blockchain to get pending transactions for.", "in": "path", "name": "chain", "required": true, "schema": { "type": "string", "maxLength": 24, "minLength": 24, "enum": [ "BNB", "BTC", "ETH", "XLM", "XRP", "BCH", "LTC", "DOGE", "VET", "BSC", "MATIC", "CELO", "FLOW", "TRON", "ONE", "XDC", "EGLD", "KLAY", "SOL" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KmsSignatureIds" } } }, "required": false, "description": "Signature IDs of the KMS which invokes this endpoint." }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PendingTransaction" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get pending transactions to sign", "tags": ["Key Management System"] } }, "/v3/kms/{id}/{txId}": { "put": { "description": "Mark pending transaction to sign as a complete and update it with a transactionID from the blockchain.
\n", "operationId": "CompletePendingSignature", "parameters": [ { "description": "ID of pending transaction", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "f91827364f91827364ajdur7", "maxLength": 24, "minLength": 24 } }, { "description": "transaction ID of blockchain transaction", "in": "path", "name": "txId", "required": true, "schema": { "type": "string", "example": "0x94Ce79B9F001E25BBEbE7C01998A78F7B27D1326", "maxLength": 80, "minLength": 10 } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Complete pending transaction to sign", "tags": ["Key Management System"] } }, "/v3/kms/{id}": { "get": { "description": "Get detail of transaction to be signed / that was already signed and contains transactionId.
", "operationId": "GetPendingTransactionToSign", "parameters": [ { "description": "ID of transaction", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 24, "minLength": 24 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PendingTransaction" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403KMSNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get transaction details", "tags": ["Key Management System"] }, "delete": { "description": "Delete transaction to be signed. When deleting offchain transaction, linked withdrawal will be cancelled automatically.
", "operationId": "DeletePendingTransactionToSign", "parameters": [ { "description": "ID of transaction", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 24, "minLength": 24 } }, { "description": "Defines whether fee should be reverted to account balance as well as amount. Defaults to true. Revert true would be typically used when withdrawal was not broadcast to blockchain. False is used usually for Ethereum ERC20 based currencies.", "in": "query", "name": "revert", "required": false, "schema": { "default": true, "example": true, "type": "boolean" } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403KMSNotExists" }, { "$ref": "#/components/schemas/Error403WithdrawalNotFound" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Delete transaction", "tags": ["Key Management System"] } }, "/v3/security/address/{address}": { "get": { "description": "Check, if the blockchain address is malicous. Malicous address can contain assets from the DarkWeb, is connected to the scam projects or contains stolen funds.
Supported Chains: ETH, BTC, LTC
\n", "operationId": "CheckMalicousAddress", "parameters": [ { "description": "Blockchain Address to check", "in": "path", "name": "address", "required": true, "schema": { "example": "0x002Bf459dC58584D58886169EA0E80f3Ca95FFAF", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Whether address is malicous or not", "example": "valid", "enum": ["valid", "invalid"] } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Check malicous address", "tags": ["Malicious address"] } }, "/v3/ledger/customer": { "get": { "description": "List of all customers. Also inactive an disabled customers are present.
\n", "operationId": "findAllCustomers", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Customer" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all customers", "tags": ["Customer"] } }, "/v3/ledger/customer/{id}": { "get": { "description": "Using anonymized external ID or internal customer ID you can access customer detail information. Internal ID is needed to call other customer related methods.
", "operationId": "getCustomerByExternalOrInternalId", "parameters": [ { "description": "Customer external or internal ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 100, "minLength": 1 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403CustomerNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get customer details", "tags": ["Customer"] }, "put": { "description": "This method is helpful in case your primary system will change ID's or customer will change the country he/she is supposed to be in compliance with.
", "operationId": "updateCustomer", "parameters": [ { "description": "Customer internal ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 50, "minLength": 10 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403CustomerInternalNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Update customer", "tags": ["Customer"] } }, "/v3/ledger/customer/{id}/activate": { "put": { "description": "Activated customer is able to do any operation.
", "operationId": "activateCustomer", "parameters": [ { "description": "Customer internal ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 50, "minLength": 10 } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403CustomerInternalNotExists" }, { "$ref": "#/components/schemas/Error403CustomerActive" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Activate customer", "tags": ["Customer"] } }, "/v3/ledger/customer/{id}/deactivate": { "put": { "description": "Deactivate customer is not able to do any operation. Customer can be deactivated only when all their accounts are already deactivated.
", "operationId": "deactivateCustomer", "parameters": [ { "description": "Customer internal ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 50, "minLength": 10 } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403CustomerDeactivateActiveAccounts" }, { "$ref": "#/components/schemas/Error403CustomerInactive" }, { "$ref": "#/components/schemas/Error403CustomerInternalNotExists" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Deactivate customer", "tags": ["Customer"] } }, "/v3/ledger/customer/{id}/enable": { "put": { "description": "Enabled customer can perform all operations. By default all customers are enabled. All previously blocked account balances will be unblocked.
", "operationId": "enableCustomer", "parameters": [ { "description": "Customer internal ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 50, "minLength": 10 } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403CustomerInactive" }, { "$ref": "#/components/schemas/Error403CustomerEnabled" }, { "$ref": "#/components/schemas/Error403CustomerInternalNotExists" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Enable customer", "tags": ["Customer"] } }, "/v3/ledger/customer/{id}/disable": { "put": { "description": "Disabled customer cannot perform end-user operations, such as create new accounts or send transactions. Available balance on all accounts is set to 0. Account balance will stay untouched.
", "operationId": "disableCustomer", "parameters": [ { "description": "Customer internal ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 50, "minLength": 10 } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403CustomerInactive" }, { "$ref": "#/components/schemas/Error403CustomerDisabled" }, { "$ref": "#/components/schemas/Error403CustomerInternalNotExists" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Disable customer", "tags": ["Customer"] } }, "/v3/ledger/virtualCurrency": { "post": { "description": "Create new virtual currency with given supply stored in account. This will create Tatum internal virtual currency. Every virtual currency must be prefixed with VC_.
\nEvery virtual currency must be pegged to existing FIAT or supported cryptocurrency. 1 unit of virtual currency has then the same amount as 1 unit of the base currency it is pegged to. It is possible to set a custom base rate for the virtual currency. (baseRate = 2 => 1 VC unit = 2 basePair units)
\nTatum virtual currency acts as any other asset within Tatum. For creation of ERC20 token, see ERC20 .
\nThis operation returns the newly created Tatum Ledger account with an initial balance set to the virtual currency's total supply. Total supply can be changed in the future.
Change base pair and/or base rate of existing virtual currency.
", "operationId": "updateCurrency", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualCurrencyUpdate" } } }, "required": true }, "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VCNotFound" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Update virtual currency", "tags": ["Virtual Currency"] } }, "/v3/ledger/virtualCurrency/{name}": { "get": { "description": "Get detail of virtual currency.
", "operationId": "getCurrency", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "maxLength": 100, "minLength": 3, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VC" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403VCNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get virtual currency", "tags": ["Virtual Currency"] } }, "/v3/ledger/virtualCurrency/mint": { "put": { "description": "
Create new supply of virtual currency linked on the given accountId. Method increases the total supply of the currency.
\nThis method creates Ledger transaction with operationType MINT with undefined counterAccountId.
\n", "operationId": "mintCurrency", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualCurrencyOperation" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionResult" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403VCNoAccount" }, { "$ref": "#/components/schemas/Error403VCTxFailed" }, { "$ref": "#/components/schemas/Error403VCNotFound" }, { "$ref": "#/components/schemas/Error403RateNotFound" }, { "$ref": "#/components/schemas/Error403AccountNotExists" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Create new supply of virtual currency", "tags": ["Virtual Currency"] } }, "/v3/ledger/virtualCurrency/revoke": { "put": { "description": "
Destroy supply of virtual currency linked on the given accountId. Method decreases the total supply of the currency.
\nThis method creates Ledger transaction with operationType REVOKE with undefined counterAccountId.
Store new buy / sell trade. If there is trade already available to fill, fill as much trades as possible.
\nIt is possible to charge fees for the trades. Fees are an extra amount on top of the trade amount and are paid in the currency that you going to block\ne.g.:\n- BUY BTC/USDT - fees will be paid in USDT\n- SELL BTC/ETH - fees will be paid in BTC\n
\nIf you fill type of the trade with FUTURE_BUY or FUTURE_SELL the trade will behave as a trade future. The trade is concluded now but will be fulfilled in future.\nThe date of fulfillment is by the “Seal Date” field. You can also block a percentage of the amount until the future trade has expired.\n
\nFutures can also penalize contracting parties if they don’t have the agreed balance available in their accounts.\nThe penalty is calculated in the following way: Penalty amount = (Percentage of incomplete deal amount because of shortage from user) × (Maximum Penalty percentage of futures deal based on blocked amount and time interval) × (total blocked value).\n
\nExample of the BTC/USDT trade future:
\nThe maker creates a sell with the following properties: 1 BTC at a price of 60000 USDT, with a blocking percentage of 22%, a penalty percentage of 45%, a system commision of 1% and with an expiration time of within 12 hours.
\n\n{\n \"type\": \"FUTURE_SELL\",\n \"price\": \"60000\",\n \"amount\": \"1\",\n \"pair\": \"BTC/USDT\",\n \"currency1AccountId\": \"60a236db1b57f60d62612bf3\",\n \"currency2AccountId\": \"609d0696bf835c241ac2920f\",\n \"fee\": 1,\n \"feeAccountId\": \"609d0696bf835c251ac2920a\",\n \"attr\": {\n \"sealDate\": 1621990960631,\n \"percentBlock\": 22,\n \"percentPenalty\": 45\n }\n}\n\n\nThe taker accepts the offer with a buy and blocks 13200 USDT (60000 USDT Ă— 0.22) in their account.\n\n{\n \"type\": \"FUTURE_BUY\",\n \"price\": \"60000\",\n \"amount\": \"1\",\n \"pair\": \"BTC/USDT\",\n \"currency1AccountId\": \"60a236db1b57f60d62612bf2\",\n \"currency2AccountId\": \"609d0696bf835c241ac2920a\",\n \"attr\": {\n \"sealDate\": 1621990960631,\n \"percentBlock\": 22,\n \"percentPenalty\": 45\n }\n}\n\nAt the time of the trade, the maker and taker have the following conditions.\nThe maker has 0.65 BTC (35% deficit) in their account and the taker has 49200 USDT (18% deficit) in their account.\n
\n\n\nThe maker penalty is equal to 0.35 Ă— 0.22 Ă— (0.45 Ă— 1 BTC) = 0.03465 BTC.\nThe taker penalty is equal to 0.18 Ă— 0.22 Ă— (0.45 Ă— 60000 USDT) = 1069.2 USDT.\n
\n\nThe system commission for the maker is 1 BTC Ă— 1% = 0.01 BTC.\nThe system commission for the taker is 60000 USDT Ă— 1% = 600 USDT.\n
\n\nThe maker’s assets after deducting penalties and commissions equals 0.65 - 0.03465 - 0.01 = 0.60535 BTC. The taker’s assets after deducting penalties and commissions equals 49200 - 1069.2 - 600 = 47530.8 USDT.\n
\n\nThe amount received by the maker after the trade is (0.60535 Ă— 60000) + 1069.2 = 37390.2 USDT and the taker receives 0.60535 + 0.03465 = 0.64 BTC.\n
\n", "operationId": "storeTrade", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTrade" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403AccountCurrencyVC" }, { "$ref": "#/components/schemas/Error403RateNotFound" }, { "$ref": "#/components/schemas/Error403VCNotFound" }, { "$ref": "#/components/schemas/Error403AmountFormat" }, { "$ref": "#/components/schemas/Error403OrderCurrency1NotFound" }, { "$ref": "#/components/schemas/Error403OrderCurrency1Frozen" }, { "$ref": "#/components/schemas/Error403OrderFeeNotFound" }, { "$ref": "#/components/schemas/Error403OrderFeeIncompatible" }, { "$ref": "#/components/schemas/Error403OrderCurrency1CustomerDisabled" }, { "$ref": "#/components/schemas/Error403OrderCurrency2NotFound" }, { "$ref": "#/components/schemas/Error403OrderCurrency2Frozen" }, { "$ref": "#/components/schemas/Error403OrderCurrency2CustomerDisabled" }, { "$ref": "#/components/schemas/Error403OrderCurrency1Pair" }, { "$ref": "#/components/schemas/Error403OrderCurrency2Pair" }, { "$ref": "#/components/schemas/Error403OrderCurrency1Balance" }, { "$ref": "#/components/schemas/Error403OrderCurrency2Balance" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Store buy / sell trade", "tags": ["Order Book"] } }, "/v3/trade/chart": { "post": { "description": "Obtain data from the closed trades for entering in the chart. Time interval is set between from and to and there is defined time frame. There can be obtained at most 200 time points in the time interval.
\n", "operationId": "chartRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Chart" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Obtain chart data from historical closed trades", "tags": ["Order Book"] } }, "/v3/trade/history": { "get": { "deprecated": true, "description": "List all historical trades. It is possible to list all trades, trades for specific trading pair and/or account.
", "operationId": "getHistoricalTrades", "parameters": [ { "description": "Account ID. If present, only closed trades for given account will be present.", "in": "query", "name": "id", "required": false, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } }, { "description": "Trade pair. If present, only closed trades on given trade pair will be present.", "in": "query", "name": "pair", "required": false, "schema": { "type": "string", "example": "BTC/ETH", "minLength": 3, "maxLength": 30, "pattern": "^[A-a-zZ0-9_\\-]+\\/[A-Za-z0-9_\\-]+$" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Get the total trade pair count based on the filter. Either count or pageSize is accepted.", "in": "query", "name": "count", "example": true, "schema": { "type": "boolean" } }, { "description": "Trade types.", "in": "query", "name": "types", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "BUY", "enum": ["FUTURE_BUY", "FUTURE_SELL", "BUY", "SELL"] } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Trade" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all historical trades", "tags": ["Order Book"] }, "post": { "description": "List all historical trades. It is possible to list all trades, trades for specific trading pair and/or account.
", "operationId": "getHistoricalTradesBody", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOderBookHistoryBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Trade" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all historical trades", "tags": ["Order Book"] } }, "/v3/trade/buy": { "get": { "description": "List all active buy trades.
", "operationId": "getBuyTrades", "deprecated": true, "parameters": [ { "description": "Account ID. If present, list current active buy trades for that account.", "in": "query", "name": "id", "required": false, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } }, { "description": "Customer ID. If present, list current active buy trades for that customer.", "in": "query", "name": "customerId", "required": false, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Trade pair. If present, list current active buy trades for that pair.", "in": "query", "name": "pair", "schema": { "type": "string", "example": "BTC/EUR", "minLength": 3, "maxLength": 30, "pattern": "^[A-a-zZ0-9_\\-]+\\/[A-Za-z0-9_\\-]+$" } }, { "description": "Get the total trade pair count based on the filter. Either count or pageSize is accepted.", "in": "query", "name": "count", "example": true, "schema": { "type": "boolean" } }, { "description": "Trade type.", "in": "query", "name": "tradeType", "example": "BUY", "required": false, "schema": { "type": "string", "enum": ["FUTURE_BUY", "BUY"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Trade" }, "type": "array" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all active buy trades", "tags": ["Order Book"] }, "post": { "description": "List all active buy trades.
", "operationId": "getBuyTradesBody", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOderBookActiveBuyBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Trade" }, "type": "array" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all active buy trades", "tags": ["Order Book"] } }, "/v3/trade/sell": { "get": { "description": "List all active sell trades.
", "operationId": "getSellTrades", "deprecated": true, "parameters": [ { "description": "Account ID. If present, list current active sell trades for that account.", "in": "query", "name": "id", "required": false, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } }, { "description": "Customer ID. If present, list current active buy trades for that customer.", "in": "query", "name": "customerId", "required": false, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Trade pair. If present, list current active sell trades for that pair.", "in": "query", "name": "pair", "schema": { "type": "string", "example": "BTC/EUR", "minLength": 3, "maxLength": 30, "pattern": "^[A-a-zZ0-9_\\-]+\\/[A-Za-z0-9_\\-]+$" } }, { "description": "Get the total trade pair count based on the filter. Either count or pageSize is accepted.", "in": "query", "name": "count", "example": true, "schema": { "type": "boolean" } }, { "description": "Trade type.", "in": "query", "name": "tradeType", "example": "SELL", "required": false, "schema": { "type": "string", "enum": ["FUTURE_SELL", "SELL"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Trade" }, "type": "array" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all active sell trades", "tags": ["Order Book"] }, "post": { "description": "List all active sell trades.
", "operationId": "getSellTradesBody", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOderBookActiveSellBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Trade" }, "type": "array" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all active sell trades", "tags": ["Order Book"] } }, "/v3/trade/matched": { "post": { "description": "List all matched orders from the FUTURE_BUY OR FUTURE_SELL orders.
", "operationId": "getMatchedTrades", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOderBookMatchedBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Trade" }, "type": "array" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all matched orders from FUTURE_SELL/FUTURE_BUY trades", "tags": ["Order Book"] } }, "/v3/trade/{id}": { "get": { "description": "Get existing opened trade.
", "parameters": [ { "description": "Trade ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "operationId": "getTradeById", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trade" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get existing trade", "tags": ["Order Book"] }, "delete": { "description": "Cancel existing trade.
", "parameters": [ { "description": "Trade ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "operationId": "deleteTrade", "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Cancel existing trade", "tags": ["Order Book"] } }, "/v3/trade/account/{id}": { "delete": { "description": "Cancel all trades for account.
", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "operationId": "deleteAccountTrades", "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Cancel all existing trades for account", "tags": ["Order Book"] } }, "/v3/subscription": { "post": { "description": "2 credits per API call + credits spent on subscriptions themselves
\nEach subscription type consumes a different number of credits.
For Free plans, there is a monthly limit of sent webhooks, which is 1000.
\nIf the webhook is sent unsuccessfully, it will be retried. The number of retries depends on the plan.
\nCreate a subscription as an HTTP web hook.
\nThe following subscription types are available:
\n| Chain | \nTestnet/Mainnet | \nToken assets support | \nPlan limitation | \nCredit consumption / day / address | \n
|---|---|---|---|---|
| Solana | \nYes/Yes | \nSOL, SPL and NFTs | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n50 credits / day / address | \n
| Ethereum | \nYes/Yes | \nETH, Internal transfers, ERC20, ERC721, ERC1155 | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n25 credits / day / address | \n
| Polygon | \nYes/Yes | \nMATIC, ERC20, ERC721, ERC1155 | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n40 credits / day / address | \n
| Celo | \nYes/Yes | \nCELO, Internal transfers, ERC20, ERC721, ERC1155 | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n25 credits / day / address | \n
| Klaytn | \nYes/Yes | \nKlay, ERC20, ERC721, ERC1155 | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n25 credits / day / address | \n
| Bitcoin | \nYes/Yes | \nBTC | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n5 credits / day / address | \n
| Litecoin | \nYes/Yes | \nLTC | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n7 credits / day / address | \n
| Bitcoin Cash | \nYes/Yes | \nBCH, only incoming transactions | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n5 credits / day / address | \n
| Dogecoin | \nYes/Yes | \nDOGE, only incoming transactions | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n7 credits / day / address | \n
| Tron | \nYes/Yes | \nTron, TRC10/TRC20 | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n30 credits / day / address | \n
| Binance Smart Chain | \nYes/Yes | \nBSC, BEP20, ERC721, ERC1155 | \nFree plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains | \n40 credits / day / address | \n
{\n \"address\": \"FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ\", // the address on which the transaction occurs; for EVM-based chains, this is the recipient's address\n \"txId\": \"2rdy3YCZHSwvpWtuDom1d4Jjy5UU9STLxF3ffXau6GToReDkfw8wEgX541fvzvh6btVC5D8iNapcKTXfPsoDBk7A\", // the transaction ID\n \"blockNumber\": 110827114, // the block number; does not appear if the transaction is in the mempool (for EMV-based blockchains)\n \"asset\": \"3gUeeR3BfVhukYJMwtHownRtRkGcf1bvwiV8TbKMZBVz\", // the asset of the transaction: for token assets, this is the token address; for native blochckain assets, this is the name of the asset (for example, SOL)\n \"amount\": \"1\", // the amount of the asset that was credited to (+) or debited from (-) the address; for EVM-based chains, when \"counterAddress\" is present, the amount is always positive\n \"tokenId\": \"1\", // (ERC-721 / ERC-1155 only) the ID of the transferred token\n \"type\": \"token\", // the type of the transaction; can be either \"native\" or \"token\"\n \"mempool\": true, // (EMV-based blockchains only) if appears and set to \"true\", the transaction is in the mempool; if set to \"false\" or does not appear at all, the transaction has been added to a block\n \"counterAddress\": undefined // an optional counter party address of the transaction; for EVM-based blockchains, this is the recipient's address\n}\n5 credits are debited for each fired web hook.| Chain | \nAvailable chains (the \"chain\" parameter in the response payload) | \nCredit consumption / day | \n
|---|---|---|
| Ethereum | \nethereum-sepolia / ethereum-mainnet | \n500,000 credits / day | \n
| Polygon | \npolygon-mumbai / polygon-mainnet | \n500,000 credits / day | \n
| Celo | \ncelo-testnet / celo-mainnet | \n500,000 credits / day | \n
| Klaytn | \nklaytn-baobab / klaytn-cypress | \n500,000 credits / day | \n
| BNB Smart Chain | \nbsc-testnet / bsc-mainnet | \n500,000 credits / day | \n
{\n \"events\": [\n {\n \"timestamp\": 1661961758000,\n \"from\": \"0x0000000000000000000000000000000000000000\",\n \"to\": \"0xfa4e7035b34294407e5df1603215983d65e5a773\",\n \"tokenId\": \"14671\",\n \"txId\": \"0x916fcf878656f7a3772317697e6d2740ac8b1b7dbe6d029aa79592fd72f3fb0b\",\n \"contractAddress\": \"0x55a2430e32dcebc3649120f26f917d1f0686f74c\",\n \"type\": \"erc721\",\n \"amount\": \"1\",\n \"logIndex\": 578,\n \"metadataURI\": \"https://graphigo.prd.galaxy.eco/metadata/0x55a2430e32dcebc3649120f26f917d1f0686f74c/14671.json\"\n }\n ],\n \"blockNumber\": 32522207,\n \"chain\": \"polygon-mainnet\",\n \"subscriptionType\": \"CONTRACT_NFT_TXS_PER_BLOCK\"\n }\n1 credit is debited for each fired web hook.| Chain | \nAvailable chains (the \"chain\" parameter in the response payload) | \nCredit consumption / day | \n
|---|---|---|
| Ethereum | \nethereum-sepolia / ethereum-mainnet | \n500,000 credits / day | \n
| Polygon | \npolygon-mumbai / polygon-mainnet | \n500,000 credits / day | \n
| Celo | \ncelo-testnet / celo-mainnet | \n500,000 credits / day | \n
| Klaytn | \nklaytn-baobab / klaytn-cypress | \n500,000 credits / day | \n
| BNB Smart Chain | \nbsc-testnet / bsc-mainnet | \n500,000 credits / day | \n
{\n \"events\": [\n {\n \"timestamp\": 1661961758000,\n \"from\": \"0x85bd970cf0e49acd572f9c2d608713bc55b5ee0e\",\n \"to\": \"0x9ab31230d5413e4af01af9bb697651a3c70c95c9\",\n \"tokenId\": \"1450000023306\",\n \"txId\": \"0x565b9ca6b7b5ff1b1ce0725acd785dbf5ff0930d5ff547bad044c0960291555f\",\n \"contractAddress\": \"0xdb6290f355a528a7284bdd528b05a78fb05226ca\",\n \"type\": \"erc1155\",\n \"amount\": \"1\",\n \"logIndex\": 571,\n \"metadataURI\": \"https://touhao.bj.bcebos.com/nft/metadata/1450000023306.json\"\n }\n ],\n \"blockNumber\": 32522207,\n \"chain\": \"polygon-mainnet\",\n \"subscriptionType\": \"CONTRACT_MULTITOKEN_TXS_PER_BLOCK\"\n}\n1 credit is debited for each fired web hook.| Chain | \nAvailable chains (the \"chain\" parameter in the response payload) | \nCredit consumption / day | \n
|---|---|---|
| Ethereum | \nethereum-sepolia / ethereum-mainnet | \n50,000 credits / day | \n
| Polygon | \npolygon-mumbai / polygon-mainnet | \n50,000 credits / day | \n
| Celo | \ncelo-testnet / celo-mainnet | \n50,000 credits / day | \n
| Klaytn | \nklaytn-baobab / klaytn-cypress | \n50,000 credits / day | \n
| BNB Smart Chain | \nbsc-testnet / bsc-mainnet | \n50,000 credits / day | \n
{\n \"events\": [\n {\n \"txId\": \"0xc98307f09ed527d5cff8305e8f65226b790e3317ded10b9e58f6f07286dcf8f1\",\n \"logIndex\": 326,\n \"timestamp\": 1661774265000,\n \"address\": \"0xc2132d05d31c914a87c6611c10748aeb04b58e8f\",\n \"topic_0\": \"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef\",\n \"topic_1\": \"0x000000000000000000000000a91ab7d77892a559d2a95baaf1d748fc97c65d29\",\n \"topic_2\": \"0x0000000000000000000000009b08288c3be4f62bbf8d1c20ac9c5e6f9467d8b7\",\n \"topic_3\": null,\n \"data\": \"0x0000000000000000000000000000000000000000000000000000000002c9e3e4\"\n }\n ],\n \"blockNumber\": 32447538,\n \"chain\": \"polygon-mumbai\",\n \"subscriptionType\": \"CONTRACT_LOG_EVENT\"\n}\n1 credit is debited for each fired web hook.{\n \"date\": 1619176527481,\n \"amount\": \"0.005\",\n \"currency\": \"BTC\",\n \"accountId\": \"6082ab462936b4478117c6a0\",\n \"reference: \"c9875708-4ba3-41c9-a4cd-271048b41b9a\", // the reference of the transaction in the virtual account\n \"txId\": \"45af182a0ffab58e5ba32fee57b297b2260c6e23a1de5ddc76c7ee22d72dea99\",\n \"blockHash\": \"45af182a0ffab58e5ba32fee57b297b2260c6e23a1de5ddc76c7ee22d72dea99\", // the hash of the block, might not be present every time\n \"blockHeight\": 12345,\n \"from\": \"SENDER_ADDRESS\", // might not be present every time; not present for UTXO-based blockchains\n \"to\": \"RECIPIENT_ADDRESS_CONNECTED_TO_LEDGER_ACCOUNT\", // the blockchain address of the recipient\n \"index\": 5 // for UTXO-based blockchains (BCH, BTC, DOGE, LTC), this is the index of the output in the transaction\n}\n1 credit is debited for each monitored account every day.{\n \"date\": 1619176527481,\n \"amount\": \"0.005\",\n \"currency\": \"BTC\",\n \"accountId\": \"6082ab462936b4478117c6a0\",\n \"reference: \"c9875708-4ba3-41c9-a4cd-271048b41b9a\", // the reference of the transaction in the virtual account\n \"txId\": \"45af182a0ffab58e5ba32fee57b297b2260c6e23a1de5ddc76c7ee22d72dea99\",\n \"blockHash\": \"45af182a0ffab58e5ba32fee57b297b2260c6e23a1de5ddc76c7ee22d72dea99\", // the hash of the block, might not be present every time; if set to \"null\", the transaction is in the mempool (for EMV-based blockchains)\n \"blockHeight\": 12345, // if set to \"null\", the transaction is in the mempool (for EMV-based blockchains)\n \"from\": \"SENDER_ADDRESS\", // might not be present every time; not present for UTXO-based blockchains (BCH, BTC, DOGE, LTC)\n \"to\": \"RECIPIENT_ADDRESS_CONNECTED_TO_LEDGER_ACCOUNT\", // the blockchain address of the recipient\n \"index\": 5 // for UTXO-based blockchains (BCH, BTC, DOGE, LTC), this is the index of the output in the transaction\n}\n1 credit is debited for each monitored account every day.{\n \"created\": 1619176527481,\n \"amount\": \"0.005\",\n \"price\": \"0.02\",\n \"type\": \"SELL\",\n \"pair\": \"VC_CHF/VC_CHF3\",\n \"id\": \"6082ab462936b4478117c6a0\", // id of the trade\n \"currency1AccountId\": \"6082ab462936b4478117c6a0\",\n \"currency2AccountId\": \"6082ab512936b4478117c6a2\",\n \"fee\": null,\n \"feeAccountId\": null,\n \"isMaker\": true,\n \"expiredWithoutMatch\": false\n}\n10 credits will be debited for every monitored customer every day.{\n \"created\": 1619176527481,\n \"amount\": \"0.005\",\n \"orderAmount\": \"0.1\",\n \"price\": \"0.02\",\n \"type\": \"SELL\",\n \"pair\": \"VC_CHF/VC_CHF3\",\n \"id\": \"6082ab462936b4478117c6a0\", // id of the trade\n \"currency1AccountId\": \"6082ab462936b4478117c6a0\",\n \"currency2AccountId\": \"6082ab512936b4478117c6a2\",\n \"fee\": null,\n \"feeAccountId\": null,\n \"isMaker\": true,\n \"expiredWithoutMatch\": false\n}\n10 credits will be debited for every monitored customer every day.\n {\n \"txId\": \"0x026f4f05b972c09279111da13dfd20d8df04eff436d7f604cd97b9ffaa690567\",\n \"reference\": \"90270634-5b07-4fad-b17b-f82899953533\",\n \"accountId\": \"6086ed0744c45b24d4fbd039\",\n \"currency\": \"BSC\",\n \"withdrawalId\": \"608fe5b73a893234ba379ab2\",\n \"address\": \"0x8ce4e40889a13971681391AAd29E88eFAF91f784\",\n \"amount\": \"0.1\",\n \"blockHeight\": 8517664\n }\n10 credits will be debited every day, 1 credit for every included transaction notified via web hook.{\n \"signatureId\": \"6082ab462936b4478117c6a0\",\n \"error\": \"Error message from the KMS\"\n}\n10 credits will be debited every day.{\n \"signatureId\": \"6082ab462936b4478117c6a0\",\n \"txId\": \"0x7bb7d3b90567e89f999f2e3d263bc3738a018dbbcfa9f5397678cf17cdf0235f\"\n}\n10 credits will be debited every day.List all active subscriptions.
", "operationId": "getSubscriptions", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Value for filtering by address", "in": "query", "name": "address", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Subscription" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all active subscriptions", "tags": ["Notification subscriptions"] }, "put": { "description": "Enable HMAC hash ID on the fired webhooks from Tatum API.\nIn order to make sure that a webhook is sent by us, we have the possibility to sign it with the HMAC Sha512 Hex algorithm.
\nTo verify that a webhook is sent by us\n
JSON.stringify(req.body)
require('crypto').createHmac('sha512', hmacSecret).update(JSON.stringify(req.body)).digest('base64').Disable HMAC hash ID on the fired webhooks from Tatum API.
\n", "operationId": "disableWebHookHmac", "responses": { "204": { "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Disable HMAC webhook digest", "tags": ["Notification subscriptions"] } }, "/v3/subscription/count": { "get": { "description": "Count of subscriptions that were found from /v3/subscription
", "operationId": "getSubscriptionsCount", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Value for filtering by address", "in": "query", "name": "address", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesCount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Count of found entities for get webhook request", "tags": ["Notification subscriptions"] } }, "/v3/subscription/{id}": { "delete": { "description": "Cancel existing subscription.
", "parameters": [ { "description": "Subscription ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "operationId": "deleteSubscription", "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Cancel existing subscription", "tags": ["Notification subscriptions"] } }, "/v3/subscription/report/{id}": { "get": { "description": "Obtain report from subscription based on its type. Following reports are supported:\n
List all webhooks.
", "operationId": "getAllWebhooks", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain the next page of data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Direction of sorting", "in": "query", "name": "direction", "schema": { "type": "string", "enum": ["asc", "desc"], "example": "asc" } }, { "description": "Flag indicating whether the webhook was successful or not", "in": "query", "name": "failed", "schema": { "type": "boolean", "example": false } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/WebHook" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "List all executed webhooks", "tags": ["Notification subscriptions"] } }, "/v3/subscription/webhook/count": { "get": { "description": "Count of webhooks that were found from /v3/subscription/webhook
", "operationId": "getAllWebhooksCount", "parameters": [ { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain the next page of data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Direction of sorting", "in": "query", "name": "direction", "schema": { "type": "string", "example": "asc", "enum": ["asc", "desc"] } }, { "description": "Flag indicating whether the webhook was successful or not", "in": "query", "name": "failed", "schema": { "type": "boolean", "example": false } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesCount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Count of found entities for get webhook request", "tags": ["Notification subscriptions"] } }, "/v3/offchain/account/{id}/address": { "post": { "description": "2 credits per API call
\nOn Flow, additional 3000 credits are consumed for each created address.
Create a deposit address associated with a virtual account.
\nYou can create multiple deposit addresses for one virtual account. When you have multiple deposit addresses created for the same virtual account, you aggregate various blockchain transactions from different addresses under a single account.
You can deposit funds from another blockchain address to a deposit address associated with the virtual account, and the funds will be credited to that virtual account.
Scanning for incoming deposits
\nBy default, deposit addresses are scanned for incoming deposits. Deposit addresses are automatically synchronized with the associated virtual account, and you can see incoming deposits on the virtual account.
Scanning deposit addresses for incoming deposits consumes 20 credits per address per day.
If you want to be notified about certain events occurring on the deposit addresses, subscribe for notifications.
\nVirtual account cryptocurrency
\nDepending on the cryptocurrency of the virtual account, this API generates:
\n
For fore information about supported blockchains and address types, see the API for creating virtual accounts.
\nDeposit addresses are generated in the natural order of the extended public key provided in the virtual account. The derivation index is the representation of that order; it starts from 0 and ends at 2^31.
\nWhen a new deposit address is generated, the last not used index is used to generate the address. You can skip some addresses to a different index, which means all the skipped addresses will no longer be used.
\n", "operationId": "generateDepositAddress", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } }, { "description": "Derivation path index for specific address. If not present, last used index for given xpub of account + 1 is used. We recommend not to pass this value manually, since when some of the indexes are skipped, it is not possible to use them lately to generate address from it.
", "in": "query", "name": "index", "schema": { "type": "number", "example": 2 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403AddressAccountXpubMissing" }, { "$ref": "#/components/schemas/Error403AddressAccountXpubUsed" }, { "$ref": "#/components/schemas/Error403AddressIndexUsed" }, { "$ref": "#/components/schemas/Error403OffchainNotSupported" }, { "$ref": "#/components/schemas/Error403AccountIncompatibleXpubBtc" }, { "$ref": "#/components/schemas/Error403AccountAddressGeneral" }, { "$ref": "#/components/schemas/Error403VCNotFound" }, { "$ref": "#/components/schemas/Error403AddressUsed" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Create a deposit address for a virtual account", "tags": ["Blockchain addresses"] }, "get": { "description": "1 credit per API call
\nGet all deposit addresses generated for a virtual account.
\n", "operationId": "getAllDepositAddresses", "parameters": [ { "description": "The ID of the virtual account to get deposit addresses for", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Address" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get all deposit addresses for a virtual account", "tags": ["Blockchain addresses"] } }, "/v3/offchain/account/address/batch": { "post": { "description": "2 credits per API call + 1 credit for each created address
\nOn Flow, additional 3000 credits are consumed for each created address.
Create multiple deposit addresses associated with a virtual account.
\nWhen you have multiple deposit addresses created for the same virtual account, you aggregate various blockchain transactions from different addresses under a single account.
You can deposit funds from another blockchain address to a deposit address associated with the virtual account, and the funds will be credited to that virtual account.
Scanning for incoming deposits
\nBy default, deposit addresses are scanned for incoming deposits. Deposit addresses are automatically synchronized with the associated virtual account, and you can see incoming deposits on the virtual account.
Scanning deposit addresses for incoming deposits consumes 20 credits per address per day.
If you want to be notified about certain events occurring on the deposit addresses, subscribe for notifications.
\nVirtual account cryptocurrency
\nDepending on the cryptocurrency of the virtual account, this API generates:
\n
For fore information about supported blockchains and address types, see the API for creating virtual accounts.
\nDeposit addresses are generated in the natural order of the extended public key provided in the virtual account. The derivation index is the representation of that order; it starts from 0 and ends at 2^31.
\nWhen a new deposit address is generated, the last not used index is used to generate the address. You can skip some addresses to a different index, which means all the skipped addresses will no longer be used.
\n", "operationId": "generateDepositAddressesBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OffchainAddresses" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403AddressAccountXpubMissing" }, { "$ref": "#/components/schemas/Error403AddressAccountXpubUsed" }, { "$ref": "#/components/schemas/Error403AddressIndexUsed" }, { "$ref": "#/components/schemas/Error403OffchainNotSupported" }, { "$ref": "#/components/schemas/Error403AccountIncompatibleXpubBtc" }, { "$ref": "#/components/schemas/Error403AccountAddressGeneral" }, { "$ref": "#/components/schemas/Error403VCNotFound" }, { "$ref": "#/components/schemas/Error403AddressUsed" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Create multiple deposit addresses for a virtual account", "tags": ["Blockchain addresses"] } }, "/v3/offchain/account/address/{address}/{currency}": { "get": { "description": "1 credit per API call
\nCheck whether a blockchain address with the specified cryptocurrency is registered within Tatum and is assigned to a virtual account (that is, whether this blockchain address is a deposit address associated with the virtual account).
\nIf the blockchain address is assigned to a virtual account, information about this account is returned. Otherwise, an error message is returned.
\n", "operationId": "addressExists", "parameters": [ { "description": "The cryptocurrency of the blockchain address to check", "in": "path", "name": "currency", "required": true, "schema": { "type": "string", "example": "BNB" } }, { "description": "The blockchain address to check", "in": "path", "name": "address", "required": true, "schema": { "example": "tbnb1sfj9981j2eo1ij2e09", "type": "string" } }, { "description": "In case of XLM or XRP, this is a memo or DestinationTag to search for.", "in": "query", "name": "index", "required": false, "schema": { "example": 1, "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403AddressNotFound" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Check whether a blockchain address is assigned to a virtual account", "tags": ["Blockchain addresses"] } }, "/v3/offchain/account/{id}/address/{address}": { "post": { "description": "2 credits per API call
\nAssign an existing blockchain address to a virtual account. The blockchain address becomes a deposit address associated with this account.Use this API when the virtual account has no default extended public key (xpub) and deposit addresses are handled manually.
You can assign multiple blockchain addresses to one virtual account. When you have multiple blockchain addresses assigned to the same virtual account, you aggregate various blockchain transactions from different addresses under a single account.
You can deposit funds from another blockchain address to a deposit address associated with the virtual account, and the funds will be credited to that virtual account.
Scanning for incoming deposits
\nBy default, deposit addresses are scanned for incoming deposits. Deposit addresses are automatically synchronized with the associated virtual account, and you can see incoming deposits on the virtual account.
Scanning deposit addresses for incoming deposits consumes 20 credits per address per day.
If you want to be notified about certain events occurring on the deposit addresses, subscribe for notifications.
\n", "operationId": "assignAddress", "parameters": [ { "description": "The ID of the virtual account to assign a blockchain address to", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } }, { "description": "The blockchain address to assign to the virtual account", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "2MsM67NLa71fHvTUBqNENW15P68nHB2vVXb" } }, { "description": "Destination tag or memo attribute for XRP or XLM addresses", "in": "query", "name": "index", "required": false, "schema": { "type": "number", "minimum": 1, "example": 1 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountNotExists" }, { "$ref": "#/components/schemas/Error403AddressXpub" }, { "$ref": "#/components/schemas/Error403OffchainNotSupported" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Assign a blockchain address to a virtual account", "tags": ["Blockchain addresses"] }, "delete": { "description": "1 credit per API call
\nRemove a deposit address from the virtual account.
\nThe deposit address will no longer be scanned for incoming deposits. You will no longer be able to generate this address again.
\n", "operationId": "removeAddress", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } }, { "description": "Blockchain address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "2MsM67NLa71fHvTUBqNENW15P68nHB2vVXb" } }, { "description": "Destination tag or memo attribute for XRP, BNB or XLM addresses", "in": "query", "name": "index", "required": false, "schema": { "type": "number", "minimum": 1, "example": 1 } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403AccountNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Remove a deposit address from a virtual account", "tags": ["Blockchain addresses"] } }, "/v3/offchain/withdrawal": { "post": { "description": "\n
Create a withdrawal from Tatum Ledger account to the blockchain.
\n
\n When withdrawal from Tatum is executed, all deposits, which are not processed yet are used as an input and\n change is moved to pool address 0 of wallet for defined account's xpub. If there are no unspent deposits, only last pool address 0 UTXO is used.\n If balance of wallet is not sufficient, it is impossible to perform withdrawal from this account -> funds were transferred to another\n linked wallet within system or outside of Tatum visibility.
\n For the first time of withdrawal from wallet, there must be some deposit made and funds are obtained from that. Since\n there is no withdrawal, there was no transfer to pool address 0 and thus it is not present in vIn. Pool transfer is identified by missing data.address property in response.\n When last not cancelled withdrawal is not completed and thus there is no tx id of output transaction given,\n we cannot perform next withdrawal.\n
\n Withdrawal from Tatum can be processed only from 1 account. In Ethereum Blockchain, each address is recognized as an account and only funds from that account can be sent in 1 transaction.\n Example: Account A has 0.5 ETH, Account B has 0.3 ETH. Account A is linked to Tatum Account 1, Account B is linked to Tatum Account 2. Tatum Account 1 has balance 0.7 Ethereum and\n Tatum Account 2 has 0.1 ETH. Withdrawal from Tatum Account 1 can be at most 0.5 ETH, even though balance in Tatum Private Ledger is 0.7 ETH.\n Because of this Ethereum Blockchain limitation, withdrawal request should always contain sourceAddress, from which withdrawal will be made. To get available balances for Ethereum wallet accounts, use hint endpoint.\n
\n\n XRP withdrawal can contain DestinationTag except of address, which is placed in attr parameter of withdrawal request.\nSourceTag of the blockchain transaction should be withdrawal ID for autocomplete purposes of withdrawals.\n
\n\n XLM withdrawal can contain memo except of address, which is placed in attr parameter of withdrawal request. XLM blockchain does not have possibility to enter source account information.\n It is possible to create memo in format 'destination|source', which is supported way of memo in Tatum and also there is information about the sender account in the blockchain.\n
\nGet withdrawals.
", "operationId": "GetWithdrawals", "parameters": [ { "description": "Currency of the withdrawal", "in": "query", "name": "currency", "schema": { "minLength": 2, "maxLength": 30, "type": "string", "example": "BTC" } }, { "description": "Status of the withdrawal", "in": "query", "name": "status", "schema": { "type": "string", "example": "Done", "enum": ["InProgress", "Done", "Cancelled"] } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/WithdrawalObject" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get withdrawals", "tags": ["Withdrawal"] } }, "/v3/offchain/withdrawal/{id}/{txId}": { "put": { "description": "Invoke complete withdrawal as soon as blockchain transaction ID is available. All other withdrawals for the same currency will be pending unless the last one is processed and marked as completed.
\n", "operationId": "completeWithdrawal", "parameters": [ { "description": "ID of created withdrawal", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 50, "minLength": 10 } }, { "description": "Blockchain transaction ID of created withdrawal", "in": "path", "name": "txId", "required": true, "schema": { "type": "string", "maxLength": 80, "minLength": 10 } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403WithdrawalNotFound" }, { "$ref": "#/components/schemas/Error403OffchainBroadcastState" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Complete withdrawal", "tags": ["Withdrawal"] } }, "/v3/offchain/withdrawal/{id}": { "delete": { "description": "This method is helpful if you need to cancel the withdrawal if the blockchain transaction fails or is not yet processed.\nThis does not cancel already broadcast blockchain transaction, only Tatum internal withdrawal, and the ledger transaction, that was linked to this withdrawal.
\nBy default, the transaction fee is included in the reverted transaction. There are situations, like sending ERC20 on ETH, TRC token on TRON, XLM or XRP based assets, when the fee should not be reverted, because e.g. the fee is in calculated\nin Ethereum and transaction was in ERC20 currency. In this situation, only the transaction amount should be reverted, not the fee.\n
Broadcast signed raw transaction end complete withdrawal associated with it.\nWhen broadcast succeeded but it is impossible to complete withdrawal, transaction id of transaction is returned and withdrawal must be completed manually.\n
\n", "operationId": "broadcastBlockchainTransaction", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastWithdrawal" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403WithdrawalNotFound" }, { "$ref": "#/components/schemas/Error403OffchainBroadcast" }, { "$ref": "#/components/schemas/Error403EthBroadcast" }, { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403Broadcast" }, { "$ref": "#/components/schemas/Error403OffchainBroadcastState" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed transaction and complete withdrawal", "tags": ["Withdrawal"] } }, "/v3/offchain/blockchain/estimate": { "post": { "description": "Estimate current transaction fee for ledger to blockchain transaction.
\nSupported blockchains:\n
Send BTC (Bitcoin) 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.\n
Send BCH (Bitcoin Cash) 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.\n
Send LTC (Litecoin) 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.\n
Send FLOW (Flow) or FUSD 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.\n
Send DOGE (Dogecoin) 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.\n
Send ETH (Ethereum) 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.\n
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.\n
Send KCS (KuCoin Community Chain (KCC)) or ERC-20-equivalent KCC 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.\n
Send Ethereum ERC-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.\n
This method is deprecated. Use Register token instead.
\nFirst step to create new ERC20 token with given supply on Ethereum blockchain with support of Tatum's private ledger.
\nThis method only creates Tatum Private ledger virtual currency with predefined parameters. It will not generate any blockchain smart contract.
\nThe whole supply of ERC20 token is stored in the customer's newly created account. Then it is possible to create new Tatum accounts with ERC20 token name as account's currency.
\nNewly created account is frozen until the specific ERC20 smart contract address is linked with the Tatum virtual currency, representing the token.
\nOrder of the steps to create ERC20 smart contract with Tatum private ledger support:\n
Deploy an Ethereum ERC-20 smart contract. This is a helper method, which is combination of\nRegister new ERC20 token in the ledger and Deploy blockchain ERC20.
\nAfter 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.
\nThis 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.\nNo 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\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
Send BSC (BNB Smart Chain) or BEP-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.\n
\n
\n
This method is deprecated. Use Register token instead.
\nFirst step to create new BEP20 token with given supply on BSC blockchain with support of Tatum's private ledger.
\n
\n
\nThis method only creates Tatum Private ledger virtual currency with predefined parameters. It will not generate any blockchain smart contract.
\nThe whole supply of BEP20 token is stored in the customer's newly created account. Then it is possible to create new Tatum accounts with BEP20 token name as account's currency.
\nNewly created account is frozen until the specific BEP20 smart contract address is linked with the Tatum virtual currency, representing the token.
\nOrder of the steps to create BEP20 smart contract with Tatum private ledger support:\n
Deploy a BNB Smart Chain BEP-20 smart contract. This is a helper method, which is combination of\nRegister new BEP20 token in the ledger and Deploy blockchain BEP20.
\n
\n
\nAfter 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.
\nThis 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.\nNo 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\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
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.\n
\n
\n
Deploy a Klaytn ERC-20-equivalent smart contract. This is a helper method, which is combination of\nRegister new ERC20 token in the ledger and Deploy blockchain ERC20.
\n
\n
\nAfter 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.
\nThis 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.\nNo 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\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
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.\n
\n
\n
This method is deprecated. Use Register token instead.
\nFirst step to create new ERC20 token with given supply on XDC blockchain with support of Tatum's private ledger.
\n
\n
\nThis method only creates Tatum Private ledger virtual currency with predefined parameters. It will not generate any blockchain smart contract.
\nThe whole supply of ERC20 token is stored in the customer's newly created account. Then it is possible to create new Tatum accounts with ERC20 token name as account's currency.
\nNewly created account is frozen until the specific ERC20 smart contract address is linked with the Tatum virtual currency, representing the token.
\nOrder of the steps to create ERC20 smart contract with Tatum private ledger support:\n
Deploy a XinFin ERC-20-equivalent smart contract. This is a helper method, which is combination of\nRegister new ERC20 token in the ledger and Deploy blockchain ERC20.
\n
\n
\nAfter 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.
\nThis 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.\nNo 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\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
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.\n
\n
\n
This method is deprecated. Use Register token instead.
\nFirst step to create new HRM20 token with given supply on ONE blockchain with support of Tatum's private ledger.
\n
\n
\nThis method only creates Tatum Private ledger virtual currency with predefined parameters. It will not generate any blockchain smart contract.
\nThe whole supply of HRM20 token is stored in the customer's newly created account. Then it is possible to create new Tatum accounts with HRM20 token name as account's currency.
\nNewly created account is frozen until the specific HRM20 smart contract address is linked with the Tatum virtual currency, representing the token.
\nOrder of the steps to create HRM20 smart contract with Tatum private ledger support:\n
Deploy a Harmony HRM-20 smart contract. This is a helper method, which is combination of\nRegister new HRM20 token in the ledger and Deploy blockchain HRM20.
\n
\n
\nAfter 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.
\nThis 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.\nNo 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\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
This is the first step to create a new ERC-20 or ERC-20 equivalent token with some supply in a virtual account.
\n
\n
\nThis method only creates Tatum Private ledger virtual currency with predefined parameters. It will not generate any blockchain smart contract.
\nThe 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.
\nNewly created account is frozen until the specific smart contract address is linked with the Tatum virtual currency, representing the token.
\nOrder of the steps to create smart contract with Tatum private ledger support:\n
Set the contact address of an ERC-20 or ERC-20-equivalent token (for example, BEP-20, HRM-20, and so on) to be able to communicate with the smart contract.\n
\n
\n
After creating and deploying an ERC-20 or ERC-20-equivalent 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.
\nNOTE:For Algorand, the contact address should be the token asset ID (AssetID), for example, 55351976.
Send CELO (Celo), ERC-20-equivalent Celo tokens, cUSD, or cEUR 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.\n
\n
\n
This method is deprecated. Use Register token instead.
\nFirst step to create new ERC-20 token with given supply on Celo blockchain with support of Tatum's private ledger.
\n
\n
\nThis method only creates Tatum Private ledger virtual currency with predefined parameters. It will not generate any blockchain smart contract.
\nThe whole supply of ERC-20 token is stored in the customer's newly created account. Then it is possible to create new Tatum accounts with ERC-20 token name as account's currency.
\nNewly created account is frozen until the specific ERC-20 smart contract address is linked with the Tatum virtual currency, representing the token.
\nOrder of the steps to create ERC-20 smart contract with Tatum private ledger support:\n
Deploy a Celo ERC-20-equivalent smart contract. This is a helper method, which is combination of\nRegister new Celo ERC-20 token in the ledger and Deploy blockchain ERC-20.
\n
\n
\nAfter 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.
\nThis 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.\nNo 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\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
Deploy a KuCoin Community Chain (KCC) ERC-20-equivalent smart contract. This is a helper method, which is combination of\nRegister new Kcs ERC20 token in the ledger and Deploy blockchain ERC-20.
\n
\n
\nAfter 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.
\nThis 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.\nNo 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\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
\n
Send SOL (Solana), USDC_SOL, or custom SPL tokens from a virtual account to the blockchain. This will create Tatum internal withdrawal request with ID. When every system works as expected,\nwithdrawal request is marked as complete and transaction id is assigned to it.\n
\n
Send XLM (Stellar) or XLM-based assets from a virtual account to the blockchain. This will create Tatum internal withdrawal request with ID. When every system works as expected,\nwithdrawal request is marked as complete and transaction id is assigned to it.\n
Create an XLM-based asset in a virtual account. The asset must be created and configured on the Stellar blockchain before creating a trust line.
\nThis API call will create an internal virtual currency. You can create virtual accounts with off-chain support.
\n", "operationId": "XlmAssetOffchain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateXlmAsset" } } }, "required": true }, "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VCCreateFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Create an XLM-based asset", "tags": ["Blockchain operations"] } }, "/v3/offchain/xrp/transfer": { "post": { "description": "\n
Send XRP (Ripple) from a virtual account to the blockchain. This will create Tatum internal withdrawal request with ID. When every system works as expected, withdrawal request is marked as complete and transaction id is assigned to it.\n
\n
Create an XRP-based asset in a virtual account. The asset must be created and configured on the Ripple blockchain before creating a trust line.
\nThis API call will create an internal virtual currency. You can create virtual accounts with off-chain support.
\n", "operationId": "XrpAssetOffchain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateXrpAsset" } } }, "required": true }, "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VCCreateFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Create XRP based Asset", "tags": ["Blockchain operations"] } }, "/v3/offchain/bnb/transfer": { "post": { "description": "\n
Send BNB (BNB Beacon Chain) or BNB assets from a virtual account to the blockchain. This will create Tatum internal withdrawal request with ID. When every system works as expected,\nwithdrawal request is marked as complete and transaction id is assigned to it.\n
\n
Create a BNB-based asset in a virtual account. The asset must first be created and configured on BNB Beacon Chain blockhain.
\nThis API call will create an internal virtual currency. You can create virtual accounts with off-chain support.
\n", "operationId": "BnbAssetOffchain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBnbAsset" } } }, "required": true }, "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VCCreateFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Create a BNB-based asset", "tags": ["Blockchain operations"] } }, "/v3/offchain/ada/transfer": { "post": { "description": "Support for Cardano is deprecated.
Send ADA (Cardano) 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.\n
Send TRON or TRX assets 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.\n
First step to create new TRC 10/20 token with given supply on the Tron blockchain with support of Tatum's private ledger.
\nThis method only creates Tatum Private ledger virtual currency with predefined parameters. It will not generate any blockchain smart contract.
\nThe whole supply of TRC 10/20 token is stored in the customer's newly created account. Then it is possible to create new Tatum accounts with TRC 10/20 token name as account's currency.
\nNewly created account is frozen until the specific TRC 10/20 smart contract address is linked with the Tatum virtual currency, representing the token.
\nOrder of the steps to create TRC 10/20 smart contract with Tatum private ledger support:\n
Deploy a TRON TRC-10 or TRC-20 smart contract. This is a helper method, which is combination of\nRegister new TRC-10/20 token in the ledger and Deploy blockchain TRC20 or Deploy blockchain TRC10.
\nAfter 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.
\nThis 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.\nNo 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\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
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.\n
\n
\n
Deploy an Algorand ERC-20-equivalent smart contract. This is a helper method, which is combination of\nRegister new Algorand ERC20 token in the ledger and Deploy blockchain ERC-20.
\n
\n
\nAfter 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.
\nThis 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.\nNo 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\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
4 credits per API call
\nSend Algos or ERC-20-equivalent Algorand tokens from a virtual account (even from a virtual account without deposit addresses adssigned) to the Algorand blockchain.
\nThe 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.
\nSending 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.
\nSigning a transaction
\nWhen 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "AlgoTransfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferAlgo" }, { "$ref": "#/components/schemas/TransferAlgoErc20" }, { "$ref": "#/components/schemas/TransferAlgoKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OffchainTransactionResult" }, { "$ref": "#/components/schemas/OffchainTransactionSignatureResult" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403WithdrawalNotFound" }, { "$ref": "#/components/schemas/Error403RateNotFound" }, { "$ref": "#/components/schemas/Error403VCNotFound" }, { "$ref": "#/components/schemas/Error403RecipientFormat" }, { "$ref": "#/components/schemas/Error403WithdrawalFailed" }, { "$ref": "#/components/schemas/Error403WithdrawalVC" }, { "$ref": "#/components/schemas/Error403OffchainNotSupported" }, { "$ref": "#/components/schemas/Error403AmountFormat" }, { "$ref": "#/components/schemas/Error403FeeFormat" }, { "$ref": "#/components/schemas/Error403OffchainNotCancelled" }, { "$ref": "#/components/schemas/Error403OffchainCancelled" }, { "$ref": "#/components/schemas/Error403TxSenderNotFound" }, { "$ref": "#/components/schemas/Error403TxSenderCustomerDisabled" }, { "$ref": "#/components/schemas/Error403TxBalance" }, { "$ref": "#/components/schemas/Error403TxAmountBtc" }, { "$ref": "#/components/schemas/Error403TxAmountEth" }, { "$ref": "#/components/schemas/Error403TxSenderFrozen" }, { "$ref": "#/components/schemas/Error403WithdrawalPending" }, { "$ref": "#/components/schemas/Error403EthMnemonicPrivateKey" }, { "$ref": "#/components/schemas/Error403EthErc20Unsupported" }, { "$ref": "#/components/schemas/Error403EthBroadcast" }, { "$ref": "#/components/schemas/Error403EthGasPrice" }, { "$ref": "#/components/schemas/Error403EthTxBody" }, { "$ref": "#/components/schemas/Error403EthGasCalculation" }, { "$ref": "#/components/schemas/Error403EthTxHash" }, { "$ref": "#/components/schemas/Error403EthTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send Algos from a virtual account to the blockchain", "tags": ["Blockchain operations"] } }, "/v3/bcash/wallet": { "get": { "description": "Tatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Bitcoin Cash wallet with derivation path m'/44'/145'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Bitcoin Cash wallet.
\n", "operationId": "BchGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Bitcoin Cash wallet", "tags": ["Bitcoin Cash"] } }, "/v3/bcash/node": { "post": { "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as an http-based JSON RPC driver to connect directly to the node provided by Tatum.\nTo learn more about JSON RPC, visit Bitcoin Cash developers' guide.
\n", "deprecated": true, "operationId": "BchRpcDriver", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid JSON RPC method content body.", "properties": { "jsonrpc": { "type": "string", "description": "Version of the JSON RPC.", "example": "1.0" }, "id": { "type": "string", "description": "ID of the request, could be any arbitrary identifier.", "example": "test" }, "method": { "type": "string", "description": "Method to invoke on the node.", "example": "getblockcount" }, "params": { "type": "array", "description": "Params to the method call, if required.", "example": [] } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid RPC response.", "example": { "jsonrpc": "1.0", "id": "test", "result": 654321 } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "x-codeSamples": [], "summary": "JSON RPC HTTP driver", "tags": ["Bitcoin Cash"] } }, "/v3/bcash/info": { "get": { "description": "Get Bitcoin Cash Blockchain Information. Obtain basic info like testnet / mainnet version of the chain, current block number and it's hash.
", "operationId": "BchGetBlockChainInfo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BchInfo" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Bitcoin Cash Blockchain Information", "tags": ["Bitcoin Cash"] } }, "/v3/bcash/block/hash/{i}": { "get": { "description": "Get Bitcoin Cash Block hash. Returns hash of the block to get the block detail.
", "operationId": "BchGetBlockHash", "parameters": [ { "description": "The number of blocks preceding a particular block on a block chain.", "in": "path", "name": "i", "required": true, "schema": { "type": "number", "example": 1580117 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "hash": { "type": "string", "description": "Block hash", "example": "0000000053f225e202cf27fe3046e06719efd3b31b5ab75fc5ef7f853c8b246f" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Bitcoin Cash Block hash", "tags": ["Bitcoin Cash"] } }, "/v3/bcash/block/{hash}": { "get": { "description": "Get Bitcoin Cash Block detail by block hash or height.
", "operationId": "BchGetBlock", "parameters": [ { "description": "Block hash or height", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "00000000000000cfb22714715f09b3721f89819a325f7f4d39b2c22a061d1be8" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BchBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Bitcoin Cash Block by hash", "tags": ["Bitcoin Cash"] } }, "/v3/bcash/transaction/{hash}": { "get": { "description": "Get Bitcoin Cash Transaction by transaction hash.
", "operationId": "BchGetRawTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "1451692ebbfbea1a2d2ec6fe6782596b6aa2e46c0589d04c406f491b5b46bc6a" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BchTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Bitcoin Cash Transaction by hash", "tags": ["Bitcoin Cash"] } }, "/v3/bcash/transaction/address/{address}": { "get": { "description": "Get Bitcoin Cash Transaction by address. Limit is 50 transaction per response.
", "operationId": "BchGetTxByAddress", "parameters": [ { "description": "Address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "2MsM67NLa71fHvTUBqNENW15P68nHB2vVXb" } }, { "description": "Define, how much transactions should be skipped to obtain another page.", "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "example": 2 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BchTx" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Bitcoin Cash Transactions by address", "tags": ["Bitcoin Cash"] } }, "/v3/bcash/address/{xpub}/{index}": { "get": { "description": "Generate Bitcoin Cash deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31 - 1. Generates new format of address starting with bitcoincash: in case of mainnet, bchtest: in case of testnet..
\n", "operationId": "BchGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "schema": { "type": "string" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 0, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Bitcoin Cash address", "example": "bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzezc" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Bitcoin Cash deposit address from Extended public key", "tags": ["Bitcoin Cash"] } }, "/v3/bcash/wallet/priv": { "post": { "description": "Generate private key for address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^32 private keys starting from index 0 until 2^31 - 1.
\n", "operationId": "BchGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Bitcoin Cash private key", "tags": ["Bitcoin Cash"] } }, "/v3/bcash/transaction": { "post": { "description": "Send Bitcoin Cash to blockchain addresses. It is possible to build a blockchain transaction in 1 way:\n
Broadcast signed transaction to Bitcoin Cash blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.
\n", "operationId": "BchBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403Broadcast" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Bitcoin Cash transaction", "tags": ["Bitcoin Cash"] } }, "/v3/litecoin/wallet": { "get": { "description": "Tatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Litecoin wallet with derivation path m'/44'/2'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/litecoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Litecoin wallet.
\n", "operationId": "LtcGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Litecoin wallet", "tags": ["Litecoin"] } }, "/v3/litecoin/node": { "post": { "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as an http-based JSON RPC driver to connect directly to the node provided by Tatum.
\n", "operationId": "LtcRpcDriver", "deprecated": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid JSON RPC method content body.", "properties": { "jsonrpc": { "type": "string", "description": "Version of the JSON RPC.", "example": "1.0" }, "id": { "type": "string", "description": "ID of the request, could be any arbitrary identifier.", "example": "test" }, "method": { "type": "string", "description": "Method to invoke on the node.", "example": "getblockcount" }, "params": { "type": "array", "description": "Params to the method call, if required.", "example": [] } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid RPC response.", "example": { "jsonrpc": "1.0", "id": "test", "result": 654321 } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "x-codeSamples": [], "summary": "JSON RPC HTTP driver", "tags": ["Litecoin"] } }, "/v3/litecoin/info": { "get": { "description": "Get Litecoin Blockchain Information. Obtain basic info like testnet / mainnet version of the chain, current block number and it's hash.
", "operationId": "LtcGetBlockChainInfo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LtcInfo" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Litecoin Blockchain Information", "tags": ["Litecoin"] } }, "/v3/litecoin/block/hash/{i}": { "get": { "description": "Get Litecoin Block hash. Returns hash of the block to get the block detail.
", "operationId": "LtcGetBlockHash", "parameters": [ { "description": "The number of blocks preceding a particular block on a block chain.", "in": "path", "name": "i", "required": true, "schema": { "type": "number", "example": 1234314 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "hash": { "type": "string", "description": "Block hash", "example": "6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Litecoin Block hash", "tags": ["Litecoin"] } }, "/v3/litecoin/block/{hash}": { "get": { "description": "Get Litecoin Block detail by block hash or height.
", "operationId": "LtcGetBlock", "parameters": [ { "description": "Block hash or height.", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "1234314" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LtcBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "404": { "description": "Block not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404BlockNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Litecoin Block by hash or height", "tags": ["Litecoin"] } }, "/v3/litecoin/transaction/{hash}": { "get": { "description": "Get Litecoin Transaction detail by transaction hash.
", "operationId": "LtcGetRawTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "d60631d8e5c8b6eb0557b5181cf28564d771c628a08abc414e87ad7c05ff2fc2" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LtcTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403TxNotFound" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Litecoin Transaction by hash", "tags": ["Litecoin"] } }, "/v3/litecoin/mempool": { "get": { "description": "Get Litecoin Transaction ids in the mempool.
", "operationId": "LtcGetMempool", "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "description": "TX ID of the transaction in mempool", "example": "4c7846a8ff8415945e96937dea27bdb3144c15d793648d725602784826052586" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403BtcBlockchain" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Mempool Transactions", "tags": ["Litecoin"] } }, "/v3/litecoin/transaction/address/{address}": { "get": { "description": "Get Litecoin Transaction by address.
", "operationId": "LtcGetTxByAddress", "parameters": [ { "description": "Address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/LtcTx" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Litecoin Transactions by address", "tags": ["Litecoin"] } }, "/v3/litecoin/address/balance/{address}": { "get": { "description": "Get Litecoin Balance of the address.
", "operationId": "LtcGetBalanceOfAddress", "parameters": [ { "description": "Address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BtcBasedBalance" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Litecoin Balance of the address", "tags": ["Litecoin"] } }, "/v3/litecoin/utxo/{hash}/{index}": { "get": { "description": "Get UTXO of given transaction and output index. UTXO means Unspent Transaction Output, which is in blockchain terminology assets, that user\nreceived on the specific address and does not spend it yet.
\nIn bitcoin-like blockchains (BTC, LTC, DOGE, BCH), every transaction is built from the list of previously\n not spent transactions connected to the address. If user owns address A, receives in transaciont T1 10 LTC, he can spend in the next transaction\nUTXO T1 of total value 10 LTC. User can spend multiple UTXOs from different addresses in 1 transaction.
\nIf UTXO is not spent, data are returned, otherwise 404 error code.
Generate Litecoin deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31 - 1.
\n", "operationId": "LtcGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "schema": { "type": "string" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 0, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Litecoin address", "example": "n36h3pAH7sC3z8KMB47BjbqvW2aJd2oTi7" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountIncompatibleXpubBtc" }, { "$ref": "#/components/schemas/Error403AccountAddressGeneral" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Litecoin deposit address from Extended public key", "tags": ["Litecoin"] } }, "/v3/litecoin/wallet/priv": { "post": { "description": "Generate private key for address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^32 private keys starting from index 0 until 2^31 - 1.
\n", "operationId": "LtcGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BlockchainPrivateFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Litecoin private key", "tags": ["Litecoin"] } }, "/v3/litecoin/transaction": { "post": { "description": "Send Litecoin to blockchain addresses. It is possible to build a blockchain transaction in 2 ways:\n
Broadcast signed transaction to Litecoin blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.
\n", "operationId": "LtcBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403Broadcast" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Litecoin transaction", "tags": ["Litecoin"] } }, "/v3/dogecoin/wallet": { "get": { "description": "Tatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Dogecoin wallet with derivation path m'/44'/3'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/litecoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Dogecoin wallet.
\n", "operationId": "DogeGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Dogecoin wallet", "tags": ["Dogecoin"] } }, "/v3/dogecoin/address/{xpub}/{index}": { "get": { "description": "Generate Dogecoin deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31 - 1.
\n", "operationId": "DogeGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "schema": { "type": "string" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 0, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Dogecoin address", "example": "n36h3pAH7sC3z8KMB47BjbqvW2aJd2oTi7" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountIncompatibleXpubBtc" }, { "$ref": "#/components/schemas/Error403AccountAddressGeneral" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Dogecoin deposit address from Extended public key", "tags": ["Dogecoin"] } }, "/v3/dogecoin/wallet/priv": { "post": { "description": "Generate private key for address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^32 private keys starting from index 0 until 2^31 - 1.
\n", "operationId": "DogeGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BlockchainPrivateFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Dogecoin private key", "tags": ["Dogecoin"] } }, "/v3/dogecoin/node": { "post": { "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as an http-based JSON RPC driver to connect directly to the node provided by Tatum.
\n", "deprecated": true, "operationId": "DogeRpcDriver", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid JSON RPC method content body.", "properties": { "jsonrpc": { "type": "string", "description": "Version of the JSON RPC.", "example": "1.0" }, "id": { "type": "string", "description": "ID of the request, could be any arbitrary identifier.", "example": "test" }, "method": { "type": "string", "description": "Method to invoke on the node.", "example": "getblockcount" }, "params": { "type": "array", "description": "Params to the method call, if required.", "example": [] } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid RPC response.", "example": { "jsonrpc": "1.0", "id": "test", "result": 654321 } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "x-codeSamples": [], "summary": "JSON RPC HTTP driver", "tags": ["Dogecoin"] } }, "/v3/dogecoin/info": { "get": { "description": "Get Dogecoin Blockchain Information. Obtain basic info like testnet / mainnet version of the chain, current block number and it's hash.
", "operationId": "DogeGetBlockChainInfo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DogeInfo" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Dogecoin Blockchain Information", "tags": ["Dogecoin"] } }, "/v3/dogecoin/block/hash/{i}": { "get": { "description": "Get Dogecoin Block hash. Returns hash of the block to get the block detail.
", "operationId": "DogeGetBlockHash", "parameters": [ { "description": "The number of blocks preceding a particular block on a block chain.", "in": "path", "name": "i", "required": true, "schema": { "type": "number", "example": 1234314 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "hash": { "type": "string", "description": "Block hash", "example": "6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Dogecoin Block hash", "tags": ["Dogecoin"] } }, "/v3/dogecoin/block/{hash}": { "get": { "description": "Get Dogecoin Block detail by block hash or height.
", "operationId": "DogeGetBlock", "parameters": [ { "description": "Block hash or height.", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "1234314" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DogeBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "404": { "description": "Block not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404BlockNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Dogecoin Block by hash or height", "tags": ["Dogecoin"] } }, "/v3/dogecoin/transaction/{hash}": { "get": { "description": "Get Dogecoin Transaction detail by transaction hash.
", "operationId": "DogeGetRawTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "d60631d8e5c8b6eb0557b5181cf28564d771c628a08abc414e87ad7c05ff2fc2" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DogeTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403TxNotFound" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Dogecoin Transaction by hash", "tags": ["Dogecoin"] } }, "/v3/dogecoin/mempool": { "get": { "description": "Get Dogecoin Transaction ids in the mempool.
", "operationId": "DogeGetMempool", "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "description": "TX ID of the transaction in mempool", "example": "4c7846a8ff8415945e96937dea27bdb3144c15d793648d725602784826052586" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403BtcBlockchain" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Mempool Transactions", "tags": ["Dogecoin"] } }, "/v3/dogecoin/utxo/{hash}/{index}": { "get": { "description": "Get UTXO of given transaction and output index. UTXO means Unspent Transaction Output, which is in blockchain terminology assets, that user\nreceived on the specific address and does not spend it yet.
\nIn bitcoin-like blockchains (BTC, LTC, DOGE, BCH), every transaction is built from the list of previously\n not spent transactions connected to the address. If user owns address A, receives in transaciont T1 10 DOGE, he can spend in the next transaction\nUTXO T1 of total value 10 DOGE. User can spend multiple UTXOs from different addresses in 1 transaction.
\nIf UTXO is not spent, data are returned, otherwise 404 error code.
Send Dogecoin to blockchain addresses. It is possible to build a blockchain transaction in 1 way:\n
Broadcast signed transaction to Dogecoin blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.
\n", "operationId": "DogeBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403Broadcast" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Dogecoin transaction", "tags": ["Dogecoin"] } }, "/v3/flow/wallet": { "get": { "description": "Tatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Dogecoin wallet with derivation path m'/44'/3'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/litecoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Dogecoin wallet.
\n", "operationId": "FlowGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Flow wallet", "tags": ["Flow"] } }, "/v3/flow/address/{xpub}/{index}": { "get": { "description": "Generate Flow address from Extended public key. This operation internally creates public key and assings it to the newly created address on the blockchain.\nThere is minimal amount, which must be sent to the FLOW address during creation - 0.001 FLOW, which will be used from Tatum service account.
\nThis operation is allowed on any Testnet plan and only on Paid Mainnet plans.\nPublic key is generated for the specific index - each extended public key can generate up to 2^31 addresses starting from index 0 until 2^31 - 1.
Generate Flow public key from Extended public key. This key is added to the address on the blockchain and can control the funds there. Public key is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31 - 1.
\n", "operationId": "FlowGeneratePubKey", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "schema": { "type": "string" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 0, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pubKey": { "type": "string", "description": "Flow public key", "example": "968c3ce11e871cb2b7161b282655ee5fcb051f3c04894705d771bf11c6fbebfc6556ab8a0c04f45ea56281312336d0668529077c9d66891a6cad3db877acbe90" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountIncompatibleXpubBtc" }, { "$ref": "#/components/schemas/Error403AccountAddressGeneral" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Flow public key from Extended public key", "tags": ["Flow"] } }, "/v3/flow/wallet/priv": { "post": { "description": "Generate private key for address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^32 private keys starting from index 0 until 2^31 - 1.
\n", "operationId": "FlowGeneratePubKeyPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BlockchainPrivateFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Flow private key", "tags": ["Flow"] } }, "/v3/flow/block/current": { "get": { "description": "Get Flow current block number.
", "operationId": "FlowGetBlockChainInfo", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 12345678 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Flow current block number", "tags": ["Flow"] } }, "/v3/flow/block/{hash}": { "get": { "description": "Get Flow Block detail by block hash or height.
", "operationId": "FlowGetBlock", "parameters": [ { "description": "Block hash or height.", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "1234314" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "404": { "description": "Block not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404BlockNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Flow Block by hash or height", "tags": ["Flow"] } }, "/v3/flow/block/events": { "get": { "description": "Get Flow events from block.
", "operationId": "FlowGetBlockEvents", "parameters": [ { "description": "Event type to search for", "in": "query", "name": "type", "required": true, "schema": { "type": "string", "example": "A.7e60df042a9c0868.FlowToken.TokensWithdrawn" } }, { "description": "Block height to start searching", "in": "query", "name": "from", "required": true, "schema": { "type": "number", "example": 654321 } }, { "description": "Block height to end searching", "in": "query", "name": "to", "required": true, "schema": { "type": "number", "example": 654326 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEvent" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "404": { "description": "Block not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404BlockNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Flow events from blocks", "tags": ["Flow"] } }, "/v3/flow/transaction/{hash}": { "get": { "description": "Get Flow Transaction detail by transaction hash.
", "operationId": "FlowGetRawTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "d60631d8e5c8b6eb0557b5181cf28564d771c628a08abc414e87ad7c05ff2fc2" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403TxNotFound" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Flow Transaction by hash", "tags": ["Flow"] } }, "/v3/flow/account/{address}": { "get": { "description": "Get Flow account details.
", "operationId": "FlowGetAccount", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x955cd3f17b2fd8ad" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowAccount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403BtcBlockchain" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Flow account", "tags": ["Flow"] } }, "/v3/flow/transaction": { "post": { "description": "Send Flow or FUSD to blockchain addresses. Tatum covers the fee connected to the transaction costs in subscription credits. This operation can be done on mainnet only for paid plans.
\nThere are two possibilites how the transaction on the blockchain can be created:\n
Send arbitrary blockchain transaction to FLOW blockchain. Tatum covers the fee connected to the transaction costs in subscription credits. This operation can be done on mainnet only for paid plans.
\nThere are two possibilites how the transaction on the blockchain can be created:\n
Create Flow blockchain addresses from public key. This will generate address on the blockchain with public key. Private key for that public key can be used for signing transaction.\nThere are two possibilites how the transaction on the blockchain can be created:\n
Add public key to existing Flow blockchain addresses. Private key for that public key can be used for signing transaction.\nThere are two possibilites how the transaction on the blockchain can be created:\n
Generate XRP account. Tatum does not support HD wallet for XRP, only specific address and private key can be generated.
\n", "operationId": "XrpWallet", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XrpWallet" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XrpFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate XRP account", "tags": ["XRP"] } }, "/v3/xrp/info": { "get": { "description": "Get XRP Blockchain last closed ledger index and hash.
", "operationId": "XrpGetLastClosedLedger", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XrpInfo" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XrpFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XRP Blockchain Information", "tags": ["XRP"] } }, "/v3/xrp/fee": { "get": { "description": "Get XRP Blockchain fee. Standard fee for the transaction is available in the drops.base_fee section and is 10 XRP drops by default.\nWhen there is a heavy traffic on the blockchain, fees are increasing according to current traffic.
\n", "operationId": "XrpGetFee", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XrpFee" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XrpFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get actual Blockchain fee", "tags": ["XRP"] } }, "/v3/xrp/account/tx/{account}": { "get": { "description": "List all Account transactions.
", "operationId": "XrpGetAccountTx", "parameters": [ { "description": "Address of XRP account.", "in": "path", "name": "account", "required": true, "schema": { "type": "string" } }, { "description": "Ledger version to start scanning for transactions from.", "in": "query", "name": "min", "required": false, "schema": { "type": "number" } }, { "description": "Marker from the last paginated request. It is stringified JSON from previous response.", "in": "query", "name": "marker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XrpAccountTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403XrpFailed" }, { "$ref": "#/components/schemas/Error403XrpCode" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Account transactions", "tags": ["XRP"] } }, "/v3/xrp/ledger/{i}": { "get": { "description": "Get ledger by sequence.
", "operationId": "XrpGetLedger", "parameters": [ { "description": "Sequence of XRP ledger.", "in": "path", "name": "i", "required": true, "schema": { "type": "number", "minimum": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XrpLedger" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403XrpFailed" }, { "$ref": "#/components/schemas/Error403XrpLedger" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Ledger", "tags": ["XRP"] } }, "/v3/xrp/transaction/{hash}": { "get": { "description": "Get XRP Transaction by transaction hash.
", "operationId": "XrpGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "example": "1A32A054B04AC9D6814710DDCA416E72C4CD2D78D6C3DFC06CC9369CC4F6B250", "type": "string", "minLength": 64, "maxLength": 64 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XrpTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403XrpFailed" }, { "$ref": "#/components/schemas/Error403XrpCode" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XRP Transaction by hash", "tags": ["XRP"] } }, "/v3/xrp/account/{account}": { "get": { "description": "Get XRP Account info.
", "operationId": "XrpGetAccountInfo", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "account", "required": true, "schema": { "example": "rDA3DJBUBjA1X3PtLLFAEXxX31oA5nL3QF", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XrpAccount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403XrpFailed" }, { "$ref": "#/components/schemas/Error403XrpCode" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Account info", "tags": ["XRP"] } }, "/v3/xrp/account/{account}/balance": { "get": { "description": "Get XRP Account Balance. Obtain balance of the XRP and other assets on the account.
", "operationId": "XrpGetAccountBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "account", "required": true, "schema": { "example": "rDA3DJBUBjA1X3PtLLFAEXxX31oA5nL3QF", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XrpAccountBalance" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403XrpFailed" }, { "$ref": "#/components/schemas/Error403XrpCode" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Account Balance", "tags": ["XRP"] } }, "/v3/xrp/transaction": { "post": { "description": "Send XRP from account to account.
\nThis 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.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
\n
Create / Update / Delete XRP trust line between accounts to transfer private assets.\nBy creating trustline for the first time, the asset is created automatically and can be used in the transactions.
\nAccount setting rippling must be enabled on the issuer account before the trust line creation to asset work correctly.\nCreating a trust line will cause an additional 5 XRP to be blocked on the account.
\nThis 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.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.
\n
Modify XRP account settings. If an XRP account should be an issuer of the custom asset, this accounts should have rippling enabled to true.\nIn order to support off-chain processing, required destination tag should be set on the account.
\nThis 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.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
Broadcast signed transaction to XRP blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.
\n", "operationId": "XrpBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XrpBroadcast" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed XRP transaction", "tags": ["XRP"] } }, "/v3/xlm/account": { "get": { "description": "Generate XLM account. Tatum does not support HD wallet for XLM, only specific address and private key can be generated.
\n", "operationId": "XlmWallet", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XlmWallet" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XlmFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate XLM account", "tags": ["Stellar"] } }, "/v3/xlm/info": { "get": { "description": "Get XLM Blockchain last closed ledger.
", "operationId": "XlmGetLastClosedLedger", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XlmLedger" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XlmFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XLM Blockchain Information", "tags": ["Stellar"] } }, "/v3/xlm/ledger/{sequence}": { "get": { "description": "Get XLM Blockchain ledger for ledger sequence.
", "operationId": "XlmGetLedger", "parameters": [ { "description": "Sequence of the ledger.", "in": "path", "name": "sequence", "required": true, "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XlmLedger" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XlmFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XLM Blockchain Ledger by sequence", "tags": ["Stellar"] } }, "/v3/xlm/ledger/{sequence}/transaction": { "get": { "description": "Get XLM Blockchain transactions in the ledger.
", "operationId": "XlmGetLedgerTx", "parameters": [ { "description": "Sequence of the ledger.", "in": "path", "name": "sequence", "required": true, "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XlmTx" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XlmFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XLM Blockchain Transactions in Ledger", "tags": ["Stellar"] } }, "/v3/xlm/fee": { "get": { "description": "Get XLM Blockchain fee in 1/10000000 of XLM (stroop)
", "operationId": "XlmGetFee", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current fee in 1/10000000 of XLM (stroop)", "example": 100 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XlmFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get actual XLM fee", "tags": ["Stellar"] } }, "/v3/xlm/account/tx/{account}": { "get": { "description": "List all XLM account transactions.
", "operationId": "XlmGetAccountTx", "parameters": [ { "description": "Address of XLM account.", "in": "path", "name": "account", "required": true, "schema": { "type": "string", "example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H" } }, { "description": "Paging token from the last transaction gives you next page", "in": "query", "name": "pagination", "required": false, "schema": { "type": "string", "example": "1348087155011584" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XlmTx" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XlmFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XLM Account transactions", "tags": ["Stellar"] } }, "/v3/xlm/transaction/{hash}": { "get": { "description": "Get XLM Transaction by transaction hash.
", "operationId": "XlmGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "example": "749e4f8933221b9942ef38a02856803f379789ec8d971f1f60535db70135673e", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XlmTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XlmFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XLM Transaction by hash", "tags": ["Stellar"] } }, "/v3/xlm/account/{account}": { "get": { "description": "Get XLM Account detail.
", "operationId": "XlmGetAccountInfo", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "account", "required": true, "schema": { "example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XlmAccount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XlmFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XLM Account info", "tags": ["Stellar"] } }, "/v3/xlm/transaction": { "post": { "description": "Send XLM from account to account. It is possbile to send native XLM asset, or any other custom asset present on the network.
\nThis 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.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
\n
Create / Update / Delete XLM trust line between accounts to transfer private assets.\nBy creating trustline for the first time, the asset is created automatically and can be used in the transactions.
\nThis 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.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
Broadcast signed transaction to XLM blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.
\n", "operationId": "XlmBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XlmFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed XLM transaction", "tags": ["Stellar"] } }, "/v3/bnb/account": { "get": { "description": "Generate BNB account. Tatum does not support HD wallet for BNB, only specific address and private key can be generated.
\n", "operationId": "BnbGenerateWallet", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BnbWallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Binance wallet", "tags": ["BNB Beacon Chain"] } }, "/v3/bnb/block/current": { "get": { "description": "Get Binance current block number.
", "operationId": "BnbGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 6491272 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BnbFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Binance current block", "tags": ["BNB Beacon Chain"] } }, "/v3/bnb/block/{height}": { "get": { "description": "Get Transactions in block by block height.
", "operationId": "BnbGetBlock", "parameters": [ { "description": "Block height", "in": "path", "name": "height", "required": true, "schema": { "type": "number", "example": 6470657 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BnbBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BnbFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Binance Transactions in Block", "tags": ["BNB Beacon Chain"] } }, "/v3/bnb/account/{address}": { "get": { "description": "Get Binance Account Detail by address.
", "operationId": "BnbGetAccount", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "tbnb185tqzq3j6y7yep85lncaz9qeectjxqe5054cgn" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BnbAccount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BnbFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Binance Account", "tags": ["BNB Beacon Chain"] } }, "/v3/bnb/transaction/{hash}": { "get": { "description": "Get Binance Transaction by transaction hash.
", "operationId": "BnbGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "4B944BBF78F3ADE3A377551B5EA7AD0FEDBDA13165D932F94B106EF7A8E16C1A" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BnbTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BnbFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Binance Transaction", "tags": ["BNB Beacon Chain"] } }, "/v3/bnb/account/transaction/{address}": { "get": { "description": "Get Binance Transactions by address.
", "operationId": "BnbGetTxByAccount", "parameters": [ { "description": "Account address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "tbnb185tqzq3j6y7yep85lncaz9qeectjxqe5054cgn" } }, { "description": "Start time in milliseconds", "in": "query", "name": "startTime", "required": true, "schema": { "type": "number", "minimum": 0, "example": 1651831727871 } }, { "description": "End time in milliseconds", "in": "query", "name": "endTime", "required": true, "schema": { "type": "number", "minimum": 0, "example": 1651831727871 } }, { "description": "Items per page.", "in": "query", "name": "limit", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 } }, { "description": "Pagination offset", "in": "query", "name": "offset", "schema": { "type": "number", "example": 10, "minimum": 0 } }, { "description": "Asset name", "in": "query", "name": "asset", "schema": { "type": "string", "example": "BNB" } }, { "description": "Address type", "in": "query", "name": "addressType", "schema": { "type": "string", "example": "FROM", "enum": ["FROM", "TO"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BnbTxInAccount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BnbFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Binance Transactions By Address", "tags": ["BNB Beacon Chain"] } }, "/v3/bnb/transaction": { "post": { "description": "Send Binance or Binance Token token from account to account.
\nThis 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.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey.\nPrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\n Tatum KMS should be used for the highest security standards, and signatureId should be present in the request.\n Alternatively, using the Tatum client library for supported languages.\n
Broadcast signed transaction to Binance blockchain. This method is used internally or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.
\n", "operationId": "BnbBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Broadcast" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BnbFailed" }, { "$ref": "#/components/schemas/Error403BnbBroadcatSigFailed" }, { "$ref": "#/components/schemas/Error403BnbTxStateFailed" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed BNB transaction", "tags": ["BNB Beacon Chain"] } }, "/v3/vet/wallet": { "get": { "description": "Tatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for VeChain wallet with derivation path m'/44'/818'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible VeChain wallet.
\n", "operationId": "VetGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate VeChain wallet", "tags": ["VeChain"] } }, "/v3/vet/address/{xpub}/{index}": { "get": { "description": "Generate VeChain account deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31 - 1.
\n", "operationId": "VetGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "schema": { "type": "string", "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "VeChain addres", "example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VetFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate VeChain account address from Extended public key", "tags": ["VeChain"] } }, "/v3/vet/wallet/priv": { "post": { "description": "Generate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^32 private keys starting from index 0 until 2^31 - 1.
\n", "operationId": "VetGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate VeChain private key", "tags": ["VeChain"] } }, "/v3/vet/block/current": { "get": { "description": "Get VeChain current block number.
", "operationId": "VetGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 6491272 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VetFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get VeChain current block", "tags": ["VeChain"] } }, "/v3/vet/block/{hash}": { "get": { "description": "Get VeChain Block by block hash or block number.
", "operationId": "VetGetBlock", "parameters": [ { "description": "Block hash or block number", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "325324" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VetBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VetFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get VeChain Block by hash", "tags": ["VeChain"] } }, "/v3/vet/account/balance/{address}": { "get": { "description": "Get VeChain Account balance in VET.
", "operationId": "VetGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x5034aa590125b64023a0262112b98d72e3c8e40e" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in VET", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VetFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get VeChain Account balance", "tags": ["VeChain"] } }, "/v3/vet/account/energy/{address}": { "get": { "description": "Get VeChain Account energy in VTHO. VTHO is used for paying for the transaction fee.
", "operationId": "VetGetEnergy", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x5034aa590125b64023a0262112b98d72e3c8e40e" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "energy": { "type": "string", "description": "Balance in VTHO", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VetFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get VeChain Account energy (VTHO)", "tags": ["VeChain"] } }, "/v3/vet/transaction/{hash}": { "get": { "description": "Get VeChain Transaction by transaction hash.
", "operationId": "VetGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0x24f691abab680972437028af22bc7a43c3fbe8d6d7eefc420dea2daf554758a7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VetTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VetFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get VeChain Transaction", "tags": ["VeChain"] } }, "/v3/vet/transaction/{hash}/receipt": { "get": { "description": "Get VeChain Transaction Receipt by transaction hash. Transaction receipt is available only after transaction is\nincluded in the block and contains information about paid fee or created contract address and much more.
\n", "operationId": "VetGetTransactionReceipt", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0x24f691abab680972437028af22bc7a43c3fbe8d6d7eefc420dea2daf554758a7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VetTxReceipt" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VetFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get VeChain Transaction Receipt", "tags": ["VeChain"] } }, "/v3/vet/transaction": { "post": { "description": "Send VET from account to account. Fee for the transaction is paid in VTHO.
\nThis 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.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
Broadcast signed transaction to VeChain blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.
\n", "operationId": "VetBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403VetFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed VeChain transaction", "tags": ["VeChain"] } }, "/v3/ada/info": { "get": { "description": "Support for Cardano is deprecated.
You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Gets Ada blockchain information. Obtains basic info like the testnet / mainnet version of the chain, the current block number and its hash.
", "operationId": "AdaGetBlockChainInfo", "deprecated": true, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdaInfo" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Blockchain information", "tags": ["Cardano"] } }, "/v3/ada/graphql": { "post": { "description": "Support for Cardano is deprecated.
\nYou can work with Cardano by connecting directly to a blockchain node provided by Tatum.
100 credits per API call
\nUse this endpoint URL as an GraphQL to connect directly to the Ada node provided by Tatum. You can find full documentation on the Cardano GraphQL API.
\n", "operationId": "AdaGraphQL", "deprecated": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid GraphQL method content body.", "example": { "query": "{ cardano { tip { number slotNo epoch { number } }} }" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid GraphQL response.", "example": { "data": { "cardano": { "tip": { "number": 3250222, "slotNo": 48226361, "epoch": { "number": 181 } } } } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Ada GraphQL", "tags": ["Cardano"] } }, "/v3/ada/wallet": { "get": { "description": "Support for Cardano is deprecated.
\nYou can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Tatum supports BIP44 HD wallets. Because they can generate 2^31 addresses from 1 mnemonic phrase, they are very convenient and secure. A mnemonic phrase consists of 24 special words in a defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for ADA wallet with derivation path m/1852'/1815'/0'. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Ada wallet.
\n", "operationId": "AdaGenerateWallet", "deprecated": true, "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Ada wallet", "tags": ["Cardano"] } }, "/v3/ada/address/{xpub}/{index}": { "get": { "description": "Support for Cardano is deprecated.
\nYou can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Generates a Ada deposit address from an Extended public key. The deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31 - 1.
\n", "operationId": "AdaGenerateAddress", "deprecated": true, "parameters": [ { "description": "Extended public key of a wallet.", "in": "path", "name": "xpub", "required": true, "example": "30e96a57be6235c686da968c1860f69d1871a692b29626b7ebb923aff8c6731cb9fef3a26b7eba8a07653483d06427d0c07966c5f81c69a7925d714530bedb1ef9e9103547b54ad0954b3569785ca70e1fd08313f92a3a9d31efa216b2b9adac4678455e66c97b53cd589f9da70a14265cf15cd4c1e0ce914407008f4a65f316", "schema": { "type": "string" } }, { "description": "Derivation index of the desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 0, "schema": { "type": "number", "minimum": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Ada address", "example": "addr1qyyxyhaa2e7kxeqcc72w7f747zqlgwwwstlzsg9umuxc40wnhawldxl4nan95rhtlcnju9q2r8j9qz8vslwsmrkj5r4spxhep9" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403AccountIncompatibleXpubBtc" }, { "$ref": "#/components/schemas/Error403AccountAddressGeneral" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Ada deposit address from Extended public key", "tags": ["Cardano"] } }, "/v3/ada/wallet/priv": { "post": { "description": "Support for Cardano is deprecated.
\nYou can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Generates a private key for an address from a mnemonic for a given derivation path index. The private key is generated for the specific index - each mnemonic\ncan generate up to 2^32 private keys starting from index 0 until 2^31 - 1.
\n", "operationId": "AdaGenerateAddressPrivateKey", "deprecated": true, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BlockchainPrivateFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Ada private key", "tags": ["Cardano"] } }, "/v3/ada/block/{hash}": { "get": { "description": "Support for Cardano is deprecated.
You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Gets Ada block detail by block hash or height.
", "operationId": "AdaGetBlock", "deprecated": true, "parameters": [ { "description": "Block hash or height.", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "00000000ca231a439a5c0a86a5a5dd6dc1918a8e897b96522fa9499288e70183" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdaBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "404": { "description": "Block not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404BlockNotExists" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Block by hash or height", "tags": ["Cardano"] } }, "/v3/ada/transaction/{hash}": { "get": { "description": "Support for Cardano is deprecated.
You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Get Ada Transaction detail by transaction hash.
", "operationId": "AdaGetRawTransaction", "deprecated": true, "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "1451692ebbfbea1a2d2ec6fe6782596b6aa2e46c0589d04c406f491b5b46bc6a" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdaTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403TxNotFound" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get transaction by hash", "tags": ["Cardano"] } }, "/v3/ada/transaction/address/{address}": { "get": { "description": "Support for Cardano is deprecated.
You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Gets a Ada transaction by address.
", "operationId": "AdaGetTxByAddress", "deprecated": true, "parameters": [ { "description": "Address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "Ae2tdPwUPEZMmrkRoduJW9w7wRvnTcdeMbw7yyyjwPqo6zuaeJaDEkHUJSz" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain the next page of data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AdaTx" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get transactions by address", "tags": ["Cardano"] } }, "/v3/ada/{address}/utxos": { "get": { "description": "Support for Cardano is deprecated.
You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Gets a Ada UTXOs by address.
", "operationId": "AdaGetUTXOByAddress", "deprecated": true, "parameters": [ { "description": "Address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "Ae2tdPwUPEZMmrkRoduJW9w7wRvnTcdeMbw7yyyjwPqo6zuaeJaDEkHUJSz" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AdaUTXO" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BtcBlockchain" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get UTXOs by address", "tags": ["Cardano"] } }, "/v3/ada/transaction": { "post": { "description": "Support for Cardano is deprecated.
\nYou can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Send Ada to blockchain addresses. It is possible to build a blockchain transaction in 2 ways:\n
Support for Cardano is deprecated.
\nYou can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Broadcasts a signed transaction to the Ada blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum Client Libraries.\nIt is possible to create a custom signing mechanism and only use this method for broadcasting data to the blockchain.
\n", "operationId": "AdaBroadcast", "deprecated": true, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403Broadcast" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Ada transaction", "tags": ["Cardano"] } }, "/v3/ada/account/{address}": { "get": { "description": "Support for Cardano is deprecated.
\nYou can work with Cardano by connecting directly to a blockchain node provided by Tatum.
Gets a Ada account by address.
\n", "operationId": "AdaGetAccount", "deprecated": true, "parameters": [ { "description": "Address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "Ae2tdPwUPEZMmrkRoduJW9w7wRvnTcdeMbw7yyyjwPqo6zuaeJaDEkHUJSz" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AdaAccount" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BtcBlockchain" }, { "$ref": "#/components/schemas/Error403Broadcast" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Gets a Ada account by address", "tags": ["Cardano"] } }, "/v3/tatum/usage": { "get": { "description": "1 credit per API call
\nGet information about your credit consumption for the last month (used credits per day).
\n", "operationId": "getCredits", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Consumption" }, "type": "array" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get information about your credit consumption for the last month", "tags": ["Service utils"] } }, "/v3/tatum/rate/{currency}": { "get": { "description": "Get currenct exchange rate of the supported FIAT / crypto asset. Base pair is EUR by default. E.g. to obtain exchange rate for the Bitcoin,\nresponse value for the API call will be expressed as 1 BTC = 10,000 EUR.
\n", "operationId": "getExchangeRate", "parameters": [ { "description": "FIAT or crypto asset", "in": "path", "name": "currency", "required": true, "schema": { "type": "string", "example": "BTC", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BNB", "BND", "BOB", "BRL", "BSC", "MATIC", "BSD", "BTC", "BTN", "BUSD", "BWP", "BYN", "BYR", "BZD", "CAD", "CAKE", "CDF", "CELO", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGLD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "WBTC", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] } }, { "description": "FIAT to convert as a basePair", "in": "query", "name": "basePair", "schema": { "type": "string", "example": "USD", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeRate" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get currenct exchange rate of the supported FIAT / crypto asset", "tags": ["Exchange rate"] } }, "/v3/tatum/version": { "get": { "description": "Get current version of the API.
", "operationId": "getVersion", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string", "example": "3.0.2" }, "status": { "type": "string", "example": "ACTIVE" }, "testnet": { "type": "boolean", "example": true }, "planName": { "type": "string", "example": "Free" }, "planCode": { "type": "string", "example": "FREE" }, "price": { "type": "number", "example": 9 }, "expiration": { "type": "number", "example": 4113115784397 }, "creditLimit": { "type": "number", "example": 1000000000 }, "usage": { "type": "number", "example": 25656634 }, "rolloverDay": { "type": "number", "example": 4 } } } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get API version", "tags": ["Service utils"] } }, "/v3/tatum/freeze": { "put": { "description": "Freeze the API Key.\nIt's not possible to perform sensitive operations like send ledger transaction, send off-chain transaction, send blockchain transaction,\nbroadcast blockchain transaction, perform Order book trade or create blockage. Only read operations are permitted.
\n", "operationId": "freezeApiKey", "responses": { "204": { "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Freeze API Key", "tags": ["Service utils"] }, "delete": { "description": "Unfreeze the API Key.\nIt's possible to perform sensitive operations like send ledger transaction, send off-chain transaction, send blockchain transaction,\nbroadcast blockchain transaction, perform Order book trade or create blockage again.
\n", "operationId": "unfreezeApiKey", "responses": { "204": { "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server while processing the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Unfreeze API Key", "tags": ["Service utils"] } }, "/v3/custodial/wallet": { "post": { "description": "Create new managed address for a specific chain. If the address is mainnet or testnet one depends on the API Key - testnet API Key manages testnet addresses, mainnet API Key manages mainnet addresses.\nResult of the operation is address and walletId, which is used for identifying the wallet later on and/or exporting the private key if needed.
\nFree users can manage only 10 addresses per API Key.\n
Get all managed addresses for an API Key.
\n", "operationId": "CustodialGetWallets", "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustodialManagedAddress" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get managed addresses", "tags": ["Custodial managed wallets"] } }, "/v3/custodial/wallet/{id}": { "get": { "description": "Get managed address for an API Key. It's possible to export the private key, if query parameter export is set to true.
\n", "operationId": "CustodialGetWallet", "parameters": [ { "in": "path", "required": true, "description": "WalletID of the managed address", "name": "id", "schema": { "type": "string", "format": "uuid", "example": "3ad54647-4166-4d34-9186-fd46caaba945" } }, { "in": "query", "name": "export", "required": false, "description": "If set to, export the private key details in the response", "schema": { "type": "boolean", "default": false, "enum": [true, false] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustodialManagedAddress" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get managed address", "tags": ["Custodial managed wallets"] }, "delete": { "description": "Delete managed address. Once deleted, the address won't be charged in a daily credit usage, but it won't be possible to get the private key for it.
\n", "operationId": "CustodialDeleteWallet", "parameters": [ { "in": "path", "required": true, "description": "WalletID of the managed address", "name": "id", "schema": { "type": "string", "format": "uuid", "example": "3ad54647-4166-4d34-9186-fd46caaba945" } } ], "responses": { "204": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Delete managed address", "tags": ["Custodial managed wallets"] } }, "/v3/custodial/transaction": { "post": { "description": "Sign transaction and transfer assets from a custodial managed address.
\nSupported chains:\n
| Mainnet address | Devnet address | |
| Address | DSpHmb7hLnetoybammcJBJiyqMVR3pDhCuW6hqVg9eBF | DSpHmb7hLnetoybammcJBJiyqMVR3pDhCuW6hqVg9eBF |
\nimport { LAMPORTS_PER_SOL, PublicKey, SystemProgram, Transaction, Connection } from '@solana/web3.js'\n\nconst connection = new Connection('https://api-eu1.tatum.io/v3/blockchain/node/SOL')\nconst from = 'HrJtQTy2RW9c6y41RvN8x3bEiD6Co74AuhER2MGCpa58'\nconst to = 'FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU'\nconst amount = '0.000001'\nconst devnet_fee_payer = '5zPr5331CtBjgVeLedhmJPEpFaUsorLCnb3aCQPsUc9w'\nconst fromPubkey = new PublicKey(from)\nconst transaction = new Transaction({ feePayer: new PublicKey(devnet_fee_payer) })\ntransaction.add(\n SystemProgram.transfer({\n fromPubkey: fromPubkey,\n toPubkey: new PublicKey(to),\n lamports: new BigNumber(amount).multipliedBy(LAMPORTS_PER_SOL).toNumber(),\n }),\n)\nconst { blockhash, lastValidBlockHeight } = await connection.getLatestBlockhash('finalized')\ntransaction.recentBlockhash = blockhash\ntransaction.lastValidBlockHeight = lastValidBlockHeight\ntransaction.partialSign(...signers)\nreturn transaction.serialize({ requireAllSignatures: false }).toString('hex')\n\nFor the above example, developer have 2 options how to sign transaction - if the sender address HrJtQTy2RW9c6y41RvN8x3bEiD6Co74AuhER2MGCpa58 is managed using a Tatum managed wallet with id 0b1eae3d-2520-4903-8bbf-5dec3ad2a5d4,\nthe final payload to the custodial/transaction endpoint should look like this:\n\n{\n \"chain\": \"SOL\",\n \"txData\": \"020001044a22af97a838a504e6f7c0b18d779afcea612da50794cc1dac641861fc1ab14afa5cacaf91c298694e64bb5496916c3c68a32affb92d4bcd2736fbb00169d57bd840de2a454960308f688cd3ee308c1fa01ecfa0b03770aaaf3b52d71d46c31d000000000000000000000000000000000000000000000000000000000000000060d38e0da20dc5900b7e902c918eae6a95e2d90af154b53a422f4ab26b050f4f01030201020c02000000e803000000000000\",\n \"walletIds\": [\n {\n \"key\": \"0b1eae3d-2520-4903-8bbf-5dec3ad2a5d4\",\n \"type\": \"MANAGED\"\n }\n ]\n}\n\nIf the sender address is not managed, the transaction could be signed with the private key of that address before the serialization and the payload will look like this:\n\n{\n \"chain\": \"SOL\",\n \"txData\": \"020001044a22af97a838a504e6f7c0b18d779afcea612da50794cc1dac641861fc1ab14afa5cacaf91c298694e64bb5496916c3c68a32affb92d4bcd2736fbb00169d57bd840de2a454960308f688cd3ee308c1fa01ecfa0b03770aaaf3b52d71d46c31d000000000000000000000000000000000000000000000000000000000000000060d38e0da20dc5900b7e902c918eae6a95e2d90af154b53a422f4ab26b050f4f01030201020c02000000e803000000000000\",\n \"walletIds\": []\n}\n\n\n",
"operationId": "CustodialTransferManagedAddress",
"requestBody": {
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/TransferManagedAddress" } }
}
},
"responses": {
"200": {
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } }
},
"description": "OK"
},
"400": {
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } },
"description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters."
},
"401": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{ "$ref": "#/components/schemas/Error401NotActive" },
{ "$ref": "#/components/schemas/Error401Invalid" }
]
}
}
},
"description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header."
},
"500": {
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } },
"description": "Internal server error. There was an error on the server during the processing of the request."
}
},
"security": [{ "X-API-Key": [] }],
"x-codeSamples": [],
"summary": "Sign and transfer using managed address",
"tags": ["Custodial managed wallets"]
}
},
"/v3/nft/deploy": {
"post": {
"description": "100 credits per API call on Flow
\n2 credits per API call on the other blockchains
Deploy an NFT smart contract on the blockchain. In a deployed NFT smart contract, you can mint NFTs (one NFT at a time or multiple NFTs at once), burn, and transfer NFTs.
\nSmart contracts are standardized and audited.
This API is supported for the following blockchains:
\nBy default, an NFT smart contract is deployed as a general ERC-721 smart contract compatible with OpenSea royalties. This is a standard ERC-721 contract with AccessControl and Ownable, enhanced with NFT batch minting. NFTs minted in this smart contract are compatible with OpenSea and its royalty structure.
\n
In addition to the general ERC-721 contract, you can also deploy the following types of NFT smart contracts for the supported blockchains except for Flow and TRON:
\n
cashback parameter set to true in the request body.provenance parameter set to true in the request body.You can enable public minting for cashback and provenance smart contracts. By default, public minting is disabled, which means that only the blockchain address whose private key was used to create the smart contract or the blockchain addresses added to the smart contract as NFT minters will be able to mint NFTs for the contract. To enable public minting and allow anyone to mint NFTs on top of the smart contract, deploy the contract with the publicMint parameter set to true in the request body.
You can review the code of a deployed NFT smart contract here (if the contract is deployed on Flow) or here (if the contract is deployed on any other supported blockchain).
\nSigning a transaction
\nWhen deploying an NFT smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "NftDeployErc721", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DeployNft" }, { "$ref": "#/components/schemas/DeployNftCelo" }, { "$ref": "#/components/schemas/DeployNftTron" }, { "$ref": "#/components/schemas/DeployNftKMS" }, { "$ref": "#/components/schemas/DeployNftCeloKMS" }, { "$ref": "#/components/schemas/DeployNftTronKMS" }, { "$ref": "#/components/schemas/DeployNftFlowPK" }, { "$ref": "#/components/schemas/DeployNftFlowMnemonic" }, { "$ref": "#/components/schemas/DeployNftFlowKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Deploy an NFT smart contract", "tags": ["NFT (ERC-721 or compatible)"] } }, "/v3/nft/mint": { "post": { "description": "100 credits per API call on Flow
\n2 credits per API call on the other blockchains
You can mint NFTs using either of the following methods:
\n\nNFT Express is Tatum's feature that helps you mint NFTs easier than minting natively on a blockchain.
\nWith NFT Express, you can choose whether to mint NFTs on the pre-built NFT smart contract provided by Tatum or on your own smart contract.
\nIf you want to mint NFTs using the pre-built smart contract, you do not need to deploy your own NFT smart contract. You do not need to provide the address of the NFT smart contract and the token ID in the request body either. The address of the smart contract and the token ID are provided automatically by Tatum.
The token ID is autogenerated. It starts with 0 and is increased by 1 for each new NFT. The token ID is calculated separately for each supported blockchain and its mainnet and testnet.
You can mint NFTs on the pre-built smart contract provided by Tatum on the following blockchains:
\nDepending on what blockchain you use, choose the request body schema to use in the API call.
\nMintNftExpress schema of the request body.MintNftExpressAlgorand schema of the request body.transferNftAlgoExpress schema of the request body).MintNftExpressSolana schema of the request body.to parameter of the request body). This address is returned in the nftAccountAddress parameter in the response body, is owned by the recipient's address, and has the same private key.nftAddress parameter.transferNftSolana or transferNftSolanaKMS schema of the request body). In the request body:\ncontractAddress parameter to the address from the nftAddress parameter in the response body of the minting call.from and to parameters to the recipient's address from the to parameter in the response body of the minting call.If you want to mint NFTs using your own smart contract, you are going to use an NTF minter, a special blockchain address provided by Tatum that will cover the minting fees. The number of credits equivalent to the fees will be then deducted from the monthly credit allowance of your paid pricing plan.
\n
You can mint NFTs on your own smart contract on the following blockchains:
\nTo mint NFTs using your own smart contract, do the following:
\nMintNftMinter schema of the request body.chain is the blockchain that you use.to is the blockchain address where to send the minted NFT to.url is the URL of the NFT metadata.minter is the address of the NFT minter that you found in Step 1.contractAddress is the address of your NFT smart contract.tokenId is the the token ID of the NFT.\n{\n \"chain\": \"CELO\",\n \"to\": \"0x8ce4e40889a13971681391aad29e88efaf91f784\",\n \"url\": \"ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj\",\n \"contractAddress\": \"0x687422eEA2cB73B5d3e242bA5456b782919AFc85\",\n \"tokenId\": \"0123\",\n \"minter\": \"0xBC2eBA680EE50d685cc4Fe65f102AA70AfB27D3F\"\n}\n\nWhen you make an API call with this request body, the private key of the NFT minter will be added to the request body automatically:\n\n{\n \"chain\": \"CELO\",\n \"to\": \"0x8ce4e40889a13971681391aad29e88efaf91f784\",\n \"url\": \"ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj\",\n \"contractAddress\": \"0x687422eEA2cB73B5d3e242bA5456b782919AFc85\",\n \"tokenId\": \"0123\",\n \"minter\": \"0xBC2eBA680EE50d685cc4Fe65f102AA70AfB27D3F\",\n \"fromPrivateKey\": \"0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2\"\n}\n \nThe following table lists the blockchain addresses of the Tatum NFT minters for the testnet and mainnet of the supported blockchains:
\n| Blockchain | \nMinter address - testnet* | \nMinter address - mainnet | \n
|---|---|---|
| BNB Smart Chain | \n0xc16ae5e8c985b906935a0cadf4e24f0400531883 | \n0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94 | \n
| Celo | \n0xBC2eBA680EE50d685cc4Fe65f102AA70AfB27D3F | \n0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94 | \n
| Ethereum | \n0x53e8577C4347C365E4e0DA5B57A589cB6f2AB848 | \n0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94 | \n
| Harmony | \n0x8906f62d40293ddca77fdf6714c3f63265deddf0 | \n0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94 | \n
| Klaytn | \n0x80d8bac9a6901698b3749fe336bbd1385c1f98f2 | \n0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94 | \n
| Polygon | \n0x542b9ac4945a3836fd12ad98acbc76a0c8b743f5 | \n0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94 | \n
*If a minter blockchain address on the testnet does not have sufficient funds to cover the transaction fee, add some amount to it using a crypto faucet of the blockchain.
\nWhen minting an NFT natively on a blockchain, 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.
\nProviding 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.
\nFor 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.
\nYou can mint NFTs natively on the following blockchains:
\nDepending on what blockchain you use, choose the request body schema to use in the API call.
\nMintNftAlgorand schema of the request body.MintNftAlgorandKMS schema of the request body.MintNft schema of the request body.MintNftKMS schema of the request body.MintNftCelo schema of the request body.MintNftKMSCelo schema of the request body.MintNftFlowPK schema of the request body.MintNftFlowMnemonic schema of the request body.MintNftFlowKMS schema of the request body.MintNftSolana schema of the request body.MintNftSolanaKMS schema of the request body.MintNftTron schema of the request body.MintNftKMSTron schema of the request body.100 credits per API call on Flow
\n2 credits per API call on the other blockchains
Transfer an NFT from the smart contract (the contractAddress parameter in the request body) to the specified blockchain address (the to parameter in the request body).
In one API call, you can transfer only one NFT.
\nThis API is supported for the following blockchains:
\nFor Ethereum, Celo, and BNB Smart Chain, transferring NFTs invokes the safeTransfer() method.
Transferring NFTs on Algorand
\ntransferNftAlgoExpress schema of the request body.Transferring NFTs on Solana
\nIf you want to transfer an NFT that was minted using NFT Express, see the section about minting NFTs on Solana using the pre-built NFT smart contract provided by Tatum for the information about how to set up the parameters in the request body.
\nSigning a transaction
\nWhen transferring an NFT, 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.
\nProviding 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.
\nFor 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.
\nNOTE: This does not apply to transferring NFTs that were minted on Algorand using NFT Express (see earlier in this section).
\n", "operationId": "NftTransferErc721", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferNft" }, { "$ref": "#/components/schemas/TransferNftCelo" }, { "$ref": "#/components/schemas/TransferNftTron" }, { "$ref": "#/components/schemas/TransferNftSolana" }, { "$ref": "#/components/schemas/TransferNftAlgo" }, { "$ref": "#/components/schemas/TransferNftAlgoExpress" }, { "$ref": "#/components/schemas/TransferNftFlowPK" }, { "$ref": "#/components/schemas/TransferNftFlowMnemonic" }, { "$ref": "#/components/schemas/TransferNftKMS" }, { "$ref": "#/components/schemas/TransferNftKMSCelo" }, { "$ref": "#/components/schemas/TransferNftAlgoKMS" }, { "$ref": "#/components/schemas/TransferNftSolanaKMS" }, { "$ref": "#/components/schemas/TransferNftFlowKMS" }, { "$ref": "#/components/schemas/TransferNftKMSTron" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Transfer an NFT", "tags": ["NFT (ERC-721 or compatible)"] } }, "/v3/nft/mint/batch": { "post": { "description": "100 credits per API call on Flow
\n2 credits per API call on the other blockchains
Create multiple NFT Tokens and transfer them to destination account. Create and transfer any NFT tokens from smart contract defined in contractAddress.
\nThis API is supported for the following blockchains:
\n{\n \"to\": [\"0x80d8bac9a6901698b3749fe336bbd1385c1f98f2\"],\n \"url\": [\"ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj\"],\n \"tokenId\": [\"9876541124516\"],\n \"contractAddress\":\"0xcd2ada00c48a27faa5cc67f9a1ed55b89ddf7f77\",\n \"minter\": \"0x542b9ac4945a3836fd12ad98acbc76a0c8b743f5\",\n \"chain\": \"MATIC\"\n}\nThe blockchain fee of the performed transaction is paid from the address connected with built-in private key and is debitted in form of credits. The credits are debitted only if NFT mint requests are performed with paid API key plan.\nWe transform fee to the credits in accordance to the rates provided by the Tatum.\nIf you want to batch mint on ERC-721 contract which is not deployed via Tatum API, your smart contract must contain this method:\nmintMultiple(address[] to, uint256[] tokenId, string[] uri): boolean\nYou can use addresses specified in the bellow table to be used as a minter.\n
| Chain | \nTestnet address | \nMainnet Address | \n
|---|---|---|
| MATIC | \n0x542b9ac4945a3836fd12ad98acbc76a0c8b743f5 | \n0xcf9e127455d28e7362380aec1b92ddee8200b295 | \n
| BSC | \n0xc16ae5e8c985b906935a0cadf4e24f0400531883 | \n0xcf9e127455d28e7362380aec1b92ddee8200b295 | \n
| ONE | \n0x8906f62d40293ddca77fdf6714c3f63265deddf0 | \n0xcf9e127455d28e7362380aec1b92ddee8200b295 | \n
| ETH | \n0x53e8577C4347C365E4e0DA5B57A589cB6f2AB848 | \n0xcf9e127455d28e7362380aec1b92ddee8200b295 | \n
| CELO | \n0xBC2eBA680EE50d685cc4Fe65f102AA70AfB27D3F | \n0xcf9e127455d28e7362380aec1b92ddee8200b295 | \n
| KLAY | \n0x80d8bac9a6901698b3749fe336bbd1385c1f98f2 | \n0xcf9e127455d28e7362380aec1b92ddee8200b295 | \n
100 credits per API call on Flow
\n2 credits per API call on the other blockchains
Burn one NFT Token. This method destroys any NFT token from smart contract defined in contractAddress.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen burning an NFT, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "NftBurnErc721", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BurnNft" }, { "$ref": "#/components/schemas/BurnNftCelo" }, { "$ref": "#/components/schemas/BurnNftKMSCelo" }, { "$ref": "#/components/schemas/BurnNftTron" }, { "$ref": "#/components/schemas/BurnNftKMSTron" }, { "$ref": "#/components/schemas/BurnNftKMS" }, { "$ref": "#/components/schemas/BurnNftFlowPK" }, { "$ref": "#/components/schemas/BurnNftFlowMnemonic" }, { "$ref": "#/components/schemas/BurnNftFlowKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Burn an NFT", "tags": ["NFT (ERC-721 or compatible)"] } }, "/v3/nft/mint/add": { "post": { "description": "2 credits per API call
\nAdd new minter of NFT Tokens. This method adds minter permission to new minter address.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen adding an NFT minter, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "NftAddMinter", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AddNftMinter" }, { "$ref": "#/components/schemas/AddNftMinterKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Add an NFT minter", "tags": ["NFT (ERC-721 or compatible)"] } }, "/v3/nft/verify": { "post": { "description": "2 credits per API call
\nVerify an NFT in an NFT collection on Solana. Verifying an NFT sets the Verified parameter to true for the NFT, which means that the NFT is really a part of the collection. To know more about Solana collections and verification, refer to the Solana user documentation.
The collection must be a sized collection that was introduced in Version 1.3 of the Metaplex Token Metadata program. The NFT must have been minted in this collection.
\nThis API is supported only for Solana.
\nSigning a transaction
\nWhen verifying an NFT, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "NftVerifyInCollection", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/VerifySolanaNFT" }, { "$ref": "#/components/schemas/VerifySolanaNFTKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Verify an NFT in an NFT collection on Solana", "tags": ["NFT (ERC-721 or compatible)"] } }, "/v3/nft/royalty": { "put": { "description": "2 credits per API call
\nUpdate royalty cashback value for one NFT Token. This method updates the first royalty value of specific author for 1 token.\nIf royalty value is set to 0, it will disable the royalty system for the token. Only from author's address of the royalty can change it's royalty value, not the owner of the token.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen updating NFT royalty, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "NftUpdateCashbackErc721", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UpdateCashbackValueForAuthorNft" }, { "$ref": "#/components/schemas/UpdateCashbackValueForAuthorNftCelo" }, { "$ref": "#/components/schemas/UpdateCashbackValueForAuthorNftTron" }, { "$ref": "#/components/schemas/UpdateCashbackValueForAuthorNftKMS" }, { "$ref": "#/components/schemas/UpdateCashbackValueForAuthorNftKMSCelo" }, { "$ref": "#/components/schemas/UpdateCashbackValueForAuthorNftKMSTron" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Update NFT royalty", "tags": ["NFT (ERC-721 or compatible)"] } }, "/v3/nft/transaction/{chain}/{address}/{tokenAddress}": { "get": { "description": "1 credit per API call
\nGet incoming and outgoing NFT transactions on a blockchain address.
\nThis API is supported for the following blockchains:
\n1 credit per API call
Get NFT transactions by token. This includes incoming and outgoing transactions for the token.
This API is supported for the following blockchains:
1 credit per API call
\nGet NFT transaction by transaction hash.
\nThis API is supported for the following blockchains:
\n1 credit per API call + 5 credits for each owned NFT
\nGet all NFTs that a blockchain address holds. The NFTs are returned grouped by the smart contracts they were minted on.
\nThis API is supported for the following blockchains:
\nOn Solana and Algorand, if a blockchain address holds fewer than 50 NFTs, the API also returns each NFT's metadata. If the metadata is not returned, you can obtain it using the API for getting NFT metadata.
\n", "operationId": "NftGetTokensByAddressErc721", "parameters": [ { "description": "Blockchain to work with", "in": "path", "name": "chain", "required": true, "schema": { "type": "string", "example": "SOL", "enum": ["ALGO", "CELO", "ETH", "MATIC", "SOL"] } }, { "description": "The blockchain address that you want to get the token balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": ["contractAddress", "balances"], "properties": { "contractAddress": { "type": "string", "example": "43821281", "description": "The address of the NFT smart contract; for Algorand, this is the asset ID" }, "balances": { "type": "array", "items": { "type": "string", "description": "The number of NFTs; on Algorand, it is either 1 or 0; on EVM-based blockchains chains like Celo or Polygon, this is the NFT IDs", "example": "1" } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "tokenId": { "description": "The ID of the NFT owned by this address; valid for EVM-based blockchains only", "example": "1", "type": "string" }, "url": { "description": "The URL pointing to the NFT metadata; the URL may not be present, and if it is not returned, you can get it by calling the NFT Contract.tokenURI() method", "example": "ipfs://QmXFpaS3S7CkLZvihLFA9JbawKdqhjg8dJeDkPntmkD2Pc", "type": "string" }, "metadata": { "type": "object", "description": "The metadata scheme obtained from the metadata URL; the scheme may not be present, and if it is not returned, you can get it using the NFT metadata API", "example": { "name": "Example NFT name", "description": "Example NFT description", "image": "ipfs://QmP4R7ACZ7JRQ6sLdmnPHqjWEXxzdnPvhAV2f6RnQ8uxJ6" } } } } } } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get all NFTs that a blockchain address holds", "tags": ["NFT (ERC-721 or compatible)"] } }, "/v3/nft/collection/{chain}/{address}": { "get": { "description": "1 credit per API call + 5 credits for each listed NFT
\nGet all minted NFTs in the collection. Returns all NFTs this contract minted.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet the NFTs minted on a specific smart contract (the contractAddress path parameter in the request endpoint URL) that a blockchain address holds.
NOTE: This API works only for the NFT smart contracts deployed using the Tatum smart contract API.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet NFT token provenance data, valid only for provenance contract.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet NFT token metadata.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet NFT token royalty.
\nThis API is supported for the following blockchains:
\nThis endpoint is deprecated. Do not use it.
\nInstead, use this API.
1 credit per API call
\nGet NFT contract address from deploy transaction.
\nThis API is supported for the following blockchains:
\n2 credits per API call
\nDeploy a fungible token smart contract on the blockchain. In a deployed smart contract, you can mint and burn fungible tokens. The whole supply of fungible tokens (the supply parameter in the request body) will be transferred to the specified blockchain address (the address parameter in the request body).
\nSmart contracts are standardized and audited.
This API is supported for the following blockchains:
\nYou can review the code of a deployed smart contract here.
\nSigning a transaction
\nWhen deploying a fungible token smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "Erc20Deploy", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChainDeployErc20" }, { "$ref": "#/components/schemas/ChainDeploySolanaSpl" }, { "$ref": "#/components/schemas/ChainDeployCeloErc20" }, { "$ref": "#/components/schemas/ChainDeployKcsErc20" }, { "$ref": "#/components/schemas/ChainDeployErc20KMS" }, { "$ref": "#/components/schemas/ChainDeploySolanaSplKMS" }, { "$ref": "#/components/schemas/ChainDeployCeloErc20KMS" }, { "$ref": "#/components/schemas/ChainDeployKcsErc20KMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Deploy a fungible token smart contract", "tags": ["Fungible Tokens (ERC-20 or compatible)"] } }, "/v3/blockchain/token/mint": { "post": { "description": "2 credits per API call
\nCreate new fungible tokens in the smart contract (the contractAddress parameter in the request body) and transfer them to the specified blockchain address (the to parameter in the request body). You can mint new fungible tokens only if the current supply of tokens in the smart contract is lower than the total supply set for this contract.
This API is supported for the following blockchains:
\nSigning a transaction
\nWhen minting fungible 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.
\nProviding 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.
\nFor 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.
\n", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "operationId": "Erc20Mint", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChainMintErc20" }, { "$ref": "#/components/schemas/ChainMintErc20KMS" }, { "$ref": "#/components/schemas/ChainMintKcsErc20" }, { "$ref": "#/components/schemas/ChainMintKcsErc20KMS" }, { "$ref": "#/components/schemas/ChainMintCeloErc20" }, { "$ref": "#/components/schemas/ChainMintCeloErc20KMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Mint fungible tokens", "tags": ["Fungible Tokens (ERC-20 or compatible)"] } }, "/v3/blockchain/token/burn": { "post": { "description": "2 credits per API call
\nBurn fungible tokens. Burning fungible tokens deletes the specified supply of the tokens (the amount parameter in the request body) from the smart contract (the contractAddress parameter in the request body).
This API is supported for the following blockchains:
\nSigning a transaction
\nWhen burning fungible 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.
\nProviding 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.
\nFor 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.
\n", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "operationId": "Erc20Burn", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChainBurnErc20" }, { "$ref": "#/components/schemas/ChainBurnErc20KMS" }, { "$ref": "#/components/schemas/ChainBurnKcsErc20" }, { "$ref": "#/components/schemas/ChainBurnKcsErc20KMS" }, { "$ref": "#/components/schemas/ChainBurnCeloErc20" }, { "$ref": "#/components/schemas/ChainBurnCeloErc20KMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Burn fungible tokens", "tags": ["Fungible Tokens (ERC-20 or compatible)"] } }, "/v3/blockchain/token/approve": { "post": { "description": "2 credits per API call
\nAllow another blockchain address (the spender parameter in the request body) to spend and burn fungible tokens on behalf of the smart contract owner.
This API is supported for the following blockchains:
\nSigning a transaction
\nWhen approving spending of fungible 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.
\nProviding 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.
\nFor 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.
\n", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "operationId": "Erc20Approve", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ApproveErc20" }, { "$ref": "#/components/schemas/ApproveErc20KMS" }, { "$ref": "#/components/schemas/ApproveCeloErc20" }, { "$ref": "#/components/schemas/ApproveCeloErc20KMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Approve spending of fungible tokens", "tags": ["Fungible Tokens (ERC-20 or compatible)"] } }, "/v3/blockchain/token/transaction": { "post": { "description": "2 credits per API call
\nTransfer a supply of fungible tokens existing in the smart contract (the contractAddress parameter in the request body) to the specified blockchain address (the to parameter in the request body).
\nTransferring fungible tokens invokes the transfer() method.
This API is supported for the following blockchains:
\nTransferring fungible tokens on Algorand
\nOn Algorand, the recipient has to agree in advance to receive your fungible tokens because Algorand charges users for storing the tokens on their addresses, and an Algorand blockchain address by default does not receive the tokens unless explicitly agreed. Before transferring the fungible tokens, make sure that the recipient has agreed to receive the NFT to their address.
\nSigning a transaction
\nWhen transferring fungible 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.
\nProviding 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.
\nFor 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.
\n", "parameters": [ { "description": "Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations for testnet API Key. For mainnet API Key, this value is ignored.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "operationId": "Erc20Transfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChainTransferEthErc20" }, { "$ref": "#/components/schemas/ChainTransferSolanaSpl" }, { "$ref": "#/components/schemas/ChainTransferBscBep20" }, { "$ref": "#/components/schemas/ChainTransferCeloErc20Token" }, { "$ref": "#/components/schemas/ChainTransferAlgoErc20" }, { "$ref": "#/components/schemas/ChainTransferKcsEthErc20" }, { "$ref": "#/components/schemas/ChainTransferEthErc20KMS" }, { "$ref": "#/components/schemas/ChainTransferSolanaSplKMS" }, { "$ref": "#/components/schemas/ChainTransferBscBep20KMS" }, { "$ref": "#/components/schemas/ChainTransferCeloErc20TokenKMS" }, { "$ref": "#/components/schemas/ChainTransferAlgoErc20KMS" }, { "$ref": "#/components/schemas/ChainTransferKcsEthErc20KMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Transfer fungible tokens", "tags": ["Fungible Tokens (ERC-20 or compatible)"] } }, "/v3/blockchain/token/transaction/{chain}/{address}/{tokenAddress}": { "get": { "description": "1 credit per API call
\nGet incoming and outgoing transactions related to fungible tokens on a blockchain address.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet the number of the fungible tokens minted on a specific smart contract (the contractAddress path parameter in the request endpoint URL) that a blockchain address holds.
This API is supported for the following blockchains:
\n1 credit per API call
\nGet the number of fungible tokens that a blockchain address holds across a blockchain. The tokens are returned grouped by the smart contracts they were minted on.
\nThis API is supported for the following blockchains:
\n2 credits per API call
\nDeploy Multi Token Smart Contract. This method creates new ERC1155 Smart Contract (Multi Tokens) on the blockchain. Smart contract is standardized and audited.\nIt is possible to mint, burn and transfer tokens. It is also possible to mint multiple tokens at once.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen deploying a Multi Token smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "DeployMultiToken", "parameters": [ { "description": "Type of testnet. Defaults to Sepolia. Valid only for ETH invocations.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DeployMultiToken" }, { "$ref": "#/components/schemas/DeployMultiTokenKMS" }, { "$ref": "#/components/schemas/DeployMultiTokenCelo" }, { "$ref": "#/components/schemas/DeployMultiTokenCeloKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Deploy a Multi Token smart contract", "tags": ["Multi Tokens (ERC-1155 or compatible)"] } }, "/v3/multitoken/mint": { "post": { "description": "2 credits per API call
\nMint a fixed amount of Multi Token and transfer it to destination account. Create and transfer any Multi Token token from smart contract defined in contractAddress. It is possible to add Metadata to the created token with a more detailed information about instead.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen minting a Multi Token, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "MintMultiToken", "parameters": [ { "description": "Type of testnet. Defaults to Sepolia. Valid only for ETH invocations.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MintMultiToken" }, { "$ref": "#/components/schemas/MintMultiTokenKMS" }, { "$ref": "#/components/schemas/MintMultiTokenCelo" }, { "$ref": "#/components/schemas/MintMultiTokenKMSCelo" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Mint a Multi Token", "tags": ["Multi Tokens (ERC-1155 or compatible)"] } }, "/v3/multitoken/mint/batch": { "post": { "description": "2 credits per API call
\nCreate a fixed amount of multiple Multi Tokens Tokens and transfer them to destination account in one transaction. Create and transfer Multi Tokens tokens from smart contract defined in contractAddress.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen minting multiple Multi 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "MintMultiTokenBatch", "parameters": [ { "description": "Type of testnet. Defaults to Sepolia. Valid only for ETH invocations.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MintMultiTokenBatch" }, { "$ref": "#/components/schemas/MintMultiTokenBatchKMS" }, { "$ref": "#/components/schemas/MintMultiTokenBatchCelo" }, { "$ref": "#/components/schemas/MintMultiTokenBatchKMSCelo" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Mint multiple Multi Tokens", "tags": ["Multi Tokens (ERC-1155 or compatible)"] } }, "/v3/multitoken/burn": { "post": { "description": "2 credits per API call
\nBurn a fixed amount of Multi Tokens by id. This method destroys Multi Tokens from smart contract defined in contractAddress.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen burning a Multi Token, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "BurnMultiToken", "parameters": [ { "description": "Type of testnet. Defaults to Sepolia. Valid only for ETH invocations.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BurnMultiToken" }, { "$ref": "#/components/schemas/BurnMultiTokenKMS" }, { "$ref": "#/components/schemas/BurnMultiTokenCelo" }, { "$ref": "#/components/schemas/BurnMultiTokenKMSCelo" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Burn a Multi Token", "tags": ["Multi Tokens (ERC-1155 or compatible)"] } }, "/v3/multitoken/burn/batch": { "post": { "description": "2 credits per API call
\nBurn multiple Multi Token Tokens by id assigned to same address in one transaction. This method destroys any Multi Tokens token from smart contract defined in contractAddress.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen burning multiple Multi 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "BurnMultiTokenBatch", "parameters": [ { "description": "Type of testnet. Defaults to Sepolia. Valid only for ETH invocations.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BurnMultiTokenBatch" }, { "$ref": "#/components/schemas/BurnMultiTokenBatchKMS" }, { "$ref": "#/components/schemas/BurnMultiTokenBatchCelo" }, { "$ref": "#/components/schemas/BurnMultiTokenBatchKMSCelo" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Burn multiple Multi Tokens", "tags": ["Multi Tokens (ERC-1155 or compatible)"] } }, "/v3/multitoken/transaction": { "post": { "description": "2 credits per API call
\nTransfer a certain amount of Multi Token from account to another account. Transfer Multi Tokens token from smart contract defined in contractAddress.
\nOnly 1 specific token with specified tokenId and value can be transferred. This method invokes ERC1155 method safeTransfer() to transfer the token in case of ETH, Celo and blockchains.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen transferring a Multi Token, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "TransferMultiToken", "parameters": [ { "description": "Type of testnet. Defaults to Sepolia. Valid only for ETH invocations.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferMultiToken" }, { "$ref": "#/components/schemas/TransferMultiTokenCelo" }, { "$ref": "#/components/schemas/TransferMultiTokenKMS" }, { "$ref": "#/components/schemas/TransferMultiTokenKMSCelo" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Transfer a Multi Token", "tags": ["Multi Tokens (ERC-1155 or compatible)"] } }, "/v3/multitoken/transaction/batch": { "post": { "description": "2 credits per API call
\nTransfer Multi Token Batch from account to various other accounts in one transaction. Transfer multiple Multi Tokens token from smart contract defined in contractAddress.
\nMultiple token with specified tokenIds and values can be transferred. This method invokes ERC1155 method safeTransfer() to transfer the token in case of ETH, Celo and BSC.\n
This API is supported for the following blockchains:
\nSigning a transaction
\nWhen transferring multiple Multi 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "TransferMultiTokenBatch", "parameters": [ { "description": "Type of testnet. Defaults to Sepolia. Valid only for ETH invocations.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferMultiTokenBatch" }, { "$ref": "#/components/schemas/TransferMultiTokenBatchKMS" }, { "$ref": "#/components/schemas/TransferMultiTokenBatchCelo" }, { "$ref": "#/components/schemas/TransferMultiTokenBatchKMSCelo" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Transfer multiple Multi Tokens", "tags": ["Multi Tokens (ERC-1155 or compatible)"] } }, "/v3/multitoken/mint/add": { "post": { "description": "2 credits per API call
\nAdd Multi Token minter.
\nThis API is supported for the following blockchains:
\nSigning a transaction
\nWhen adding a Multi Token minter, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "AddMultiTokenMinter", "parameters": [ { "description": "Type of testnet. Defaults to Sepolia. Valid only for ETH invocations.", "in": "header", "name": "x-testnet-type", "required": false, "schema": { "default": "ethereum-sepolia", "type": "string", "enum": ["ethereum-sepolia"] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AddMultiTokenMinter" }, { "$ref": "#/components/schemas/AddMultiTokenMinterKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Add a Multi Token minter", "tags": ["Multi Tokens (ERC-1155 or compatible)"] } }, "/v3/multitoken/transaction/{chain}/{address}/{tokenAddress}": { "get": { "description": "1 credit per API call
\nGet incoming and outgoing Multi Token transactions on a blockchain address.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet Multi Token transaction by transaction hash.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet all Multi Tokens that a blockchain address holds. The Multi Tokens are returned grouped by the smart contracts they were minted on.
\nThis API is supported for the following blockchains:
\n1 credit per API call
\nGet the amount of a specific Multi Token (minted on the smart contract specified by the contractAddress path parameter in the request endpoint URL) that a blockchain address holds.
This API is supported for the following blockchains:
\n1 credit per API call
\nFor multiple blockchain addresses, get the amount of one or multiple Multi Tokens (minted on the smart contract specified by the contractAddress path parameter in the request endpoint URL) that those addresses hold.
This API is supported for the following blockchains:
\n1 credit per API call
\nGet Multi Token metadata.
\nThis API is supported for the following blockchains:
\nThis endpoint is deprecated. Do not use it.
\nInstead, use this API.
1 credit per API call
\nGet Multi Token contract address from deploy transaction.
\nThis API is supported for the following blockchains:
\nGenerate Solana private key and account address.
\n", "operationId": "SolanaGenerateWallet", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "description": "Generated account address.", "example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ", "type": "string" }, "privateKey": { "description": "Generated private key for account.", "example": "zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv", "type": "string" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Solana wallet", "tags": ["Solana"] } }, "/v3/solana/web3/{xApiKey}": { "post": { "deprecated": true, "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based JSON RPC driver to connect directly to the Solana node provided by Tatum.\nTo learn more about Solana JSON RPC, visit the Solana developer's guide.
\n", "operationId": "SolanaWeb3Driver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid JSON RPC method content body.", "example": { "jsonrpc": "2.0", "method": "getVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid JSON RPC response.", "example": { "jsonrpc": "2.0", "result": { "solana-core": "1.8.5" }, "id": 1 } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "JSON RPC HTTP driver", "tags": ["Solana"] } }, "/v3/solana/block/current": { "get": { "description": "Get Solana current block number. This is the number of the latest block in the blockchain.
", "operationId": "SolanaGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 6491272 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["Solana"] } }, "/v3/solana/block/{height}": { "get": { "description": "Get Solana block by block hash or block number.
\nYou can find full data description here - https://docs.solana.com/developing/clients/jsonrpc-api#getblock\n
Get Solana account balance in SOL. This method does not prints any balance of the SPL or NFT tokens on the account.
", "operationId": "SolanaGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in SOL", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Solana Account balance", "tags": ["Solana"] } }, "/v3/solana/transaction/{hash}": { "get": { "description": "Get Solana transaction by transaction hash.
\nYou can find full data description here - https://docs.solana.com/developing/clients/jsonrpc-api#gettransaction\n
Send SOL from account to account.
\nThis 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.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
Broadcast signed custom transactions to Solana blockchain and waits for transaction confirmation depending on the commitment given. More information about commitment levels here
\n", "operationId": "SolanaBroadcastConfirm", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SolanaBroadcastConfirm" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SolanaTransactionHashWithConfirm" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403SolanaBroadcastConfirm" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast and confirm signed Solana transaction", "tags": ["Solana"] } }, "/v3/bsc/wallet": { "get": { "description": "1 credit per API call
\nTatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for BSC wallet with derivation path m'/44'/60'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible BSC wallet.
\n", "operationId": "BscGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate BSC wallet", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/address/{xpub}/{index}": { "get": { "description": "1 credit per API call
\nGenerate BSC account deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31.
\n", "operationId": "BscGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "schema": { "type": "string", "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 1, "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "BSC address", "example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate BSC account address from Extended public key", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/wallet/priv": { "post": { "description": "1 credit per API call
\nGenerate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^31 private keys starting from index 0 until 2^31.
\n", "operationId": "BscGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate BSC private key", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/web3/{xApiKey}": { "post": { "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based web3 driver to connect directly to the BSC node provided by Tatum.\nTo learn more about BSC Web3, visit the BSC developer's guide.
\n", "operationId": "BscWeb3Driver", "deprecated": true, "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 method content body.", "example": { "jsonrpc": "2.0", "method": "web3_clientVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 response.", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "Web3 HTTP driver", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/block/current": { "get": { "description": "1 credit per API call
\nGet BSC current block number. This is the number of the latest block in the blockchain.
\n", "operationId": "BscGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 6491272 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/block/{hash}": { "get": { "description": "1 credit per API call
\nGet BSC block by block hash or block number.
\n", "operationId": "BscGetBlock", "parameters": [ { "description": "Block hash or block number", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "6470657" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get BSC block by hash", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/account/balance/{address}": { "get": { "description": "1 credit per API call
\nGet BSC account balance in BNB. This method does not prints any balance of the BEP20 or BEP721 tokens on the account.
\n", "operationId": "BscGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in BNB", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get BSC Account balance", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/transaction/{hash}": { "get": { "description": "2 credits per API call
\nGet BSC transaction by transaction hash.
\n", "operationId": "BscGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BscTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get BSC Transaction", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/transaction/count/{address}": { "get": { "description": "1 credit per API call
\nGet a number of outgoing BSC transactions for the address. When a transaction is sent, there can be multiple outgoing transactions,\nwhich are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents\nthe order of the transaction in the list of outgoing transactions.
\n", "operationId": "BscGetTransactionCount", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 42, "minLength": 42, "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 5, "description": "Number of transactions, that were made from this address. Can be used as a nonce parameter in send transaction calls." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing BSC transactions", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/transaction": { "post": { "description": "2 credits per API call
\nSend BNB or Tatum supported BEP20 token from account to account.
\n
Signing a transaction
\nWhen sending BNB, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "BscBlockchainTransfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferBscBlockchain" }, { "$ref": "#/components/schemas/TransferBscBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BscBroadcast" }, { "$ref": "#/components/schemas/Error403BscGasPrice" }, { "$ref": "#/components/schemas/Error403BscTxBody" }, { "$ref": "#/components/schemas/Error403BscGasCalculation" }, { "$ref": "#/components/schemas/Error403BscTxHash" }, { "$ref": "#/components/schemas/Error403BscTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send BSC / BEP20 from account to account", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/smartcontract": { "post": { "description": "2 credits per API call
\nInvoke a method in an existing smart contract on BNB Smart Chain.
\nYou can call a read-only or write method.
\nSigning a transaction
\nWhen invoking a method in a smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "BscBlockchainSmartContractInvocation", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CallBscSmartContractReadMethod" }, { "$ref": "#/components/schemas/CallBscSmartContractMethod" }, { "$ref": "#/components/schemas/CallBscSmartContractMethodKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" }, { "$ref": "#/components/schemas/Data" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403BscBroadcast" }, { "$ref": "#/components/schemas/Error403BscGasPrice" }, { "$ref": "#/components/schemas/Error403BscScBody" }, { "$ref": "#/components/schemas/Error403BscGasCalculation" }, { "$ref": "#/components/schemas/Error403BscTxHash" }, { "$ref": "#/components/schemas/Error403BscTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Invoke a method in a smart contract on BNB Smart Chain", "tags": ["BNB Smart Chain"] } }, "/v3/bsc/broadcast": { "post": { "description": "2 credits per API call
\nBroadcast signed transaction to BSC blockchain. This method is used internally from Tatum KMS or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "BscBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BscBroadcast" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed BSC transaction", "tags": ["BNB Smart Chain"] } }, "/v3/polygon/wallet": { "get": { "description": "1 credit per API call
\nTatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Polygon wallet with derivation path m'/44'/966'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Polygon wallet.
\n", "operationId": "PolygonGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Polygon wallet", "tags": ["Polygon"] } }, "/v3/polygon/address/{xpub}/{index}": { "get": { "description": "1 credit per API call
\nGenerate Polygon account deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31.
\n", "operationId": "PolygonGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "schema": { "type": "string", "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 1, "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Polygon address", "example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Polygon account address from Extended public key", "tags": ["Polygon"] } }, "/v3/polygon/wallet/priv": { "post": { "description": "1 credit per API call
\nGenerate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^31 private keys starting from index 0 until 2^31.
\n", "operationId": "PolygonGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Polygon private key", "tags": ["Polygon"] } }, "/v3/polygon/web3/{xApiKey}": { "post": { "deprecated": true, "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based web3 driver to connect directly to the Polygon node provided by Tatum.\nTo learn more about Polygon Web3, visit the Polygon developer's guide.
\n", "operationId": "PolygonWeb3Driver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 method content body.", "example": { "jsonrpc": "2.0", "method": "web3_clientVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 response.", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "Web3 HTTP driver", "tags": ["Polygon"] } }, "/v3/polygon/block/current": { "get": { "description": "1 credit per API call
\nGet Polygon current block number. This is the number of the latest block in the blockchain.
\n", "operationId": "PolygonGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 6491272 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["Polygon"] } }, "/v3/polygon/block/{hash}": { "get": { "description": "1 credit per API call
\nGet Polygon block by block hash or block number.
\n", "operationId": "PolygonGetBlock", "parameters": [ { "description": "Block hash or block number", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "6470657" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Polygon block by hash", "tags": ["Polygon"] } }, "/v3/polygon/account/balance/{address}": { "get": { "description": "1 credit per API call
\nGet Polygon account balance in MATIC. This method does not prints any balance of the ERC20 or ERC721 tokens on the account.
\n", "operationId": "PolygonGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in MATIC", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Polygon Account balance", "tags": ["Polygon"] } }, "/v3/polygon/transaction/{hash}": { "get": { "description": "2 credits per API call
\nGet Polygon transaction by transaction hash.
\n", "operationId": "PolygonGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolygonTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Polygon Transaction", "tags": ["Polygon"] } }, "/v3/polygon/account/transaction/{address}": { "get": { "description": "1 credit per API call
\nGet Polygon transactions by address. This includes incoming and outgoing transactions for the address.
\n", "operationId": "PolygonGetTransactionByAddress", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x8ce4e40889a13971681391aad29e88efaf91f784" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Transactions from this block onwords will be included.", "in": "query", "name": "from", "schema": { "type": "number", "minimum": 0, "example": 1087623 } }, { "description": "Transactions up to this block will be included.", "in": "query", "name": "to", "schema": { "type": "number", "minimum": 0, "example": 1087823 } }, { "description": "Sorting of the data. ASC - oldest first, DESC - newest first.", "in": "query", "name": "sort", "schema": { "type": "string", "default": "DESC", "example": "ASC", "enum": ["ASC", "DESC"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PolygonTx" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Polygon transactions by address", "tags": ["Polygon"] } }, "/v3/polygon/transaction/count/{address}": { "get": { "description": "1 credit per API call
\nGet a number of outgoing Polygon transactions for the address. When a transaction is sent, there can be multiple outgoing transactions,\nwhich are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents\nthe order of the transaction in the list of outgoing transactions.
\n", "operationId": "PolygonGetTransactionCount", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 42, "minLength": 42, "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 5, "description": "Number of transactions, that were made from this address. Can be used as a nonce parameter in send transaction calls." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing Polygon transactions", "tags": ["Polygon"] } }, "/v3/polygon/transaction": { "post": { "description": "2 credits per API call
\nSend MATIC from account to account.
\n
Signing a transaction
\nWhen sending MATIC, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "PolygonBlockchainTransfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferPolygonBlockchain" }, { "$ref": "#/components/schemas/TransferPolygonBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403PolygonBroadcast" }, { "$ref": "#/components/schemas/Error403PolygonGasPrice" }, { "$ref": "#/components/schemas/Error403PolygonTxBody" }, { "$ref": "#/components/schemas/Error403PolygonGasCalculation" }, { "$ref": "#/components/schemas/Error403PolygonTxHash" }, { "$ref": "#/components/schemas/Error403PolygonTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send MATIC from account to account", "tags": ["Polygon"] } }, "/v3/polygon/smartcontract": { "post": { "description": "2 credits per API call
\nInvoke a method in an existing smart contract on Polygon.
\nYou can call a read-only or write method.
\nSigning a transaction
\nWhen invoking a method in a smart contract, 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.
\nIf caller field is present instead of the private key, Tatum will sign the transaction with the managed private key connected to the caller address. This is applicable only for paid mainnet plans and all testnet plans. Keep in mind that the caller address must have enough access right to perform the action in the smart contract method.
\nProviding 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.
\nFor 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.
\n", "operationId": "PolygonBlockchainSmartContractInvocation", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CallPolygonSmartContractReadMethod" }, { "$ref": "#/components/schemas/CallPolygonSmartContractMethod" }, { "$ref": "#/components/schemas/CallPolygonSmartContractMethodCaller" }, { "$ref": "#/components/schemas/CallPolygonSmartContractMethodKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" }, { "$ref": "#/components/schemas/Data" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403PolygonBroadcast" }, { "$ref": "#/components/schemas/Error403PolygonGasPrice" }, { "$ref": "#/components/schemas/Error403PolygonScBody" }, { "$ref": "#/components/schemas/Error403PolygonGasCalculation" }, { "$ref": "#/components/schemas/Error403PolygonTxHash" }, { "$ref": "#/components/schemas/Error403PolygonTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Invoke a method in a smart contract on Polygon", "tags": ["Polygon"] } }, "/v3/polygon/broadcast": { "post": { "description": "2 credits per API call
\nBroadcast signed transaction to Polygon blockchain. This method is used internally from Tatum KMS or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "PolygonBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403PolygonBroadcast" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Polygon transaction", "tags": ["Polygon"] } }, "/v3/celo/wallet": { "get": { "description": "1 credit per API call
\nTatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Celo wallet with derivation path m'/44'/52752'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Celo wallet.
\n", "operationId": "CeloGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Celo wallet", "tags": ["Celo"] } }, "/v3/celo/address/{xpub}/{index}": { "get": { "description": "1 credit per API call
\nGenerate Celo account deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31.
\n", "operationId": "CeloGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "schema": { "type": "string", "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "example": 1, "required": true, "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Celo address", "example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Celo account address from Extended public key", "tags": ["Celo"] } }, "/v3/celo/wallet/priv": { "post": { "description": "1 credit per API call
\nGenerate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^31 private keys starting from index 0 until 2^31.
\n", "operationId": "CeloGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Celo private key", "tags": ["Celo"] } }, "/v3/celo/web3/{xApiKey}": { "post": { "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based web3 driver to connect directly to the Celo node provided by Tatum.\nTo learn more about Celo Web3, visit the Celo developer's guide.
\n", "operationId": "CeloWeb3Driver", "deprecated": true, "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 method content body.", "example": { "jsonrpc": "2.0", "method": "web3_clientVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 response.", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "Web3 HTTP driver", "tags": ["Celo"] } }, "/v3/celo/block/current": { "get": { "description": "1 credit per API call
\nGet Celo current block number. This is the number of the latest block in the blockchain.
\n", "operationId": "CeloGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 6491272 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["Celo"] } }, "/v3/celo/block/{hash}": { "get": { "description": "1 credit per API call
\nGet Celo block by block hash or block number.
\n", "operationId": "CeloGetBlock", "parameters": [ { "description": "Block hash or block number", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "6470657" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CeloBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Celo block by hash", "tags": ["Celo"] } }, "/v3/celo/account/balance/{address}": { "get": { "description": "1 credit per API call
\nGet Celo account balance in ETH. This method does not prints any balance of the ERC20 or ERC721 tokens on the account.
\n", "operationId": "CeloGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "celo": { "type": "string", "description": "Balance of Celo", "example": "10.52" }, "cUsd": { "type": "string", "description": "Balance of cUSD", "example": "11.53" }, "cEur": { "type": "string", "description": "Balance of cEUR", "example": "11.53" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Celo Account balance", "tags": ["Celo"] } }, "/v3/celo/account/transaction/{address}": { "get": { "description": "1 credit per API call
\nGet Celo transactions by address. This includes incoming and outgoing transactions for the address.
\n", "operationId": "CeloGetTransactionByAddress", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x8ce4e40889a13971681391aad29e88efaf91f784" } }, { "description": "Max number of items per page is 50.", "in": "query", "name": "pageSize", "schema": { "type": "number", "example": 10, "maximum": 50, "minimum": 1 }, "required": true }, { "description": "Offset to obtain next page of the data.", "in": "query", "name": "offset", "schema": { "type": "number", "example": 0 } }, { "description": "Transactions from this block onwords will be included.", "in": "query", "name": "from", "schema": { "type": "number", "minimum": 0, "example": 1087623 } }, { "description": "Transactions up to this block will be included.", "in": "query", "name": "to", "schema": { "type": "number", "minimum": 0, "example": 1087823 } }, { "description": "Sorting of the data. ASC - oldest first, DESC - newest first.", "in": "query", "name": "sort", "schema": { "type": "string", "default": "DESC", "example": "ASC", "enum": ["ASC", "DESC"] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CeloTx" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Celo transactions by address", "tags": ["Celo"] } }, "/v3/celo/transaction/{hash}": { "get": { "description": "2 credits per API call
\nGet Celo transaction by transaction hash.
\n", "operationId": "CeloGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CeloTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Celo Transaction", "tags": ["Celo"] } }, "/v3/celo/transaction/count/{address}": { "get": { "description": "1 credit per API call
\nGet a number of outgoing Celo transactions for the address. When a transaction is sent, there can be multiple outgoing transactions,\nwhich are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents\nthe order of the transaction in the list of outgoing transactions.
\n", "operationId": "CeloGetTransactionCount", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 42, "minLength": 42, "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 5, "description": "Number of transactions, that were made from this address. Can be used as a nonce parameter in send transaction calls." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing Celo transactions", "tags": ["Celo"] } }, "/v3/celo/transaction": { "post": { "description": "2 credits per API call
\nSend Celo, cUSD or Tatum supported ERC20 token from account to account.
\n
Signing a transaction
\nWhen sending CELO, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "CeloBlockchainTransfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferCeloBlockchain" }, { "$ref": "#/components/schemas/TransferCeloBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403Celo" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send Celo / ERC20 from account to account", "tags": ["Celo"] } }, "/v3/celo/smartcontract": { "post": { "description": "2 credits per API call
\nInvoke a method in an existing smart contract on Celo.
\nYou can call a read-only or write method.
\nSigning a transaction
\nWhen invoking a method in a smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "CeloBlockchainSmartContractInvocation", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CallCeloReadSmartContractMethod" }, { "$ref": "#/components/schemas/CallCeloSmartContractMethod" }, { "$ref": "#/components/schemas/CallCeloSmartContractMethodKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" }, { "$ref": "#/components/schemas/Data" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403EthBroadcast" }, { "$ref": "#/components/schemas/Error403EthGasPrice" }, { "$ref": "#/components/schemas/Error403EthScBody" }, { "$ref": "#/components/schemas/Error403EthGasCalculation" }, { "$ref": "#/components/schemas/Error403EthTxHash" }, { "$ref": "#/components/schemas/Error403EthTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Invoke a method in a smart contract on Celo", "tags": ["Celo"] } }, "/v3/celo/broadcast": { "post": { "description": "2 credits per API call
\nBroadcast signed transaction to Celo blockchain. This method is used internally from Tatum KMS or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "CeloBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Celo" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Celo transaction", "tags": ["Celo"] } }, "/v3/egld/wallet": { "get": { "description": "The Elrond Address format is bech32, specified by the BIP 0173. The address always starts with an erd1. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase.\nMnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.\n
\nEach address is identified by 3 main values:\n
Tatum follows BIP44 specification and generates for EGLD wallet with derivation path m'/44'/508'/0'/0'.\nMore about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible EGLD wallet.
\n", "operationId": "EgldGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of private key.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mnemonic": { "type": "string", "description": "Mnemonic to use for generation of private key", "example": "quantum tobacco key they maid mean crime youth chief jungle mind design broken tilt bus shoulder leaf good forward erupt split divert bread kitten" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate EGLD wallet", "tags": ["Elrond"] } }, "/v3/egld/address/{mnemonic}/{index}": { "get": { "description": "Generate EGLD account deposit address from mnemonic phrase. Deposit address is generated for the specific\nindex - each mnemonic phrase can generate up to 2^31 addresses starting from index 0 until 2^31.
\n", "operationId": "EgldGenerateAddress", "parameters": [ { "description": "Mnemonic to use for generation of address.", "in": "path", "name": "mnemonic", "required": true, "schema": { "type": "string", "example": "quantum tobacco key they maid mean crime youth chief jungle mind design broken tilt bus shoulder leaf good forward erupt split divert bread kitten" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 1, "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "EGLD address", "example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate EGLD account address from mnemonic", "tags": ["Elrond"] } }, "/v3/egld/wallet/priv": { "post": { "description": "Generate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^31 private keys starting from index 0 until 2^31.
\n", "operationId": "EgldGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate EGLD private key", "tags": ["Elrond"] } }, "/v3/egld/node/{xApiKey}/*": { "post": { "deprecated": true, "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based driver to connect directly to the EGLD node provided by Tatum.\nTo learn more about EGLD, visit the EGLD developer's guide.
\n", "operationId": "EgldNodePost", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "/v3/egld/node/asdlkfjnqunalkwjf124387ad/transaction/cost" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid method content body.", "example": { "version": 1, "chainId": "D", "nonce": 42, "value": "100000000000000000", "receiver": "erd1cux02zersde0l7hhklzhywcxk4u9n4py5tdxyx7vrvhnza2r4gmq4vw35r", "sender": "erd1njqj2zggfup4nl83x0nfgqjkjserm7mjyxdx5vzkm8k0gkh40ezqtfz9lg", "gasPrice": 1000000000, "gasLimit": 70000, "data": "food for cats", "signature": "93207c579bf57be03add632b0e1624a73576eeda8a1687e0fa286f03eb1a17ffb125ccdb008a264c402f074a360442c7a034e237679322f62268b614e926d10f" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid response." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "Node HTTP driver", "tags": ["Elrond"] }, "get": { "deprecated": true, "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based driver to connect directly to the EGLD node provided by Tatum.\nTo learn more about EGLD, visit the EGLD developer's guide.
\n", "operationId": "EgldNodeGet", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "/v3/egld/node/asdlkfjnqunalkwjf12341kljl/network/config" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid response.", "example": { "config": { "erd_chain_id": "1", "erd_denomination": 18, "erd_gas_per_data_byte": 1500, "erd_latest_tag_software_version": "v1.1.0.0", "erd_meta_consensus_group_size": 400, "erd_min_gas_limit": 50000, "erd_min_gas_price": 1000000000, "erd_min_transaction_version": 1, "erd_num_metachain_nodes": 400, "erd_num_nodes_in_shard": 400, "erd_num_shards_without_meta": 3, "erd_round_duration": 6000, "erd_shard_consensus_group_size": 63, "erd_start_time": 1596117600 } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "Node HTTP driver", "tags": ["Elrond"] } }, "/v3/egld/block/current": { "get": { "description": "Get EGLD current block number. This is the number of the latest block in the blockchain.
", "operationId": "EGldGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 649127 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["Elrond"] } }, "/v3/egld/block/{hash}": { "get": { "description": "Get EGLD block by block hash or block number. EGLD docs
", "operationId": "EgldGetBlock", "parameters": [ { "description": "Block hash or nonce", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "a6f2ac15a6b1bafdde9afff2297cef49c4c523c516f8ee12fed54be070e9512b" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EgldBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get EGLD block by hash", "tags": ["Elrond"] } }, "/v3/egld/account/balance/{address}": { "get": { "description": "Get account balance in EGLD.
", "operationId": "EgldGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in EGLD", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get EGLD Account balance", "tags": ["Elrond"] } }, "/v3/egld/transaction/{hash}": { "get": { "description": "Get EGLD transaction by transaction hash. Detail result please find here EGLD docs
", "operationId": "EgldGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "99996224823736c1e9b8484ed74c1573049478f871d6f94b86811fb1c7b2addd" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EgldTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403EgldBroadcast" }, { "$ref": "#/components/schemas/Error403EgldGasCalculation" }, { "$ref": "#/components/schemas/Error403EgldTxHash" }, { "$ref": "#/components/schemas/Error403EgldTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get EGLD Transaction", "tags": ["Elrond"] } }, "/v3/egld/transaction/address/{address}": { "get": { "description": "This endpoint allows one to retrieve the latest 20 transactions sent from an address.
\n", "operationId": "EgldGetTransactionAddress", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 62, "minLength": 62, "example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "description": "List of transactions sent from an address.", "items": { "type": "object" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing EGLD transactions", "tags": ["Elrond"] } }, "/v3/egld/transaction/count/{address}": { "get": { "description": "Get a number of outgoing EGLD transactions for the address. When a transaction is sent, there can be multiple outgoing transactions,\nwhich are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents\nthe order of the transaction in the list of outgoing transactions.
\n", "operationId": "EgldGetTransactionCount", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 62, "minLength": 62, "example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 5, "description": "Number of transactions, that were made from this address. Can be used as a nonce parameter in send transaction calls." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing EGLD transactions", "tags": ["Elrond"] } }, "/v3/egld/transaction": { "post": { "description": "Send EGLD from account to account.
\nThis 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.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey\nor signatureId. PrivateKey should be used only for quick development on devnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
Broadcast signed transaction to EGLD blockchain. This method is used internally from Tatum KMS or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "EgldBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403EgldBroadcast" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed EGLD transaction", "tags": ["Elrond"] } }, "/v3/algorand/wallet": { "get": { "description": "Tatum supports Algorand wallets.
\n", "operationId": "AlgorandGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoWallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Algorand wallet", "tags": ["Algorand"] } }, "/v3/algorand/address/{priv}": { "get": { "description": "Generate Algorand account deposit address from private key.
\n", "operationId": "AlgorandGenerateAddress", "parameters": [ { "description": "private key of wallet.", "in": "path", "name": "priv", "required": true, "schema": { "type": "string", "example": "NBYMCVEEDFYV3TPWVRE6APE7PKHUJD4XAKXCKNCLKGUXOC3LFNJGZQCJCRA53HB7ZAHF6NFJH2QIVQ5USQNWG35QCJLD4KZ5IWMB24Q" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Algorand address", "example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Algorand account address from private key", "tags": ["Algorand"] } }, "/v3/algorand/node/indexer/{xApiKey}/{indexerPath}": { "get": { "deprecated": true, "description": "1 credit per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based url to connect directly to the Algorand node provided by Tatum.\nYou can check all available APIs here - https://developer.algorand.org/docs/rest-apis/indexer/.\n
\nExample call for Get Tx By ID is described in the response. https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactionstxid.\n
\nURL used for this call would be
https://api-eu1.tatum.io/v3/algorand/node/indexer/YOUR_API_KEY/v2/transactions/HNIQ76UTJYPOLZP5FWODYABBJPYPGJNEM2QEJSMDMQRWEKHEYJHQ\n", "operationId": "AlgoNodeIndexerGetDriver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } }, { "description": "`**` path of indexer.", "in": "path", "name": "indexerPath", "required": true, "schema": { "type": "string", "example": "v2/accounts" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Access Algorand Indexer GET node endpoints", "tags": ["Algorand"] } }, "/v3/algorand/node/algod/{xApiKey}/{algodPath}": { "get": { "deprecated": true, "description": "
1 credit per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based url to connect directly to the Algorand node provided by Tatum.\nYou can check al available APIs here - https://developer.algorand.org/docs/rest-apis/algod/v2/.\n
\nExample call for Get Block is described in the response. https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2blocksround.\n
\nURL used for this call would be
https://api-eu1.tatum.io/v3/algorand/node/algod/YOUR_API_KEY/v2/blocks/16775567\n\n", "operationId": "AlgoNodeGetDriver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } }, { "description": "`**` path of algod.", "in": "path", "name": "algodPath", "required": true, "schema": { "type": "string", "example": "v2/accounts" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Access Algorand Algod GET node endpoints", "tags": ["Algorand"] }, "post": { "deprecated": true, "description": "
2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based url to connect directly to the Algorand node provided by Tatum.\n You can check al available APIs here - https://developer.algorand.org/docs/rest-apis/algod/v2/.\n
\n Example call for Broadcast a raw transaction is described in the response. https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2transactions.\n
\n URL used for this call would be
https://api-eu1.tatum.io/v3/algorand/node/algod/YOUR_API_KEY/v2/transactions\n \n", "operationId": "AlgoNodePostDriver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } }, { "description": "`**` path of algod.", "in": "path", "name": "algodPath", "required": true, "schema": { "type": "string", "example": "v2/accounts" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rawtxn": { "type": "string", "description": "Check here - https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2transactions" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "txId": { "type": "string", "description": "Check here - https://developer.algorand.org/docs/rest-apis/algod/v2/#rawtransaction-response-200", "example": "X4VI2Q3SHG4RC3T2RNDCFHNPUL6WYX2ONWHJGLKNMBA4SVE5M4KQ" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Access Algorand Algod POST node endpoints", "tags": ["Algorand"] } }, "/v3/algorand/account/balance/{address}": { "get": { "description": "
Get Algorand account balance in ALGO.
\n", "operationId": "AlgorandGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "assets": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "description": "Balance in asset unit", "example": 1000 }, "assetIndex": { "type": "number", "description": "Asset Index of ASA", "example": 87748168 } } } }, "balance": { "type": "number", "description": "Balance in ALGO", "example": 1000 } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Algorand Account balance", "tags": ["Algorand"] } }, "/v3/algorand/block/current": { "get": { "description": "Get Algorand current block number. This is the number of the latest block in the blockchain.
", "operationId": "AlgorandGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 16775567 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["Algorand"] } }, "/v3/algorand/block/{roundNumber}": { "get": { "description": "Get Algorand block by block round number.
", "operationId": "AlgorandGetBlock", "parameters": [ { "description": "Block round number", "in": "path", "name": "roundNumber", "required": true, "schema": { "type": "number", "example": 16775567 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Algorand block by block round number", "tags": ["Algorand"] } }, "/v3/algorand/transaction": { "post": { "description": "2 credits per API call
\nSend Algos from one Algorand address to the other one.
\nSigning a transaction
\nWhen sending Algos, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "AlgorandBlockchainTransfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferAlgorandBlockchain" }, { "$ref": "#/components/schemas/TransferAlgorandBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send Algos to an Algorand account", "tags": ["Algorand"] } }, "/v3/algorand/asset/receive": { "post": { "description": "Enable accepting Algorand asset on the sender account.
\nThis operation needs the private key of the blockchain address.\nNo one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey\nor signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production,\nTatum KMS should be used for the highest security standards, and signatureId should be present in the request.\nAlternatively, using the Tatum client library for supported languages.\n
Get Algorand transaction by transaction id.
", "operationId": "AlgorandGetTransaction", "parameters": [ { "description": "Transaction id", "in": "path", "name": "txid", "required": true, "schema": { "type": "string", "example": "LXEBXIBDAIF72NRI76SU252QSOGFCKEHTG7AI4P6W25V35PETU3Q" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Algorand Transaction", "tags": ["Algorand"] } }, "/v3/algorand/transactions/{from}/{to}": { "get": { "description": "Get Algorand transaction by specified period of time.
", "operationId": "AlgorandGetPayTransactionsByFromTo", "parameters": [ { "description": "Start timestamp in specified period of time", "in": "path", "name": "from", "required": true, "schema": { "type": "string", "example": "2021-05-01T20:44:39Z" } }, { "description": "End timestamp in specified period of time", "in": "path", "name": "to", "required": true, "schema": { "type": "string", "example": "2021-06-01T20:44:39Z" } }, { "description": "page size for pagination", "in": "query", "name": "limit", "required": false, "schema": { "type": "string", "example": "5" } }, { "description": "Algorand Next Token for getting the next page results", "in": "query", "name": "next", "required": false, "schema": { "type": "string", "example": "ywAAAAAAAAAAAAAA" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoTxsWithPagination" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Algorand Transactions between from and to", "tags": ["Algorand"] } }, "/v3/algorand/broadcast": { "post": { "description": "Broadcast signed transaction to Algorand blockchain. This method is used internally from Tatum KMS or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "AlgoandBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoTransactionHashKMS" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Algorand transaction", "tags": ["Algorand"] } }, "/v3/tron/wallet": { "get": { "summary": "Generate a TRON wallet", "description": "1 credit per API call
\nTatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Bitcoin wallet with derivation path m'/44'/195'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/tron/bips/blob/master/bip-0044.mediawiki.\n Generate BIP44 compatible Tron wallet.
\n", "operationId": "GenerateTronwallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TronWallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "tags": ["Tron"] } }, "/v3/tron/address/{xpub}/{index}": { "get": { "description": "5 credits per API call
\nGenerate a TRON address from the extended public key of the wallet. The address is generated for the specific index - each extended public key can generate up to 2^32 addresses with the index starting from 0 up to 2^31.
\n", "operationId": "TronGenerateAddress", "parameters": [ { "description": "The extended public key of the wallet; can be in the base58 format (111 characters) or the hexadecimal format (130 characters)", "in": "path", "name": "xpub", "required": true, "example": "0244b3f40c6e570ae0032f6d7be87737a6c4e5314a4a1a82e22d0460a0d0cd794936c61f0c80dc74ace4cd04690d4eeb1aa6555883be006e1748306faa7ed3a26a", "schema": { "type": "string" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 1, "schema": { "type": "number", "minimum": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Tron address", "example": "TFFBpkRNro4Pe4154ayGWx7C6Ev7BvQZ6t" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403AccountAddressGeneral" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate a TRON address from the wallet's extended public key", "tags": ["Tron"] } }, "/v3/tron/wallet/priv": { "post": { "description": "10 credits per API call
\nGenerate private key for address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^31 private keys starting from index 0 until 2^31.
\n", "operationId": "TronGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403BlockchainPrivateFailed" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate the private key for a TRON address", "tags": ["Tron"] } }, "/v3/tron/info": { "get": { "tags": ["Tron"], "summary": "Get the current TRON block", "description": "5 credits per API call
\nGet current Tron block.
\n", "operationId": "TronGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "blockNumber": { "description": "Block height.", "type": "number", "example": 26585295 }, "hash": { "description": "Block hash.", "type": "string", "example": "000000000195a8cfe2ea4ca60ce921b30e95980a96c6bb1da4a35aa03da9c5a8" }, "testnet": { "description": "Wether the block is from mainnet of Shasta testnet", "type": "boolean", "example": false } } } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/block/{hash}": { "get": { "tags": ["Tron"], "summary": "Get a TRON block by its hash or height", "description": "5 credits per API call
\nGet Tron block by hash or height.
\n", "operationId": "TronGetBlock", "parameters": [ { "in": "path", "name": "hash", "required": true, "description": "Block hash or height.", "schema": { "type": "string", "example": "000000000195a8cfe2ea4ca60ce921b30e95980a96c6bb1da4a35aa03da9c5a8" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TronBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/account/{address}": { "get": { "tags": ["Tron"], "summary": "Get the TRON account by its address", "description": "5 credits per API call
\nGet Tron account by address.
\n", "operationId": "TronGetAccount", "parameters": [ { "in": "path", "name": "address", "required": true, "description": "Account address.", "schema": { "type": "string", "example": "TGDqQAP5bduoPKVgdbk7fGyW4DwEt3RRn8" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TronAccount" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/freezeBalance": { "post": { "tags": ["Tron"], "summary": "Freeze the balance of a TRON account", "description": "10 credits per API call
\nFreeze Tron assets on the address. By freezing assets, you can obtain energy or bandwidth to perform transactions.
\nSigning a transaction
\nWhen freezing the balance, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "TronFreeze", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FreezeTron" }, { "$ref": "#/components/schemas/FreezeTronKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/transaction/account/{address}": { "get": { "tags": ["Tron"], "summary": "Get all transactions for a TRON account", "description": "5 credits per API call
\nGet all transactions for a TRON account.
\nThis API returns up to 200 transactions in one API call. If there are more than 200 transactions for the TRON account, the response body will contain the next parameter with the ID of the transaction that follows the last (200th) transaction in the returned list.
To get the next 200 transactions, make another call using this API, but this time add the next parameter the endpoint URL and set it to the transaction ID from the next parameter in the response, for example:
https://{region}.tatum.io/v3/tron/transaction/account/{address}?next=81d0524acf5967f3b361e03fd7d141ab511791cd7aad7ae406c4c8d408290991
5 credits per API call
\nGet TRC-20 transactions for a TRON account.
\nThis API returns up to 200 transactions in one API call. If there are more than 200 transactions for the TRON account, the response body will contain the next parameter with the ID of the transaction that follows the last (200th) transaction in the returned list.
To get the next 200 transactions, make another call using this API, but this time add the next parameter the endpoint URL and set it to the transaction ID from the next parameter in the response, for example:
https://{region}.tatum.io/v3/tron/transaction/account/{address}/trc20?next=81d0524acf5967f3b361e03fd7d141ab511791cd7aad7ae406c4c8d408290991
10 credits per API call
\nSend an amount in TRX from address to address.
\nSigning a transaction
\nWhen sending TRX to a TRON 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "TronTransfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferTronBlockchain" }, { "$ref": "#/components/schemas/TransferTronBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/trc10/transaction": { "post": { "tags": ["Tron"], "summary": "Send TRC-10 tokens to a TRON account", "description": "10 credits per API call
\nSend TRC-10 tokens from address to address.
\nSigning a transaction
\nWhen sending TRC-10 tokens to a TRON 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "TronTransferTrc10", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferTronTrc10Blockchain" }, { "$ref": "#/components/schemas/TransferTronTrc10BlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/trc20/transaction": { "post": { "tags": ["Tron"], "summary": "Send TRC-20 tokens to a TRON account", "description": "10 credits per API call
\nSend TRC-20 tokens from address to address.
\nSigning a transaction
\nWhen sending TRC-20 tokens to a TRON 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "TronTransferTrc20", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferTronTrc20Blockchain" }, { "$ref": "#/components/schemas/TransferTronTrc20BlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/trc10/deploy": { "post": { "tags": ["Tron"], "summary": "Create a TRC-10 token", "description": "10 credits per API call
\nCreate Tron TRC10 token. 1 account can create only 1 token. All supply of the tokens are transferred to the issuer account 100 seconds after the creation.
\nSigning a transaction
\nWhen creating a TRC-10 token, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "TronCreateTrc10", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateTronTrc10Blockchain" }, { "$ref": "#/components/schemas/CreateTronTrc10BlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/trc10/detail/{id}": { "get": { "tags": ["Tron"], "summary": "Get information about a TRC-10 token", "description": "5 credits per API call
\nGet Tron TRC10 token details.
\n", "operationId": "TronTrc10Detail", "parameters": [ { "in": "path", "name": "id", "required": true, "description": "TRC10 token ID", "schema": { "type": "number", "example": 1000540 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TronTrc10Detail" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/trc20/deploy": { "post": { "tags": ["Tron"], "summary": "Create a TRC-20 token", "description": "10 credits per API call
\nCreate Tron TRC20 token. 1 account can create only 1 token. All supply of the tokens are transfered to the issuer account 100 seconds after the creation.
\nSigning a transaction
\nWhen creating a TRC-20 token, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "TronCreateTrc20", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateTronTrc20Blockchain" }, { "$ref": "#/components/schemas/CreateTronTrc20BlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/transaction/{hash}": { "get": { "tags": ["Tron"], "summary": "Get a TRON transaction by its hash", "description": "5 credits per API call
\nGet Tron transaction by hash.
\n", "operationId": "TronGetTransaction", "parameters": [ { "in": "path", "name": "hash", "required": true, "description": "Transaction hash.", "schema": { "type": "string", "example": "81d0524acf5967f3b361e03fd7d141ab511791cd7aad7ae406c4c8d408290991" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TronTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/tron/broadcast": { "post": { "tags": ["Tron"], "summary": "Broadcast a TRON transaction", "description": "5 credits per API call
\nBroadcast Tron transaction. This method is used internally from Tatum Middleware or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "TronBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TronBroadcast" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403Tron" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [] } }, "/v3/klaytn/wallet": { "get": { "description": "1 credit per API call
\nTatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Klaytn wallet with derivation path m'/44'/966'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Klaytn wallet.
\n", "operationId": "KlaytnGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Klaytn wallet", "tags": ["Klaytn"] } }, "/v3/klaytn/address/{xpub}/{index}": { "get": { "description": "1 credit per API call
\nGenerate Klaytn account deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31.
\n", "operationId": "KlaytnGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "schema": { "type": "string", "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "example": 1, "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Klaytn address", "example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Klaytn account address from Extended public key", "tags": ["Klaytn"] } }, "/v3/klaytn/wallet/priv": { "post": { "description": "1 credit per API call
\nGenerate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^31 private keys starting from index 0 until 2^31.
\n", "operationId": "KlaytnGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Klaytn private key", "tags": ["Klaytn"] } }, "/v3/klaytn/web3/{xApiKey}": { "post": { "deprecated": true, "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based web3 driver to connect directly to the Klaytn node provided by Tatum.\nTo learn more about Klaytn Web3, visit the Klaytn developer's guide.
\n", "operationId": "KlaytnWeb3Driver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 method content body.", "example": { "jsonrpc": "2.0", "method": "web3_clientVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 response.", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "Web3 HTTP driver", "tags": ["Klaytn"] } }, "/v3/klaytn/block/current": { "get": { "description": "1 credit per API call
\nGet Klaytn current block number. This is the number of the latest block in the blockchain.
\n", "operationId": "KlaytnGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 6491272 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["Klaytn"] } }, "/v3/klaytn/block/{hash}": { "get": { "description": "1 credit per API call
\nGet Klaytn block by block hash or block number.
\n", "operationId": "KlaytnGetBlock", "parameters": [ { "description": "Block hash or block number", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "6470657" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KlaytnBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Klaytn block by hash", "tags": ["Klaytn"] } }, "/v3/klaytn/account/balance/{address}": { "get": { "description": "1 credit per API call
\nGet Klaytn account balance in KLAY. This method does not prints any balance of the ERC20 or ERC721 tokens on the account.
\n", "operationId": "KlaytnGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in KLAY", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Klaytn Account balance", "tags": ["Klaytn"] } }, "/v3/klaytn/transaction/{hash}": { "get": { "description": "2 credits per API call
\nGet Klaytn transaction by transaction hash.
\n", "operationId": "KlaytnGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KlaytnTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Klaytn Transaction", "tags": ["Klaytn"] } }, "/v3/klaytn/transaction/count/{address}": { "get": { "description": "1 credit per API call
\nGet a number of outgoing Klaytn transactions for the address. When a transaction is sent, there can be multiple outgoing transactions, which are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents the order of the transaction in the list of outgoing transactions.
\n", "operationId": "KlaytnGetTransactionCount", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 42, "minLength": 42, "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 5, "description": "Number of transactions, that were made from this address. Can be used as a nonce parameter in send transaction calls." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing Klaytn transactions", "tags": ["Klaytn"] } }, "/v3/klaytn/transaction": { "post": { "description": "2 credits per API call
\nSend KLAY from account to account.
\n
Signing a transaction
\nWhen sending KLAY, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "KlaytnBlockchainTransfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferKlaytnBlockchain" }, { "$ref": "#/components/schemas/TransferKlaytnBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403KlaytnBroadcast" }, { "$ref": "#/components/schemas/Error403KlaytnGasPrice" }, { "$ref": "#/components/schemas/Error403KlaytnTxBody" }, { "$ref": "#/components/schemas/Error403KlaytnGasCalculation" }, { "$ref": "#/components/schemas/Error403KlaytnTxHash" }, { "$ref": "#/components/schemas/Error403KlaytnTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send KLAY from account to account", "tags": ["Klaytn"] } }, "/v3/klaytn/smartcontract": { "post": { "description": "2 credits per API call
\nInvoke a method in an existing smart contract on Klaytn.
\nYou can call a read-only or write method.
\nSigning a transaction
\nWhen invoking a method in a smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "KlaytnBlockchainSmartContractInvocation", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CallKlaytnSmartContractReadMethod" }, { "$ref": "#/components/schemas/CallKlaytnSmartContractMethod" }, { "$ref": "#/components/schemas/CallKlaytnSmartContractMethodKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" }, { "$ref": "#/components/schemas/Data" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403KlaytnBroadcast" }, { "$ref": "#/components/schemas/Error403KlaytnGasPrice" }, { "$ref": "#/components/schemas/Error403KlaytnScBody" }, { "$ref": "#/components/schemas/Error403KlaytnGasCalculation" }, { "$ref": "#/components/schemas/Error403KlaytnTxHash" }, { "$ref": "#/components/schemas/Error403KlaytnTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Invoke a method in a smart contract on Klaytn", "tags": ["Klaytn"] } }, "/v3/klaytn/broadcast": { "post": { "description": "2 credits per API call
\nBroadcast signed transaction to Klaytn blockchain. This method is used internally from Tatum KMS or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "KlaytnBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403KlaytnBroadcast" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Klaytn transaction", "tags": ["Klaytn"] } }, "/v3/one/wallet": { "get": { "description": "1 credit per API call
\nTatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for ONE wallet with derivation path m'/44'/60'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible ONE wallet.
\n", "operationId": "OneGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate ONE wallet", "tags": ["Harmony"] } }, "/v3/one/address/{xpub}/{index}": { "get": { "description": "1 credit per API call
\nGenerate ONE account deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31.
\n", "operationId": "OneGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "schema": { "type": "string", "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "example": 1, "required": true, "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "ONE address", "example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate ONE account address from Extended public key", "tags": ["Harmony"] } }, "/v3/one/address/format/{address}": { "get": { "description": "1 credit per API call
\nTransform HEX address to Bech32 format with one prefix.
\n", "operationId": "OneFormatAddress", "parameters": [ { "description": "Address in HEX (ETH compatible) format.", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "ONE address", "example": "one15annzcwtlcq3dfx7nc6plpr9jsxzyyw5xc8pjn" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Transform HEX address to Bech32 ONE address format", "tags": ["Harmony"] } }, "/v3/one/wallet/priv": { "post": { "description": "1 credit per API call
\nGenerate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^31 private keys starting from index 0 until 2^31.
\n", "operationId": "OneGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate ONE private key", "tags": ["Harmony"] } }, "/v3/one/web3/{xApiKey}": { "post": { "deprecated": true, "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based web3 driver to connect directly to the ONE node provided by Tatum.\nTo learn more about ONE Web3, visit the ONE developer's guide.
\n", "operationId": "OneWeb3Driver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } }, { "description": "Shard to read data from", "in": "query", "name": "shardID", "required": false, "schema": { "default": 0, "type": "number", "example": 0 } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 method content body.", "example": { "jsonrpc": "2.0", "method": "web3_clientVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 response.", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "Web3 HTTP driver", "tags": ["Harmony"] } }, "/v3/one/block/current": { "get": { "description": "1 credit per API call
\nGet ONE current block number. This is the number of the latest block in the blockchain.
\n", "operationId": "OneGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "shardID": { "type": "number", "description": "Shard ID", "example": 0 }, "blockNumber": { "type": "number", "description": "Current block number in this shard", "example": 6491272 } } } } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["Harmony"] } }, "/v3/one/block/{hash}": { "get": { "description": "1 credit per API call
\nGet ONE block by block hash or block number.
\n", "operationId": "OneGetBlock", "parameters": [ { "description": "Block hash or block number", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "6470657" } }, { "description": "Shard to read data from", "in": "query", "name": "shardID", "required": false, "schema": { "default": 0, "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get ONE block by hash", "tags": ["Harmony"] } }, "/v3/one/account/balance/{address}": { "get": { "description": "1 credit per API call
\nGet ONE account balance in ONE. This method does not prints any balance of the HRM20 or HRM721 tokens on the account.
\n", "operationId": "OneGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" } }, { "description": "Shard to read data from", "in": "query", "name": "shardID", "required": false, "schema": { "default": 0, "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in ONE", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get ONE Account balance", "tags": ["Harmony"] } }, "/v3/one/transaction/{hash}": { "get": { "description": "2 credits per API call
\nGet ONE transaction by transaction hash.
\n", "operationId": "OneGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } }, { "description": "Shard to read data from", "in": "query", "name": "shardID", "required": false, "schema": { "default": 0, "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OneTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get ONE Transaction", "tags": ["Harmony"] } }, "/v3/one/transaction/count/{address}": { "get": { "description": "1 credit per API call
\nGet a number of outgoing ONE transactions for the address. When a transaction is sent, there can be multiple outgoing transactions,\nwhich are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents\nthe order of the transaction in the list of outgoing transactions.
\n", "operationId": "OneGetTransactionCount", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 42, "minLength": 42, "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } }, { "description": "Shard to read data from", "in": "query", "name": "shardID", "required": false, "schema": { "default": 0, "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 5, "description": "Number of transactions, that were made from this address. Can be used as a nonce parameter in send transaction calls." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing ONE transactions", "tags": ["Harmony"] } }, "/v3/one/transaction": { "post": { "description": "2 credits per API call
\nSend ONE or Tatum supported HRM20 token from account to account.
\nDefault shard 0 is used for sender and recipient.
\n
Signing a transaction
\nWhen sending ONE, 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.
\nProviding 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.
\nFor 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.
\nAlternatively, using the Tatum client library for supported languages.\n", "operationId": "OneBlockchainTransfer", "parameters": [ { "description": "Shard to read data from", "in": "query", "name": "shardID", "required": false, "schema": { "default": 0, "type": "number", "example": 0 } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferOneBlockchain" }, { "$ref": "#/components/schemas/TransferOneBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403OneBroadcast" }, { "$ref": "#/components/schemas/Error403OneGasPrice" }, { "$ref": "#/components/schemas/Error403OneTxBody" }, { "$ref": "#/components/schemas/Error403OneGasCalculation" }, { "$ref": "#/components/schemas/Error403OneTxHash" }, { "$ref": "#/components/schemas/Error403OneTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send ONE / HRM20 from account to account", "tags": ["Harmony"] } }, "/v3/one/smartcontract": { "post": { "description": "2 credits per API call
\nInvoke a method in an existing smart contract on Harmony.
\nYou can call a read-only or write method.
\nSigning a transaction
\nWhen invoking a method in a smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "OneBlockchainSmartContractInvocation", "parameters": [ { "description": "Shard to read data from", "in": "query", "name": "shardID", "required": false, "schema": { "default": 0, "type": "number", "example": 0 } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CallOneReadSmartContractMethod" }, { "$ref": "#/components/schemas/CallOneSmartContractMethod" }, { "$ref": "#/components/schemas/CallOneSmartContractMethodKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" }, { "$ref": "#/components/schemas/Data" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403OneBroadcast" }, { "$ref": "#/components/schemas/Error403OneGasPrice" }, { "$ref": "#/components/schemas/Error403OneScBody" }, { "$ref": "#/components/schemas/Error403OneGasCalculation" }, { "$ref": "#/components/schemas/Error403OneTxHash" }, { "$ref": "#/components/schemas/Error403OneTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Invoke a method in a smart contract on Harmony", "tags": ["Harmony"] } }, "/v3/one/broadcast": { "post": { "description": "2 credits per API call
\nBroadcast signed transaction to ONE blockchain. This method is used internally from Tatum KMS or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "OneBroadcast", "parameters": [ { "description": "Shard to read data from", "in": "query", "name": "shardID", "required": false, "schema": { "default": 0, "type": "number", "example": 0 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403OneBroadcast" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed ONE transaction", "tags": ["Harmony"] } }, "/v3/xdc/wallet": { "get": { "description": "1 credit per API call
\nTatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase.\nMnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.\n
\nEach address is identified by 3 main values:\n
Tatum follows BIP44 specification and generates for XDC wallet with derivation path m'/44'/550'/0'/0.\nMore about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible XDC wallet.
\n", "operationId": "XdcGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate XDC wallet", "tags": ["XinFin"] } }, "/v3/xdc/address/{xpub}/{index}": { "get": { "description": "1 credit per API call
\nGenerate XDC account deposit address from Extended public key. Deposit address is generated for the specific\nindex - each extended public key can generate up to 2^31 addresses starting from index 0 until 2^31.
\n", "operationId": "XdcGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "schema": { "type": "string", "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "required": true, "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "XDC address", "example": "xdca7673161CbfE0116A4De9E341f8465940c2211d4" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate XDC account address from Extended public key", "tags": ["XinFin"] } }, "/v3/xdc/wallet/priv": { "post": { "description": "1 credit per API call
\nGenerate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^31 private keys starting from index 0 until 2^31.
\n", "operationId": "XdcGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate XDC private key", "tags": ["XinFin"] } }, "/v3/xdc/web3/{xApiKey}": { "post": { "deprecated": true, "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based web3 driver to connect directly to the XDC node provided by Tatum.\nTo learn more about XDC Web3, visit the XDC developer's guide.
\n", "operationId": "XdcWeb3Driver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 method content body.", "example": { "jsonrpc": "2.0", "method": "web3_clientVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 response.", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "Web3 HTTP driver", "tags": ["XinFin"] } }, "/v3/xdc/block/current": { "get": { "description": "1 credit per API call
\nGet XDC current block number. This is the number of the latest block in the blockchain.
\n", "operationId": "XdcGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 649127 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["XinFin"] } }, "/v3/xdc/block/{hash}": { "get": { "description": "1 credit per API call
\nGet XDC block by block hash or block number.
\n", "operationId": "XdcGetBlock", "parameters": [ { "description": "Block hash or block number", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "647065" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XdcBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XDC block by hash", "tags": ["XinFin"] } }, "/v3/xdc/account/balance/{address}": { "get": { "description": "1 credit per API call
\nGet account balance in XDC. This method does not prints any balance of the ERC20 or ERC721 tokens on the account.
\n", "operationId": "XdcGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "xdc3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in XDC", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XDC Account balance", "tags": ["XinFin"] } }, "/v3/xdc/transaction/{hash}": { "get": { "description": "2 credits per API call
\nGet XDC transaction by transaction hash.
\n", "operationId": "XdcGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XdcTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403XdcBroadcast" }, { "$ref": "#/components/schemas/Error403XdcGasCalculation" }, { "$ref": "#/components/schemas/Error403XdcTxHash" }, { "$ref": "#/components/schemas/Error403XdcTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get XDC Transaction", "tags": ["XinFin"] } }, "/v3/xdc/transaction/count/{address}": { "get": { "description": "1 credit per API call
\nGet a number of outgoing XDC transactions for the address. When a transaction is sent, there can be multiple outgoing transactions,\nwhich are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents\nthe order of the transaction in the list of outgoing transactions.
\n", "operationId": "XdcGetTransactionCount", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 42, "minLength": 42, "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 5, "description": "Number of transactions, that were made from this address. Can be used as a nonce parameter in send transaction calls." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing XDC transactions", "tags": ["XinFin"] } }, "/v3/xdc/transaction": { "post": { "description": "2 credits per API call
\nSend XDC or Tatum supported ERC20 token from account to account.
\n
Signing a transaction
\nWhen sending XDC, 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.
\nProviding 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.
\nFor 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.
\nAlternatively, using the Tatum client library for supported languages.\n", "operationId": "XdcBlockchainTransfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferXdcBlockchain" }, { "$ref": "#/components/schemas/TransferXdcBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403XdcBroadcast" }, { "$ref": "#/components/schemas/Error403XdcGasCalculation" }, { "$ref": "#/components/schemas/Error403XdcTxHash" }, { "$ref": "#/components/schemas/Error403XdcTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send XDC / ERC20 from account to account", "tags": ["XinFin"] } }, "/v3/xdc/smartcontract": { "post": { "description": "2 credits per API call
\nInvoke a method in an existing smart contract on XinFin.
\nYou can call a read-only or write method.
\nSigning a transaction
\nWhen invoking a method in a smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "XdcBlockchainSmartContractInvocation", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CallXdcReadSmartContractMethod" }, { "$ref": "#/components/schemas/CallXdcSmartContractMethod" }, { "$ref": "#/components/schemas/CallXdcSmartContractMethodKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" }, { "$ref": "#/components/schemas/Data" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403XdcBroadcast" }, { "$ref": "#/components/schemas/Error403XdcGasCalculation" }, { "$ref": "#/components/schemas/Error403XdcTxHash" }, { "$ref": "#/components/schemas/Error403XdcTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Invoke a method in a smart contract on XinFin", "tags": ["XinFin"] } }, "/v3/xdc/broadcast": { "post": { "description": "2 credits per API call
\nBroadcast signed transaction to XDC blockchain. This method is used internally from Tatum KMS or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "XdcBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403XdcBroadcast" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed XDC transaction", "tags": ["XinFin"] } }, "/v3/kcs/wallet": { "get": { "description": "1 credit per API call
\nTatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Kcs wallet with derivation path m'/44'/966'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.\nGenerate BIP44 compatible Kcs wallet.
\n", "operationId": "KcsGenerateWallet", "parameters": [ { "description": "Mnemonic to use for generation of extended public and private keys.", "in": "query", "name": "mnemonic", "required": false, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Kcs wallet", "tags": ["KuCoin"] } }, "/v3/kcs/address/{xpub}/{index}": { "get": { "description": "1 credit per API call
\nGenerate Kcs account deposit address from Extended public key. Deposit address is generated for the specific index - each extended public key can generate\nup to 2^31 addresses starting from index 0 until 2^31.
\n", "operationId": "KcsGenerateAddress", "parameters": [ { "description": "Extended public key of wallet.", "in": "path", "name": "xpub", "required": true, "schema": { "type": "string", "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid" } }, { "description": "Derivation index of desired address to be generated.", "in": "path", "name": "index", "example": 1, "required": true, "schema": { "type": "number", "example": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "Kcs address", "example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Kcs account address from Extended public key", "tags": ["KuCoin"] } }, "/v3/kcs/wallet/priv": { "post": { "description": "1 credit per API call
\nGenerate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic\ncan generate up to 2^31 private keys starting from index 0 until 2^31.
\n", "operationId": "KcsGenerateAddressPrivateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivKey" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Generate Kcs private key", "tags": ["KuCoin"] } }, "/v3/kcs/web3/{xApiKey}": { "post": { "deprecated": true, "description": "2 credits per API call
\nThis endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based web3 driver to connect directly to the Kcs node provided by Tatum.\nTo learn more about Kcs Web3, visit the Kcs developer's guide.
\n", "operationId": "KcsWeb3Driver", "parameters": [ { "description": "Tatum X-API-Key used for authorization.", "in": "path", "name": "xApiKey", "required": true, "schema": { "type": "string", "example": "asdlkfjnqunalkwjfnq2oi303294857k" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 method content body.", "example": { "jsonrpc": "2.0", "method": "web3_clientVersion", "params": [], "id": 2 } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Any valid Web3 response.", "example": { "jsonrpc": "2.0", "id": 2, "result": "Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4" } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "x-codeSamples": [], "summary": "Web3 HTTP driver", "tags": ["KuCoin"] } }, "/v3/kcs/block/current": { "get": { "description": "1 credit per API call
\nGet Kcs current block number. This is the number of the latest block in the blockchain.
\n", "operationId": "KcsGetCurrentBlock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "description": "Current block number", "example": 6491272 } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get current block number", "tags": ["KuCoin"] } }, "/v3/kcs/block/{hash}": { "get": { "description": "1 credit per API call
\nGet Kcs block by block hash or block number.
\n", "operationId": "KcsGetBlock", "parameters": [ { "description": "Block hash or block number", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "6470657" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthBlock" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Kcs block by hash", "tags": ["KuCoin"] } }, "/v3/kcs/account/balance/{address}": { "get": { "description": "1 credit per API call
\nGet Kcs account balance in KCS. This method does not prints any balance of the ERC20 or ERC721 tokens on the account.
\n", "operationId": "KcsGetBalance", "parameters": [ { "description": "Account address you want to get balance of", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in KCS", "example": "10.52" } } } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Kcs Account balance", "tags": ["KuCoin"] } }, "/v3/kcs/transaction/{hash}": { "get": { "description": "2 credits per API call
\nGet Kcs transaction by transaction hash.
\n", "operationId": "KcsGetTransaction", "parameters": [ { "description": "Transaction hash", "in": "path", "name": "hash", "required": true, "schema": { "type": "string", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KcsTx" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/Error403TxNotFound" }] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get Kcs Transaction", "tags": ["KuCoin"] } }, "/v3/kcs/transaction/count/{address}": { "get": { "description": "1 credit per API call
\nGet a number of outgoing Kcs transactions for the address. When a transaction is sent, there can be multiple outgoing transactions,\nwhich are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents\nthe order of the transaction in the list of outgoing transactions.
\n", "operationId": "KcsGetTransactionCount", "parameters": [ { "description": "address", "in": "path", "name": "address", "required": true, "schema": { "type": "string", "maxLength": 42, "minLength": 42, "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "number", "example": 5, "description": "Number of transactions, that were made from this address. Can be used as a nonce parameter in send transaction calls." } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Get count of outgoing Kcs transactions", "tags": ["KuCoin"] } }, "/v3/kcs/transaction": { "post": { "description": "2 credits per API call
\nSend KCS from account to account.
\n
Signing a transaction
\nWhen sending KCS, 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.
\nProviding 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.
\nFor 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.
\nAlternatively, using the Tatum client library for supported languages.\n", "operationId": "KcsBlockchainTransfer", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransferKcsBlockchain" }, { "$ref": "#/components/schemas/TransferKcsBlockchainKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403KcsBroadcast" }, { "$ref": "#/components/schemas/Error403KcsGasPrice" }, { "$ref": "#/components/schemas/Error403KcsTxBody" }, { "$ref": "#/components/schemas/Error403KcsGasCalculation" }, { "$ref": "#/components/schemas/Error403KcsTxHash" }, { "$ref": "#/components/schemas/Error403KcsTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Send KCS from account to account", "tags": ["KuCoin"] } }, "/v3/kcs/smartcontract": { "post": { "description": "2 credits per API call
\nInvoke a method in an existing smart contract on KuCoin Community Chain.
\nYou can call a read-only or write method.
\nSigning a transaction
\nWhen invoking a method in a smart contract, 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.
\nProviding 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.
\nFor 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.
\n", "operationId": "KcsBlockchainSmartContractInvocation", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CallKcsSmartContractReadMethod" }, { "$ref": "#/components/schemas/CallKcsSmartContractMethod" }, { "$ref": "#/components/schemas/CallKcsSmartContractMethodKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" }, { "$ref": "#/components/schemas/Data" } ] } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error403KcsBroadcast" }, { "$ref": "#/components/schemas/Error403KcsGasPrice" }, { "$ref": "#/components/schemas/Error403KcsScBody" }, { "$ref": "#/components/schemas/Error403KcsGasCalculation" }, { "$ref": "#/components/schemas/Error403KcsTxHash" }, { "$ref": "#/components/schemas/Error403KcsTxSign" } ] } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Invoke a method in a smart contract on KuCoin Community Chain", "tags": ["KuCoin"] } }, "/v3/kcs/broadcast": { "post": { "description": "2 credits per API call
\nBroadcast signed transaction to Kcs blockchain. This method is used internally from Tatum KMS or Tatum client libraries.\nIt is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchian.
\n", "operationId": "KcsBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastKMS" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHash" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error400" } } }, "description": "Bad Request. Validation failed for the given object in the HTTP Body or Request parameters." }, "401": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Error401NotActive" }, { "$ref": "#/components/schemas/Error401Invalid" } ] } } }, "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header." }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403KcsBroadcast" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error500" } } }, "description": "Internal server error. There was an error on the server during the processing of the request." } }, "security": [{ "X-API-Key": [] }], "x-codeSamples": [], "summary": "Broadcast signed Kcs transaction", "tags": ["KuCoin"] } } }, "components": { "schemas": { "Account": { "properties": { "id": { "description": "The ID of the virtual account", "example": "5e68c66581f2ee32bc354087", "type": "string" }, "balance": { "$ref": "#/components/schemas/AccountBalance" }, "currency": { "description": "The currency of the virtual account", "example": "BTC", "type": "string" }, "frozen": { "description": "If set to \"true\", the virtual account is frozen", "example": false, "type": "boolean" }, "active": { "description": "If set to \"true\", the virtual account is active", "example": true, "type": "boolean" }, "customerId": { "description": "The ID of the customer (newly created or existing one) associated with the virtual account", "type": "string", "example": "5e68c66581f2ee32bc354087" }, "accountNumber": { "description": "The number associated with the virtual account in an external system", "maxLength": 50, "minLength": 1, "example": "123456", "type": "string" }, "accountCode": { "description": "The code associated with the virtual account in an external system to designate the purpose of the account in bookkeeping", "example": "03_ACC_01", "type": "string" }, "accountingCurrency": { "description": "The currency in which all the transactions for all accounts will be accounted", "example": "EUR", "type": "string" }, "xpub": { "description": "The extended public key of the blockchain wallet associated with the virtual account; used to generate deposit addresses for the virtual account", "example": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka", "type": "string" } }, "required": ["id", "active", "frozen", "currency", "balance"], "type": "object" }, "Deposit": { "required": [ "txId", "address", "timestamp", "xpub", "derivationKey", "amount", "status", "accountId", "currency", "reference", "vout", "spent", "blockHeight" ], "properties": { "txId": { "type": "string", "example": "6498A3BE7313FEF32C9C0130F321D7808439F7F59D41932122383CC9E109F534" }, "address": { "description": "Blockchain address.", "example": "7c21ed165e294db78b95f0f181086d6f", "type": "string" }, "timestamp": { "type": "number", "minimum": 0, "example": 1613654998398, "description": "End interval in UTC millis." }, "xpub": { "description": "Extended public key to derive address from.", "example": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka", "type": "string" }, "derivationKey": { "description": "Derivation key index for given address.", "format": "int32", "type": "integer", "maximum": 2147483647 }, "amount": { "type": "string", "description": "Amount of the trade", "example": "15000" }, "status": { "type": "string", "example": "Done", "description": "Status of deposit", "enum": ["InProgress", "Done", "Failed"] }, "accountId": { "description": "Account ID.", "example": "5e68c66581f2ee32bc354087", "type": "string" }, "currency": { "type": "string", "example": "BTC", "description": "Currency" }, "reference": { "type": "string", "example": "some reference" }, "vout": { "type": "number", "example": 0 }, "spent": { "type": "boolean" }, "blockHeight": { "type": "number", "minimum": 0, "description": "Block of deposit", "example": 228232166 }, "blockHash": { "description": "Hash of the block where this transaction was in.", "type": "string", "example": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137" }, "from": { "description": "Blockchain address.", "example": "7c21ed165e294db78b95f0f181086d6f", "type": "string" } } }, "EntitiesCount": { "type": "object", "properties": { "total": { "description": "Total entities", "example": 20, "type": "number" } } }, "ChartRequest": { "type": "object", "required": ["pair", "from", "to", "timeFrame"], "properties": { "pair": { "type": "string", "description": "Trading pair", "example": "BTC/EUR", "minLength": 3, "maxLength": 30, "pattern": "^[A-a-zZ0-9_\\-]+\\/[A-Za-z0-9_\\-]+$" }, "from": { "type": "number", "minimum": 0, "example": 1613654998398, "description": "Start interval in UTC millis." }, "to": { "type": "number", "minimum": 0, "example": 1613654998398, "description": "End interval in UTC millis." }, "timeFrame": { "type": "string", "example": "MIN_5", "description": "Time frame of the chart.", "enum": [ "MIN_1", "MIN_3", "MIN_5", "MIN_15", "MIN_30", "HOUR_1", "HOUR_4", "HOUR_12", "DAY", "WEEK", "MONTH", "YEAR" ] } } }, "Chart": { "type": "object", "description": "1 point in the chart. This point represents the tick in the grapch based on the specified time frame.", "required": ["timestamp", "high", "low", "open", "close", "volume"], "properties": { "timestamp": { "type": "number", "description": "Milliseconds in UTC of the time interval.", "example": 1613654117167 }, "high": { "type": "string", "description": "Highest trade value in the current interval.", "example": "54213.21" }, "low": { "type": "string", "description": "Lowest trade value in the current interval.", "example": "53213.54" }, "open": { "type": "string", "description": "Open trade value in the current interval.", "example": "53513" }, "close": { "type": "string", "description": "Close trade value in the current interval.", "example": "54113" }, "volume": { "type": "string", "description": "Total volume of assets traded in the current interval. Volume is in currency1 asset.", "example": "2.423" } } }, "AccountBalance": { "properties": { "accountBalance": { "description": "All assets on the account, both available and blocked", "example": "1000000", "type": "string" }, "availableBalance": { "description": "The account balance minus the blocked assets; use the available balance to determine how much a customer can send or withdraw from their virtual account", "example": "1000000", "type": "string" } }, "type": "object", "required": ["accountBalance", "availableBalance"] }, "Subscription": { "type": "object", "required": ["type", "id"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "ACCOUNT_BALANCE_LIMIT", "enum": [ "ADDRESS_TRANSACTION", "CONTRACT_LOG_EVENT", "ACCOUNT_INCOMING_BLOCKCHAIN_TRANSACTION", "ACCOUNT_PENDING_BLOCKCHAIN_TRANSACTION", "CUSTOMER_TRADE_MATCH", "CUSTOMER_PARTIAL_TRADE_MATCH", "TRANSACTION_IN_THE_BLOCK", "KMS_FAILED_TX", "KMS_COMPLETED_TX", "ACCOUNT_BALANCE_LIMIT", "TRANSACTION_HISTORY_REPORT" ] }, "id": { "type": "string", "description": "ID of the subscription", "example": "7c21ed165e294db78b95f0f1" }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type." } } }, "WebHook": { "type": "object", "required": ["id", "type", "subscriptionId", "url", "data", "failed", "response"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "ACCOUNT_BALANCE_LIMIT", "enum": [ "INCOMING_BLOCKCHAIN_HOOK", "ADDRESS_TRANSACTION", "CONTRACT_LOG_EVENT", "TRADE_MATCH", "TRADE_PARTIAL_FILL", "PENDING_BLOCKCHAIN_HOOK", "TRANSACTION_IN_THE_BLOCK", "KMS_FAILED_TX", "KMS_COMPLETED_TX" ] }, "id": { "type": "string", "description": "ID of the WebHook", "example": "7c21ed165e294db78b95f0f1" }, "subscriptionId": { "type": "string", "description": "ID of the subscription", "example": "7c21ed165e294db78b95f0f1" }, "url": { "type": "string", "description": "ID of the subscription", "example": "http://some-host.net/webhook" }, "data": { "type": "object", "description": "Data of webhook" }, "nextTime": { "type": "number", "description": "Next webhook execution try time", "example": 1653320900353 }, "timestamp": { "type": "number", "description": "Webhook execution time", "example": 1653320900353 }, "retryCount": { "type": "number", "description": "Number", "example": 3 }, "failed": { "type": "boolean", "description": "Flag indicating whether this webhook was successful or not", "example": false }, "response": { "type": "object", "description": "Response from the server in case the webhook was unsuccessful", "required": ["networkError"], "properties": { "code": { "type": "number", "description": "HTTP Status", "example": 500 }, "data": { "type": "string", "description": "Response from the server", "example": "Internal server error" }, "networkError": { "type": "boolean", "description": "Flag indicating whether an error has been caused by the network", "example": false } } } } }, "CreateSubscriptionBalance": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "ACCOUNT_BALANCE_LIMIT", "enum": ["ACCOUNT_BALANCE_LIMIT"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["limit", "typeOfBalance"], "properties": { "limit": { "type": "string", "description": "Limit to filter accounts with balance above it.", "example": "15000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "maxLength": 38 }, "typeOfBalance": { "type": "string", "description": "Type of balance to filter.", "enum": ["account", "available"] } } } } }, "CreateSubscriptionInterval": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "TRANSACTION_HISTORY_REPORT", "enum": ["TRANSACTION_HISTORY_REPORT"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["interval"], "properties": { "interval": { "type": "number", "description": "Number of hours to obtain transactions for.", "example": 1, "minimum": 1, "maximum": 720 } } } } }, "CreateSubscriptionIncoming": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "ACCOUNT_INCOMING_BLOCKCHAIN_TRANSACTION", "enum": ["ACCOUNT_INCOMING_BLOCKCHAIN_TRANSACTION"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["id", "url"], "properties": { "id": { "description": "ID of the account, on which the webhook will be applied, when new incoming blockchain transaction will be credited.", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "url": { "type": "string", "description": "URL of the endpoint, where HTTP POST request will be sent, when new incoming blockchain transaction will be credited.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "CreateSubscriptionNotification": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "ADDRESS_TRANSACTION", "enum": ["ADDRESS_TRANSACTION"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["chain", "address", "url"], "properties": { "address": { "description": "Blockchain address to watch.", "example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ", "maxLength": 128, "minLength": 13, "type": "string" }, "chain": { "description": "Blockchain of the address.", "example": "SOL", "type": "string", "enum": ["SOL", "ETH", "MATIC", "CELO", "KLAY", "BTC", "LTC", "BCH", "DOGE", "TRON", "BSC"] }, "url": { "type": "string", "description": "URL of the endpoint, where HTTP POST request will be sent, when transaction is detected on the address.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "CreateSubscriptionContractLogEvent": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "CONTRACT_LOG_EVENT", "enum": ["CONTRACT_LOG_EVENT"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["chain", "event", "url"], "properties": { "event": { "description": "Hexadecimal data representing the event emitted from the smart contract; represents \"topic[0,1,2,...]\" from the event log.", "example": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef", "maxLength": 66, "minLength": 66, "type": "string" }, "chain": { "description": "The blockchain on which events should be monitored.", "example": "MATIC", "type": "string", "enum": ["ETH", "MATIC", "CELO", "KLAY", "BSC"] }, "url": { "type": "string", "description": "The URL of the endpoint where an HTTP POST request will be sent when the block where the events from the smart contracts are reflected gets completed.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "CreateSubscriptionMultiTokenTransferEvent": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "CONTRACT_MULTITOKEN_TXS_PER_BLOCK", "enum": ["CONTRACT_MULTITOKEN_TXS_PER_BLOCK"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["chain", "url"], "properties": { "chain": { "description": "The blockchain on which events should be monitored.", "example": "MATIC", "type": "string", "enum": ["ETH", "MATIC", "CELO", "KLAY", "BSC"] }, "url": { "type": "string", "description": "The URL of the endpoint where an HTTP POST request will be sent when the block where the events from the smart contracts are reflected gets completed.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "CreateSubscriptionNftTransferEvent": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "CONTRACT_NFT_TXS_PER_BLOCK", "enum": ["CONTRACT_NFT_TXS_PER_BLOCK"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["chain", "url"], "properties": { "chain": { "description": "The blockchain on which events should be monitored.", "example": "MATIC", "type": "string", "enum": ["ETH", "MATIC", "CELO", "KLAY", "BSC"] }, "url": { "type": "string", "description": "The URL of the endpoint where an HTTP POST request will be sent when the block where the events from the smart contracts are reflected gets completed.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "CreateSubscriptionTradeMatch": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "CUSTOMER_TRADE_MATCH", "enum": ["CUSTOMER_TRADE_MATCH"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["id", "url"], "properties": { "id": { "description": "ID of the customer, on which the webhook will be applied, when on any of his accounts trade will be matched and closed.", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "url": { "type": "string", "description": "URL of the endpoint, where HTTP POST request will be sent, when on any of his accounts trade will be matched and closed.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "CreateSubscriptionPartialTradeMatch": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "CUSTOMER_PARTIAL_TRADE_MATCH", "enum": ["CUSTOMER_PARTIAL_TRADE_MATCH"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["id", "url"], "properties": { "id": { "description": "ID of the customer, on which the webhook will be applied, when on any of his accounts trade will be matched and closed.", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "url": { "type": "string", "description": "URL of the endpoint, where HTTP POST request will be sent, when on any of his accounts trade will be matched and closed.", "example": "https://webhook.tatum.io/trade", "maxLength": 500 } } } } }, "CreateSubscriptionKMSError": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "KMS_FAILED_TX", "enum": ["KMS_FAILED_TX"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["url"], "properties": { "url": { "type": "string", "description": "URL of the endpoint, where HTTP POST request will be sent, when error occurs inside Tatum KMS.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "CreateSubscriptionKMSSuccess": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "KMS_COMPLETED_TX", "enum": ["KMS_COMPLETED_TX"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["url"], "properties": { "url": { "type": "string", "description": "URL of the endpoint, where HTTP POST request will be sent, when tx is sucessfully broadcasted using Tatum KMS.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "CreateSubscriptionTxInTheBlock": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "TRANSACTION_IN_THE_BLOCK", "enum": ["TRANSACTION_IN_THE_BLOCK"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["url"], "properties": { "url": { "type": "string", "description": "URL of the endpoint, where HTTP POST request will be sent, when outgoing ledger transaction is included in the block.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "CreateSubscriptionPending": { "type": "object", "required": ["type", "attr"], "properties": { "type": { "type": "string", "description": "Type of the subscription.", "example": "ACCOUNT_PENDING_BLOCKCHAIN_TRANSACTION", "enum": ["ACCOUNT_PENDING_BLOCKCHAIN_TRANSACTION"] }, "attr": { "type": "object", "description": "Additional attributes based on the subscription type.", "required": ["id", "url"], "properties": { "id": { "description": "ID of the account, on which the webhook will be applied, when new incoming pending blockchain transaction with 0 confirmations will be credited.", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "url": { "type": "string", "description": "URL of the endpoint, where HTTP POST request will be sent, when new incoming pending blockchain transaction with 0 confirmations will be credited.", "example": "https://dashboard.tatum.io/webhook-handler", "maxLength": 500 } } } } }, "OffchainAddresses": { "type": "object", "required": ["addresses"], "properties": { "addresses": { "type": "array", "items": { "type": "object", "required": ["accountId"], "properties": { "accountId": { "description": "ID of the account, for which blockchain address will be created.", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "derivationKey": { "description": "Derivation key index for given address to generate. If not present, first not used address will be created.", "format": "int32", "type": "integer", "minimum": 0, "maximum": 2147483647 } } } } } }, "Address": { "required": ["address", "currency"], "properties": { "address": { "description": "Blockchain address.", "example": "7c21ed165e294db78b95f0f181086d6f", "type": "string" }, "currency": { "description": "Currency of generated address. BTC, LTC, DOGE, BCH, ETH, XRP, XLM, BNB, TRX, ERC20, TRC20.", "example": "BTC", "type": "string" }, "derivationKey": { "description": "Derivation key index for given address.", "format": "int32", "type": "integer", "maximum": 2147483647 }, "xpub": { "description": "Extended public key to derive address from. In case of XRP, this is account address, since address is defined as DestinationTag, which is address field. In case of XLM, this is account address, since address is defined as message, which is address field.", "example": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka", "type": "string" }, "destinationTag": { "description": "In case of XRP, destinationTag is the distinguisher of the account.", "type": "number", "example": 5 }, "memo": { "description": "In case of BNB, message is the distinguisher of the account.", "type": "string", "example": "5" }, "message": { "description": "In case of XLM, message is the distinguisher of the account.", "type": "string", "example": "5" } }, "type": "object" }, "Trade": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the trade", "example": "7c21ed165e294db78b95f0f1" }, "type": { "type": "string", "description": "Type of the trade, BUY or SELL", "example": "BUY", "enum": ["BUY", "SELL"] }, "price": { "type": "string", "description": "Price to buy / sell", "example": "8650.4" }, "amount": { "type": "string", "description": "Amount of the trade to be bought / sold", "example": "15000" }, "pair": { "type": "string", "description": "Trading pair", "example": "BTC/EUR" }, "isMaker": { "type": "boolean", "description": "If closed trade was Maker or Taker trade", "example": true }, "fill": { "type": "string", "description": "How much of the trade was already filled.", "example": "1500" }, "feeAccountId": { "type": "string", "description": "ID of the account where fee will be paid, if any. If trade is a BUY or FUTURE_BUY type, feeAccountId must have same currency as a currency of currency2AccountId, and vice versa if trade is a SELL or FUTURE_SELL type, feeAccountId must have same currency as a currency of currency1AccountId.", "example": "7c21ed165e294db78b95f0f1", "minLength": 24, "maxLength": 24 }, "fee": { "type": "number", "description": "Percentage of the trade amount to be paid as a fee.", "example": 1.5, "minimum": 0, "maximum": 100 }, "currency1AccountId": { "type": "string", "description": "ID of the account of the currenc 1 trade currency", "example": "7c21ed165e294db78b95f0f1" }, "currency2AccountId": { "type": "string", "description": "ID of the account of the currenc 2 trade currency", "example": "7c21ed165e294db78b95f0f1" }, "created": { "type": "number", "description": "Creation date, UTC millis", "example": 1585170363103 }, "attr": { "type": "object", "description": "Additional attributes for the future type.", "required": ["sealDate"], "properties": { "sealDate": { "type": "number", "description": "Time in UTC when the future will be filled.", "example": 1572031674384, "minimum": 0 }, "percentBlock": { "description": "Percentage of the future amount which the selling or buying account must have available for the future’s creation. This amount will be blocked until the future is filled or expires.", "type": "number", "example": 1.5, "minimum": 0, "maximum": 100 }, "percentPenalty": { "description": "If one of the parties doesn’t have the full amount of the future at the time of expiration filled, the party will be penalized.", "type": "number", "example": 1.5, "minimum": 0, "maximum": 100 } } } } }, "CreateTrade": { "type": "object", "required": ["type", "price", "amount", "pair", "currency1AccountId", "currency2AccountId", "attr"], "properties": { "type": { "type": "string", "description": "Type of the trade, BUY, SELL, FUTURE_BUY, FUTURE_SELL", "example": "BUY", "enum": ["BUY", "SELL", "FUTURE_BUY", "FUTURE_SELL"] }, "price": { "type": "string", "description": "Price to buy / sell", "example": "8650.4", "maxLength": 38, "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "amount": { "type": "string", "description": "Amount of the trade to be bought / sold", "example": "15000", "maxLength": 38, "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "pair": { "type": "string", "description": "Trading pair", "example": "BTC/EUR", "minLength": 3, "maxLength": 30, "pattern": "^[A-a-zZ0-9_\\-]+\\/[A-Za-z0-9_\\-]+$" }, "currency1AccountId": { "type": "string", "description": "ID of the account of the currency 1 trade currency", "example": "7c21ed165e294db78b95f0f1", "minLength": 24, "maxLength": 24 }, "currency2AccountId": { "type": "string", "description": "ID of the account of the currency 2 trade currency", "example": "7c21ed165e294db78b95f0f1", "minLength": 24, "maxLength": 24 }, "feeAccountId": { "type": "string", "description": "ID of the account where fee will be paid, if any. If trade is a BUY or FUTURE_BUY type, feeAccountId must have same currency as a currency of currency2AccountId, and vice versa if trade is a SELL or FUTURE_SELL type, feeAccountId must have same currency as a currency of currency1AccountId.", "example": "7c21ed165e294db78b95f0f1", "minLength": 24, "maxLength": 24 }, "fee": { "type": "number", "description": "Percentage of the trade amount to be paid as a fee.", "example": 1.5, "minimum": 0, "maximum": 100 }, "attr": { "type": "object", "description": "Additional attributes for the future type.", "required": ["sealDate"], "properties": { "sealDate": { "type": "number", "description": "Time in UTC when the future will be filled.", "example": 1572031674384, "minimum": 0 }, "percentBlock": { "description": "Percentage of the future amount which selling or buying account must have available on future creation. This amount will be blocked till future is filled or expires.", "example": 1.5, "minimum": 0, "maximum": 100 }, "percentPenalty": { "description": "If one of the parties dont have filled full amount of the future at the time of expiration, the party will be penalized. Penalty is sent to opposite party in exchanged crypto.", "example": 1.5, "minimum": 0, "maximum": 100 } } } } }, "BnbBlock": { "type": "object", "properties": { "timestamp": { "type": "number", "example": 1651145988650 }, "blockHeight": { "type": "number", "example": 44925860 }, "tx": { "type": "array", "items": { "$ref": "#/components/schemas/BnbTransaction" } } } }, "BnbTransaction": { "type": "object", "properties": { "txHash": { "type": "string", "example": "4B944BBF78F3ADE3A377551B5EA7AD0FEDBDA13165D932F94B106EF7A8E16C1A" }, "blockHeight": { "type": "number", "example": 44925860 }, "txType": { "type": "string", "example": "TRANSFER" }, "timeStamp": { "type": "string", "example": "2019-10-17T18:58:01.423Z" }, "fromAddr": { "type": "string", "example": "tbnb138u9djee6fwphhd2a3628q2h0j5w97yx48zqex" }, "toAddr": { "type": "string", "example": "tbnb14wu3a8pmauj2kjswyvxtvhdrjktx60efq227uw" }, "value": { "type": "string", "example": "200.00000000" }, "txAsset": { "type": "string", "example": "BNB" }, "txFee": { "type": "string", "example": "0.00037500" }, "code": { "type": "number", "example": 0 }, "memo": { "type": "string", "example": "" }, "source": { "type": "number", "example": 0 }, "sequence": { "type": "number" } } }, "BnbTx": { "type": "object", "properties": { "code": { "type": "number", "example": 0 }, "hash": { "type": "string", "example": "4B944BBF78F3ADE3A377551B5EA7AD0FEDBDA13165D932F94B106EF7A8E16C1A" }, "height": { "type": "string", "example": "44925860" }, "log": { "type": "string", "example": "Msg 0: " }, "ok": { "type": "boolean", "example": true }, "tx": { "properties": { "type": { "type": "string", "example": "auth/StdTx" }, "value": { "properties": { "memo": { "type": "string", "example": "" }, "msg": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cosmos-sdk/Send" }, "value": { "properties": { "inputs": { "description": "List of transactions, from which assets are being sent.", "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "tbnb138u9djee6fwphhd2a3628q2h0j5w97yx48zqex" }, "coins": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "string", "example": "20000000000" }, "denom": { "type": "string", "example": "BNB" } } } } } } }, "outputs": { "description": "List of recipient addresses and amounts to send to each of them.", "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "tbnb14wu3a8pmauj2kjswyvxtvhdrjktx60efq227uw" }, "coins": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "string", "example": "20000000000" }, "denom": { "type": "string", "example": "BNB" } } } } } } } }, "type": "object" } } } }, "signatures": { "type": "array", "items": { "type": "object", "properties": { "account_number": { "type": "string", "example": "14" }, "pub_key": { "properties": { "type": { "type": "string", "example": "tendermint/PubKeySecp256k1" }, "value": { "type": "string", "example": "A4q95eEn4cR1bbxVRqYc8pbLvKYyaMxjzaTSmkTJQUr6" } }, "type": "object" }, "sequence": { "type": "string", "example": "47816" }, "signature": { "type": "string", "example": "VhewxOCPucjrtrpRbQMbl05i5MyJMrw12nUJ4ATssB1qvCqIO2+Fgqa/WTHaYpkhjJuIbpK620e0zpIQ56a5nw==" } } } }, "source": { "type": "string", "example": "0" } }, "type": "object" } }, "type": "object" } } }, "BnbTxInAccount": { "type": "object", "properties": { "total": { "type": "number", "example": 10 }, "tx": { "type": "array", "items": { "$ref": "#/components/schemas/BnbTransaction" } } } }, "BnbAccount": { "type": "object", "properties": { "account_number": { "type": "number", "example": 696215 }, "address": { "type": "string", "example": "tbnb185tqzq3j6y7yep85lncaz9qeectjxqe5054cgn" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "free": { "type": "string", "example": "207.00000000" }, "frozen": { "type": "string", "example": "0.00000000" }, "locked": { "type": "string", "example": "0.00000000" }, "symbol": { "type": "string", "example": "BNB" } } } }, "flags": { "type": "number", "example": 0 }, "sequence": { "type": "number", "example": 0 } } }, "BtcBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of block.", "example": "00000000ca231a439a5c0a86a5a5dd6dc1918a8e897b96522fa9499288e70183" }, "height": { "description": "The number of blocks preceding a particular block on a block chain.", "type": "number", "example": 15235 }, "depth": { "description": "The number of blocks following a particular block on a block chain, including current one.", "type": "number", "example": 1567867 }, "version": { "type": "number", "description": "Block version.", "example": 1 }, "prevBlock": { "type": "string", "description": "Hash of the previous block.", "example": "000000006e79360d7b2519410fe5a73e8e08393fd7166620c73c711e4507d9fd" }, "merkleRoot": { "type": "string", "description": "The root node of a merkle tree, a descendant of all the hashed pairs in the tree.", "example": "480c227c5042377dbd54464d33e1f59c19fe02fe76d7f55b6955db438479aece" }, "time": { "type": "number", "description": "Time of the block.", "example": 1338861927 }, "bits": { "type": "number", "example": 486604799 }, "nonce": { "type": "number", "description": "Arbitrary number that is used in Bitcoin's proof of work consensus algorithm.", "example": 1193572362 }, "txs": { "type": "array", "items": { "$ref": "#/components/schemas/BtcTx" } } } }, "BtcInfo": { "type": "object", "properties": { "chain": { "type": "string", "description": "Chain of the blockchain, main or test.", "example": "test" }, "blocks": { "type": "number", "description": "Last block.", "example": 1579820 }, "headers": { "type": "number", "description": "Last headers.", "example": 1579820 }, "bestblockhash": { "description": "Hash of the last block.", "type": "string", "example": "0000000000000106e4c03ca093ce0cf77e796ddff4f3cadc59ca6b0380e3eed4" }, "difficulty": { "type": "number", "description": "Difficulty of the algorithm.", "example": 6522714.521250089 } } }, "BtcBasedBalance": { "type": "object", "properties": { "incoming": { "type": "string", "description": "Total sum of the assets that arrives to the address.", "example": "0.1234" }, "outgoing": { "type": "string", "description": "Total sum of the assets that leaves from the address.", "example": "0.1" } } }, "BtcTx": { "type": "object", "properties": { "hash": { "type": "string", "description": "Transaction hash.", "example": "4c7846a8ff8415945e96937dea27bdb3144c15d793648d725602784826052586" }, "witnessHash": { "type": "string", "description": "Witness hash in case of a SegWit transaction.", "example": "4c7846a8ff8415945e96937dea27bdb3144c15d793648d725602784826052586" }, "fee": { "type": "number", "description": "Fee paid for this transaction, in satoshis.", "example": 4540 }, "rate": { "type": "number", "example": 20088 }, "mtime": { "type": "number", "example": 1575663337 }, "blockNumber": { "type": "number", "description": "Height of the block this transaction belongs to.", "example": 1611609 }, "block": { "type": "string", "description": "Hash of the block this transaction belongs to.", "example": "00000000000001e13fe1eb3977f3379e3d0f6577fc6e087d27db46597ebddb8b" }, "time": { "type": "number", "description": "Time of the transaction.", "example": 1575663091 }, "index": { "type": "number", "description": "Index of the transaction in the block.", "example": 1 }, "version": { "type": "number", "description": "Index of the transaction.", "example": 2 }, "inputs": { "description": "List of transactions, from which assets are being sent.", "type": "array", "items": { "type": "object", "properties": { "prevout": { "properties": { "hash": { "type": "string", "description": "Transaction hash of the input.", "example": "60bc8445c11318e45a72a3259e65118d2f352568757e6ceb8bf1b527ce68379f" }, "index": { "type": "number", "description": "Transaction index of the input.", "example": 1 } }, "type": "object" }, "script": { "type": "string", "description": "Data generated by a spender which is almost always used as variables to satisfy a pubkey script.", "example": "1600148c65244f095f3689aebb70981d102e33036fe786" }, "witness": { "type": "string", "description": "Transaction witness.", "example": "0247304402207d7af97665ef5502c957f76a9fcdde2c228b6a8dc9951d45c318e6dfca0fcd2802207519528d6b61cc044800ab2cb499ef5f31d4decdc327c14fad4abbc3dd6e0190012102861d682cfd3bec8cbed98f5162299ba613bc5f352dd0d51961a5d81359fbc0af" }, "sequence": { "type": "number", "example": 4294967294 }, "coin": { "properties": { "version": { "type": "number", "example": 2 }, "blockNumber": { "type": "number", "example": 1611608 }, "value": { "type": "number", "description": "Amount of the transaction, in Satoshis (1 BTC = 100 000 000 Satoshis)", "example": 1341956178 }, "script": { "type": "string", "example": "0014049a97d91d4e1123899bf48c5ba6ce3fd959664e" }, "address": { "type": "string", "description": "Sender address.", "example": "tb1qqjdf0kgafcgj8zvm7jx9hfkw8lv4jejw6wsmjg" }, "coinbase": { "type": "boolean", "description": "Coinbase transaction - miner fee.", "example": false } }, "type": "object" } } } }, "outputs": { "type": "array", "description": "List of recipient addresses and amounts to send to each of them.", "items": { "type": "object", "properties": { "value": { "type": "number", "description": "Sent amount in satoshis.", "example": 2068942 }, "script": { "type": "string", "description": "Transaction script.", "example": "a914eaf2ad7e161c3ce7092bde14dc5842b642fe925187" }, "address": { "type": "string", "description": "Recipient address.", "example": "2NEfWpiQwLEcHGbX2Fwij16NDxTEZwHk4BH" } } } }, "locktime": { "type": "number", "description": "Block this transaction was included in.", "example": 1611608 } } }, "BtcUTXO": { "type": "object", "properties": { "version": { "type": "number", "description": "The version of the transaction", "example": 1 }, "height": { "type": "number", "description": "The height (number) of the block where the transaction is included in", "example": 210000 }, "value": { "type": "number", "description": "The amount of the UTXO (in satoshis)", "example": 30000000 }, "script": { "type": "string", "description": "Data generated by the spender; is almost always used as variables to satisfy the conditions in the pubkey script", "example": "76a91400ba915c3d18907b79e6cfcd8b9fdf69edc7a7db88ac" }, "address": { "type": "string", "description": "The blockchain address of the UTXO owner", "example": "R9M3aUWCcKoiqDPusJvqNkAbjffLgCqYip" }, "coinbase": { "type": "boolean", "description": "If set to \"true\", the transaction is a coinbase transaction (a transaction created by a Bitcoin miner to collect their reward)", "example": false }, "hash": { "type": "string", "description": "The hash of the transaction", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc" }, "index": { "type": "number", "description": "The index of the transaction output checked for the UTXO", "example": 0 } } }, "FeeAndChange": { "type": "object", "required": ["changeAddress"], "properties": { "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf", "minimum": 30, "maximum": 110 }, "fee": { "type": "string", "description": "Fee to be paid.", "example": "0.5" } } }, "AdaTransactionFromAddress": { "allOf": [ { "$ref": "#/components/schemas/FeeAndChange" }, { "$ref": "#/components/schemas/BtcTransactionFromAddress" } ] }, "AdaTransactionFromUTXO": { "allOf": [ { "$ref": "#/components/schemas/FeeAndChange" }, { "$ref": "#/components/schemas/BtcTransactionFromUTXO" } ] }, "AdaTransactionFromAddressKMS": { "allOf": [ { "$ref": "#/components/schemas/FeeAndChange" }, { "$ref": "#/components/schemas/BtcTransactionFromAddressKMS" } ] }, "AdaTransactionFromUTXOKMS": { "allOf": [ { "$ref": "#/components/schemas/FeeAndChange" }, { "$ref": "#/components/schemas/BtcTransactionFromUTXOKMS" } ] }, "BtcTransactionFromAddress": { "type": "object", "required": ["to", "fromAddress"], "properties": { "fromAddress": { "description": "Array of addresses and corresponding private keys. Tatum will automatically scan last 100 transactions for each address and will use all of the unspent values. We advise to use this option if you have 1 address per 1 transaction only.", "type": "array", "items": { "type": "object", "required": ["address", "privateKey"], "properties": { "address": { "description": "Address to send assets from.", "type": "string", "example": "2N9bBiH2qrTDrPCzrNhaFGdkNKS86PJAAAS", "minimum": 30, "maximum": 50 }, "privateKey": { "description": "Private key of the address to send assets from. Private key, or signature Id must be present.", "type": "string", "minimum": 52, "maximum": 52, "example": "cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf" } } } }, "to": { "description": "Array of addresses and values to send bitcoins to. Values must be set in BTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in BTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in BTC.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 } } }, "BtcTransactionFromUTXO": { "type": "object", "required": ["to", "fromUTXO"], "properties": { "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "index", "privateKey"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 }, "privateKey": { "description": "Private key of the UTXO to be spent.", "type": "string", "example": "cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf", "minLength": 52, "maxLength": 52 } } } }, "to": { "description": "Array of addresses and values to send bitcoins to. Values must be set in BTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in BTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in BTC.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 } } }, "BtcTransactionFromAddressKMS": { "type": "object", "required": ["to", "fromAddress"], "properties": { "fromAddress": { "description": "Array of addresses and corresponding private keys. Tatum will automatically scan last 100 transactions for each address and will use all of the unspent values. We advise to use this option if you have 1 address per 1 transaction only.", "type": "array", "items": { "type": "object", "required": ["address", "signatureId"], "properties": { "signatureId": { "type": "string", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "address": { "description": "Address to send assets from.", "type": "string", "example": "2N9bBiH2qrTDrPCzrNhaFGdkNKS86PJAAAS", "minimum": 30, "maximum": 50 }, "index": { "description": "Index of the SignatureId (mnemonic with-index).", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 } } } }, "to": { "description": "Array of addresses and values to send bitcoins to. Values must be set in BTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in BTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in BTC.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 } } }, "BtcTransactionFromUTXOKMS": { "type": "object", "required": ["to", "fromUTXO"], "properties": { "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "signatureId", "index"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 }, "signatureId": { "type": "string", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "description": "Identifier of the private key associated in signing application." } } } }, "to": { "description": "Array of addresses and values to send bitcoins to. Values must be set in BTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in BTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in BTC.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 } } }, "BchBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of block.", "example": "000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201" }, "size": { "type": "number", "description": "Block size.", "example": 81577 }, "height": { "type": "number", "description": "The number of blocks preceding a particular block on a block chain.", "example": 500000 }, "version": { "type": "number", "description": "Block version.", "example": 536870912 }, "merkleroot": { "type": "string", "description": "The root node of a merkle tree, a descendant of all the hashed pairs in the tree.", "example": "4af279645e1b337e655ae3286fc2ca09f58eb01efa6ab27adedd1e9e6ec19091" }, "tx": { "type": "array", "description": "List of transactions present in the block.", "items": { "$ref": "#/components/schemas/BchTx" } }, "time": { "type": "number", "description": "Time of the block.", "example": 1509343584 }, "nonce": { "type": "number", "description": "Arbitrary number that is used in Bitcoin's proof of work consensus algorithm.", "example": 3604508752 }, "difficulty": { "type": "number", "example": 113081236211.45331 }, "confirmations": { "type": "number", "description": "Number of blocks mined after this block.", "example": 109602 }, "previousblockhash": { "type": "string", "description": "Hash of the previous block.", "example": "0000000000000000043831d6ebb013716f0580287ee5e5687e27d0ed72e6e523" }, "nextblockhash": { "type": "string", "description": "Hash of the next block.", "example": "00000000000000000568f0a96bf4348847bc84e455cbfec389f27311037a20f3" } } }, "BchInfo": { "type": "object", "properties": { "chain": { "type": "string", "description": "Chain of the blockchain, main or test.", "example": "main" }, "blocks": { "type": "number", "description": "Last block.", "example": 609604 }, "bestblockhash": { "type": "string", "description": "Hash of the last block.", "example": "0000000000000000024997c878c5a90bd73cd50060877c4f70eef1f2e92243f5" }, "difficulty": { "type": "number", "description": "Difficulty of the PoW algorithm.", "example": 375206303347.133 } } }, "BchTransaction": { "type": "object", "required": ["to", "fromUTXO"], "properties": { "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "index", "privateKey"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 }, "privateKey": { "description": "Private key of the UTXO to be spent. Private key, or signature Id must be present.", "type": "string", "example": "cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf", "minLength": 52, "maxLength": 52 } } } }, "to": { "description": "Array of addresses and values to send bitcoins to. Values must be set in BCH. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in BCH.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in BCH.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez", "minimum": 30, "maximum": 60 } } }, "BchTransactionKMS": { "type": "object", "required": ["to", "fromUTXO"], "properties": { "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "index", "signatureId"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 }, "signatureId": { "type": "string", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." } } } }, "to": { "description": "Array of addresses and values to send bitcoins to. Values must be set in BCH. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in BCH.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in BCH.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez", "minimum": 30, "maximum": 60 } } }, "BchTx": { "type": "object", "properties": { "txid": { "type": "string", "example": "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" }, "version": { "type": "number", "example": 1 }, "locktime": { "type": "number", "example": 0 }, "vin": { "type": "array", "items": { "type": "object", "properties": { "txid": { "type": "string", "example": "eea57285462dd70dadcd431fc814857b3f81fe4d0a059a8c02c12fd7d33c02d1" }, "vout": { "type": "number", "example": 0 }, "scriptSig": { "properties": { "hex": { "type": "string", "example": "48304502210083753ff9954579f1062d60905650d5d07f50dedc96f9425403b80957f199e1ee022053625597b069c48ed29f8825bd3c8f66757ccaa21a7bb49314eae4eca1fb8d7041210299b1eedeb115b5880cd5e0df0717bd982748a8e003e34371dc36301e17ee0ed6" }, "asm": { "type": "string", "example": "304502210083753ff9954579f1062d60905650d5d07f50dedc96f9425403b80957f199e1ee022053625597b069c48ed29f8825bd3c8f66757ccaa21a7bb49314eae4eca1fb8d70[ALL|FORKID] 0299b1eedeb115b5880cd5e0df0717bd982748a8e003e34371dc36301e17ee0ed6" } }, "type": "object" }, "coinbase": { "type": "string", "example": "04ffff001d02fd04" }, "sequence": { "type": "number", "example": 2147483647 } } } }, "vout": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "example": "50.00000000" }, "n": { "type": "number", "example": 0 }, "scriptPubKey": { "properties": { "hex": { "type": "string", "example": "4104f5eeb2b10c944c6b9fbcfff94c35bdeecd93df977882babc7f3a2cf7f5c81d3b09a68db7f0e04f21de5d4230e75e6dbe7ad16eefe0d4325a62067dc6f369446aac" }, "asm": { "type": "string", "example": "04f5eeb2b10c944c6b9fbcfff94c35bdeecd93df977882babc7f3a2cf7f5c81d3b09a68db7f0e04f21de5d4230e75e6dbe7ad16eefe0d4325a62067dc6f369446a OP_CHECKSIG" }, "addresses": { "type": "array", "items": { "type": "string" }, "example": ["1BW18n7MfpU35q4MTBSk8pse3XzQF8XvzT"] }, "type": { "type": "string", "example": "pubkeyhash" } }, "type": "object" } } } } } }, "DogeInfo": { "type": "object", "properties": { "chain": { "type": "string", "description": "Chain of the blockchain, main or test.", "example": "test" }, "blocks": { "type": "number", "description": "Last block.", "example": 1234314 }, "headers": { "type": "number", "description": "Last headers.", "example": 1234314 }, "bestblockhash": { "type": "string", "description": "Hash of the last block.", "example": "6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078" }, "difficulty": { "type": "number", "description": "Difficulty of the PoW algorithm.", "example": 0.0018856935093586335 } } }, "DogeBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of block.", "example": "6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078" }, "height": { "type": "number", "description": "The number of blocks preceding a particular block on a block chain.", "example": 1234314 }, "size": { "type": "number", "description": "The size of the block.", "example": 1234314 }, "confirmations": { "type": "number", "description": "Number of confirmations of that block.", "example": 1234314 }, "weight": { "type": "number", "description": "The weight of the block.", "example": 1234314 }, "version": { "type": "number", "example": 536870912, "description": "Block version." }, "previousblockhash": { "type": "string", "description": "Hash of the previous block.", "example": "a3047a060e5d586a9b26779ebe62fc57ce7323745da8f28761ab755454d89c52" }, "merkleRoot": { "type": "string", "description": "The root node of a merkle tree, a descendant of all the hashed pairs in the tree.", "example": "a1634a42a8e956a5fb5225d06c3af6207e7f6fe5a00fa45229edfd0ddfa587f0" }, "time": { "type": "number", "description": "Time of the block.", "example": 1572865501 }, "bits": { "type": "number", "example": 503452237 }, "nonce": { "type": "number", "description": "Arbitrary number that is used in Litecoin's proof of work consensus algorithm.", "example": 2278594841 }, "txs": { "type": "array", "items": { "$ref": "#/components/schemas/DogeTx" } } } }, "DogeTx": { "type": "object", "properties": { "hash": { "type": "string", "description": "Transaction hash.", "example": "5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a" }, "size": { "type": "number", "description": "Size of the transaction.", "example": 145 }, "vsize": { "type": "number", "example": 145 }, "version": { "type": "number", "description": "Index of the transaction.", "example": 2 }, "vin": { "description": "List of transactions, from which assets are being sent.", "type": "array", "items": { "type": "object", "properties": { "txid": { "type": "string", "description": "Transaction hash of the input.", "example": "0db5a2881f26f7dce20222f9c2538dc296ab562e134a72052596bdf4bb6913b4" }, "vout": { "type": "number", "description": "Transaction index of the input.", "example": 1 }, "scriptSig": { "type": "object", "properties": { "asm": { "type": "string" }, "hex": { "type": "string" } } }, "sequence": { "type": "number", "example": 4294967294 } } } }, "vout": { "description": "List of recipient addresses and amounts to send to each of them.", "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number", "description": "Amount of UTXO in 1/1000000 DOGE.", "example": 1000 }, "n": { "type": "number", "description": "Transaction index of the output.", "example": 1 }, "scriptPubKey": { "type": "object", "properties": { "asm": { "type": "string", "example": "OP_HASH160 905c261d73922a21a16f505cefccaa07aaee50cd OP_EQUAL" }, "hex": { "type": "string", "example": "a914905c261d73922a21a16f505cefccaa07aaee50cd87" }, "type": { "type": "string", "example": "scripthash" }, "addresses": { "type": "array", "items": { "type": "string", "description": "Recipient address.", "example": "n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or" } } } } } } }, "locktime": { "type": "number", "example": 1233222 } } }, "DogeUTXO": { "type": "object", "properties": { "scriptPubKey": { "type": "object", "properties": { "asm": { "type": "string", "example": "OP_HASH160 905c261d73922a21a16f505cefccaa07aaee50cd OP_EQUAL" }, "hex": { "type": "string", "example": "a914905c261d73922a21a16f505cefccaa07aaee50cd87" }, "type": { "type": "string", "example": "scripthash" }, "addresses": { "type": "array", "items": { "type": "string", "description": "Recipient address.", "example": "n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or" } } } }, "version": { "type": "number", "description": "Version of the UTXO.", "example": 2 }, "height": { "type": "number", "example": 1233224 }, "value": { "type": "number", "description": "Amount of UTXO in 1/1000000 DOGE.", "example": 1000 }, "coinbase": { "type": "boolean", "description": "Coinbase transaction - miner fee.", "example": false }, "bestblock": { "type": "string", "description": "Block hash.", "example": "5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a" } } }, "DogeTransactionUTXOKMS": { "type": "object", "required": ["to", "fromUTXO"], "properties": { "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "value", "address", "index", "signatureId"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "value": { "type": "string", "description": "Sent amount in DOGE.", "example": "0.0015" }, "address": { "description": "Receiving address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 }, "signatureId": { "type": "string", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." } } } }, "to": { "description": "Array of addresses and values to send Litecoins to. Values must be set in LTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in DOGE.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in DOGE.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 } } }, "DogeTransactionUTXO": { "type": "object", "required": ["to", "fromUTXO", "fee", "changeAddress"], "properties": { "fee": { "type": "string", "description": "Fee to be paid in DOGE.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "index", "privateKey", "value", "address"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "value": { "type": "string", "description": "Sent amount in DOGE.", "example": "0.0015" }, "address": { "description": "Receiving address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 }, "privateKey": { "description": "Private key of the UTXO to be spent. Private key, or signature Id must be present.", "type": "string", "example": "cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf", "minLength": 52, "maxLength": 52 } } } }, "to": { "description": "Array of addresses and values to send Litecoins to. Values must be set in LTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in DOGE.", "type": "number", "minimum": 0, "example": 0.02969944 } } } } } }, "LtcInfo": { "type": "object", "properties": { "chain": { "type": "string", "description": "Chain of the blockchain, main or test.", "example": "test" }, "blocks": { "type": "number", "description": "Last block.", "example": 1234314 }, "headers": { "type": "number", "description": "Last headers.", "example": 1234314 }, "bestblockhash": { "type": "string", "description": "Hash of the last block.", "example": "6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078" }, "difficulty": { "type": "number", "description": "Difficulty of the PoW algorithm.", "example": 0.0018856935093586335 } } }, "LtcBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of block.", "example": "6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078" }, "blockNumber": { "type": "number", "description": "The number of blocks preceding a particular block on a block chain.", "example": 1234314 }, "version": { "type": "number", "example": 536870912, "description": "Block version." }, "prevBlock": { "type": "string", "description": "Hash of the previous block.", "example": "a3047a060e5d586a9b26779ebe62fc57ce7323745da8f28761ab755454d89c52" }, "merkleRoot": { "type": "string", "description": "The root node of a merkle tree, a descendant of all the hashed pairs in the tree.", "example": "a1634a42a8e956a5fb5225d06c3af6207e7f6fe5a00fa45229edfd0ddfa587f0" }, "time": { "type": "number", "description": "Time of the block.", "example": 1572865501 }, "bits": { "type": "number", "example": 503452237 }, "nonce": { "type": "number", "description": "Arbitrary number that is used in Litecoin's proof of work consensus algorithm.", "example": 2278594841 }, "txs": { "type": "array", "items": { "$ref": "#/components/schemas/LtcTx" } } } }, "LtcTx": { "type": "object", "properties": { "hash": { "type": "string", "description": "Transaction hash.", "example": "5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a" }, "witnessHash": { "type": "string", "description": "Witness hash in case of a SegWit transaction.", "example": "d819688a3ac77cb6d2751808e5411baf7e20fa3eeeccf65867554a09beddd9a3" }, "fee": { "type": "string", "description": "Fee paid for this transaction, in LTC.", "example": "0.00001682" }, "rate": { "type": "string", "example": "0.00010011" }, "ps": { "type": "number", "example": 1572703011 }, "blockNumber": { "type": "number", "description": "Height of the block this transaction belongs to.", "example": 1233224 }, "block": { "type": "string", "description": "Hash of the block this transaction belongs to.", "example": "b540bf37450eae0fb9fb7f190009ca890f0dd17cb19521c6241a0dc5e70f67dc" }, "ts": { "type": "number", "description": "Time of the transaction.", "example": 1572694484 }, "index": { "type": "number", "description": "Index of the transaction in the block.", "example": 2 }, "version": { "type": "number", "description": "Index of the transaction.", "example": 2 }, "flag": { "type": "number", "example": 1 }, "inputs": { "description": "List of transactions, from which assets are being sent.", "type": "array", "items": { "type": "object", "properties": { "prevout": { "properties": { "hash": { "type": "string", "description": "Transaction hash of the input.", "example": "0db5a2881f26f7dce20222f9c2538dc296ab562e134a72052596bdf4bb6913b4" }, "index": { "type": "number", "description": "Transaction index of the input.", "example": 1 } }, "type": "object" }, "script": { "type": "string", "description": "Data generated by a spender which is almost always used as variables to satisfy a pubkey script.", "example": "1600148c65244f095f3689aebb70981d102e33036fe786" }, "witness": { "type": "string", "description": "Transaction witness.", "example": "0247304402202cad8f03fd061fbdd19d285f528dd7451c3818f4a1d0f5f9f559f141fb910c6e02203fb62fc770cf54ae53e4b488b589f9f096d28c1bd24dc8e4d80783dd58041826012102c44d21e840b24c786a7eff2980e35f51c4abcc9a032e7a132ca258f90ee4a19d" }, "sequence": { "type": "number", "example": 4294967294 }, "coin": { "properties": { "version": { "type": "number", "example": 2 }, "height": { "type": "number", "example": 1232869 }, "value": { "type": "string", "description": "Value of the transaction, in LTC.", "example": "0.0989946" }, "script": { "type": "string", "example": "a91472593295cfe5e7ea466e43822167cabcb2cb103387" }, "address": { "type": "string", "description": "Sender address.", "example": "2N3fqsiA5Nk4pZGWcfZApATGhXfn9B74oXK" }, "coinbase": { "type": "boolean", "description": "Coinbase transaction - miner fee.", "example": false } }, "type": "object" } } } }, "outputs": { "description": "List of recipient addresses and amounts to send to each of them.", "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "Sent amount in LTC.", "example": "0.0015" }, "script": { "type": "string", "description": "Transaction script.", "example": "76a914fc8f50c952da910f473a0533561311ad140c989b88ac" }, "address": { "type": "string", "description": "Recipient address.", "example": "n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or" } } } }, "locktime": { "type": "number", "description": "Block this transaction was included in.", "example": 1233222 } } }, "LtcUTXO": { "type": "object", "properties": { "version": { "type": "number", "description": "Version of the UTXO.", "example": 2 }, "height": { "type": "number", "example": 1233224 }, "value": { "type": "number", "description": "Amount of UTXO in satoshis.", "example": 30000000 }, "script": { "type": "string", "description": "Data generated by a spender which is almost always used as variables to satisfy a pubkey script.", "example": "76a914fc8f50c952da910f473a0533561311ad140c989b88ac" }, "address": { "type": "string", "description": "Address of the owner of the UTXO.", "example": "n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or" }, "coinbase": { "type": "boolean", "description": "Coinbase transaction - miner fee.", "example": false }, "hash": { "type": "string", "description": "Transaction hash.", "example": "5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a" }, "index": { "type": "number", "description": "Transaction index of the output.", "example": 0 } } }, "LtcTransactionAddress": { "type": "object", "required": ["to", "fromAddress"], "properties": { "fromAddress": { "description": "Array of addresses and corresponding private keys. Tatum will automatically scan last 100 transactions for each address and will use all of the unspent values. We advise to use this option if you have 1 address per 1 transaction only.", "type": "array", "items": { "type": "object", "required": ["address", "privateKey"], "properties": { "address": { "description": "Address to send assets from.", "type": "string", "minimum": 30, "maximum": 50, "example": "2N9bBiH2qrTDrPCzrNhaFGdkNKS86PJAAAS" }, "privateKey": { "description": "Private key of the address to send assets from. Private key, or signature Id must be present.", "type": "string", "minimum": 52, "maximum": 52, "example": "cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf" } } } }, "to": { "description": "Array of addresses and values to send Litecoins to. Values must be set in LTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in LTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in LTC.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 } } }, "LtcTransactionUTXO": { "type": "object", "required": ["to", "fromUTXO"], "properties": { "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "index", "privateKey"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 }, "privateKey": { "description": "Private key of the UTXO to be spent. Private key, or signature Id must be present.", "type": "string", "example": "cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf", "minLength": 52, "maxLength": 52 } } } }, "to": { "description": "Array of addresses and values to send Litecoins to. Values must be set in LTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in LTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in LTC.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 } } }, "LtcTransactionAddressKMS": { "type": "object", "required": ["to", "fromAddress"], "properties": { "fromAddress": { "description": "Array of addresses and corresponding private keys. Tatum will automatically scan last 100 transactions for each address and will use all of the unspent values. We advise to use this option if you have 1 address per 1 transaction only.", "type": "array", "items": { "type": "object", "required": ["address", "signatureId"], "properties": { "address": { "description": "Address to send assets from.", "type": "string", "minimum": 30, "maximum": 50, "example": "2N9bBiH2qrTDrPCzrNhaFGdkNKS86PJAAAS" }, "signatureId": { "type": "string", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "description": "Index of the SignatureId (mnemonic with-index).", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 } } } }, "to": { "description": "Array of addresses and values to send Litecoins to. Values must be set in LTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in LTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in LTC.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 } } }, "LtcTransactionUTXOKMS": { "type": "object", "required": ["to", "fromUTXO"], "properties": { "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "index", "signatureId"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 }, "signatureId": { "type": "string", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." } } } }, "to": { "description": "Array of addresses and values to send Litecoins to. Values must be set in LTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in LTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } }, "fee": { "type": "string", "description": "Fee to be paid in LTC.", "example": "0.0015" }, "changeAddress": { "description": "Address, where unspent funds will be transferred.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 } } }, "AdaBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of block.", "example": "6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078" }, "number": { "type": "number", "description": "The number of blocks preceding a particular block on a block chain.", "example": 1234314 }, "epochNo": { "type": "number", "example": 536870912, "description": "Number of the epoch the block is included in." }, "slotNo": { "type": "number", "description": "Number of the slot the block is included in.", "example": "a3047a060e5d586a9b26779ebe62fc57ce7323745da8f28761ab755454d89c52" }, "merkleRoot": { "type": "string", "description": "The root node of a merkle tree, a descendant of all the hashed pairs in the tree.", "example": "a1634a42a8e956a5fb5225d06c3af6207e7f6fe5a00fa45229edfd0ddfa587f0" }, "forgedAt": { "type": "string", "description": "Time of the block.", "example": "2020-10-20T08:21:50.107Z" }, "fees": { "type": "number", "description": "Sum of fees paid in the block.", "example": 503452237 }, "slotInEpoch": { "type": "number", "description": "Number of the slot in the epoch.", "example": 2278594841 }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/AdaTx" } } } }, "AdaTx": { "type": "object", "properties": { "hash": { "type": "string", "description": "Transaction hash.", "example": "5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a" }, "fee": { "type": "string", "description": "Fee paid for this transaction, in LTC.", "example": "0.00001682" }, "block": { "type": "number", "description": "Index of the block this transaction belongs to.", "example": 1233224 }, "includedAt": { "type": "string", "description": "Time of the transaction.", "example": "2020-10-20T08:21:50.107Z" }, "inputs": { "description": "List of transactions, from which assets are being sent.", "type": "array", "items": { "type": "object", "properties": { "txHash": { "type": "string", "description": "Transaction hash of the input.", "example": "0db5a2881f26f7dce20222f9c2538dc296ab562e134a72052596bdf4bb6913b4" }, "sourceTxHash": { "type": "string", "description": "Transaction hash of the source transaction input.", "example": "0db5a2881f26f7dce20222f9c2538dc296ab562e134a72052596bdf4bb6913b4" }, "sourceTxIndex": { "type": "number", "description": "Transaction index of the input.", "example": 1 }, "value": { "type": "string", "description": "Value of the transaction, in Lovelace - 1/1000000 of ADA.", "example": "989946" }, "address": { "type": "string", "description": "Sender address.", "example": "addr1qxm3vd0msv9ph8elhy7xrv975z88y6lr3d8vdgy3fwr2e22uvu2ffa2ctx3pdl4rjjja5p7al2k356x5yx8cn03am88s2807d9" } } } }, "outputs": { "description": "List of recipient addresses and amounts to send to each of them.", "type": "array", "items": { "$ref": "#/components/schemas/AdaUTXO" } } } }, "AdaUTXO": { "type": "object", "properties": { "value": { "type": "string", "description": "Sent amount in Lovelace - 1/1000000 of ADA.", "example": "15000" }, "index": { "type": "number", "description": "Index of the output in the transaction.", "example": 1 }, "txHash": { "type": "string", "description": "Transaction hash.", "example": "76a914fc8f50c952da910f473a0533561311ad140c989b88ac" }, "address": { "type": "string", "description": "Recipient address.", "example": "addr1qxm3vd0msv9ph8elhy7xrv975z88y6lr3d8vdgy3fwr2e22uvu2ffa2ctx3pdl4rjjja5p7al2k356x5yx8cn03am88s2807d9" } } }, "AdaAccount": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "utxosCount": { "type": "number", "description": "Count of UTXOs transaction." }, "assetBalances": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Id of the asset." }, "assetName": { "type": "string", "description": "Name of the asset." }, "name": { "type": "string", "description": "Name of the asset." }, "description": { "type": "string", "description": "Description of the asset." }, "logo": { "type": "string", "description": "Logo of the asset." }, "metadataHash": { "type": "string", "description": "Metadata hash of the asset." }, "url": { "type": "string", "description": "Url of the asset." } } }, "quantity": { "type": "string", "description": "Quantity of the asset." } } } } } } } }, "AdaTransaction": { "type": "object", "required": ["to"], "properties": { "fromAddress": { "description": "Array of addresses and corresponding private keys. Tatum will automatically scan last unspent transactions for each address and will use all of the unspent values. We advise to use this option if you have 1 address per 1 transaction only.", "type": "array", "items": { "type": "object", "required": ["address"], "properties": { "address": { "description": "Address to send assets from.", "type": "string", "minimum": 30, "maximum": 150, "example": "addr1qxm3vd0msv9ph8elhy7xrv975z88y6lr3d8vdgy3fwr2e22uvu2ffa2ctx3pdl4rjjja5p7al2k356x5yx8cn03am88s2807d9" }, "privateKey": { "description": "Private key of the address to send assets from. Private key, or signature Id must be present.", "type": "string", "minimum": 192, "maximum": 192, "example": "7808a501e1bbc9926ac8ac6981e47cb0401288ae331a1f2333d1bed46c5b3051b5f875c39477b05bc3a43a3800b763f616ae3646f21df0ab5d95db944e71f5cfa8082d5c4e6241d49b17b2b6173f01bb3fd03be012cc8908ceea9e559e33e4fc" }, "signatureId": { "type": "string", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." } } } }, "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "index"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 }, "privateKey": { "description": "Private key of the UTXO to be spent. Private key, or signature Id must be present.", "type": "string", "example": "7808a501e1bbc9926ac8ac6981e47cb0401288ae331a1f2333d1bed46c5b3051b5f875c39477b05bc3a43a3800b763f616ae3646f21df0ab5d95db944e71f5cfa8082d5c4e6241d49b17b2b6173f01bb3fd03be012cc8908ceea9e559e33e4fc", "minLength": 192, "maxLength": 192 }, "signatureId": { "type": "string", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." } } } }, "to": { "description": "Array of addresses and values to send Litecoins to. Values must be set in LTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "addr1qxm3vd0msv9ph8elhy7xrv975z88y6lr3d8vdgy3fwr2e22uvu2ffa2ctx3pdl4rjjja5p7al2k356x5yx8cn03am88s2807d9", "minimum": 30, "maximum": 150 }, "value": { "description": "Amount to be sent, in ADA.", "type": "number", "minimum": 0, "example": 0.029609 } } } } } }, "AdaInfo": { "type": "object", "properties": { "testnet": { "type": "string", "description": "Chain of the blockchain, main or test.", "example": "test" }, "tip": { "type": "object", "properties": { "number": { "type": "number", "description": "Last block.", "example": 2749845 }, "slotNo": { "type": "number", "description": "Last slot number.", "example": 31798572 }, "epoch": { "type": "object", "properties": { "number": { "type": "number", "description": "Last epoch number.", "example": 143 } } } } } } }, "Blockage": { "properties": { "id": { "description": "ID of the blockage.", "type": "string", "example": "5e68c66581f2ee32bc354087" }, "accountId": { "description": "ID of the account this blockage is for.", "type": "string", "example": "5e68c66581f2ee32bc354087" }, "amount": { "description": "Amount blocked on account.", "example": "5", "type": "string" }, "type": { "description": "Type of blockage.", "type": "string", "example": "DEBIT_CARD_OP" }, "description": { "description": "Description of blockage.", "type": "string", "example": "Card payment in the shop." } } }, "BlockAmount": { "properties": { "amount": { "description": "Amount to be blocked on account.", "maxLength": 38, "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "example": "5", "type": "string" }, "type": { "description": "Type of blockage.", "type": "string", "minLength": 1, "maxLength": 100, "example": "DEBIT_CARD_OP" }, "description": { "description": "Description of blockage.", "type": "string", "minLength": 1, "maxLength": 300, "example": "Card payment in the shop." } }, "required": ["amount", "type"], "type": "object" }, "BroadcastKMS": { "properties": { "txData": { "description": "Raw signed transaction to be published to network.", "example": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D", "maxLength": 500000, "minLength": 1, "type": "string" }, "signatureId": { "description": "ID of prepared payment template to sign. Required only, when broadcasting transaction signed by Tatum KMS.", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "type": "string" } }, "required": ["txData"], "type": "object" }, "HmacWebHook": { "properties": { "hmacSecret": { "description": "Your HMAC secret password, which is used for signing the webhook payload.", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "type": "string", "maxLength": 100 } }, "required": ["hmacSecret"], "type": "object" }, "Broadcast": { "properties": { "txData": { "description": "Raw signed transaction to be published to network.", "example": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D", "maxLength": 500000, "minLength": 1, "type": "string" }, "signatureId": { "type": "string", "minLength": 24, "maxLength": 24, "example": "5e68c66581f2ee32bc354087", "description": "Identifier of KMS pending transaction ID to be completed with the broadcast." } }, "required": ["txData"], "type": "object" }, "BroadcastResponse": { "properties": { "completed": { "description": "Flag, if withdrawal is successfully completed within Tatum systems.", "example": true, "type": "boolean" }, "txId": { "description": "Transaction ID of broadcast transaction and status", "example": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D", "type": "string" } }, "type": "object" }, "BroadcastWithdrawal": { "properties": { "currency": { "description": "Currency of signed transaction to be broadcast, BTC, LTC, DOGE, BNB, XLM, TRX, BCH, ETH, XRP, ERC20, TRC20", "example": "BTC", "maxLength": 40, "minLength": 2, "type": "string" }, "txData": { "description": "Raw signed transaction to be published to network.", "example": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D", "maxLength": 500000, "minLength": 1, "type": "string" }, "withdrawalId": { "description": "Withdrawal ID to be completed by transaction broadcast", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "signatureId": { "description": "ID of prepared payment template to sign. This is should be stored on a client side to retrieve ID of the blockchain transaction, when signing application signs the transaction and broadcasts it to the blockchain.", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "type": "string" } }, "required": ["txData", "currency"], "type": "object" }, "Id": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the entity.", "example": "5e68c66581f2ee32bc354087" } } }, "CreateAccountBatch": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/CreateAccount" } } }, "required": ["accounts"] }, "CreateAccount": { "properties": { "currency": { "description": "Account currency. Supported values are BTC, BNB, LTC, DOGE, BCH, ETH, XLM, XRP, TRON, BSC, SOL, MATIC, ALGO, KCS, EGLD, CELO, KLAY, XDC, FLOW, Tatum virtual currencies started with the \"VC_\" prefix (this includes fiat currencies), USDT, WBTC, LEO, LINK, GMC, UNI, FREE, MKR, USDC, BAT, TUSD, BUSD, PAX, PAXG, MMY, XCON, USDT_TRON, BETH, BUSD, BBTC, BADA, WBNB, BDOT, BXRP, BLTC, BBCH, CAKE, BUSD_BSC, ERC-20, BEP-20 or TRC-10/20 custom tokens registered on the Tatum platform, XLM or XRP assets created via the Tatum platform. ERC-20 tokens and BEP-20 tokens do not have testnet blockchains, therefore you cannot use them in a non-production environment. You can emulate a testnet environment by registering a custom ERC-20 or BEP-20 token on the Tatum platform and then minting some tokens from the token's address using the Ethereum ERC-20 Token Faucet.\n", "example": "BTC", "maxLength": 40, "minLength": 2, "type": "string" }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "compliant": { "description": "Enable compliant checks. If this is enabled, it is impossible to create account if compliant check fails.", "example": false, "type": "boolean" }, "accountCode": { "description": "For bookkeeping to distinct account purpose.", "maxLength": 50, "minLength": 1, "example": "AC_1011_B", "type": "string" }, "accountingCurrency": { "description": "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", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "FLOW", "FUSD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "accountNumber": { "description": "Account number from external system.", "maxLength": 50, "minLength": 1, "example": "123456", "type": "string" } }, "required": ["currency"], "type": "object" }, "CreateAccountXpub": { "properties": { "currency": { "description": "Account currency. Supported values are BTC, BNB, LTC, DOGE, BCH, ETH, XLM, XRP, TRON, BSC, SOL, MATIC, ALGO, KCS, EGLD, CELO, KLAY, XDC, FLOW, Tatum virtual currencies started with the \"VC_\" prefix (this includes fiat currencies), USDT, WBTC, LEO, LINK, GMC, UNI, FREE, MKR, USDC, BAT, TUSD, BUSD, PAX, PAXG, MMY, XCON, USDT_TRON, BETH, BUSD, BBTC, BADA, WBNB, BDOT, BXRP, BLTC, BBCH, CAKE, BUSD_BSC, ERC-20, BEP-20 or TRC-10/20 custom tokens registered on the Tatum platform, XLM or XRP assets created via the Tatum platform. ERC-20 tokens and BEP-20 tokens do not have testnet blockchains, therefore you cannot use them in a non-production environment. You can emulate a testnet environment by registering a custom ERC-20 or BEP-20 token on the Tatum platform and then minting some tokens from the token's address using the Ethereum ERC-20 Token Faucet.\n", "example": "BTC", "maxLength": 40, "minLength": 2, "type": "string" }, "xpub": { "description": "Extended public key to generate addresses from.", "maxLength": 192, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "compliant": { "description": "Enable compliant checks. If this is enabled, it is impossible to create account if compliant check fails.", "example": false, "type": "boolean" }, "accountCode": { "description": "For bookkeeping to distinct account purpose.", "maxLength": 50, "minLength": 1, "example": "AC_1011_B", "type": "string" }, "accountingCurrency": { "description": "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", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "FLOW", "FUSD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "accountNumber": { "description": "Account number from external system.", "maxLength": 50, "minLength": 1, "example": "123456", "type": "string" } }, "required": ["currency", "xpub"], "type": "object" }, "UpdateAccount": { "properties": { "accountCode": { "description": "For bookkeeping to distinct account purpose.", "maxLength": 50, "minLength": 1, "example": "AC_1011_B", "type": "string" }, "accountNumber": { "description": "Account number from external system.", "maxLength": 50, "minLength": 1, "example": "123456", "type": "string" } }, "type": "object" }, "CreateTransaction": { "properties": { "senderAccountId": { "description": "Internal sender account ID within Tatum platform", "example": "5e6645712b55823de7ea82f1", "maxLength": 24, "minLength": 24, "type": "string" }, "recipientAccountId": { "description": "Internal recipient account ID within Tatum platform", "example": "5e6645712b55823de7ea82f2", "maxLength": 24, "minLength": 24, "type": "string" }, "amount": { "description": "Amount to be sent.", "maxLength": 38, "example": "5", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "anonymous": { "default": false, "description": "Anonymous transaction does not show sender account to recipient, default is false", "example": false, "type": "boolean" }, "compliant": { "description": "Enable compliant checks. Transaction will not be processed, if compliant check fails.", "example": false, "type": "boolean" }, "transactionCode": { "description": "For bookkeeping to distinct transaction purpose.", "example": "1_01_EXTERNAL_CODE", "maxLength": 100, "minLength": 1, "type": "string" }, "paymentId": { "description": "Payment ID, External identifier of the payment, which can be used to pair transactions within Tatum accounts.", "example": "9625", "maxLength": 100, "minLength": 1, "type": "string" }, "recipientNote": { "description": "Note visible to both, sender and recipient", "example": "Private note", "maxLength": 500, "minLength": 1, "type": "string" }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Only applicable for Tatum's Virtual currencies Ledger transactions. Override default exchange rate for the Virtual Currency." }, "senderNote": { "description": "Note visible to sender", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "recipientAccountId", "senderAccountId"], "type": "object" }, "BatchCreateTransaction": { "properties": { "senderAccountId": { "description": "Internal sender account ID within Tatum platform", "example": "5e6645712b55823de7ea82f1", "maxLength": 24, "minLength": 24, "type": "string" }, "transaction": { "description": "Array of block seals.", "type": "array", "items": { "type": "object", "required": ["amount", "recipientAccountId"], "properties": { "recipientAccountId": { "description": "Internal recipient account ID within Tatum platform", "example": "5e6645712b55823de7ea82f2", "maxLength": 24, "minLength": 24, "type": "string" }, "amount": { "description": "Amount to be sent.", "maxLength": 38, "example": "5", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "anonymous": { "default": false, "description": "Anonymous transaction does not show sender account to recipient, default is false", "example": false, "type": "boolean" }, "compliant": { "description": "Enable compliant checks. Transaction will not be processed, if compliant check fails.", "example": false, "type": "boolean" }, "transactionCode": { "description": "For bookkeeping to distinct transaction purpose.", "example": "1_01_EXTERNAL_CODE", "maxLength": 100, "minLength": 1, "type": "string" }, "paymentId": { "description": "Payment ID, External identifier of the payment, which can be used to pair transactions within Tatum accounts.", "example": "9625", "maxLength": 100, "minLength": 1, "type": "string" }, "recipientNote": { "description": "Note visible to both, sender and recipient", "example": "Private note", "maxLength": 500, "minLength": 1, "type": "string" }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Only applicable for Tatum's Virtual currencies Ledger transactions. Override default exchange rate for the Virtual Currency." }, "senderNote": { "description": "Note visible to sender", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } } } } }, "required": ["senderAccountId"], "type": "object" }, "UnblockAmount": { "properties": { "recipientAccountId": { "description": "Internal recipient account ID within Tatum platform", "example": "5e6645712b55823de7ea82f2", "maxLength": 24, "minLength": 24, "type": "string" }, "amount": { "description": "Amount to be sent. Amount can be smaller then the blocked amount.", "maxLength": 38, "example": "5", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "anonymous": { "default": false, "description": "Anonymous transaction does not show sender account to recipient, default is false", "example": false, "type": "boolean" }, "compliant": { "description": "Enable compliant checks. Transaction will not be processed, if compliant check fails.", "example": false, "type": "boolean" }, "transactionCode": { "description": "For bookkeeping to distinct transaction purpose.", "example": "1_01_EXTERNAL_CODE", "maxLength": 100, "minLength": 1, "type": "string" }, "paymentId": { "description": "Payment ID, External identifier of the payment, which can be used to pair transactions within Tatum accounts.", "example": "9625", "maxLength": 100, "minLength": 1, "type": "string" }, "recipientNote": { "description": "Note visible to both, sender and recipient", "example": "Private note", "maxLength": 500, "minLength": 1, "type": "string" }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Only applicable for Tatum's Virtual currencies Ledger transactions. Override default exchange rate for the Virtual Currency." }, "senderNote": { "description": "Note visible to sender", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "recipientAccountId"], "type": "object" }, "Customer": { "required": ["active", "id", "externalId", "enabled"], "properties": { "externalId": { "description": "Customer external ID.", "example": "651234", "type": "string" }, "id": { "description": "Customer internal ID within Tatum.", "example": "5e68c66581f2ee32bc354087", "type": "string" }, "enabled": { "description": "Indicates whether customer is enabled or not", "example": true, "type": "boolean" }, "active": { "description": "Indicates whether customer is active or not", "example": true, "type": "boolean" }, "accountingCurrency": { "description": "All transaction will be accounted in this currency for all accounts of the customer. Currency can be overridden per account level. ISO-4217", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "FLOW", "FUSD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "USD", "type": "string" }, "customerCountry": { "description": "Country customer has to be compliant with", "example": "US", "type": "string" }, "providerCountry": { "description": "Country service provider has to be compliant with", "example": "US", "type": "string" } }, "type": "object" }, "CustomerRegistration": { "properties": { "accountingCurrency": { "description": "All transaction will be accounted in this currency for all accounts. Currency can be overridden per account level. If not set, EUR is used. ISO-4217", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "FLOW", "FUSD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "customerCountry": { "description": "Country customer has to be compliant with. ISO-3166-1", "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "externalId": { "description": "Customer external ID. Use only anonymized identification you have in your system. If customer with externalId does not exists new customer is created. If customer with specified externalId already exists it is updated.", "example": "123654", "maxLength": 100, "minLength": 1, "type": "string" }, "providerCountry": { "description": "Country service provider has to be compliant with. ISO-3166-1", "example": "US", "maxLength": 2, "minLength": 2, "type": "string" } }, "required": ["externalId"], "type": "object", "description": "If customer is filled then is created or updated." }, "CustomerUpdate": { "properties": { "externalId": { "description": "External customer ID. If not set, it will not be updated.", "example": "123654", "maxLength": 100, "minLength": 1, "type": "string" }, "accountingCurrency": { "description": "All transaction will be accounted in this currency for all accounts. Currency can be overridden per account level. If not set, it will not be updated. ISO-4217", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "FLOW", "FUSD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "customerCountry": { "description": "Country customer has to be compliant with. If not set, it will not be updated. ISO-3166-1.", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "providerCountry": { "description": "Country service provider has to be compliant with. If not set, it will not be updated. ISO-3166-1", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "example": "US", "maxLength": 2, "minLength": 2, "type": "string" } }, "type": "object", "required": ["externalId"] }, "DeployErc20OffchainMnemXpub": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic to generate private key for the deploy account of ERC20, from which the gas will be paid (index will be used). If address is not present, mnemonic is used to generate xpub and index is set to 1. Either mnemonic and index or privateKey and address must be present, not both.", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "index": { "description": "derivation index of address to pay for deployment of ERC20", "example": 0, "type": "integer", "maximum": 2147483647 }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": [ "description", "supply", "symbol", "basePair", "xpub", "derivationIndex", "mnemonic", "index" ] }, "DeployErc20OffchainMnemonicAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Ethereum blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 42, "minLength": 42, "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic to generate private key for the deploy account of ERC20, from which the gas will be paid (index will be used). If address is not present, mnemonic is used to generate xpub and index is set to 1. Either mnemonic and index or privateKey and address must be present, not both.", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "index": { "description": "derivation index of address to pay for deployment of ERC20", "example": 0, "type": "integer", "maximum": 2147483647 }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "address", "mnemonic", "index"] }, "DeployErc20OffchainPKXpub": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "privateKey": { "description": "Private key of Ethereum account address, from which gas for deployment of ERC20 will be paid. Private key, mnemonic or signature Id must be present.", "type": "string", "maxLength": 66, "minLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2" }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "xpub", "derivationIndex", "privateKey"] }, "DeployErc20OffchainPKAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Ethereum blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 42, "minLength": 42, "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "privateKey": { "description": "Private key of Ethereum account address, from which gas for deployment of ERC20 will be paid. Private key, mnemonic or signature Id must be present.", "type": "string", "maxLength": 66, "minLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2" }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "privateKey", "address"] }, "DeployErc20OffchainKMSAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Ethereum blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 42, "minLength": 42, "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n" }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "address", "signatureId"] }, "DeployErc20OffchainKMSXpub": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n" }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "xpub", "derivationIndex", "signatureId"] }, "DeployKCSErc20OffchainMnemXpub": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic to generate private key for the deploy account of ERC20, from which the gas will be paid (index will be used). If address is not present, mnemonic is used to generate xpub and index is set to 1. Either mnemonic and index or privateKey and address must be present, not both.", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "index": { "description": "derivation index of address to pay for deployment of ERC20", "example": 0, "type": "integer", "maximum": 2147483647 }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": [ "description", "supply", "symbol", "basePair", "xpub", "derivationIndex", "mnemonic", "index" ] }, "DeployKCSErc20OffchainMnemonicAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Ethereum blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 42, "minLength": 42, "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic to generate private key for the deploy account of ERC20, from which the gas will be paid (index will be used). If address is not present, mnemonic is used to generate xpub and index is set to 1. Either mnemonic and index or privateKey and address must be present, not both.", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "index": { "description": "derivation index of address to pay for deployment of ERC20", "example": 0, "type": "integer", "maximum": 2147483647 }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "address", "mnemonic", "index"] }, "DeployKCSErc20OffchainPKXpub": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "privateKey": { "description": "Private key of Ethereum account address, from which gas for deployment of ERC20 will be paid. Private key, mnemonic or signature Id must be present.", "type": "string", "maxLength": 66, "minLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2" }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "xpub", "derivationIndex", "privateKey"] }, "DeployKCSErc20OffchainPKAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Ethereum blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 42, "minLength": 42, "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "privateKey": { "description": "Private key of Ethereum account address, from which gas for deployment of ERC20 will be paid. Private key, mnemonic or signature Id must be present.", "type": "string", "maxLength": 66, "minLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2" }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "privateKey", "address"] }, "DeployKCSErc20OffchainKMSAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Ethereum blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 42, "minLength": 42, "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n" }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "address", "signatureId"] }, "DeployKCSErc20OffchainKMSXpub": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n" }, "nonce": { "type": "number", "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used.", "minimum": 0 } }, "required": ["description", "supply", "symbol", "basePair", "xpub", "derivationIndex", "signatureId"] }, "DeployAlgoErc20OffchainMnemonicAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Ethereum blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 58, "minLength": 58, "example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y", "type": "string" }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic to generate private key for the deploy account of ERC20, from which the gas will be paid (index will be used). If address is not present, mnemonic is used to generate xpub and index is set to 1. Either mnemonic and index or privateKey and address must be present, not both.", "example": "artist alarm clerk obscure timber firm reopen provide ankle vicious exhibit waste math toilet believe puppy lucky coast post kind black suspect mule able market", "type": "string" } }, "required": ["description", "supply", "symbol", "basePair", "address", "mnemonic"] }, "DeployAlgoErc20OffchainPKAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Ethereum blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 58, "minLength": 58, "example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y", "type": "string" }, "privateKey": { "description": "Private key of Ethereum account address, from which gas for deployment of ERC20 will be paid. Private key, mnemonic or signature Id must be present.", "type": "string", "maxLength": 103, "minLength": 103, "example": "NBYMCVEEDFYV3TPWVRE6APE7PKHUJD4XAKXCKNCLKGUXOC3LFNJGZQCJCRA53HB7ZAHF6NFJH2QIVQ5USQNWG35QCJLD4KZ5IWMB24Q" } }, "required": ["description", "supply", "symbol", "basePair", "privateKey", "address"] }, "DeployAlgoErc20OffchainKMSAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the ERC20 token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "description": { "description": "Description of the ERC20 token", "example": "My ERC20 Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20 token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Ethereum blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 58, "minLength": 58, "example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n" } }, "required": ["description", "supply", "symbol", "basePair", "address", "signatureId"] }, "TransferAlgoErc20": { "type": "object", "properties": { "senderAccountId": { "maxLength": 24, "minLength": 24, "description": "The ID of the virtual account to send the ERC-20-equivalent Algorand tokens from", "example": "61b3bffddfb389cde19c73be", "type": "string" }, "address": { "description": "The blockchain address to send the ERC-20-equivalent Algorand tokens to", "example": "5YVZBUH3STSQ5ABCTLEIEIJ7QOZFILM2DLAEEA4ZL6CU55ODZIQXO5EMYM", "maxLength": 58, "minLength": 58, "type": "string" }, "amount": { "description": "The amount of the ERC-20-equivalent Algorand tokens to send", "maxLength": 38, "example": "10000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "privateKey": { "maxLength": 103, "minLength": 103, "description": "The secret of the Algorand wallet (account). Secret, or signature Id must be present.", "example": "NBYMCVEEDFYV3TPWVRE6APE7PKHUJD4XAKXCKNCLKGUXOC3LFNJGZQCJCRA53HB7ZAHF6NFJH2QIVQ5USQNWG35QCJLD4KZ5IWMB24Q", "type": "string" }, "compliant": { "description": "Compliance check; if the withdrawal is not compliant, it will not be processed", "example": false, "type": "boolean" }, "paymentId": { "description": "The identifier of the token transfer that is shown on the virtual account for the created transaction", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "maxLength": 500, "minLength": 1, "description": "The note for the recipient; must not contain spaces", "example": "Helloworld", "type": "string" } }, "required": ["senderAccountId", "address", "privateKey", "amount", "fee"] }, "DeployTrcOffchainMnemXpub": { "type": "object", "properties": { "symbol": { "description": "Name of the TRC token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of TRC token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "decimals": { "description": "Number of decimal points of the token.", "example": 6, "minimum": 0, "type": "number" }, "type": { "description": "Type of TRC token to create.", "example": "TRC10", "type": "string", "enum": ["TRC10", "TRC20"] }, "description": { "description": "Description of the TRC token", "example": "My TRC Token", "maxLength": 100, "minLength": 1, "type": "string" }, "url": { "description": "URL of the project. Applicable for TRC-10 only.", "example": "https://mytoken.com", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for TRC token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 130, "minLength": 130, "example": "0244b3f40c6e570ae0032f6d7be87737a6c4e5314a4a1a82e22d0460a0d0cd794936c61f0c80dc74ace4cd04690d4eeb1aa6555883be006e1748306faa7ed3a26a", "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic to generate private key for the deploy account of TRC, from which the gas will be paid (index will be used). If address is not present, mnemonic is used to generate xpub and index is set to 1. Either mnemonic and index or privateKey and address must be present, not both.", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "index": { "description": "derivation index of address to pay for deployment of TRC", "example": 0, "type": "integer", "maximum": 2147483647 } }, "required": [ "description", "supply", "symbol", "basePair", "decimals", "type", "xpub", "derivationIndex", "mnemonic", "index" ] }, "DeployTrcOffchainMnemonicAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the TRC token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of TRC token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "decimals": { "description": "Number of decimal points of the token.", "example": 6, "minimum": 0, "type": "number" }, "type": { "description": "Type of TRC token to create.", "example": "TRC10", "type": "string", "enum": ["TRC10", "TRC20"] }, "description": { "description": "Description of the TRC token", "example": "My TRC Token", "maxLength": 100, "minLength": 1, "type": "string" }, "url": { "description": "URL of the project. Applicable for TRC-10 only.", "example": "https://mytoken.com", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for TRC token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Tron blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 34, "minLength": 34, "example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW", "type": "string" }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic to generate private key for the deploy account of TRC, from which the gas will be paid (index will be used). If address is not present, mnemonic is used to generate xpub and index is set to 1. Either mnemonic and index or privateKey and address must be present, not both.", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "index": { "description": "derivation index of address to pay for deployment of TRC", "example": 0, "type": "integer", "maximum": 2147483647 } }, "required": [ "description", "supply", "symbol", "decimals", "type", "basePair", "address", "mnemonic", "index" ] }, "DeployTrcOffchainPKXpub": { "type": "object", "properties": { "symbol": { "description": "Name of the TRC token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of TRC token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "decimals": { "description": "Number of decimal points of the token.", "example": 6, "minimum": 0, "type": "number" }, "type": { "description": "Type of TRC token to create.", "example": "TRC10", "type": "string", "enum": ["TRC10", "TRC20"] }, "description": { "description": "Description of the TRC token", "example": "My TRC Token", "maxLength": 100, "minLength": 1, "type": "string" }, "url": { "description": "URL of the project. Applicable for TRC-10 only.", "example": "https://mytoken.com", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for TRC token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 150, "minLength": 1, "example": "0244b3f40c6e570ae0032f6d7be87737a6c4e5314a4a1a82e22d0460a0d0cd794936c61f0c80dc74ace4cd04690d4eeb1aa6555883be006e1748306faa7ed3a26a", "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "privateKey": { "description": "Private key of Tron account address, from which gas for deployment of TRC will be paid. Private key, mnemonic or signature Id must be present.", "type": "string", "maxLength": 66, "minLength": 66, "example": "e75d702ce00987633f8009fbb1eabb5b187cb5b50fe9179a8d6cee6bab076b66" } }, "required": [ "description", "supply", "symbol", "basePair", "decimals", "type", "xpub", "derivationIndex", "privateKey" ] }, "DeployTrcOffchainPKAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the TRC token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of TRC token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "decimals": { "description": "Number of decimal points of the token.", "example": 6, "minimum": 0, "type": "number" }, "type": { "description": "Type of TRC token to create.", "example": "TRC10", "type": "string", "enum": ["TRC10", "TRC20"] }, "description": { "description": "Description of the TRC token", "example": "My TRC Token", "maxLength": 100, "minLength": 1, "type": "string" }, "url": { "description": "URL of the project. Applicable for TRC-10 only.", "example": "https://mytoken.com", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for TRC token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Tron blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 42, "minLength": 42, "example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW", "type": "string" }, "privateKey": { "description": "Private key of Tron account address, from which gas for deployment of TRC will be paid. Private key, mnemonic or signature Id must be present.", "type": "string", "maxLength": 66, "minLength": 66, "example": "0244b3f40c6e570ae0032f6d7be87737a6c4e5314a4a1a82e22d0460a0d0cd794936c61f0c80dc74ace4cd04690d4eeb1aa6555883be006e1748306faa7ed3a26a" } }, "required": [ "description", "supply", "symbol", "decimals", "type", "basePair", "privateKey", "address" ] }, "DeployTrcOffchainKMSAddress": { "type": "object", "properties": { "symbol": { "description": "Name of the TRC token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of TRC token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "decimals": { "description": "Number of decimal points of the token.", "example": 6, "minimum": 0, "type": "number" }, "type": { "description": "Type of TRC token to create.", "example": "TRC10", "type": "string", "enum": ["TRC10", "TRC20"] }, "description": { "description": "Description of the TRC token", "example": "My TRC Token", "maxLength": 100, "minLength": 1, "type": "string" }, "url": { "description": "URL of the project. Applicable for TRC-10 only.", "example": "https://mytoken.com", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for TRC token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "address": { "description": "Address on Tron blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 42, "minLength": 42, "example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW", "type": "string" }, "from": { "description": "Blockchain address to perform operation from", "example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW", "maxLength": 34, "minLength": 34, "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n" } }, "required": [ "description", "supply", "symbol", "from", "decimals", "type", "basePair", "address", "signatureId" ] }, "DeployTrcOffchainKMSXpub": { "type": "object", "properties": { "symbol": { "description": "Name of the TRC token - stored as a symbol on Blockchain", "example": "MT", "maxLength": 30, "pattern": "^[a-zA-Z0-9_]+$", "minLength": 1, "type": "string" }, "supply": { "description": "max supply of TRC token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "decimals": { "description": "Number of decimal points of the token.", "example": 6, "minimum": 0, "type": "number" }, "type": { "description": "Type of TRC token to create.", "example": "TRC10", "type": "string", "enum": ["TRC10", "TRC20"] }, "description": { "description": "Description of the TRC token", "example": "My TRC Token", "maxLength": 100, "minLength": 1, "type": "string" }, "url": { "description": "URL of the project. Applicable for TRC-10 only.", "example": "https://mytoken.com", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for TRC token. 1 token will be equal to 1 unit of base pair. Transaction value will be calculated according to this base pair.", "maxLength": 30, "minLength": 2, "type": "string", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 150, "minLength": 1, "example": "0244b3f40c6e570ae0032f6d7be87737a6c4e5314a4a1a82e22d0460a0d0cd794936c61f0c80dc74ace4cd04690d4eeb1aa6555883be006e1748306faa7ed3a26a", "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "from": { "description": "Blockchain address to perform operation from", "example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW", "maxLength": 34, "minLength": 34, "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n" } }, "required": [ "description", "supply", "symbol", "from", "decimals", "type", "basePair", "xpub", "derivationIndex", "signatureId" ] }, "DeployErc20": { "type": "object", "properties": { "symbol": { "description": "Symbol of the ERC20 token", "example": "ERC_SYMBOL", "maxLength": 30, "minLength": 1, "type": "string" }, "name": { "description": "Name of the ERC20 token", "example": "MyERC20", "maxLength": 100, "minLength": 1, "pattern": "^[a-zA-Z0-9_]+$", "type": "string" }, "totalCap": { "description": "Max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "supply": { "description": "Max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "digits": { "description": "Number of decimal points", "example": 18, "maximum": 30, "minimum": 1, "type": "number" }, "address": { "description": "Address on XDC blockchain, where all created ERC20 tokens will be transferred.", "maxLength": 43, "minLength": 42, "example": "xdca0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6", "type": "string" }, "fromPrivateKey": { "description": "Private key of XDC account address, from which the fee for the deployment of ERC20 will be paid. Private key, or signature Id must be present.", "type": "string", "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "maxLength": 66, "minLength": 66 }, "nonce": { "type": "number", "minimum": 0, "description": "Nonce to be set to XDC transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["name", "symbol", "address", "supply", "fromPrivateKey", "digits"] }, "DeployErc20KMS": { "type": "object", "properties": { "symbol": { "description": "Symbol of the ERC20 token", "example": "ERC_SYMBOL", "maxLength": 30, "minLength": 1, "type": "string" }, "name": { "description": "Name of the ERC20 token", "example": "MyERC20", "maxLength": 100, "minLength": 1, "pattern": "^[a-zA-Z0-9_]+$", "type": "string" }, "totalCap": { "description": "Max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "supply": { "description": "Max supply of ERC20 token.", "maxLength": 38, "example": "10000000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "digits": { "description": "Number of decimal points", "example": 18, "maximum": 30, "minimum": 1, "type": "number" }, "address": { "description": "Address on XDC blockchain, where all created ERC20 tokens will be transferred.", "maxLength": 43, "minLength": 42, "example": "xdca0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6", "type": "string" }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "nonce": { "type": "number", "minimum": 0, "description": "Nonce to be set to XDC transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["name", "symbol", "address", "supply", "signatureId", "digits"] }, "DeployErc721": { "type": "object", "properties": { "name": { "description": "Name of the ERC721 token", "example": "My ERC721", "maxLength": 100, "minLength": 1, "type": "string" }, "symbol": { "description": "Symbol of the ERC721 token", "example": "ERC_SYMBOL", "maxLength": 30, "minLength": 1, "type": "string" }, "fromPrivateKey": { "description": "Private key of Ethereum account address, from which gas for deployment of ERC721 will be paid. Private key, or signature Id must be present.", "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66 }, "nonce": { "type": "number", "minimum": 0, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["name", "symbol", "fromPrivateKey"] }, "DeployErc721KMS": { "type": "object", "properties": { "name": { "description": "Name of the ERC721 token", "example": "My ERC721", "maxLength": 100, "minLength": 1, "type": "string" }, "symbol": { "description": "Symbol of the ERC721 token", "example": "ERC_SYMBOL", "maxLength": 30, "minLength": 1, "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "minimum": 0, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["name", "symbol", "signatureId"] }, "EthBlock": { "type": "object", "properties": { "difficulty": { "description": "Difficulty for this block.", "type": "string", "example": "3296820833" }, "extraData": { "description": "The 'extra data' field of this block.", "type": "string", "example": "0x" }, "gasLimit": { "description": "The maximum gas allowed in this block.", "type": "number", "example": 8000000 }, "gasUsed": { "description": "The total used gas by all transactions in this block.", "type": "number", "example": 7985124 }, "hash": { "description": "Hash of the block. 'null' when its pending block.", "type": "string", "example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc" }, "logsBloom": { "description": "The bloom filter for the logs of the block. 'null' when its pending block.", "type": "string", "example": "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000" }, "miner": { "description": "The address of the beneficiary to whom the mining rewards were given.", "type": "string", "example": "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B" }, "mixHash": { "description": "", "type": "string", "example": "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6" }, "nonce": { "description": "Hash of the generated proof-of-work. 'null' when its pending block.", "type": "string", "example": "0xfa1692f52a7ac672" }, "number": { "description": "The block number. 'null' when its pending block.", "type": "number", "example": 6470657 }, "parentHash": { "description": "Hash of the parent block.", "type": "string", "example": "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15" }, "receiptsRoot": { "description": "", "type": "string", "example": "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960" }, "sha3Uncles": { "description": "SHA3 of the uncles data in the block.", "type": "string", "example": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347" }, "size": { "description": "The size of this block in bytes.", "type": "number", "example": 15296 }, "stateRoot": { "description": "The root of the final state trie of the block.", "type": "string", "example": "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba" }, "timestamp": { "description": "The unix timestamp for when the block was collated.", "type": "number", "example": 1569600592 }, "totalDifficulty": { "description": "Total difficulty of the chain until this block.", "type": "string", "example": "23329673338013873" }, "transactions": { "description": "Array of transactions.", "type": "array", "items": { "$ref": "#/components/schemas/EthTx" } }, "transactionsRoot": { "description": "The root of the transaction trie of the block.", "type": "string", "example": "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704" } } }, "FlowBlock": { "type": "object", "properties": { "id": { "description": "Hash of the block.", "type": "string", "example": "e11ca8f92f2d5dea7406e64ab8cb1780a8a19185d9ac670b16ca8c4f09f05add" }, "parentId": { "description": "Hash of the parent block.", "type": "string", "example": "7bd701e87f319254d19dc17459f97df6a44052d05df5e1cd442dd2e3f48ecedc" }, "height": { "description": "The block number.", "type": "number", "example": 31733102 }, "timestamp": { "description": "Timestamp of the block.", "type": "string", "example": "2021-05-11T19:13:03.227Z" }, "transactions": { "description": "Array of transaction IDs.", "type": "array", "items": { "type": "string", "example": "3b4351560d3b454a4c1ae2485074b0786093058bfe2b28d436584311b1e433a4" } }, "signatures": { "description": "Array of signatures.", "type": "array", "items": { "type": "string", "example": "b5ffad6c227cc8dbcb3043dfaa50e8ea5093459ee30242379e6e65e982db84c22faa1da70792349219f3620de95ea16aa8a490000ae824a0002abd60d80b54dc0b42ceab5e98339ec22464f5abb794465357f780f8143f2df077b8f2af69ecd2" } }, "blockSeals": { "description": "Array of block seals.", "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "example": "c85bc2853ca9596a80050b6d2661aad10bd6b27d06b013050076ad1bed2c8b6a" }, "executionReceiptSignatures": { "type": "array", "items": { "type": "string" } }, "executionReceiptId": { "type": "string", "example": "e79acd6437efe49c22832802346908f9590b92fbcd452f72e3b2f1151c48f3ea" }, "resultApprovalSignatures": { "type": "array", "items": { "type": "string" } } } } } } }, "FlowAccount": { "type": "object", "properties": { "address": { "description": "Account address.", "type": "string", "example": "0x02fcc83938d2b63b" }, "balance": { "description": "Balance of the account in smallest FLOW unit = 1 FLOW = 1e8 unit", "type": "number", "example": 10000000 }, "code": { "description": "Account code", "type": "string" }, "contracts": { "type": "object" }, "keys": { "description": "Array of public keys assigned.", "type": "array", "items": { "type": "object", "properties": { "index": { "description": "Index of the public key.", "type": "number", "example": 0 }, "publicKey": { "type": "string", "example": "ba38c835921828e11264e35fe31cc5ad90149f803fd3106e1dd1df49567a05714ed2bf5e42d58b4fef7eb9b0f7121f446d9b607216fdf04459e007b053288287" }, "signAlgo": { "description": "Type of signature algorithm. 2 - ECDSA_secp256k1", "type": "number", "example": 2 }, "hashAlgo": { "description": "Type of hash algo. 3 - SHA3_256", "type": "number", "example": 3 }, "sequenceNumber": { "description": "Number of outgoing transactions for this public key.", "type": "number", "example": 1 }, "revoked": { "type": "boolean", "example": false }, "weight": { "description": "Weight of the key. 1000 means single signature necessary.", "type": "number", "example": 1000 } } } } } }, "FlowTx": { "type": "object", "properties": { "referenceBlockId": { "description": "Id of the block", "type": "string", "example": "ad8b9ab637d56e19188cd5410db6e993fbf66216296c99f7934cf9f3594f9658" }, "script": { "description": "Script to execute in the transaction", "type": "string" }, "args": { "description": "Args to the transaction", "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "Address" }, "value": { "type": "string", "example": "0x21cbd745a4df66f1" } } } }, "gasLimit": { "type": "number", "example": 1000, "description": "Gas limit for the transaction" }, "proposalKey": { "type": "object", "properties": { "address": { "type": "string", "example": "21cbd745a4df66f1" }, "keyId": { "type": "number", "example": 0 }, "sequenceNumber": { "type": "number", "example": 20 } } }, "payer": { "type": "string", "description": "Address from which the assets and fees were debited", "example": "955cd3f17b2fd8ad" }, "payloadSignatures": { "description": "Array of payload signatures.", "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "21cbd745a4df66f1" }, "keyId": { "type": "number", "example": 0 }, "signature": { "type": "string", "example": "17a936b93b405f74af8ed4c70884ef10d98e900d04fb05bf12767e64ce5e498194348a13952c86335f56c8638fbfd0b1efde66b87e6df9ad687833709f9bd3f3" } } } }, "envelopeSignatures": { "description": "Array of envelope signatures.", "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "21cbd745a4df66f1" }, "keyId": { "type": "number", "example": 0 }, "signature": { "type": "string", "example": "17a936b93b405f74af8ed4c70884ef10d98e900d04fb05bf12767e64ce5e498194348a13952c86335f56c8638fbfd0b1efde66b87e6df9ad687833709f9bd3f3" } } } }, "status": { "type": "number", "example": 4, "description": "Status of the transaction" }, "statusCode": { "type": "number", "example": 0, "description": "Status cofe of the transaction" }, "errorMessage": { "type": "string" }, "events": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "A.7e60df042a9c0868.FlowToken.TokensWithdrawn" }, "transactionId": { "type": "string", "example": "d1c75a84e4bdf0dd9bf1bcd0ce4fb25f89e2ed3c5e9574dbca2760b52c428717" }, "transactionIndex": { "type": "number", "example": 0 }, "eventIndex": { "type": "number", "example": 0 }, "data": { "type": "object", "description": "Event specific data. May vary." } } } } } }, "FlowEvent": { "type": "object", "properties": { "blockID": { "type": "string", "example": "c49322287d9ce1d05e909668a15f3e1ed5593b11ace2cbbee56eebf8e9fb1a85" }, "blockHeight": { "type": "number", "example": 14493280 }, "blockTimestamp": { "type": "string", "example": "2021-05-14T21:08:34.536Z" }, "type": { "type": "string", "example": "A.7e60df042a9c0868.FlowToken.TokensWithdrawn" }, "transactionId": { "type": "string", "example": "d1c75a84e4bdf0dd9bf1bcd0ce4fb25f89e2ed3c5e9574dbca2760b52c428717" }, "transactionIndex": { "type": "number", "example": 0 }, "eventIndex": { "type": "number", "example": 0 }, "payload": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of payload.", "enum": ["Event"] }, "value": { "type": "object", "properties": { "id": { "type": "string", "description": "Event type", "example": "A.1654653399040a61.FlowToken.TokensWithdrawn" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "name", "description": "Name of the property" }, "value": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the value", "example": "UFix64" }, "value": { "type": "string", "description": "Value", "example": "0.001" } } }, { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the value", "example": "Optional" }, "value": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the value", "example": "Address" }, "value": { "type": "string", "description": "Value", "example": "0x18eb4ee6b3c026d2" } } } } } ] } } } } } } } } } }, "EthTx": { "type": "object", "properties": { "blockHash": { "description": "Hash of the block where this transaction was in.", "type": "string", "example": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137" }, "status": { "type": "boolean", "example": true, "description": "TRUE if the transaction was successful, FALSE, if the EVM reverted the transaction." }, "blockNumber": { "type": "number", "description": "Block number where this transaction was in.", "example": 6470854 }, "from": { "type": "string", "description": "Address of the sender.", "example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647" }, "gas": { "type": "number", "description": "Gas provided by the sender.", "example": 21000 }, "gasPrice": { "type": "string", "description": "Gas price provided by the sender in wei.", "example": "1000000000" }, "transactionHash": { "type": "string", "description": "Hash of the transaction.", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" }, "input": { "type": "string", "description": "The data sent along with the transaction.", "example": "0x" }, "nonce": { "type": "number", "description": "The number of transactions made by the sender prior to this one.", "example": 26836405 }, "to": { "type": "string", "description": "Address of the receiver. 'null' when its a contract creation transaction.", "example": "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d" }, "transactionIndex": { "type": "number", "description": "Integer of the transactions index position in the block.", "example": 3 }, "value": { "type": "string", "description": "Value transferred in wei.", "example": "1000000000000000000" }, "gasUsed": { "type": "number", "description": "The amount of gas used by this specific transaction alone.", "example": 21000 }, "cumulativeGasUsed": { "type": "number", "description": "The total amount of gas used when this transaction was executed in the block.", "example": 314159 }, "contractAddress": { "type": "string", "description": "The contract address created, if the transaction was a contract creation, otherwise null.", "example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647" }, "logs": { "type": "array", "description": "Log events, that happened in this transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "From which this event originated from.", "example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647" }, "topics": { "type": "array", "description": "An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.", "items": { "type": "string", "example": "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234" } }, "data": { "type": "string", "description": "The data containing non-indexed log parameter." }, "logIndex": { "type": "number", "description": "Integer of the event index position in the block." }, "transactionIndex": { "type": "number", "description": "Integer of the transaction’s index position, the event was created in." }, "transactionHash": { "type": "string", "description": "Hash of the transaction this event was created in.", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" } } } } } }, "EthTxInternal": { "type": "object", "properties": { "from": { "type": "string", "description": "Address of the sender.", "example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647" }, "to": { "type": "string", "description": "Address of the receiver. 'null' when its a contract creation transaction.", "example": "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d" }, "value": { "type": "string", "description": "Value transferred in wei.", "example": "1000000000000000000" }, "blockNumber": { "type": "number", "description": "Block number where this transaction was in.", "example": 6470854 }, "timeStamp": { "type": "string", "description": "Time of the transaction in seconds.", "example": "1477837690" }, "hash": { "type": "string", "description": "Hash of the transaction.", "example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" }, "input": { "type": "string", "description": "The data sent along with the transaction.", "example": "" }, "traceId": { "type": "string", "description": "Trace ID.", "example": "0" }, "type": { "type": "string", "description": "Type of the transaction.", "example": "create" }, "errCode": { "type": "string", "description": "Error code.", "example": "Bad jump destination" }, "gas": { "type": "number", "description": "Gas provided by the sender.", "example": 21000 }, "isError": { "type": "string", "example": "0", "description": "1 if the transaction was not successful, 0 otherwise." }, "gasUsed": { "type": "number", "description": "The amount of gas used by this specific transaction alone.", "example": 21000 }, "contractAddress": { "type": "string", "description": "The contract address created, if the transaction was a contract creation, otherwise null.", "example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647" } } }, "Trc": { "properties": { "symbol": { "description": "TRC token name. Used as a identifier within Tatum system and also in blockchain as a currency symbol.", "example": "MY_TOKEN", "maxLength": 30, "minLength": 1, "pattern": "^[a-zA-Z0-9_]+$", "type": "string" }, "supply": { "description": "Supply of TRC tokens.", "maxLength": 38, "example": "1000000.0", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "decimals": { "description": "Number of decimal points of the token.", "example": 6, "minimum": 0, "type": "number" }, "type": { "description": "Type of TRC token to create.", "example": "TRC10", "type": "string", "enum": ["TRC10", "TRC20"] }, "description": { "description": "Used as a description within Tatum system and in blockchain as a currency name.", "example": "My Public Token", "maxLength": 100, "minLength": 1, "type": "string" }, "url": { "description": "URL of the project. Applicable for TRC-10 only.", "example": "https://mytoken.com", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for TRC token. Transaction value will be calculated according to this base pair.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "EUR", "maxLength": 50, "minLength": 3, "type": "string" }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "accountingCurrency": { "description": "All transaction will be billed in this currency for created account associated with this currency. If not set, EUR is used. ISO-4217", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "FLOW", "FUSD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 130, "minLength": 130, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "address": { "description": "Address on Tron blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 34, "minLength": 34, "example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW", "type": "string" } }, "required": ["symbol", "supply", "decimals", "type", "description", "basePair"], "type": "object" }, "Erc20": { "properties": { "symbol": { "description": "ERC20/BEP20 token name. Used as a identifier within Tatum system and also in blockchain as a currency symbol.", "example": "MY_TOKEN", "maxLength": 30, "minLength": 1, "pattern": "^[a-zA-Z0-9_]+$", "type": "string" }, "supply": { "description": "Supply of ERC20/BEP20 token.", "maxLength": 38, "example": "1000000.0", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "decimals": { "description": "Decimals of ERC20/BEP20 token.", "minimum": 0, "example": 8, "type": "number" }, "description": { "description": "Used as a description within Tatum system and in blockchain as a currency name.", "example": "My Public Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20/BEP20 token. Transaction value will be calculated according to this base pair.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CELO", "CEUR", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CUSD", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "EUR", "maxLength": 50, "minLength": 3, "type": "string" }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "accountingCurrency": { "description": "All transaction will be billed in this currency for created account associated with this currency. If not set, EUR is used. ISO-4217", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "FLOW", "FUSD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "derivationIndex": { "description": "Derivation index for xpub to generate specific deposit address.", "format": "int32", "example": 0, "type": "integer", "maximum": 2147483647 }, "xpub": { "description": "Extended public key (xpub), from which address, where all initial supply will be stored, will be generated. Either xpub and derivationIndex, or address must be present, not both.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" } }, "required": ["symbol", "supply", "decimals", "description", "basePair", "derivationIndex", "xpub"], "type": "object" }, "Erc20Address": { "properties": { "symbol": { "description": "ERC20/BEP20/SPL token name. Used as a identifier within Tatum system and also in blockchain as a currency symbol.", "example": "MY_TOKEN", "maxLength": 30, "minLength": 1, "pattern": "^[a-zA-Z0-9_]+$", "type": "string" }, "supply": { "description": "Supply of ERC20/BEP20/SPL token.", "maxLength": 38, "example": "1000000.0", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "decimals": { "description": "Decimals of ERC20/BEP20/SPL token.", "minimum": 0, "example": 8, "type": "number" }, "description": { "description": "Used as a description within Tatum system and in blockchain as a currency name.", "example": "My Public Token", "maxLength": 100, "minLength": 1, "type": "string" }, "basePair": { "description": "Base pair for ERC20/BEP20/SPL token. Transaction value will be calculated according to this base pair.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CELO", "CEUR", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CUSD", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "EUR", "maxLength": 50, "minLength": 3, "type": "string" }, "baseRate": { "type": "number", "example": 1, "default": 1, "minimum": 0, "description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair." }, "customer": { "$ref": "#/components/schemas/CustomerRegistration" }, "accountingCurrency": { "description": "All transaction will be billed in this currency for created account associated with this currency. If not set, EUR is used. ISO-4217", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "FLOW", "FUSD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "address": { "description": "Address on the blockchain, where all initial supply will be stored. Either xpub and derivationIndex, or address must be present, not both. For Solana, only address can be used.", "maxLength": 44, "minLength": 42, "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" } }, "required": ["symbol", "supply", "decimals", "description", "basePair", "address"], "type": "object" }, "Erc20Response": { "properties": { "accountId": { "description": "Account ID with the type of currency as created ERC20/BEP20 token symbol. Supply of ERC20/BEP20 token will be credited as soon as ERC20/BEP20 token is deployed to the Ethereum blockchain.", "type": "string", "example": "5e68c66581f2ee32bc354087" }, "address": { "description": "Initial address of new created ERC20/BEP20 token. On this address, all tokens will be minted.", "example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4", "type": "string" } }, "type": "object" }, "DeployErc20Response": { "properties": { "accountId": { "description": "Account ID with the type of currency as created ERC20/BEP20 token symbol. Account will be unfrozen when ERC20/BEP20 contract address will be set.", "type": "string", "example": "5e68c66581f2ee32bc354087" }, "txId": { "description": "TX hash of successful transaction. From this transaction receipt contract address can be obtained.", "example": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9", "type": "string" } }, "type": "object", "required": ["accountId", "txId"] }, "DeployErc20SignatureResponse": { "properties": { "accountId": { "description": "Account ID with the type of currency as created ERC20/BEP20 token symbol. Account will be unfrozen when ERC20/BEP20 contract address will be set.", "type": "string", "example": "5e68c66581f2ee32bc354087" }, "signatureId": { "description": "ID of prepared payment template to sign. This is should be stored on a client side to retrieve ID of the blockchain transaction, when signing application signs the transaction and broadcasts it to the blockchain.", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "type": "string" } }, "type": "object", "required": ["accountId", "signatureId"] }, "DeployAlgoErc20Response": { "properties": { "accountId": { "description": "Account ID with the type of currency as created ERC20 token symbol. Account will be unfrozen when ERC20 contract address will be set.", "type": "string", "example": "5e68c66581f2ee32bc354087" }, "txId": { "description": "TX hash of successful transaction. From this transaction receipt contract address can be obtained.", "example": "JGDMW6F6BUWQLFXDEPZIUO5WCTQOL3QV7KZ2SBV44K5WE6SSNN7Q", "type": "string" } }, "type": "object", "required": ["accountId", "txId"] }, "DeployAlgoErc20SignatureResponse": { "properties": { "accountId": { "description": "Account ID with the type of currency as created ERC20 token symbol. Account will be unfrozen when ERC20 contract address will be set.", "type": "string", "example": "5e68c66581f2ee32bc354087" }, "signatureId": { "description": "ID of prepared payment template to sign. This is should be stored on a client side to retrieve ID of the blockchain transaction, when signing application signs the transaction and broadcasts it to the blockchain.", "format": "uuid", "example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6", "type": "string" } }, "type": "object", "required": ["accountId", "signatureId"] }, "Error": { "properties": { "errorCode": { "description": "payment.amount.notNull", "type": "string" }, "message": { "description": "Payment amount must be greater than 0.", "type": "string" }, "statusCode": { "description": "403", "type": "number" } }, "required": ["errorCode", "message"], "type": "object" }, "Error400": { "properties": { "errorCode": { "example": "validation.failed", "description": "validation.failed", "type": "string" }, "message": { "example": "Request validation failed. Please see data for additional information.", "description": "Request validation failed. Please see data for additional information.", "type": "string" }, "statusCode": { "example": 400, "description": "400", "type": "number" }, "data": { "type": "array", "items": { "type": "object", "required": ["target"], "properties": { "target": { "type": "object", "additionalProperties": true, "description": "Request object present in the body of the HTTP request", "example": { "property": 12345 } }, "value": { "type": "number", "description": "Value of the target object which validation is wrong. Can be of any data type, example here is using type number.", "example": 12345 }, "property": { "type": "string", "description": "Property name of the target object which validation is wrong", "example": "property1" }, "constraints": { "type": "object", "additionalProperties": true, "description": "Object of failed constraints for the target object. Key is the constraint, value is detailed description of the failed constraint.", "example": { "min": "property1 must not be less than 50000" } } } } } }, "required": ["errorCode", "message", "statusCode", "data"], "type": "object" }, "Error401Invalid": { "properties": { "errorCode": { "example": "subscription.invalid", "description": "subscription.invalid", "type": "string" }, "message": { "example": "Unable to find valid subscription for '${apiKey}'", "description": "Unable to find valid subscription for '${apiKey}'", "type": "string" }, "statusCode": { "example": 401, "description": "401", "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error401NotActive": { "properties": { "errorCode": { "example": "subscription.not.active", "description": "subscription.not.active", "type": "string" }, "message": { "example": "Subscription not active anymore.", "description": "Subscription not active anymore.", "type": "string" }, "statusCode": { "example": 401, "description": "401", "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403ComplianceBtc": { "properties": { "errorCode": { "description": "compliance.country.btc.not.supported", "example": "compliance.country.btc.not.supported", "type": "string" }, "message": { "description": "Customer country not supported for BTC.", "example": "Customer country not supported for BTC.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403Libra": { "properties": { "errorCode": { "description": "libra.request.failed", "example": "libra.request.failed", "type": "string" }, "message": { "description": "${error}", "example": "${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthBroadcast": { "properties": { "errorCode": { "description": "ethereum.broadcast.failed", "example": "ethereum.broadcast.failed", "type": "string" }, "message": { "description": "Unable to broadcast transaction due to ${error}.", "example": "Unable to broadcast transaction due to ${error}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthErc20NotFound": { "properties": { "errorCode": { "description": "erc20.token.notFound", "example": "erc20.token.notFound", "type": "string" }, "message": { "description": "No such ERC20 currency ${name}.", "example": "No such ERC20 currency ${name}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxNotFound": { "properties": { "errorCode": { "description": "tx.missing", "example": "tx.missing", "type": "string" }, "message": { "description": "No such tx.", "example": "No such tx.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error404TxNotFound": { "properties": { "errorCode": { "description": "tx.not.found", "example": "tx.not.found", "type": "string" }, "message": { "description": "Transaction not found. Possible not exists or is still pending.", "example": "Transaction not found. Possible not exists or is still pending.", "type": "string" }, "statusCode": { "description": "404", "example": 404, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthErc20Set": { "properties": { "errorCode": { "description": "erc20.address.set", "example": "erc20.address.set", "type": "string" }, "message": { "description": "ERC20 address was already set.", "example": "ERC20 address was already set.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthMnemonicPrivateKey": { "properties": { "errorCode": { "description": "private.mnemonic.missing", "example": "private.mnemonic.missing", "type": "string" }, "message": { "description": "Either mnemonic and index or private key must be present.", "example": "Either mnemonic and index or private key must be present.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthErc20Unsupported": { "properties": { "errorCode": { "description": "eth.erc20.unsupported", "example": "eth.erc20.unsupported", "type": "string" }, "message": { "description": "Unsupported ETH ERC20 blockchain.", "example": "Unsupported ETH ERC20 blockchain.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthTxHash": { "properties": { "errorCode": { "description": "eth.transaction.hash", "example": "eth.transaction.hash", "type": "string" }, "message": { "description": "Unable to calculate transaction hash. ${error}", "example": "Unable to calculate transaction hash. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthTxSign": { "properties": { "errorCode": { "description": "eth.transaction.sign", "example": "eth.transaction.sign", "type": "string" }, "message": { "description": "Unable to sign transaction. ${error}", "example": "Unable to sign transaction. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthErc20TxSign": { "properties": { "errorCode": { "description": "eth.erc20.sign", "example": "eth.erc20.sign", "type": "string" }, "message": { "description": "Unable to sign transaction for contract creation. ${error}", "example": "Unable to sign transaction for contract creation. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthErc721TxSign": { "properties": { "errorCode": { "description": "eth.erc721.sign", "example": "eth.erc721.sign", "type": "string" }, "message": { "description": "Unable to sign transaction for contract creation. ${error}", "example": "Unable to sign transaction for contract creation. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthErc721Call": { "properties": { "errorCode": { "description": "eth.erc721.failed", "example": "eth.erc721.failed", "type": "string" }, "message": { "description": "Unable to obtain information for token. ${error}", "example": "Unable to obtain information for token. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthGasCalculation": { "properties": { "errorCode": { "description": "eth.transaction.gas", "example": "eth.transaction.gas", "type": "string" }, "message": { "description": "Unable to calculate gas limit for transaction. ${error}", "example": "Unable to calculate gas limit for transaction. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthTxBody": { "properties": { "errorCode": { "description": "ethereum.transaction.body", "example": "ethereum.transaction.body", "type": "string" }, "message": { "description": "Either currency, or tokenAddress must be defined.", "example": "Either currency, or tokenAddress must be defined.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthScBody": { "properties": { "errorCode": { "description": "ethereum.sc.invalid", "example": "ethereum.sc.invalid", "type": "string" }, "message": { "description": "Invalid parameters for smart contract invocation.", "example": "Invalid parameters for smart contract invocation.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403EthGasPrice": { "properties": { "errorCode": { "description": "gas.price.failed", "example": "gas.price.failed", "type": "string" }, "message": { "description": "Unable to obtain current GAS price.", "example": "Unable to obtain current GAS price.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403ComplianceEth": { "properties": { "errorCode": { "description": "compliance.country.eth.not.supported", "example": "compliance.country.eth.not.supported", "type": "string" }, "message": { "description": "Customer country not supported for ETH.", "example": "Customer country not supported for ETH.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountTestnet": { "properties": { "errorCode": { "description": "account.blockchain.testnet", "example": "account.blockchain.testnet", "type": "string" }, "message": { "description": "Unable to create account, unsupported testnet blockchain.", "example": "Unable to create account, unsupported testnet blockchain.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountXpub": { "properties": { "errorCode": { "description": "account.xpub.present", "example": "account.xpub.present", "type": "string" }, "message": { "description": "Unable to create ${account.currency} account with xpub.", "example": "Unable to create ${account.currency} account with xpub.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AddressXpub": { "properties": { "errorCode": { "description": "account.xpub.present", "example": "account.xpub.present", "type": "string" }, "message": { "description": "Xpub assigned to account, it is not possible to assign address. Use generateAddress method instead.", "example": "Xpub assigned to account, it is not possible to assign address. Use generateAddress method instead.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountCurrency": { "properties": { "errorCode": { "description": "ledger.currency.invalid", "example": "ledger.currency.invalid", "type": "string" }, "message": { "description": "Unable to create an account, unsupported currency.", "example": "Unable to create an account, unsupported currency.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountIncompatibleXpub": { "properties": { "errorCode": { "description": "account.xpub.incompatible", "example": "account.xpub.incompatible", "type": "string" }, "message": { "description": "Xpub not compatible with account currency.", "example": "Xpub not compatible with account currency.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountIncompatibleXpubBtc": { "properties": { "errorCode": { "description": "Address.generation.failed.wrong.xpub", "example": "address.generation.failed.wrong.xpub", "type": "string" }, "message": { "description": "Unable to generate address, wrong xpub and account type.", "example": "Unable to generate address, wrong xpub and account type.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountAddressGeneral": { "properties": { "errorCode": { "description": "Address.generation.failed", "example": "address.generation.failed", "type": "string" }, "message": { "description": "Unable to generate address.", "example": "Unable to generate address.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BnbFailed": { "properties": { "errorCode": { "description": "bnb.failed", "example": "bnb.failed", "type": "string" }, "message": { "description": "Unable to communicate with blockchain. ${error}", "example": "Unable to communicate with blockchain. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BnbAddressFailed": { "properties": { "errorCode": { "description": "Address.bnb.generation.failed.wrong.xpub", "example": "address.bnb.generation.failed.wrong.xpub", "type": "string" }, "message": { "description": "Unable to generate BNB address, wrong xpub and account type.", "example": "Unable to generate BNB address, wrong xpub and account type.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BnbBroadcatSigFailed": { "properties": { "errorCode": { "description": "bnb.broadcast.bad.signature", "example": "bnb.broadcast.bad.signature", "type": "string" }, "message": { "description": "Unable to broadcast BNB transaction, bad signature.", "example": "Unable to broadcast BNB transaction, bad signature.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BnbTxStateFailed": { "properties": { "errorCode": { "description": "bnb.broadcast.failed.tx.state", "example": "bnb.broadcast.failed.tx.state", "type": "string" }, "message": { "description": "Unable to broadcast BNB transaction, tx ${hash} state not OK.", "example": "Unable to broadcast BNB transaction, tx ${hash} state not OK.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BnbTxFailed": { "properties": { "errorCode": { "description": "bnb.transfer.failed", "example": "bnb.transfer.failed", "type": "string" }, "message": { "description": "Unable to transfer funds. ${error}", "example": "Unable to transfer funds. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BtcTxFailed": { "properties": { "errorCode": { "description": "transaction.failed", "example": "transaction.failed", "type": "string" }, "message": { "description": "No spendable inputs.", "example": "No spendable inputs.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BtcTx": { "properties": { "errorCode": { "description": "transaction.invalid.body", "example": "transaction.invalid.body", "type": "string" }, "message": { "description": "Either UTXO, or addresses must be present.", "example": "Either UTXO, or addresses must be present.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountNotExists": { "properties": { "errorCode": { "description": "account.not.exists", "example": "account.not.exists", "type": "string" }, "message": { "description": "No such account.", "example": "No such account.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BlockageNotExists": { "properties": { "errorCode": { "description": "blockage.not.exists", "example": "blockage.not.exists", "type": "string" }, "message": { "description": "No such blockage.", "example": "No such blockage.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BlockageAmount": { "properties": { "errorCode": { "description": "blockage.amount.exceeded", "example": "blockage.amount.exceeded", "type": "string" }, "message": { "description": "Amount to transfer is greater then amount of the blockage.", "example": "Amount to transfer is greater then amount of the blockage.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403SubscriptionNotExists": { "properties": { "errorCode": { "description": "subscription.not.exists", "example": "subscription.not.exists", "type": "string" }, "message": { "description": "No such subscription.", "example": "No such subscription.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403SubscriptionType": { "properties": { "errorCode": { "description": "subscription.type.invalid", "example": "subscription.type.invalid", "type": "string" }, "message": { "description": "Invalid subscription type.", "example": "Invalid subscription type.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403SubscriptionCurrency": { "properties": { "errorCode": { "description": "subscription.attr.currency.invalid", "example": "subscription.attr.currency.invalid", "type": "string" }, "message": { "description": "Invalid subscription attribute 'currency'.", "example": "Invalid subscription attribute 'currency'.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403SubscriptionInterval": { "properties": { "errorCode": { "description": "subscription.attr.interval.invalid", "example": "subscription.attr.interval.invalid", "type": "string" }, "message": { "description": "Invalid subscription attribute 'interval'.", "example": "Invalid subscription attribute 'interval'.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403SubscriptionBalance": { "properties": { "errorCode": { "description": "subscription.attr.balance.invalid", "example": "subscription.attr.balance.invalid", "type": "string" }, "message": { "description": "Invalid subscription attribute 'limit' or 'typeOfBalance'.", "example": "Invalid subscription attribute 'limit' or 'typeOfBalance'.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403SubscriptionId": { "properties": { "errorCode": { "description": "subscription.attr.incoming.invalid", "example": "subscription.attr.incoming.invalid", "type": "string" }, "message": { "description": "Invalid subscription attribute 'id' or 'url'.", "example": "Invalid subscription attribute 'id' or 'url'.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403SubscriptionPendingId": { "properties": { "errorCode": { "description": "subscription.attr.pending.invalid", "example": "subscription.attr.pending.invalid", "type": "string" }, "message": { "description": "Invalid subscription attribute 'id' or 'url'.", "example": "Invalid subscription attribute 'id' or 'url'.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403ReportNotAvailable": { "properties": { "errorCode": { "description": "report.invalid", "example": "report.invalid", "type": "string" }, "message": { "description": "Unsupported report type.", "example": "Unsupported report type.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountInactive": { "properties": { "errorCode": { "description": "account.inactive", "example": "account.inactive", "type": "string" }, "message": { "description": "Unable to deactivate inactive account.", "example": "Unable to deactivate inactive account.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountActive": { "properties": { "errorCode": { "description": "account.active", "example": "account.active", "type": "string" }, "message": { "description": "Unable to activate active account.", "example": "Unable to activate active account.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountFrozen": { "properties": { "errorCode": { "description": "account.frozen", "example": "account.frozen", "type": "string" }, "message": { "description": "Unable to freeze frozen account.", "example": "Unable to freeze frozen account.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountNotFrozen": { "properties": { "errorCode": { "description": "account.not.frozen", "example": "account.not.frozen", "type": "string" }, "message": { "description": "Unable to unfreeze unfrozen account.", "example": "Unable to unfreeze unfrozen account.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403CustomerInternalNotExists": { "properties": { "errorCode": { "description": "customer.internal.not.exists", "example": "customer.internal.not.exists", "type": "string" }, "message": { "description": "No such customer.", "example": "No such customer.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403CustomerActive": { "properties": { "errorCode": { "description": "customer.active", "example": "customer.active", "type": "string" }, "message": { "description": "Unable to activate active customer.", "example": "Unable to activate active customer.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403CustomerInactive": { "properties": { "errorCode": { "description": "customer.inactive", "example": "customer.inactive", "type": "string" }, "message": { "description": "Unable to perform operation on inactive customer.", "example": "Unable to perform operation on inactive customer.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403CustomerDisabled": { "properties": { "errorCode": { "description": "customer.disabled", "example": "customer.disabled", "type": "string" }, "message": { "description": "Unable to disable disabled customer.", "example": "Unable to disable disabled customer.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403CustomerEnabled": { "properties": { "errorCode": { "description": "customer.enabled", "example": "customer.enabled", "type": "string" }, "message": { "description": "Unable to enable enabled customer.", "example": "Unable to enable enabled customer.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403CustomerDeactivateActiveAccounts": { "properties": { "errorCode": { "description": "customer.deactivate.account.active", "example": "customer.deactivate.account.active", "type": "string" }, "message": { "description": "Unable to deactivate customer, accounts not deactivated.", "example": "Unable to deactivate customer, accounts not deactivated.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403CustomerNotExists": { "properties": { "errorCode": { "description": "customer.not.exists", "example": "customer.not.exists", "type": "string" }, "message": { "description": "No customer with given external ID ${externalId} exists.", "example": "No customer with given external ID ${externalId} exists.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BlockDelete": { "properties": { "errorCode": { "description": "customer.blockage.inactive", "example": "customer.blockage.inactive", "type": "string" }, "message": { "description": "Unable to delete blockages on account for inactive customer.", "example": "Unable to delete blockages on account for inactive customer.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403CustomerNotActive": { "properties": { "errorCode": { "description": "customer.not.active", "example": "customer.not.active", "type": "string" }, "message": { "description": "Customer not active.", "example": "Customer not active.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VCNoAccount": { "properties": { "errorCode": { "description": "virtual.account.notValid", "example": "virtual.account.notValid", "type": "string" }, "message": { "description": "Unable to perform operation on virtual currency, account does not exists.", "example": "Unable to perform operation on virtual currency, account does not exists.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VCTxFailed": { "properties": { "errorCode": { "description": "virtual.tx.failed", "example": "virtual.tx.failed", "type": "string" }, "message": { "description": "Unable to perform operation on virtual currency, impossible to store transaction.", "example": "Unable to perform operation on virtual currency, impossible to store transaction.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VCRevokeBalance": { "properties": { "errorCode": { "description": "virtual.account.balance", "example": "virtual.account.balance", "type": "string" }, "message": { "description": "Insufficient balance to revoke virtual currency on account.", "example": "Insufficient balance to revoke virtual currency on account.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VCCreateFailed": { "properties": { "errorCode": { "description": "virtual.creation.error", "example": "virtual.creation.error", "type": "string" }, "message": { "description": "It is not possible to create virtual currency.", "example": "It is not possible to create virtual currency.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VCPrefix": { "properties": { "errorCode": { "description": "virtual.name.prefix", "example": "virtual.name.prefix", "type": "string" }, "message": { "description": "Virtual currency has wrong name, must start with VC_.", "example": "Virtual currency has wrong name, must start with VC_.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VCDuplicate": { "properties": { "errorCode": { "description": "virtual.duplicate", "example": "virtual.duplicate", "type": "string" }, "message": { "description": "Virtual currency with given name already exists.", "example": "Virtual currency with given name already exists.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountCustomerInactive": { "properties": { "errorCode": { "description": "account.customer.inactive", "example": "account.customer.inactive", "type": "string" }, "message": { "description": "Unable to activate account, customer inactive.", "example": "Unable to activate account, customer inactive.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountBalanceNonZero": { "properties": { "errorCode": { "description": "account.balance.non.zero", "example": "account.balance.non.zero", "type": "string" }, "message": { "description": "Unable to deactivate account with non-zero balance.", "example": "Unable to deactivate account with non-zero balance.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TradeBalanceNonZero": { "properties": { "errorCode": { "description": "account.trade.non.zero", "example": "account.trade.non.zero", "type": "string" }, "message": { "description": "Unable to deactivate account with non-zero exchange trades.", "example": "Unable to deactivate account with non-zero exchange trades.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AmountFormat": { "properties": { "errorCode": { "description": "amount.format", "example": "amount.format", "type": "string" }, "message": { "description": "Amount has incorrect format.", "example": "Amount has incorrect format.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403RecipientFormat": { "properties": { "errorCode": { "description": "withdrawal.recipient.format", "example": "withdrawal.recipient.format", "type": "string" }, "message": { "description": "Recipient blockchain address has incorrect format.", "example": "Recipient blockchain address has incorrect format.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AccountCurrencyVC": { "properties": { "errorCode": { "description": "account.currency.missing", "example": "account.currency.missing", "type": "string" }, "message": { "description": "No such virtual currency ${currency} for account ${account}.", "example": "No such virtual currency ${currency} for account ${account}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VCNotFound": { "properties": { "errorCode": { "description": "vc.not.found", "example": "vc.not.found", "type": "string" }, "message": { "description": "No such virtual currency.", "example": "No such virtual currency.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AddressUsed": { "properties": { "errorCode": { "description": "Address.used", "example": "address.used", "type": "string" }, "message": { "description": "Address and currency already in use.", "example": "Address and currency already in use.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AddressNotFound": { "properties": { "errorCode": { "description": "Address.not.found", "example": "address.not.found", "type": "string" }, "message": { "description": "No such address exists.", "example": "No such address exists.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AddressAccountXpubMissing": { "properties": { "errorCode": { "description": "account.xpub.missing", "example": "account.xpub.missing", "type": "string" }, "message": { "description": "No xpub assigned to account, it is not possible to generate address. Use assignAddress method instead.", "example": "No xpub assigned to account, it is not possible to generate address. Use assignAddress method instead.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AddressIndexUsed": { "properties": { "errorCode": { "description": "Address.index.used", "example": "address.index.used", "type": "string" }, "message": { "description": "Unable to create address, derivation index is already used.", "example": "Unable to create address, derivation index is already used.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BtcBlockchain": { "properties": { "errorCode": { "description": "blockchain.error.code", "example": "blockchain.error.code", "type": "string" }, "message": { "description": "${error.message} Code: ${error.code}", "example": "${error.message} Code: ${error.code}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error404BlockNotExists": { "properties": { "errorCode": { "description": "block.hash.not.exists", "example": "block.hash.not.exists", "type": "string" }, "message": { "description": "No such block.", "example": "No such block.", "type": "string" }, "statusCode": { "description": "404", "example": 404, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403Broadcast": { "properties": { "errorCode": { "description": "blockchain.broadcast.error", "example": "blockchain.broadcast.error", "type": "string" }, "message": { "description": "Unable to broadcast transaction, wrong input data.", "example": "Unable to broadcast transaction, wrong input data.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BlockchainPrivateFailed": { "properties": { "errorCode": { "description": "key.generation.failed.wrong.mnemonic", "example": "key.generation.failed.wrong.mnemonic", "type": "string" }, "message": { "description": "Unable to generate address, wrong mnemonic and index.", "example": "Unable to generate address, wrong mnemonic and index.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BtcUTXO": { "properties": { "errorCode": { "description": "tx.hash.index.spent", "example": "tx.hash.index.spent", "type": "string" }, "message": { "description": "No such UTXO for transaction and index.", "example": "No such UTXO for transaction and index.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BcashBroadcast": { "properties": { "errorCode": { "description": "bch.broadcast.failed", "example": "bch.broadcast.failed", "type": "string" }, "message": { "description": "Unable to broadcast transaction. Error from blockchain: ${error}", "example": "Unable to broadcast transaction. Error from blockchain: ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403WithdrawalNotFound": { "properties": { "errorCode": { "description": "withdrawal.missing", "example": "withdrawal.missing", "type": "string" }, "message": { "description": "No such withdrawal.", "example": "No such withdrawal.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403KMSNotExists": { "properties": { "errorCode": { "description": "kms.missing", "example": "kms.missing", "type": "string" }, "message": { "description": "No such KMS signature with id '{id}'.", "example": "No such KMS signature with id '{id}'.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OffchainNotCancelled": { "properties": { "errorCode": { "description": "withdrawal.not.cancelled.transaction.failed", "example": "withdrawal.not.cancelled.transaction.failed", "type": "string" }, "message": { "description": "Unable to broadcast transaction, and impossible to cancel withdrawal. ID is attached, \"${withdrawalId}\", cancel it manually.", "example": "Unable to broadcast transaction, and impossible to cancel withdrawal. ID is attached, \"${withdrawalId}\", cancel it manually.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XlmFailed": { "properties": { "errorCode": { "description": "xlm.failed", "example": "xlm.failed", "type": "string" }, "message": { "description": "Unable to communicate with blockchain. ${error}", "example": "Unable to communicate with blockchain. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XrpFailed": { "properties": { "errorCode": { "description": "xrp.failed", "example": "xrp.failed", "type": "string" }, "message": { "description": "Unable to communicate with blockchain. ${error}", "example": "Unable to communicate with blockchain. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XrpCode": { "properties": { "errorCode": { "description": "xrp.account.failed", "example": "xrp.account.failed", "type": "string" }, "message": { "description": "${error} Code: ${code}", "example": "${error} Code: ${code}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XrpLedger": { "properties": { "errorCode": { "description": "xrp.ledger.failed", "example": "xrp.ledger.failed", "type": "string" }, "message": { "description": "${error} Code: ${code}", "example": "${error} Code: ${code}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XrpBroadcast": { "properties": { "errorCode": { "description": "xrp.broadcast.failed", "example": "xrp.broadcast.failed", "type": "string" }, "message": { "description": "Xrp submit tx failed. ${error}", "example": "Xrp submit tx failed. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XrpMultiple": { "properties": { "errorCode": { "description": "xrp.settings.multiple", "example": "xrp.settings.multiple", "type": "string" }, "message": { "description": "It is possible to set 1 parameter at a time.", "example": "It is possible to set 1 parameter at a time.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XrpAttr": { "properties": { "errorCode": { "description": "attr.wrong.format", "example": "attr.wrong.format", "type": "string" }, "message": { "description": "Wrong attr of withdrawal, should be of uint32 type.", "example": "Wrong attr of withdrawal, should be of uint32 type.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XrpFee": { "properties": { "errorCode": { "description": "xrp.fee", "example": "xrp.fee", "type": "string" }, "message": { "description": "Unable to calculate fee.", "example": "Unable to calculate fee.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XrpSign": { "properties": { "errorCode": { "description": "xrp.sign.failed", "example": "xrp.sign.failed", "type": "string" }, "message": { "description": "Unable to sign tx. ${error}", "example": "Unable to sign tx. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403XlmTxFailed": { "properties": { "errorCode": { "description": "xlm.tx.failed", "example": "xlm.tx.failed", "type": "string" }, "message": { "description": "Unable to construct transaction. ${error}", "example": "Unable to construct transaction. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VetFailed": { "properties": { "errorCode": { "description": "vet.failed", "example": "vet.failed", "type": "string" }, "message": { "description": "Unable to communicate with blockchain. ${error}", "example": "Unable to communicate with blockchain. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VetGas": { "properties": { "errorCode": { "description": "vet.transaction.gas", "example": "vet.transaction.gas", "type": "string" }, "message": { "description": "Unable to calculate gas limit for transaction. ${error}", "example": "Unable to calculate gas limit for transaction. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403VetTxHash": { "properties": { "errorCode": { "description": "vet.transaction.hash", "example": "vet.transaction.hash", "type": "string" }, "message": { "description": "Unable to calculate transaction hash.", "example": "Unable to calculate transaction hash.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "TransactionFeeEgldBlockchain": { "type": "object", "properties": { "sender": { "description": "Account address of the sender", "example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7", "maxLength": 62, "minLength": 62, "type": "string" }, "receiver": { "description": "Account address of the receiver or smart contract", "example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq6", "maxLength": 62, "minLength": 62, "type": "string" }, "value": { "type": "string", "description": "Value to be sent.", "example": "0.1" }, "data": { "type": "string", "description": "Additinal data, that will be passed to blockchain transaction.", "example": "Hello world" } }, "required": ["sender", "receiver", "value"] }, "Error403EgldGasCalculation": { "properties": { "errorCode": { "description": "egld.transaction.gas", "example": "egld.transaction.gas", "type": "string" }, "message": { "description": "Unable to calculate gas limit for transaction. ${error}", "example": "Unable to calculate gas limit for transaction. ${error}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OffchainBroadcastState": { "properties": { "errorCode": { "description": "withdrawal.unexpected.state", "example": "withdrawal.unexpected.state", "type": "string" }, "message": { "description": "Unable to complete withdrawal, which is not in InProgress state.", "example": "Unable to complete withdrawal, which is not in InProgress state.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OffchainCancelled": { "properties": { "errorCode": { "description": "withdrawal.prepare.failed", "example": "withdrawal.prepare.failed", "type": "string" }, "message": { "description": "Unable to prepare transaction, withdrawal cancelled.", "example": "Unable to prepare transaction, withdrawal cancelled.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OffchainNotSupported": { "properties": { "errorCode": { "description": "offchain.not.supported", "example": "offchain.not.supported", "type": "string" }, "message": { "description": "Offchain not supported for account with ${account.currency} currency.", "example": "Offchain not supported for account with ${account.currency} currency.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403AddressAccountXpubUsed": { "properties": { "errorCode": { "description": "xpub.used", "example": "xpub.used", "type": "string" }, "message": { "description": "XPub already used registered within Tatum", "example": "XPub already used registered within Tatum", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403RateNotFound": { "properties": { "errorCode": { "description": "rate.not.found", "example": "rate.not.found", "type": "string" }, "message": { "description": "No such currency rate.", "example": "No such currency rate.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OffchainBroadcast": { "properties": { "errorCode": { "description": "broadcast.failed.withdrawalId", "example": "broadcast.failed.withdrawalId", "type": "string" }, "message": { "description": "WithdrawalId must be present.", "example": "WithdrawalId must be present.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OffchainCheck": { "properties": { "errorCode": { "description": "withdrawal.check.currency", "example": "withdrawal.check.currency", "type": "string" }, "message": { "description": "Withdrawal check available only for ETH based currencies.", "example": "Withdrawal check available only for ETH based currencies.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BtcTxUtxoFailed": { "properties": { "errorCode": { "description": "transaction.preparation.failed.utxo", "example": "transaction.preparation.failed.utxo", "type": "string" }, "message": { "description": "Impossible to find last UTXO.", "example": "Impossible to find last UTXO.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403BtcMnemonicTxFailed": { "properties": { "errorCode": { "description": "transaction.preparation.failed", "example": "transaction.preparation.failed", "type": "string" }, "message": { "description": "Impossible to prepare transaction. Either mnemonic or keyPair and attr must be present.", "example": "Impossible to prepare transaction. Either mnemonic or keyPair and attr must be present.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403WithdrawalFailed": { "properties": { "errorCode": { "description": "withdrawal.failed.transaction.failed", "example": "withdrawal.failed.transaction.failed", "type": "string" }, "message": { "description": "Unable to store withdrawal, it is impossible to create transaction.", "example": "Unable to store withdrawal, it is impossible to create transaction.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403WithdrawalCancelled": { "properties": { "errorCode": { "description": "withdrawal.not.cancelled.transaction.failed", "example": "withdrawal.not.cancelled.transaction.failed", "type": "string" }, "message": { "description": "Unable to cancel withdrawal ${id}, it is impossible to create refund transaction.", "example": "Unable to cancel withdrawal ${id}, it is impossible to create refund transaction.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403FeeFormat": { "properties": { "errorCode": { "description": "fee.format", "example": "fee.format", "type": "string" }, "message": { "description": "Fee has incorrect format.", "example": "Fee has incorrect format.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxSenderNotFound": { "properties": { "errorCode": { "description": "senderAccount.not.exists", "example": "senderAccount.not.exists", "type": "string" }, "message": { "description": "Unable to find sender account ${transaction.senderAccountId}.", "example": "Unable to find sender account ${transaction.senderAccountId}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxSenderFrozen": { "properties": { "errorCode": { "description": "senderAccount.frozen", "example": "senderAccount.frozen", "type": "string" }, "message": { "description": "Sender account ${transaction.senderAccountId} is frozen, unable to perform payment.", "example": "Sender account ${transaction.senderAccountId} is frozen, unable to perform payment.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxSenderCustomerDisabled": { "properties": { "errorCode": { "description": "senderAccount.customer.disabled", "example": "senderAccount.customer.disabled", "type": "string" }, "message": { "description": "Sender accounts customer ${senderAccount.customerId} is disabled, unable to perform payment.", "example": "Sender accounts customer ${senderAccount.customerId} is disabled, unable to perform payment.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxRecipientNotFound": { "properties": { "errorCode": { "description": "recipientAccount.not.exists", "example": "recipientAccount.not.exists", "type": "string" }, "message": { "description": "Unable to find recipient account ${transaction.recipientAccountId}.", "example": "Unable to find recipient account ${transaction.recipientAccountId}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxCurrency": { "properties": { "errorCode": { "description": "transaction.currency.incompatible", "example": "transaction.currency.incompatible", "type": "string" }, "message": { "description": "Incompatible currencies for sender account ${transaction.senderAccountId} and recipient account ${transaction.recipientAccountId}.", "example": "Incompatible currencies for sender account ${transaction.senderAccountId} and recipient account ${transaction.recipientAccountId}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxBalance": { "properties": { "errorCode": { "description": "balance.insufficient", "example": "balance.insufficient", "type": "string" }, "message": { "description": "Insufficient balance for account ${transaction.senderAccountId} and payment amount ${transaction.amount}. Sender balance is ${senderAccount.balance.availableBalance as string}, amount is ${amount}", "example": "Insufficient balance for account ${transaction.senderAccountId} and payment amount ${transaction.amount}. Sender balance is ${senderAccount.balance.availableBalance as string}, amount is ${amount}", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxAmountBtc": { "properties": { "errorCode": { "description": "amount.btc", "example": "amount.btc", "type": "string" }, "message": { "description": "BTC|LTC|BCH payment amount must be at least 0.00000000000001, not ${transaction.amount}.", "example": "BTC|LTC|BCH payment amount must be at least 0.00000000000001, not ${transaction.amount}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxAmountBtcOffchain": { "properties": { "errorCode": { "description": "transaction.amount.btc", "example": "transaction.amount.btc", "type": "string" }, "message": { "description": "BTC|LTC|BCH payment amount must be at least 0.00000001, not ${transaction.amount}.", "example": "BTC|LTC|BCH payment amount must be at least 0.00000001, not ${transaction.amount}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxAmountAda": { "properties": { "errorCode": { "description": "transaction.amount.ada", "example": "transaction.amount.ada", "type": "string" }, "message": { "description": "ADA payment amount must be at least 0.000001, not ${transaction.amount}.", "example": "ADA payment amount must be at least 0.000001, not ${transaction.amount}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxAmountAdaOffchain": { "properties": { "errorCode": { "description": "amount.ada", "example": "amount.ada", "type": "string" }, "message": { "description": "ADA payment amount must be at least 0.000000000001, not ${transaction.amount}.", "example": "ADA payment amount must be at least 0.000000000001, not ${transaction.amount}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403WithdrawalPending": { "properties": { "errorCode": { "description": "withdrawal.pending", "example": "withdrawal.pending", "type": "string" }, "message": { "description": "Unable to prepare withdrawal, last withdrawal with id ${id} is not yet processed by blockchain.", "example": "Unable to prepare withdrawal, last withdrawal with id ${id} is not yet processed by blockchain.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxAmountEth": { "properties": { "errorCode": { "description": "amount.eth", "example": "amount.eth", "type": "string" }, "message": { "description": "ETH payment amount must be at least 0.000000000001, not ${transaction.amount}.", "example": "ETH payment amount must be at least 0.000000000001, not ${transaction.amount}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxAmountEthOffchain": { "properties": { "errorCode": { "description": "transaction.amount.eth", "example": "transaction.amount.eth", "type": "string" }, "message": { "description": "ETH payment amount must be at least 0.000000000000000001, not ${transaction.amount}.", "example": "ETH payment amount must be at least 0.000000000000000001, not ${transaction.amount}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403TxNotCompliant": { "properties": { "errorCode": { "description": "transaction.not.compliant", "example": "transaction.not.compliant", "type": "string" }, "message": { "description": "Transaction not compliant, recipient account customer country is not defined.", "example": "Transaction not compliant, recipient account customer country is not defined.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403WithdrawalVC": { "properties": { "errorCode": { "description": "withdrawal.account.virtual", "example": "withdrawal.account.virtual", "type": "string" }, "message": { "description": "Sender account cannot be virtual.", "example": "Sender account cannot be virtual.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403Erc20Prefix": { "properties": { "errorCode": { "description": "erc20.symbol.prefix", "example": "erc20.symbol.prefix", "type": "string" }, "message": { "description": "ERC20 token cannot start with VC_.", "example": "ERC20 token cannot start with VC_.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403Erc20XpubBoth": { "properties": { "errorCode": { "description": "erc20.address.xpub.both", "example": "erc20.address.xpub.both", "type": "string" }, "message": { "description": "Either xpub or address must be present, not both.", "example": "Either xpub or address must be present, not both.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403Erc20XpubMissing": { "properties": { "errorCode": { "description": "erc20.address.xpub.missing", "example": "erc20.address.xpub.missing", "type": "string" }, "message": { "description": "Either xpub or address must be present.", "example": "Either xpub or address must be present.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403Erc20NameDuplicate": { "properties": { "errorCode": { "description": "erc20.duplicate.name", "example": "erc20.duplicate.name", "type": "string" }, "message": { "description": "ERC20 token with given name already exists.", "example": "ERC20 token with given name already exists.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency1NotFound": { "properties": { "errorCode": { "description": "trade.currency1AccountId.not.exists", "example": "trade.currency1AccountId.not.exists", "type": "string" }, "message": { "description": "Unable to find currency1 account ${trade.currency1AccountId}.", "example": "Unable to find currency1 account ${trade.currency1AccountId}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderFeeNotFound": { "properties": { "errorCode": { "description": "trade.feeAccount", "example": "trade.feeAccount", "type": "string" }, "message": { "description": "Unable to find fee account ${trade.feeAccountId}.", "example": "Unable to find fee account ${trade.feeAccountId}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderFeeIncompatible": { "properties": { "errorCode": { "description": "trade.currency.fee", "example": "trade.currency.fee", "type": "string" }, "message": { "description": "Incompatible currencies for currency1 and fee account.", "example": "Incompatible currencies for currency1 and fee account.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency1Frozen": { "properties": { "errorCode": { "description": "trade.currency1AccountId.frozen", "example": "trade.currency1AccountId.frozen", "type": "string" }, "message": { "description": "Currency1 account ${trade.currency1AccountId} is frozen, unable to perform trade.", "example": "Currency1 account ${trade.currency1AccountId} is frozen, unable to perform trade.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency1CustomerDisabled": { "properties": { "errorCode": { "description": "trade.currency1AccountId.customer.disabled", "example": "trade.currency1AccountId.customer.disabled", "type": "string" }, "message": { "description": "Currency1 account's customer ${currency1Account.customerId} is disabled, unable to perform exchange trade.", "example": "Currency1 account's customer ${currency1Account.customerId} is disabled, unable to perform exchange trade.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency2NotFound": { "properties": { "errorCode": { "description": "trade.currency2AccountId.not.exists", "example": "trade.currency2AccountId.not.exists", "type": "string" }, "message": { "description": "Unable to find currency2 account ${trade.currency2AccountId}.", "example": "Unable to find currency2 account ${trade.currency2AccountId}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency2Frozen": { "properties": { "errorCode": { "description": "trade.currency2AccountId.frozen", "example": "trade.currency2AccountId.frozen", "type": "string" }, "message": { "description": "Currency2 account ${trade.currency2AccountId} is frozen, unable to perform trade.", "example": "Currency2 account ${trade.currency2AccountId} is frozen, unable to perform trade.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency2CustomerDisabled": { "properties": { "errorCode": { "description": "trade.currency2AccountId.customer.disabled", "example": "trade.currency2AccountId.customer.disabled", "type": "string" }, "message": { "description": "Currency2 account's customer ${currency2Account.customerId} is disabled, unable to perform exchange trade.", "example": "Currency2 account's customer ${currency2Account.customerId} is disabled, unable to perform exchange trade.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency1Pair": { "properties": { "errorCode": { "description": "trade.currency1.pair", "example": "trade.currency1.pair", "type": "string" }, "message": { "description": "Incompatible currencies for currency1 account ${trade.currency1AccountId} and trading pair.", "example": "Incompatible currencies for currency1 account ${trade.currency1AccountId} and trading pair.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency2Pair": { "properties": { "errorCode": { "description": "trade.currency2.pair", "example": "trade.currency2.pair", "type": "string" }, "message": { "description": "Incompatible currencies for currency2 account ${trade.currency2AccountId} and trading pair.", "example": "Incompatible currencies for currency2 account ${trade.currency2AccountId} and trading pair.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency1Balance": { "properties": { "errorCode": { "description": "trade.currency1.balance", "example": "trade.currency1.balance", "type": "string" }, "message": { "description": "Insufficient balance on currency1 account ${trade.currency1AccountId}.", "example": "Insufficient balance on currency1 account ${trade.currency1AccountId}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error403OrderCurrency2Balance": { "properties": { "errorCode": { "description": "trade.currency2.balance", "example": "trade.currency2.balance", "type": "string" }, "message": { "description": "Insufficient balance on currency2 account ${trade.currency2AccountId}.", "example": "Insufficient balance on currency2 account ${trade.currency2AccountId}.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": ["errorCode", "message", "statusCode"], "type": "object" }, "Error500": { "properties": { "message": { "example": "Internal server error", "description": "Internal server error", "type": "string" }, "statusCode": { "example": 500, "description": "500", "type": "number" } }, "required": ["statusCode", "message"], "type": "object" }, "Error403": { "properties": { "message": { "example": "Forbidden", "description": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "description": "403", "type": "number" } }, "required": ["statusCode", "message"], "type": "object" }, "Error401": { "properties": { "message": { "example": "Unauthorized", "description": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "description": "401", "type": "number" } }, "required": ["statusCode", "message"], "type": "object" }, "FeeETH": { "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "number", "description": "Gas limit for transaction in gas price.", "example": 40000 }, "gasPrice": { "type": "number", "description": "Gas price in Gwei.", "example": 20 } } }, "FeeBtc": { "type": "object", "required": ["fast", "medium", "slow"], "properties": { "fast": { "type": "string", "description": "Transaction fee in BTC|LTC to be paid, if transaction should be included in next 1-2 blocks.", "example": "0.006584" }, "medium": { "type": "string", "description": "Transaction fee in BTC|LTC to be paid, if transaction should be included in next 5-6 blocks.", "example": "0.004584" }, "slow": { "type": "string", "description": "Transaction fee in BTC|LTC to be paid, if transaction should be included in next 7+ blocks.", "example": "0.002584" } } }, "EstimateFee": { "type": "object", "required": ["chain", "type"], "properties": { "chain": { "type": "string", "description": "Blockchain to estimate fee for.", "enum": ["CELO", "ETH", "BSC", "XDC", "ONE", "MATIC", "KLAY"] }, "type": { "type": "string", "description": "Type of transaction", "enum": [ "DEPLOY_ERC20", "DEPLOY_NFT", "MINT_NFT", "BURN_NFT", "TRANSFER_NFT", "TRANSFER_ERC20", "DEPLOY_AUCTION", "DEPLOY_MARKETPLACE" ] }, "sender": { "type": "string", "maxLength": 42, "minLength": 42, "example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef", "description": "Sender address, if type is TRANSFER_ERC20" }, "recipient": { "description": "Blockchain address to send assets, if type is TRANSFER_ERC20", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "maxLength": 42, "minLength": 42, "type": "string" }, "contractAddress": { "description": "Contract address of ERC20 token, if type is TRANSFER_ERC20", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "maxLength": 42, "minLength": 42, "type": "string" }, "amount": { "description": "Amount to be sent in ERC20, if type is TRANSFER_ERC20", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" } } }, "EstimateFeeDeployCustodialWallet": { "type": "object", "required": ["chain", "type", "batchCount"], "properties": { "chain": { "type": "string", "description": "Blockchain to estimate fee for.", "enum": ["CELO", "ETH", "BSC", "XDC", "ONE", "MATIC", "KLAY"] }, "type": { "type": "string", "description": "Type of transaction", "enum": ["DEPLOY_CUSTODIAL_WALLET_BATCH"] }, "batchCount": { "description": "Number of addresses to create", "example": 10, "minimum": 1, "maximum": 300, "type": "number" } } }, "EstimateFeeBatchMintNft": { "type": "object", "required": ["chain", "type", "sender", "recipients", "tokenIds", "urls"], "properties": { "chain": { "type": "string", "description": "Blockchain to estimate fee for.", "enum": ["CELO", "ETH", "BSC", "XDC", "ONE", "MATIC", "KLAY"] }, "type": { "type": "string", "description": "Type of transaction", "enum": ["MINT_NFT_BATCH"] }, "sender": { "type": "string", "maxLength": 42, "minLength": 43, "example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef", "description": "Address of the minter" }, "recipients": { "type": "array", "description": "Blockchain addresses to mint tokens to", "items": { "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "maxLength": 42, "minLength": 43, "type": "string" } }, "contractAddress": { "description": "Contract address of NFT token", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "maxLength": 42, "minLength": 43, "type": "string" }, "tokenIds": { "type": "array", "description": "Token IDs", "items": { "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" } }, "urls": { "type": "array", "description": "Metadata URLs", "items": { "example": "ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" } } } }, "EstimateFeeTransferFromCustodial": { "type": "object", "required": [ "chain", "type", "sender", "recipient", "contractAddress", "custodialAddress", "amount", "tokenType" ], "properties": { "chain": { "type": "string", "description": "Blockchain to estimate fee for.", "enum": ["CELO", "ETH", "BSC", "XDC", "KLAY", "ONE", "MATIC"] }, "type": { "type": "string", "description": "Type of transaction", "enum": ["TRANSFER_CUSTODIAL"] }, "sender": { "type": "string", "maxLength": 42, "example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef", "minLength": 42, "description": "Sender address" }, "recipient": { "description": "Blockchain address to send assets", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "maxLength": 42, "minLength": 42, "type": "string" }, "contractAddress": { "description": "Contract address of the token", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "maxLength": 42, "minLength": 42, "type": "string" }, "custodialAddress": { "description": "Contract address of custodial wallet contract", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "maxLength": 42, "minLength": 42, "type": "string" }, "amount": { "description": "Amount to be sent in native asset, ERC20 or ERC1155", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenType": { "description": "Type of the token to transfer from gas pump wallet. 0 - ERC20, 1 - ERC721, 2 - ERC1155, 3 - native asset", "example": 0, "type": "number", "minimum": 0, "maximum": 3 } } }, "OffchainEstimateFee": { "type": "object", "required": ["senderAccountId", "address", "amount"], "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "xpub": { "description": "Extended public key (xpub) of the wallet associated with the accounts.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" } } }, "EstimateFeeFromAddress": { "type": "object", "required": ["chain", "type", "fromAddress", "to"], "properties": { "chain": { "type": "string", "description": "Blockchain to estimate fee for.", "enum": ["BTC", "LTC"] }, "type": { "type": "string", "description": "Type of transaction", "enum": ["TRANSFER"] }, "fromAddress": { "description": "Array of addresses. Tatum will automatically scan last 100 transactions for each address and will use all of the unspent values. We advise to use this option if you have 1 address per 1 transaction only.", "type": "array", "items": { "type": "string", "example": "2N9bBiH2qrTDrPCzrNhaFGdkNKS86PJAAAS", "minimum": 30, "maximum": 50 } }, "to": { "description": "Array of addresses and values to send bitcoins to. Values must be set in BTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in BTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } } } }, "EstimateFeeFromUTXO": { "type": "object", "required": ["chain", "type", "fromUTXO", "to"], "properties": { "chain": { "type": "string", "description": "Blockchain to estimate fee for.", "enum": ["BTC", "LTC"] }, "type": { "type": "string", "description": "Type of transaction", "enum": ["TRANSFER"] }, "fromUTXO": { "description": "Array of transaction hashes, index of UTXO in it and corresponding private keys. Use this option if you want to calculate amount to send manually. Either fromUTXO or fromAddress must be present.", "type": "array", "items": { "type": "object", "required": ["txHash", "index"], "properties": { "txHash": { "description": "Transaction hash of the UTXO to be spent.", "type": "string", "example": "53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc", "minLength": 64, "maxLength": 64 }, "index": { "description": "Index of the UTXO to be spent.", "type": "number", "example": 0, "minimum": 0, "maximum": 2147483647 } } } }, "to": { "description": "Array of addresses and values to send bitcoins to. Values must be set in BTC. Difference between from and to is transaction fee.", "type": "array", "items": { "type": "object", "required": ["address", "value"], "properties": { "address": { "description": "Destination address.", "type": "string", "example": "2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7", "minimum": 30, "maximum": 60 }, "value": { "description": "Amount to be sent, in BTC.", "type": "number", "minimum": 0, "example": 0.02969944 } } } } } }, "MarketValue": { "description": "FIAT value of transaction.", "properties": { "amount": { "description": "Value of transaction in given base pair.", "example": "1235.56", "type": "string" }, "currency": { "description": "Base pair.", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "type": "string" }, "sourceDate": { "description": "Date of validity of rate in UTC.", "example": 1572031674384, "type": "number" }, "source": { "description": "Source of base pair.", "example": "fixer.io", "type": "string" } }, "type": "object", "required": ["amount", "currency", "sourceDate", "source"] }, "ExchangeRate": { "description": "FIAT value in EURO of the FIAT or crypto asset.", "properties": { "id": { "description": "FIAT or crypto asset.", "example": "BTC", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "value": { "description": "FIAT value of the asset in given base pair.", "example": "1235.56", "type": "string" }, "basePair": { "description": "Base pair.", "example": "EUR", "default": "EUR", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BAT", "BBD", "BCH", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DOGE", "DZD", "EGP", "ERN", "ETB", "ETH", "EUR", "FJD", "FKP", "FLOW", "FUSD", "FREE", "GMC", "GMC_BSC", "RMD", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LEO", "LINK", "LKR", "LRD", "LSL", "LTC", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MKR", "MMK", "MMY", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PAX", "PAXG", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TRON", "TUSD", "BUSD", "TWD", "TZS", "UAH", "UGX", "UNI", "USD", "USDC", "USDT", "USDT_TRON", "USDT_MATIC", "UYU", "UZS", "VEF", "VND", "VUV", "WBTC", "WST", "XAF", "XAG", "XAU", "XCD", "XCON", "XDR", "XLM", "XOF", "XPF", "XRP", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "timestamp": { "description": "Date of validity of rate in UTC.", "example": 1572031674384, "type": "number" }, "source": { "description": "Source of base pair.", "example": "fixer.io", "type": "string" } }, "type": "object", "required": ["id", "value", "basePair", "timestamp", "source"] }, "Object": { "type": "object" }, "Consumption": { "type": "object", "properties": { "day": { "type": "string", "description": "The date in the MM/DD/YYYY format", "example": "10/25/2020" }, "usage": { "type": "number", "description": "The number of credits used on the specified day", "example": 123 } } }, "PrivKey": { "type": "object", "properties": { "key": { "description": "Generated private key.", "example": "cTmS2jBWXgFaXZ2xG9jhn67TiyTshnMp3UedamzEhGm6BZV1vLgQ", "type": "string" } } }, "PrivKeyRequest": { "type": "object", "properties": { "index": { "description": "Derivation index of private key to generate.", "example": 0, "maximum": 2147483647, "type": "integer" }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic to generate private key from.", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" } }, "required": ["mnemonic", "index"] }, "EthBalance": { "type": "object", "properties": { "balance": { "type": "string", "description": "Balance in ETH", "example": "10.52" } } }, "Transaction": { "properties": { "accountId": { "description": "Source account - source of transaction(s)", "example": "5e6645712b55823de7ea82f1", "type": "string" }, "counterAccountId": { "description": "Counter account - transaction(s) destination account. In case of blockchain recipient, this is addess of blockchain account.", "example": "5e6645712b55823de7ea82f1", "type": "string" }, "currency": { "description": "Transaction currency", "example": "BTC", "type": "string" }, "amount": { "description": "Amount in account's currency", "example": "0.1", "type": "string" }, "anonymous": { "description": "Whether the transaction is anonymous. If true, counter account owner does not see source account.", "example": false, "type": "boolean" }, "created": { "description": "Time in UTC of transaction.", "example": 1572031674384, "type": "number" }, "marketValue": { "$ref": "#/components/schemas/MarketValue" }, "operationType": { "description": "Type of operation.", "enum": [ "PAYMENT", "WITHDRAWAL", "BLOCKCHAIN_TRANSACTION", "EXCHANGE", "FAILED", "DEPOSIT", "MINT", "REVOKE" ], "example": "PAYMENT", "type": "string" }, "transactionType": { "description": "Type of payment.", "enum": [ "FAILED", "DEBIT_PAYMENT", "CREDIT_PAYMENT", "CREDIT_DEPOSIT", "DEBIT_WITHDRAWAL", "CANCEL_WITHDRAWAL", "DEBIT_OUTGOING_PAYMENT", "CREDIT_INCOMING_PAYMENT", "EXCHANGE_BUY", "EXCHANGE_SELL" ], "example": "CREDIT_PAYMENT", "type": "string" }, "reference": { "description": "Transaction internal reference - unique identifier within Tatum ledger. In order of failure, use this value to search for problems.", "example": "5e6be8e9e6aa436299950c41", "type": "string" }, "transactionCode": { "description": "For bookkeeping to distinct transaction purpose.", "example": "1_01_EXTERNAL_CODE", "type": "string" }, "senderNote": { "description": "Note visible for sender.", "example": "Sender note", "type": "string" }, "recipientNote": { "description": "Note visible for both sender and recipient.", "example": "Private note", "type": "string" }, "paymentId": { "description": "Payment ID defined in payment order by sender.", "example": "65426", "type": "string" }, "attr": { "example": "123", "description": "Present only for operationType WITHDRAWAL and XLM / XRP based accounts it represents message or destinationTag of the recipient, if present.", "type": "string" }, "address": { "type": "string", "description": "For operationType DEPOSIT it represents address, on which was deposit credited for the account.", "example": "qrppgud79n5h5ehqt9s7x8uc82pcag82es0w9tada0" }, "txId": { "type": "string", "description": "For operationType DEPOSIT, BLOCKCHAIN_TRANSACTION it represents transaction id, for which deposit occured.", "example": "c6c176e3f6705596d58963f0ca79b34ffa5b78874a65df9c974e22cf86a7ba67" } }, "type": "object", "required": [ "accountId", "reference", "anonymous", "amount", "marketValue", "created", "operationType", "transactionType", "currency" ] }, "TransactionFilter": { "properties": { "id": { "description": "Account ID - source of transaction(s).", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "counterAccount": { "description": "Counter account - transaction(s) destination account.", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "from": { "description": "Starting date to search for transactions from in UTC millis. If not present, search all history.", "example": 1571833231000, "type": "integer", "format": "int64", "minimum": 0 }, "to": { "description": "Date until to search for transactions in UTC millis. If not present, search up till now.", "example": 1571833231000, "type": "integer", "format": "int64", "minimum": 0 }, "currency": { "description": "Currency of the transactions.", "example": "BTC", "minLength": 1, "maxLength": 50, "type": "string" }, "amount": { "type": "array", "description": "Amount of the transaction. AND is used between filter options.", "items": { "type": "object", "properties": { "op": { "type": "string", "description": "Filtering operation.", "example": "gte", "enum": ["gte", "lte", "gt", "lt", "eq", "neq"] }, "value": { "type": "string", "description": "Value of the operation.", "example": "1.5" } }, "required": ["op", "value"] } }, "currencies": { "description": "List of currencies of the transactions.", "type": "array", "items": { "example": "BTC", "minLength": 1, "maxLength": 50, "type": "string" } }, "transactionType": { "description": "Type of payment", "enum": [ "FAILED", "DEBIT_PAYMENT", "CREDIT_PAYMENT", "CREDIT_DEPOSIT", "DEBIT_WITHDRAWAL", "CANCEL_WITHDRAWAL", "DEBIT_OUTGOING_PAYMENT", "EXCHANGE_BUY", "EXCHANGE_SELL", "DEBIT_TRANSACTION", "CREDIT_INCOMING_PAYMENT" ] }, "transactionTypes": { "description": "Types of payment", "type": "array", "items": { "type": "string", "example": "CREDIT_PAYMENT", "enum": [ "FAILED", "DEBIT_PAYMENT", "CREDIT_PAYMENT", "CREDIT_DEPOSIT", "DEBIT_WITHDRAWAL", "CANCEL_WITHDRAWAL", "DEBIT_OUTGOING_PAYMENT", "EXCHANGE_BUY", "EXCHANGE_SELL", "DEBIT_TRANSACTION", "CREDIT_INCOMING_PAYMENT" ] } }, "opType": { "description": "Type of operation", "enum": [ "PAYMENT", "WITHDRAWAL", "BLOCKCHAIN_TRANSACTION", "EXCHANGE", "FAILED", "DEPOSIT", "MINT", "REVOKE" ], "example": "PAYMENT", "type": "string" }, "transactionCode": { "description": "For bookkeeping to distinct transaction purpose.", "example": "1_01_EXTERNAL_CODE", "maxLength": 100, "minLength": 1, "type": "string" }, "paymentId": { "description": "Payment ID defined in payment order by sender.", "example": "65426", "maxLength": 100, "minLength": 1, "type": "string" }, "recipientNote": { "description": "Recipient note defined in payment order by sender.", "example": "65426", "maxLength": 500, "minLength": 1, "type": "string" }, "senderNote": { "description": "Sender note defined in payment order by sender.", "example": "65426", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["id"], "type": "object" }, "TransactionFilterCustomer": { "properties": { "id": { "description": "Customer internal ID to search for.", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "account": { "description": "Source account - source of transaction(s).", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "counterAccount": { "description": "Counter account - transaction(s) destination account.", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "currency": { "description": "Currency of the transactions.", "example": "BTC", "minLength": 1, "maxLength": 50, "type": "string" }, "from": { "description": "Starting date to search for transactions from in UTC millis. If not present, search all history.", "example": 1571833231000, "type": "integer", "format": "int64", "minimum": 0 }, "to": { "description": "Date until to search for transactions in UTC millis. If not present, search up till now.", "example": 1571833231000, "type": "integer", "format": "int64", "minimum": 0 }, "amount": { "type": "array", "description": "Amount of the transaction. AND is used between filter options.", "items": { "type": "object", "properties": { "op": { "type": "string", "description": "Filtering operation.", "example": "gte", "enum": ["gte", "lte", "gt", "lt", "eq", "neq"] }, "value": { "type": "string", "description": "Value of the operation.", "example": "1.5" } }, "required": ["op", "value"] } }, "currencies": { "description": "List of currencies of the transactions.", "type": "array", "items": { "example": "BTC", "minLength": 1, "maxLength": 50, "type": "string" } }, "transactionType": { "description": "Type of payment", "enum": [ "FAILED", "DEBIT_PAYMENT", "CREDIT_PAYMENT", "CREDIT_DEPOSIT", "DEBIT_WITHDRAWAL", "CANCEL_WITHDRAWAL", "DEBIT_OUTGOING_PAYMENT", "EXCHANGE_BUY", "EXCHANGE_SELL", "DEBIT_TRANSACTION", "CREDIT_INCOMING_PAYMENT" ] }, "transactionTypes": { "description": "Types of payment", "type": "array", "items": { "type": "string", "example": "CREDIT_PAYMENT", "enum": [ "FAILED", "DEBIT_PAYMENT", "CREDIT_PAYMENT", "CREDIT_DEPOSIT", "DEBIT_WITHDRAWAL", "CANCEL_WITHDRAWAL", "DEBIT_OUTGOING_PAYMENT", "EXCHANGE_BUY", "EXCHANGE_SELL", "DEBIT_TRANSACTION", "CREDIT_INCOMING_PAYMENT" ] } }, "opType": { "description": "Type of operation.", "enum": [ "PAYMENT", "WITHDRAWAL", "BLOCKCHAIN_TRANSACTION", "EXCHANGE", "FAILED", "DEPOSIT", "MINT", "REVOKE" ], "example": "PAYMENT", "type": "string" }, "transactionCode": { "description": "For bookkeeping to distinct transaction purpose.", "example": "1_01_EXTERNAL_CODE", "maxLength": 100, "minLength": 1, "type": "string" }, "paymentId": { "description": "Payment ID defined in payment order by sender.", "example": "65426", "maxLength": 100, "minLength": 1, "type": "string" }, "recipientNote": { "description": "Recipient note defined in payment order by sender.", "example": "65426", "maxLength": 500, "minLength": 1, "type": "string" }, "senderNote": { "description": "Sender note defined in payment order by sender.", "example": "65426", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["id"], "type": "object" }, "TransactionFilterLedger": { "properties": { "account": { "description": "Source account - source of transaction(s).", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "counterAccount": { "description": "Counter account - transaction(s) destination account.", "example": "5e6be8e9e6aa436299950c41", "maxLength": 24, "minLength": 24, "type": "string" }, "currency": { "description": "Currency of the transactions.", "example": "BTC", "minLength": 1, "maxLength": 50, "type": "string" }, "from": { "description": "Starting date to search for transactions from in UTC millis. If not present, search all history.", "example": 1571833231000, "type": "integer", "format": "int64", "minimum": 0 }, "amount": { "type": "array", "description": "Amount of the transaction. AND is used between filter options.", "items": { "type": "object", "properties": { "op": { "type": "string", "description": "Filtering operation.", "example": "gte", "enum": ["gte", "lte", "gt", "lt", "eq", "neq"] }, "value": { "type": "string", "description": "Value of the operation.", "example": "1.5" } }, "required": ["op", "value"] } }, "currencies": { "description": "List of currencies of the transactions.", "type": "array", "items": { "example": "BTC", "minLength": 1, "maxLength": 50, "type": "string" } }, "transactionType": { "description": "Type of payment", "enum": [ "FAILED", "DEBIT_PAYMENT", "CREDIT_PAYMENT", "CREDIT_DEPOSIT", "DEBIT_WITHDRAWAL", "CANCEL_WITHDRAWAL", "DEBIT_OUTGOING_PAYMENT", "EXCHANGE_BUY", "EXCHANGE_SELL", "DEBIT_TRANSACTION", "CREDIT_INCOMING_PAYMENT" ] }, "transactionTypes": { "description": "Types of payment", "type": "array", "items": { "type": "string", "example": "CREDIT_PAYMENT", "enum": [ "FAILED", "DEBIT_PAYMENT", "CREDIT_PAYMENT", "CREDIT_DEPOSIT", "DEBIT_WITHDRAWAL", "CANCEL_WITHDRAWAL", "DEBIT_OUTGOING_PAYMENT", "EXCHANGE_BUY", "EXCHANGE_SELL", "DEBIT_TRANSACTION", "CREDIT_INCOMING_PAYMENT" ] } }, "opType": { "description": "Type of operation.", "enum": [ "PAYMENT", "WITHDRAWAL", "BLOCKCHAIN_TRANSACTION", "EXCHANGE", "FAILED", "DEPOSIT", "MINT", "REVOKE" ], "example": "PAYMENT", "type": "string" }, "transactionCode": { "description": "For bookkeeping to distinct transaction purpose.", "example": "1_01_EXTERNAL_CODE", "maxLength": 100, "minLength": 1, "type": "string" }, "paymentId": { "description": "Payment ID defined in payment order by sender.", "example": "65426", "maxLength": 100, "minLength": 1, "type": "string" }, "recipientNote": { "description": "Recipient note defined in payment order by sender.", "example": "65426", "maxLength": 500, "minLength": 1, "type": "string" }, "senderNote": { "description": "Sender note defined in payment order by sender.", "example": "65426", "maxLength": 500, "minLength": 1, "type": "string" }, "to": { "description": "Date until to search for transactions in UTC millis. If not present, search up till now.", "example": 1571833231000, "type": "integer", "format": "int64", "minimum": 0 } }, "type": "object" }, "TransactionResult": { "properties": { "reference": { "description": "Transaction internal reference - unique identifier within Tatum ledger. In order of failure, use this value to search for problems.", "example": "0c64cc04-5412-4e57-a51c-ee5727939bcb", "type": "string" } }, "type": "object" }, "BatchTransactionResult": { "type": "array", "items": { "type": "object", "properties": { "reference": { "description": "Transaction internal reference - unique identifier within Tatum ledger. In order of failure, use this value to search for problems.", "example": "0c64cc04-5412-4e57-a51c-ee5727939bcb", "type": "string" } } } }, "TransferBnbBlockchain": { "type": "object", "properties": { "to": { "description": "Blockchain address to send assets.", "example": "tbnb138u9djee6fwphhd2a3628q2h0j5w97yx48zqex", "maxLength": 100, "minLength": 1, "type": "string" }, "currency": { "description": "Currency to transfer from Binance Blockchain Account.", "enum": ["BNB"], "example": "BNB", "type": "string" }, "amount": { "description": "Amount to be sent in BNB.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 100, "minLength": 1, "example": "cTmS2jBWXgFaXZ2xG9jhn67TiyTshnMp3UedamzEhGm6BZV1vLgQ", "description": "Private key of sender address." }, "message": { "maxLength": 50, "minLength": 1, "description": "Message to recipient.", "example": "Message to recipient", "type": "string" } }, "required": ["to", "amount", "fromPrivateKey", "currency"] }, "TransferBnbBlockchainKMS": { "type": "object", "properties": { "to": { "description": "Blockchain address to send assets.", "example": "tbnb138u9djee6fwphhd2a3628q2h0j5w97yx48zqex", "maxLength": 100, "minLength": 1, "type": "string" }, "currency": { "description": "Currency to transfer from Binance Blockchain Account.", "enum": ["BNB"], "example": "BNB", "type": "string" }, "amount": { "description": "Amount to be sent in BNB.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Signature hash of the mnemonic, which will be used to sign transactions locally.\nAll signature Ids should be present, which might be used to sign transaction.\n" }, "fromAddress": { "description": "Blockchain address to send from", "example": "tbnb1q82g2h9q0kfe7sysnj5w7nlak92csfjztymp39", "maxLength": 50, "minLength": 42, "type": "string" }, "message": { "maxLength": 50, "minLength": 1, "description": "Message to recipient.", "example": "Message to recipient", "type": "string" } }, "required": ["to", "amount", "signatureId", "fromAddress", "currency"] }, "TransferLtcMnemonic": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.0005 LTC is used. Minimum fee is 0.00001 LTC.", "example": "0.0005", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic seed - usually 12-24 words with access to whole wallet.\nEither mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "xpub": { "description": "Extended public key (xpub) of the wallet associated with the accounts. Should be present, when mnemonic is used.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "mnemonic", "xpub"], "type": "object" }, "TransferLtcKeyPair": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.0005 LTC is used. Minimum fee is 0.00001 LTC.", "example": "0.0005", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "keyPair": { "description": "Array of assigned blockchain addresses with their private keys.\nEither mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n", "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Blockchain address assigned to account withdrawal is made from.", "maxLength": 50, "minLength": 30 }, "privateKey": { "type": "string", "description": "Private key of blockchain address.", "maxLength": 52, "example": "cTmS2jBWXgFaXZ2xG9jhn67TiyTshnMp3UedamzEhGm6BZV1vLgQ", "minLength": 52 } } } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "keyPair", "attr"], "type": "object" }, "TransferLtcKMS": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.0005 LTC is used. Minimum fee is 0.00001 LTC.", "example": "0.0005", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Signature hash of the mnemonic, which will be used to sign transactions locally.\nAll signature Ids should be present, which might be used to sign transaction.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n" }, "xpub": { "description": "Extended public key (xpub) of the wallet associated with the accounts. Should be present, when mnemonic is used.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "signatureId", "xpub"], "type": "object" }, "TransferDogeMnemonic": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 1 DOGE is used.", "example": "1", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic seed - usually 12-24 words with access to whole wallet.\nEither mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "xpub": { "description": "Extended public key (xpub) of the wallet associated with the accounts. Should be present, when mnemonic is used.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "mnemonic", "xpub"], "type": "object" }, "TransferDogeKeyPair": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 1 DOGE is used.", "example": "1", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "keyPair": { "description": "Array of assigned blockchain addresses with their private keys.\nEither mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n", "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Blockchain address assigned to account withdrawal is made from.", "maxLength": 50, "minLength": 30 }, "privateKey": { "type": "string", "description": "Private key of blockchain address.", "maxLength": 52, "example": "cTmS2jBWXgFaXZ2xG9jhn67TiyTshnMp3UedamzEhGm6BZV1vLgQ", "minLength": 52 } } } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "keyPair", "attr"], "type": "object" }, "TransferDogeKMS": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 1 DOGE is used.", "example": "1", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Signature hash of the mnemonic, which will be used to sign transactions locally.\nAll signature Ids should be present, which might be used to sign transaction.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n" }, "xpub": { "description": "Extended public key (xpub) of the wallet associated with the accounts. Should be present, when mnemonic is used.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "signatureId", "xpub"], "type": "object" }, "TransferBtcMnemonic": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.0005 BTC is used. Minimum fee is 0.00001 BTC.", "example": "0.0005", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic seed - usually 12-24 words with access to whole wallet.\nEither mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "xpub": { "description": "Extended public key (xpub) of the wallet associated with the accounts. Should be present, when mnemonic is used.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "mnemonic", "xpub"], "type": "object" }, "TransferBtcKeyPair": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.0005 BTC is used. Minimum fee is 0.00001 BTC.", "example": "0.0005", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "keyPair": { "description": "Array of assigned blockchain addresses with their private keys.\nEither mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n", "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Blockchain address assigned to account withdrawal is made from.", "maxLength": 50, "minLength": 30 }, "privateKey": { "type": "string", "description": "Private key of blockchain address.", "example": "cTmS2jBWXgFaXZ2xG9jhn67TiyTshnMp3UedamzEhGm6BZV1vLgQ", "maxLength": 52, "minLength": 52 } } } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "keyPair", "attr"], "type": "object" }, "TransferBtcKMS": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.0005 BTC is used. Minimum fee is 0.00001 BTC.", "example": "0.0005", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Signature hash of the mnemonic, which will be used to sign transactions locally.\nAll signature Ids should be present, which might be used to sign transaction.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n" }, "xpub": { "description": "Extended public key (xpub) of the wallet associated with the accounts. Should be present, when mnemonic is used.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "signatureId", "xpub"], "type": "object" }, "TransferBchMnemonic": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.00005 BCH is used.", "example": "0.00005", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "mnemonic": { "maxLength": 500, "minLength": 1, "description": "Mnemonic seed - usually 12-24 words with access to whole wallet.\nEither mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n", "example": "urge pulp usage sister evidence arrest palm math please chief egg abuse", "type": "string" }, "xpub": { "description": "Extended public key (xpub) of the wallet associated with the accounts. Should be present, when mnemonic is used.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "mnemonic", "xpub"], "type": "object" }, "TransferBchKeyPair": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.00005 BCH is used.", "example": "0.00005", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "keyPair": { "description": "Array of assigned blockchain addresses with their private keys.\nEither mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n", "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Blockchain address assigned to account withdrawal is made from.", "example": "bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez", "maxLength": 50, "minLength": 30 }, "privateKey": { "type": "string", "description": "Private key of blockchain address.", "example": "cTmS2jBWXgFaXZ2xG9jhn67TiyTshnMp3UedamzEhGm6BZV1vLgQ", "maxLength": 52, "minLength": 52 } } } }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "keyPair", "attr"], "type": "object" }, "TransferBchKMS": { "properties": { "senderAccountId": { "description": "Sender account ID", "example": "5e68c66581f2ee32bc354087", "maxLength": 24, "minLength": 24, "type": "string" }, "address": { "description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.", "example": "bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez", "maxLength": 10000, "minLength": 1, "type": "string" }, "amount": { "description": "Amount to be withdrawn to blockchain.", "maxLength": 38, "example": "0.001", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "compliant": { "description": "Compliance check, if withdrawal is not compliant, it will not be processed.", "example": false, "type": "boolean" }, "multipleAmounts": { "description": "For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.", "type": "array", "items": { "type": "string", "example": "0.1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" } }, "fee": { "description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 0.00005 BCH is used.", "example": "0.00005", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "attr": { "description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.", "maxLength": 256, "minLength": 1, "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Signature hash of the mnemonic, which will be used to sign transactions locally.\nAll signature Ids should be present, which might be used to sign transaction.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n" }, "xpub": { "description": "Extended public key (xpub) of the wallet associated with the accounts. Should be present, when mnemonic is used.", "maxLength": 150, "minLength": 1, "example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid", "type": "string" }, "paymentId": { "description": "Identifier of the payment, shown for created Transaction within Tatum sender account.", "example": "1234", "maxLength": 100, "minLength": 1, "type": "string" }, "senderNote": { "description": "Note visible to owner of withdrawing account", "example": "Sender note", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": ["amount", "senderAccountId", "address", "signatureId", "xpub"], "type": "object" }, "TransferErc20Blockchain": { "type": "object", "properties": { "to": { "maxLength": 50, "minLength": 1, "description": "Blockchain address to send ERC20 token to", "example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "amount": { "description": "Amount to be sent.", "example": "100000", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "contractAddress": { "maxLength": 43, "minLength": 42, "description": "Address of ERC20 token", "example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "digits": { "description": "Number of decimal points that ERC20 token has.", "example": 18, "maximum": 30, "minimum": 1, "type": "number" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "minimum": 0, "description": "Nonce to be set to XDC transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["to", "contractAddress", "digits", "fromPrivateKey", "amount"] }, "TransferErc20BlockchainKMS": { "type": "object", "properties": { "to": { "maxLength": 50, "minLength": 1, "description": "Blockchain address to send ERC20 token to", "example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "amount": { "description": "Amount to be sent.", "example": "100000", "type": "string", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$" }, "contractAddress": { "maxLength": 43, "minLength": 42, "description": "Address of ERC20 token", "example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "digits": { "description": "Number of decimal points that ERC20 token has.", "example": 18, "maximum": 30, "minimum": 1, "type": "number" }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "nonce": { "type": "number", "minimum": 0, "description": "Nonce to be set to XDC transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["to", "contractAddress", "signatureId", "digits", "amount"] }, "CallSmartContractMethod": { "type": "object", "properties": { "contractAddress": { "maxLength": 42, "minLength": 42, "description": "The address of the smart contract", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "methodName": { "minLength": 1, "maxLength": 500, "description": "Name of the method to invoke on smart contract.", "type": "string", "example": "transfer" }, "methodABI": { "type": "object", "example": { "inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }], "name": "stake", "outputs": [], "stateMutability": "nonpayable", "type": "function" }, "description": "ABI of the method to invoke." }, "params": { "type": "array", "example": ["0x632"], "items": { "type": "object" }, "description": "Parameters of the method to be invoked." }, "amount": { "description": "Amount of the assets to be sent.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "minimum": 0, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["contractAddress", "params", "methodABI", "fromPrivateKey", "methodName"] }, "CallReadSmartContractMethod": { "type": "object", "properties": { "contractAddress": { "maxLength": 42, "minLength": 42, "description": "The address of the smart contract", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "methodName": { "minLength": 1, "maxLength": 500, "description": "Name of the method to invoke on smart contract.", "type": "string", "example": "transfer" }, "methodABI": { "type": "object", "example": { "inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }], "name": "stake", "outputs": [], "stateMutability": "nonpayable", "type": "function" }, "description": "ABI of the method to invoke." }, "params": { "type": "array", "example": ["0x632"], "items": { "type": "object" }, "description": "Parameters of the method to be invoked." } }, "required": ["contractAddress", "params", "methodABI", "methodName"] }, "CallSmartContractMethodKMS": { "type": "object", "properties": { "contractAddress": { "maxLength": 42, "minLength": 42, "description": "The address of the smart contract", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "amount": { "description": "Amount of the assets to be sent.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "methodName": { "minLength": 1, "maxLength": 500, "description": "Name of the method to invoke on smart contract.", "type": "string", "example": "transfer" }, "methodABI": { "type": "object", "description": "ABI of the method to invoke." }, "params": { "type": "array", "items": { "type": "object" }, "description": "Parameters of the method to be invoked." }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "minimum": 0, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["contractAddress", "params", "methodABI", "signatureId", "methodName"] }, "TransferErc721": { "type": "object", "properties": { "to": { "maxLength": 42, "minLength": 42, "description": "Blockchain address to send ERC721 token to", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "tokenId": { "description": "ID of token.", "example": "100000", "type": "string", "maxLength": 256 }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of ERC721 token", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["to", "contractAddress", "tokenId", "fromPrivateKey"] }, "GenerateMarketplace": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "KLAY", "BSC", "MATIC"], "example": "ETH", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Address of the recipient of the fee for the trade.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["feeRecipient", "chain", "marketplaceFee", "fromPrivateKey"] }, "GenerateMarketplaceCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Address of the recipient of the fee for the trade.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["feeRecipient", "marketplaceFee", "chain", "feeCurrency", "fromPrivateKey"] }, "GenerateMarketplaceKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "KLAY", "BSC", "MATIC"], "example": "ETH", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Address of the recipient of the fee for the trade.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["feeRecipient", "chain", "marketplaceFee", "signatureId"] }, "GenerateMarketplaceCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Address of the recipient of the fee for the trade.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["feeRecipient", "marketplaceFee", "chain", "feeCurrency", "signatureId"] }, "GenerateAuction": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "KLAY", "BSC", "MATIC"], "example": "ETH", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Address of the recipient of the fee for the trade.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "auctionFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["feeRecipient", "chain", "auctionFee", "fromPrivateKey"] }, "GenerateAuctionCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Address of the recipient of the fee for the trade.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "auctionFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["feeRecipient", "auctionFee", "chain", "feeCurrency", "fromPrivateKey"] }, "GenerateAuctionKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "KLAY", "BSC", "MATIC"], "example": "ETH", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Address of the recipient of the fee for the trade.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "auctionFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["feeRecipient", "chain", "auctionFee", "signatureId"] }, "GenerateAuctionCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Address of the recipient of the fee for the trade.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "auctionFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["feeRecipient", "auctionFee", "chain", "feeCurrency", "signatureId"] }, "GenerateMarketplaceTron": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "feeRecipient": { "maxLength": 34, "minLength": 34, "description": "Address of the recipient of the fee for the trade.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "from", "feeRecipient", "marketplaceFee", "fromPrivateKey"] }, "GenerateMarketplaceTronKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "feeRecipient": { "maxLength": 34, "minLength": 34, "description": "Address of the recipient of the fee for the trade.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "from": { "maxLength": 34, "minLength": 34, "description": "Address of the recipient of the fee for the trade.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "from", "feeRecipient", "marketplaceFee", "signatureId"] }, "SellAssetOnMarketplace": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "nftAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the NFT asset to sell smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "seller": { "maxLength": 42, "minLength": 42, "description": "Address of the seller of the NFT asset.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter amount only in case of native currency cashback.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "price": { "description": "Price of the asset to sell. Marketplace fee will be obtained on top of this price.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "listingId", "seller", "price", "fromPrivateKey" ] }, "SellAssetOnMarketplaceCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "nftAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the NFT asset to sell smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "seller": { "maxLength": 42, "minLength": 42, "description": "Address of the seller of the NFT asset.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter amount only in case of native currency cashback.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "price": { "description": "Price of the asset to sell. Marketplace fee will be obtained on top of this price.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "listingId", "seller", "price", "feeCurrency", "fromPrivateKey" ] }, "SellAssetOnMarketplaceKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "nftAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the NFT asset to sell smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "seller": { "maxLength": 42, "minLength": 42, "description": "Address of the seller of the NFT asset.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter amount only in case of natiev currency cashback.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "price": { "description": "Price of the asset to sell. Marketplace fee will be obtained on top of this price.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "listingId", "seller", "price", "signatureId" ] }, "SellAssetOnMarketplaceCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "nftAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the NFT asset to sell smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "seller": { "maxLength": 42, "minLength": 42, "description": "Address of the seller of the NFT asset.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter amount only in case of natiev currency cashback.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "price": { "description": "Price of the asset to sell. Marketplace fee will be obtained on top of this price.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "listingId", "seller", "price", "feeCurrency", "signatureId" ] }, "CreateAuction": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the auction smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "nftAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the NFT asset to sell smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "seller": { "maxLength": 42, "minLength": 42, "description": "Address of the seller of the NFT asset.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter 1.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "endedAt": { "description": "Last block, where auction accepts bids.", "example": 100000, "minimum": 0, "type": "number" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "id", "seller", "endedAt", "fromPrivateKey" ] }, "CreateAuctionCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the auction smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "nftAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the NFT asset to sell smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "seller": { "maxLength": 42, "minLength": 42, "description": "Address of the seller of the NFT asset.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter 1.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "endedAt": { "description": "Last block, where auction accepts bids.", "example": 100000, "minimum": 0, "type": "number" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "id", "seller", "endedAt", "feeCurrency", "fromPrivateKey" ] }, "CreateAuctionKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the auction smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "nftAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the NFT asset to sell smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "seller": { "maxLength": 42, "minLength": 42, "description": "Address of the seller of the NFT asset.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter 1.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "endedAt": { "description": "Last block, where auction accepts bids.", "example": 100000, "minimum": 0, "type": "number" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "id", "seller", "endedAt", "signatureId" ] }, "CreateAuctionCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the auction smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "nftAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the NFT asset to sell smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "seller": { "maxLength": 42, "minLength": 42, "description": "Address of the seller of the NFT asset.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter 1.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "endedAt": { "description": "Last block, where auction accepts bids.", "example": 100000, "minimum": 0, "type": "number" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "id", "seller", "endedAt", "feeCurrency", "signatureId" ] }, "SellAssetOnMarketplaceTron": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "nftAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the NFT asset to sell smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "seller": { "maxLength": 34, "minLength": 34, "description": "Address of the seller of the NFT asset.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "erc20Address": { "maxLength": 34, "minLength": 34, "description": "Optional address of the TRC20 token, which will be used as a selling currency of the NFT.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter 1.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "price": { "description": "Price of the asset to sell. Marketplace fee will be obtained on top of this price.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": [ "feeLimit", "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "listingId", "seller", "price", "fromPrivateKey" ] }, "SellAssetOnMarketplaceTronKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "from": { "maxLength": 34, "minLength": 34, "description": "Address of the recipient of the fee for the trade.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nftAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the NFT asset to sell smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "seller": { "maxLength": 34, "minLength": 34, "description": "Address of the seller of the NFT asset.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "erc20Address": { "maxLength": 34, "minLength": 34, "description": "Optional address of the TRC20 token, which will be used as a selling currency of the NFT.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter 1.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "price": { "description": "Price of the asset to sell. Marketplace fee will be obtained on top of this price.", "example": "100000", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": [ "feeLimit", "nftAddress", "chain", "contractAddress", "tokenId", "isErc721", "listingId", "seller", "price", "from", "signatureId" ] }, "BuyAssetOnMarketplace": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "buyer": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 listing, it's possible to buy on behalf of someone else. This value is the address of the buyer, which should approve spending of the ERC20 tokens for the Marketplace contract. This could be used for a buying from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing.", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent for buying.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "listingId", "amount", "fromPrivateKey"] }, "BuyAssetOnMarketplaceCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing.", "minLength": 1, "maxLength": 200 }, "buyer": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 listing, it's possible to buy on behalf of someone else. This value is the address of the buyer, which should approve spending of the ERC20 tokens for the Marketplace contract. This could be used for a buying from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "amount": { "description": "Amount of the assets to be sent for buying.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "listingId", "amount", "feeCurrency", "fromPrivateKey"] }, "BuyAssetOnMarketplaceKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "buyer": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 listing, it's possible to buy on behalf of someone else. This value is the address of the buyer, which should approve spending of the ERC20 tokens for the Marketplace contract. This could be used for a buying from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing.", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent for buying.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["nftAddress", "chain", "listingId", "amount", "signatureId", "contractAddress"] }, "BuyAssetOnMarketplaceCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "buyer": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 listing, it's possible to buy on behalf of someone else. This value is the address of the buyer, which should approve spending of the ERC20 tokens for the Marketplace contract. This could be used for a buying from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing.", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent for buying.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "listingId", "amount", "feeCurrency", "signatureId"] }, "ApproveNftSpending": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "spender": { "maxLength": 42, "minLength": 42, "description": "Address of the auction smart contract - new spender.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the ERC20 token, which is used for buying NFT asset from the marketplace.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "spender", "fromPrivateKey", "isErc721", "tokenId"] }, "ApproveNftSpendingCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the ERC20 token, which is used for buying NFT asset from the marketplace.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "spender": { "maxLength": 42, "minLength": 42, "description": "Address of the auction smart contract - new spender.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "chain", "contractAddress", "spender", "tokenId", "isErc721", "feeCurrency", "fromPrivateKey" ] }, "ApproveNftSpendingKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the ERC20 token, which is used for buying NFT asset from the marketplace.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "spender": { "maxLength": 42, "minLength": 42, "description": "Address of the auction smart contract - new spender.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["contractAddress", "chain", "spender", "tokenId", "isErc721", "signatureId"] }, "ApproveNftSpendingCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the ERC20 token, which is used for buying NFT asset from the marketplace.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "spender": { "maxLength": 42, "minLength": 42, "description": "Address of the auction smart contract - new spender.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "isErc721": { "type": "boolean", "description": "True if asset is NFT of type ERC721, false if ERC1155.", "example": true }, "tokenId": { "description": "ID of token, if transaction is for ERC-721 or ERC-1155.", "example": "100000", "type": "string", "maxLength": 256 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": [ "chain", "contractAddress", "spender", "isErc721", "tokenId", "feeCurrency", "signatureId" ] }, "BidOnAuction": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x487422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "bidder": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 auction, it's possible to bid on behalf of someone else. This value is the address of the bidder, which should approve spending of the ERC20 tokens for the Auction contract. This could be used for a bidding from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction.", "minLength": 1, "maxLength": 200 }, "bidValue": { "description": "Amount of the assets to be bid. This must include auction fee.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "id", "amount", "fromPrivateKey"] }, "BidOnAuctionCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "bidder": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 auction, it's possible to bid on behalf of someone else. This value is the address of the bidder, which should approve spending of the ERC20 tokens for the Auction contract. This could be used for a bidding from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction.", "minLength": 1, "maxLength": 200 }, "bidValue": { "description": "Amount of the assets to be bid. This must include auction fee.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "id", "amount", "feeCurrency", "fromPrivateKey"] }, "BidOnAuctionKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "bidder": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 auction, it's possible to bid on behalf of someone else. This value is the address of the bidder, which should approve spending of the ERC20 tokens for the Auction contract. This could be used for a bidding from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction.", "minLength": 1, "maxLength": 200 }, "bidValue": { "description": "Amount of the assets to be bid. This must include auction fee.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["nftAddress", "chain", "id", "amount", "signatureId"] }, "BidOnAuctionCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "bidder": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 auction, it's possible to bid on behalf of someone else. This value is the address of the bidder, which should approve spending of the ERC20 tokens for the Auction contract. This could be used for a bidding from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction.", "minLength": 1, "maxLength": 200 }, "bidValue": { "description": "Amount of the assets to be bid. This must include auction fee.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "id", "amount", "feeCurrency", "signatureId"] }, "CancelOrSettleAuction": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction.", "minLength": 1, "maxLength": 200 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "id", "amount", "fromPrivateKey"] }, "CancelOrSettleAuctionCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction.", "minLength": 1, "maxLength": 200 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "id", "amount", "feeCurrency", "fromPrivateKey"] }, "CancelOrSettleAuctionKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction.", "minLength": 1, "maxLength": 200 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["nftAddress", "chain", "id", "amount", "signatureId"] }, "CancelOrSettleAuctionCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "id": { "type": "string", "description": "ID of the auction.", "minLength": 1, "maxLength": 200 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "id", "feeCurrency", "signatureId"] }, "BuyAssetOnMarketplaceTron": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "erc20Address": { "maxLength": 34, "minLength": 34, "description": "Optional address of the TRC20 token, which will be used as a selling currency of the NFT.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "buyer": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 listing, it's possible to buy on behalf of someone else. This value is the address of the buyer, which should approve spending of the ERC20 tokens for the Marketplace contract. This could be used for a buying from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter 1.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "chain", "contractAddress", "listingId", "fromPrivateKey"] }, "BuyAssetOnMarketplaceTronKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "from": { "maxLength": 34, "minLength": 34, "description": "Address of the recipient of the fee for the trade.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "buyer": { "maxLength": 42, "minLength": 42, "description": "In case of the ERC20 listing, it's possible to buy on behalf of someone else. This value is the address of the buyer, which should approve spending of the ERC20 tokens for the Marketplace contract. This could be used for a buying from the custodial wallet address.", "example": "0x587422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "erc20Address": { "maxLength": 34, "minLength": 34, "description": "Optional address of the TRC20 token, which will be used as a selling currency of the NFT.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "amount": { "description": "Amount of the assets to be sent. For ERC-721 tokens, enter 1.", "example": "1", "pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "chain", "contractAddress", "listingId", "from", "signatureId"] }, "UpdateFeeRecipient": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Recipient address of the marketplace fee.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "feeRecipient", "fromPrivateKey"] }, "UpdateFeeRecipientCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Recipient address of the marketplace fee.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "feeRecipient", "feeCurrency", "fromPrivateKey"] }, "UpdateFeeRecipientKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Recipient address of the marketplace fee.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["nftAddress", "chain", "feeRecipient", "signatureId", "contractAddress"] }, "UpdateFeeRecipientCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "feeRecipient": { "maxLength": 42, "minLength": 42, "description": "Recipient address of the marketplace fee.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "feeRecipient", "feeCurrency", "signatureId"] }, "UpdateFeeRecipientTron": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "feeRecipient": { "maxLength": 34, "minLength": 34, "description": "Recipient address of the marketplace fee.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "chain", "contractAddress", "feeRecipient", "fromPrivateKey"] }, "UpdateFeeRecipientTronKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "from": { "maxLength": 34, "minLength": 34, "description": "Address of the recipient of the fee for the trade.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "feeRecipient": { "maxLength": 34, "minLength": 34, "description": "Recipient address of the marketplace fee.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "chain", "contractAddress", "feeRecipient", "from", "signatureId"] }, "UpdateFee": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "marketplaceFee", "fromPrivateKey"] }, "UpdateFeeCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "marketplaceFee", "feeCurrency", "fromPrivateKey"] }, "UpdateFeeKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["nftAddress", "chain", "marketplaceFee", "signatureId", "contractAddress"] }, "UpdateFeeCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "marketplaceFee", "feeCurrency", "signatureId"] }, "UpdateFeeTron": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "chain", "contractAddress", "marketplaceFee", "fromPrivateKey"] }, "UpdateFeeTronKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "from": { "maxLength": 34, "minLength": 34, "description": "Address of the recipient of the fee for the trade.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "marketplaceFee": { "type": "number", "description": "Percentage of the selling amount of the NFT asset. 100 - 1%", "example": 150, "minimum": 0, "maximum": 10000 }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "chain", "contractAddress", "marketplaceFee", "from", "signatureId"] }, "CancelSellAssetOnMarketplace": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "listingId", "fromPrivateKey"] }, "CancelSellAssetOnMarketplaceCelo": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "fromPrivateKey": { "type": "string", "maxLength": 66, "example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 66, "description": "Private key of sender address. Private key, or signature Id must be present." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "listingId", "feeCurrency", "fromPrivateKey"] }, "CancelSellAssetOnMarketplaceKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["ETH", "ONE", "BSC", "KLAY", "MATIC"], "example": "ETH", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["nftAddress", "chain", "listingId", "signatureId", "contractAddress"] }, "CancelSellAssetOnMarketplaceCeloKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["CELO"], "example": "CELO", "type": "string" }, "contractAddress": { "maxLength": 42, "minLength": 42, "description": "Address of the marketplace smart contract.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "feeCurrency": { "type": "string", "description": "Currency to pay for transaction gas", "enum": ["CELO", "CUSD", "CEUR"] }, "erc20Address": { "maxLength": 42, "minLength": 42, "description": "Optional address of the ERC20 token, which will be used as a selling currency of the NFT.", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "listingId": { "type": "string", "description": "ID of the listing. It's up to the developer to generate unique ID", "minLength": 1, "maxLength": 200 }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "nonce": { "type": "number", "example": 1, "description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used." }, "fee": { "description": "Custom defined fee. If not present, it will be calculated automatically.", "type": "object", "required": ["gasLimit", "gasPrice"], "properties": { "gasLimit": { "type": "string", "description": "Gas limit for transaction in gas price.", "pattern": "^[+]?\\d+$", "example": "40000" }, "gasPrice": { "type": "string", "description": "Gas price in Gwei.", "pattern": "^[+]?\\d+$", "example": "20" } } } }, "required": ["chain", "contractAddress", "listingId", "feeCurrency", "signatureId"] }, "CancelSellAssetOnMarketplaceTron": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "erc20Address": { "maxLength": 34, "minLength": 34, "description": "Optional address of the TRC20 token, which will be used as a selling currency of the NFT.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "chain", "contractAddress", "listingId", "fromPrivateKey"] }, "CancelSellAssetOnMarketplaceTronKMS": { "type": "object", "properties": { "chain": { "description": "Blockchain to work with.", "enum": ["TRON"], "example": "TRON", "type": "string" }, "contractAddress": { "maxLength": 34, "minLength": 34, "description": "Address of the marketplace smart contract.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "from": { "maxLength": 34, "minLength": 34, "description": "Address of the recipient of the fee for the trade.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "signatureId": { "type": "string", "format": "uuid", "example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83", "description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present." }, "index": { "type": "number", "minimum": 0, "description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic." }, "erc20Address": { "maxLength": 34, "minLength": 34, "description": "Optional address of the TRC20 token, which will be used as a selling currency of the NFT.", "example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh", "type": "string" }, "fromPrivateKey": { "type": "string", "maxLength": 64, "example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2", "minLength": 64, "description": "Private key of sender address. Private key, or signature Id must be present." }, "feeLimit": { "type": "number", "minimum": 0, "description": "Fee in TRX to be paid.", "example": 0.01 } }, "required": ["feeLimit", "chain", "contractAddress", "listingId", "from", "signatureId"] }, "ApproveTransferCustodialWallet": { "type": "object", "properties": { "chain": { "description": "The blockchain to work with", "enum": ["BSC", "ETH", "KLAY", "MATIC", "ONE", "XDC"], "example": "ETH", "type": "string" }, "custodialAddress": { "maxLength": 42, "minLength": 42, "description": "The gas pump address that holds the asset", "example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85", "type": "string" }, "spender": { "maxLength": 42, "minLength": 42, "description": "The blockchain address to allow the transfer of the asset from the gas pump address", "example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3", "type": "string" }, "contractType": { "type": "number", "description": "The type of the asset to transfer. Set0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), or 2 for Multi Tokens (ERC-1155 or equivalent).",
"example": 0,
"enum": [0, 1, 2]
},
"tokenAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the asset to transfer",
"example": "0x782919AFc85eEA2cB736874225456bB5d3e242bA",
"type": "string"
},
"amount": {
"description": "(Only if the asset is a fungible token or Multi Token) The amount of the asset to transfer. Do not use if the asset is an NFT.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(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.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address that owns the gas pump address (\"master address\")"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "spender", "fromPrivateKey"]
},
"ApproveTransferCustodialWalletCelo": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that holds the asset",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"spender": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address to allow the transfer of the asset from the gas pump address",
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
},
"contractType": {
"type": "number",
"description": "The type of the asset to transfer. Set 0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), or 2 for Multi Tokens (ERC-1155 or equivalent).",
"example": 0,
"enum": [0, 1, 2]
},
"tokenAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the asset to transfer",
"example": "0x782919AFc85eEA2cB736874225456bB5d3e242bA",
"type": "string"
},
"amount": {
"description": "(Only if the asset is a fungible token or Multi Token) The amount of the asset to transfer. Do not use if the asset is an NFT.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(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.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address that owns the gas pump address (\"master address\")"
},
"feeCurrency": {
"type": "string",
"description": "The currency to pay for the gas fee",
"enum": ["CELO", "CUSD", "CEUR"]
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "feeCurrency", "spender", "fromPrivateKey"]
},
"ApproveTransferCustodialWalletCeloKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that holds the asset",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"spender": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address to allow the transfer of the asset from the gas pump address",
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
},
"contractType": {
"type": "number",
"description": "The type of the asset to transfer. Set 0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), or 2 for Multi Tokens (ERC-1155 or equivalent).",
"example": 0,
"enum": [0, 1, 2]
},
"tokenAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the asset to transfer",
"example": "0x782919AFc85eEA2cB736874225456bB5d3e242bA",
"type": "string"
},
"amount": {
"description": "(Only if the asset is a fungible token or Multi Token) The amount of the asset to transfer. Do not use if the asset is an NFT.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(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.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that owns the gas pump address key (\"master address\")"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the specific address from the mnemonic"
},
"feeCurrency": {
"type": "string",
"description": "The currency to pay for the gas fee",
"enum": ["CELO", "CUSD", "CEUR"]
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "feeCurrency", "spender", "signatureId"]
},
"ApproveTransferCustodialWalletKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["BSC", "ETH", "KLAY", "MATIC", "ONE", "XDC"],
"example": "ETH",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that holds the asset",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"spender": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address to allow the transfer of the asset from the gas pump address",
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
},
"contractType": {
"type": "number",
"description": "The type of the asset to transfer. Set 0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), or 2 for Multi Tokens (ERC-1155 or equivalent).",
"example": 0,
"enum": [0, 1, 2]
},
"tokenAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the asset to transfer",
"example": "0x782919AFc85eEA2cB736874225456bB5d3e242bA",
"type": "string"
},
"amount": {
"description": "(Only if the asset is a fungible token or Multi Token) The amount of the asset to transfer. Do not use if the asset is an NFT.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(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.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that owns the gas pump address key (\"master address\")"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the specific address from the mnemonic"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "spender", "signatureId"]
},
"TransferCustodialWallet": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["BSC", "ETH", "KLAY", "MATIC", "ONE", "XDC"],
"example": "ETH",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that transfers the asset",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"recipient": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address that receives the asset",
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
},
"contractType": {
"type": "number",
"description": "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,
"enum": [0, 1, 2, 3]
},
"tokenAddress": {
"maxLength": 42,
"minLength": 42,
"description": "(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",
"type": "string"
},
"amount": {
"description": "(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",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(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",
"type": "string",
"maxLength": 256
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address that owns the gas pump address (\"master address\")"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "recipient", "fromPrivateKey"]
},
"TransferCustodialWalletCelo": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that transfers the asset",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"recipient": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address that receives the asset",
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
},
"contractType": {
"type": "number",
"description": "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,
"enum": [0, 1, 2, 3]
},
"tokenAddress": {
"maxLength": 42,
"minLength": 42,
"description": "(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",
"type": "string"
},
"amount": {
"description": "(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",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(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",
"type": "string",
"maxLength": 256
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address that owns the gas pump address (\"master address\")"
},
"feeCurrency": {
"type": "string",
"description": "The currency to pay for the gas fee",
"enum": ["CELO", "CUSD", "CEUR"]
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": [
"custodialAddress",
"chain",
"contractType",
"feeCurrency",
"recipient",
"fromPrivateKey"
]
},
"TransferCustodialWalletCeloKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that transfers the asset",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"recipient": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address that receives the asset",
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
},
"contractType": {
"type": "number",
"description": "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,
"enum": [0, 1, 2, 3]
},
"tokenAddress": {
"maxLength": 42,
"minLength": 42,
"description": "(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",
"type": "string"
},
"amount": {
"description": "(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",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(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",
"type": "string",
"maxLength": 256
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that owns the gas pump address key (\"master address\")"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the specific address from the mnemonic"
},
"feeCurrency": {
"type": "string",
"description": "The currency to pay for the gas fee",
"enum": ["CELO", "CUSD", "CEUR"]
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "feeCurrency", "recipient", "signatureId"]
},
"TransferCustodialWalletKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["BSC", "ETH", "KLAY", "MATIC", "ONE", "XDC"],
"example": "ETH",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that transfers the asset",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"recipient": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address that receives the asset",
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
},
"contractType": {
"type": "number",
"description": "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,
"enum": [0, 1, 2, 3]
},
"tokenAddress": {
"maxLength": 42,
"minLength": 42,
"description": "(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",
"type": "string"
},
"amount": {
"description": "(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",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(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",
"type": "string",
"maxLength": 256
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that owns the gas pump address key (\"master address\")"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the specific address from the mnemonic"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "recipient", "signatureId"]
},
"TransferCustodialWalletTronKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["TRON"],
"example": "TRON",
"type": "string"
},
"custodialAddress": {
"maxLength": 34,
"minLength": 34,
"description": "The gas pump address that transfers the asset",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh",
"type": "string"
},
"from": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "The gas pump address that transfers the assets in the Base58 format",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"recipient": {
"maxLength": 34,
"minLength": 34,
"description": "The blockchain address that receives the asset",
"example": "TYMcTVBz48okKLRczhwiDu22V6XG3yk6W9",
"type": "string"
},
"contractType": {
"type": "number",
"description": "The type of the asset to transfer. Set 0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), or 3 for native blockchain currencies.",
"example": 0,
"enum": [0, 1, 3]
},
"tokenAddress": {
"maxLength": 34,
"minLength": 34,
"description": "(Only if the asset is a fungible token or NFT) The address of the token to transfer. Do not use if the asset is a native blockchain currency.",
"example": "TYMG3ykLRczh6W9cTVBz48wiDu22V6XokK",
"type": "string"
},
"amount": {
"description": "(Only if the asset is a fungible token or native blockchain currency) The amount of the asset to transfer. Do not use if the asset is an NFT.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(Only if the asset is an NFT) The ID of the token to transfer. Do not use if the asset is a fungible token or native blockchain currency.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that owns the gas pump address key (\"master address\")"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the specific address from the mnemonic"
},
"feeLimit": {
"type": "number",
"minimum": 0,
"description": "The maximum amount to be paid as the gas fee (in TRX)",
"example": 0.01
}
},
"required": [
"custodialAddress",
"chain",
"contractType",
"feeLimit",
"from",
"recipient",
"signatureId"
]
},
"TransferCustodialWalletTron": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["TRON"],
"example": "TRON",
"type": "string"
},
"custodialAddress": {
"maxLength": 34,
"minLength": 34,
"description": "The gas pump address that transfers the asset",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh",
"type": "string"
},
"recipient": {
"maxLength": 34,
"minLength": 34,
"description": "The blockchain address that receives the asset",
"example": "TYMcTVBz48okKLRczhwiDu22V6XG3yk6W9",
"type": "string"
},
"contractType": {
"type": "number",
"description": "The type of the asset to transfer. Set 0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), or 3 for native blockchain currencies.",
"example": 0,
"enum": [0, 1, 3]
},
"tokenAddress": {
"maxLength": 34,
"minLength": 34,
"description": "(Only if the asset is a fungible token or NFT) The address of the token to transfer. Do not use if the asset is a native blockchain currency.",
"example": "TYMG3ykLRczh6W9cTVBz48wiDu22V6XokK",
"type": "string"
},
"amount": {
"description": "(Only if the asset is a fungible token or native blockchain currency) The amount of the asset to transfer. Do not use if the asset is an NFT.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"tokenId": {
"description": "(Only if the asset is an NFT) The ID of the token to transfer. Do not use if the asset is a fungible token or native blockchain currency.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 64,
"description": "The private key of the blockchain address that owns the gas pump address (\"master address\")"
},
"feeLimit": {
"type": "number",
"minimum": 0,
"description": "The maximum amount to be paid as the gas fee (in TRX)",
"example": 0.01
}
},
"required": ["custodialAddress", "chain", "contractType", "feeLimit", "recipient", "fromPrivateKey"]
},
"TransferCustodialWalletBatch": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["BSC", "ETH", "KLAY", "MATIC", "ONE", "XDC"],
"example": "ETH",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that transfers the assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"recipient": {
"type": "array",
"description": "The blockchain address that receives the assets",
"items": {
"maxLength": 42,
"minLength": 42,
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
}
},
"contractType": {
"type": "array",
"description": "The type of the assets 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.",
"items": { "type": "number", "example": 0, "enum": [0, 1, 2, 3] }
},
"tokenAddress": {
"type": "array",
"description": "(Only if the assets are fungible tokens, NFTs, or Multi Tokens) The addresses of the tokens to transfer. Do not use if the assets are a native blockchain currency.",
"items": {
"maxLength": 42,
"minLength": 42,
"example": "0x782919AFc85eEA2cB736874225456bB5d3e242bA",
"type": "string"
}
},
"amount": {
"type": "array",
"description": "(Only if the assets are fungible tokens, Multi Tokens, or a native blockchain currency) The amounts of the assets to transfer. Do not use if the assets are NFTs.",
"items": {
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"tokenId": {
"type": "array",
"description": "(Only if the assets are Multi Tokens or NFTs) The IDs of the tokens to transfer. Do not use if the assets are fungible tokens or a native blockchain currency.",
"items": { "example": "100000", "type": "string", "maxLength": 256 }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address that owns the gas pump address (\"master address\")"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "recipient", "fromPrivateKey"]
},
"TransferCustodialWalletBatchCelo": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that transfers the assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"recipient": {
"type": "array",
"description": "The blockchain address that receives the assets",
"items": {
"maxLength": 42,
"minLength": 42,
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
}
},
"contractType": {
"type": "array",
"description": "The type of the assets 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.",
"items": { "type": "number", "example": 0, "enum": [0, 1, 2, 3] }
},
"tokenAddress": {
"type": "array",
"description": "(Only if the assets are fungible tokens, NFTs, or Multi Tokens) The addresses of the tokens to transfer. Do not use if the assets are a native blockchain currency.",
"items": {
"maxLength": 42,
"minLength": 42,
"example": "0x782919AFc85eEA2cB736874225456bB5d3e242bA",
"type": "string"
}
},
"amount": {
"type": "array",
"description": "(Only if the assets are fungible tokens, Multi Tokens, or a native blockchain currency) The amounts of the assets to transfer. Do not use if the assets are NFTs.",
"items": {
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"tokenId": {
"type": "array",
"description": "(Only if the assets are Multi Tokens or NFTs) The IDs of the tokens to transfer. Do not use if the assets are fungible tokens or a native blockchain currency.",
"items": { "example": "100000", "type": "string", "maxLength": 256 }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address that owns the gas pump address (\"master address\")"
},
"feeCurrency": {
"type": "string",
"description": "The currency to pay for the gas fee",
"enum": ["CELO", "CUSD", "CEUR"]
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": [
"custodialAddress",
"chain",
"contractType",
"feeCurrency",
"recipient",
"fromPrivateKey"
]
},
"TransferCustodialWalletBatchTron": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["TRON"],
"example": "TRON",
"type": "string"
},
"custodialAddress": {
"maxLength": 34,
"minLength": 34,
"description": "The gas pump address that transfers the assets",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh",
"type": "string"
},
"recipient": {
"type": "array",
"description": "The blockchain address that receives the assets",
"items": {
"maxLength": 34,
"minLength": 34,
"example": "TYMcTVBz48okKLRczhwiDu22V6XG3yk6W9",
"type": "string"
}
},
"contractType": {
"type": "array",
"description": "The type of the assets to transfer. Set 0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), or 3 for native blockchain currencies.",
"items": { "type": "number", "example": 0, "enum": [0, 1, 3] }
},
"tokenAddress": {
"type": "array",
"description": "(Only if the assets are fungible tokens or NFTs) The addresses of the tokens to transfer. Do not use if the assets are a native blockchain currency.",
"items": {
"maxLength": 34,
"minLength": 34,
"example": "TYMG3ykLRczh6W9cTVBz48wiDu22V6XokK",
"type": "string"
}
},
"amount": {
"type": "array",
"description": "(Only if the assets are fungible tokens or a native blockchain currency) The amounts of the assets to transfer. Do not use if the assets are NFTs.",
"items": {
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"tokenId": {
"type": "array",
"description": "(Only if the assets are NFTs) The IDs of the tokens to transfer. Do not use if the assets are fungible tokens or a native blockchain currency.",
"items": { "example": "100000", "type": "string", "maxLength": 256 }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2648ce5080c2",
"minLength": 64,
"description": "The private key of the blockchain address that owns the gas pump address (\"master address\")"
},
"feeLimit": {
"type": "number",
"minimum": 0,
"description": "The maximum amount to be paid as the gas fee (in TRX)",
"example": 0.01
}
},
"required": ["custodialAddress", "chain", "contractType", "feeLimit", "recipient", "fromPrivateKey"]
},
"TransferCustodialWalletBatchCeloKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that transfers the assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"recipient": {
"type": "array",
"description": "The blockchain address that receives the assets",
"items": {
"maxLength": 42,
"minLength": 42,
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
}
},
"contractType": {
"type": "array",
"description": "The type of the assets 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.",
"items": { "type": "number", "example": 0, "enum": [0, 1, 2, 3] }
},
"tokenAddress": {
"type": "array",
"description": "(Only if the assets are fungible tokens, NFTs, or Multi Tokens) The addresses of the tokens to transfer. Do not use if the assets are a native blockchain currency.",
"items": {
"maxLength": 42,
"minLength": 42,
"example": "0x782919AFc85eEA2cB736874225456bB5d3e242bA",
"type": "string"
}
},
"amount": {
"type": "array",
"description": "(Only if the assets are fungible tokens, Multi Tokens, or a native blockchain currency) The amounts of the assets to transfer. Do not use if the assets are NFTs.",
"items": {
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"tokenId": {
"type": "array",
"description": "(Only if the assets are Multi Tokens or NFTs) The IDs of the tokens to transfer. Do not use if the assets are fungible tokens or a native blockchain currency.",
"items": { "example": "100000", "type": "string", "maxLength": 256 }
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that owns the gas pump address key (\"master address\")"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the specific address from the mnemonic"
},
"feeCurrency": {
"type": "string",
"description": "The currency to pay for the gas fee",
"enum": ["CELO", "CUSD", "CEUR"]
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "feeCurrency", "recipient", "signatureId"]
},
"TransferCustodialWalletBatchTronKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["TRON"],
"example": "TRON",
"type": "string"
},
"custodialAddress": {
"maxLength": 34,
"minLength": 34,
"description": "The gas pump address that transfers the assets",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh",
"type": "string"
},
"from": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "The gas pump address that transfers the assets in the Base58 format",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"recipient": {
"type": "array",
"description": "The blockchain address that receives the assets",
"items": {
"maxLength": 34,
"minLength": 34,
"example": "TYMcTVBz48okKLRczhwiDu22V6XG3yk6W9",
"type": "string"
}
},
"contractType": {
"type": "array",
"description": "The type of the assets to transfer. Set 0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), or 3 for native blockchain currencies.",
"items": { "type": "number", "example": 0, "enum": [0, 1, 3] }
},
"tokenAddress": {
"type": "array",
"description": "(Only if the assets are fungible tokens or NFTs) The addresses of the tokens to transfer. Do not use if the assets are a native blockchain currency.",
"items": {
"maxLength": 34,
"minLength": 34,
"example": "TYMG3ykLRczh6W9cTVBz48wiDu22V6XokK",
"type": "string"
}
},
"amount": {
"type": "array",
"description": "(Only if the assets are fungible tokens or a native blockchain currency) The amounts of the assets to transfer. Do not use if the assets are NFTs.",
"items": {
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"tokenId": {
"type": "array",
"description": "(Only if the assets are NFTs) The IDs of the tokens to transfer. Do not use if the assets are fungible tokens or a native blockchain currency.",
"items": { "example": "100000", "type": "string", "maxLength": 256 }
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that owns the gas pump address key (\"master address\")"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the specific address from the mnemonic"
},
"feeLimit": {
"type": "number",
"minimum": 0,
"description": "The maximum amount to be paid as the gas fee (in TRX)",
"example": 0.01
}
},
"required": [
"custodialAddress",
"chain",
"contractType",
"feeLimit",
"from",
"recipient",
"signatureId"
]
},
"TransferCustodialWalletBatchKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": ["BSC", "ETH", "KLAY", "MATIC", "ONE", "XDC"],
"example": "ETH",
"type": "string"
},
"custodialAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The gas pump address that transfers the assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"recipient": {
"type": "array",
"description": "The blockchain address that receives the assets",
"items": {
"maxLength": 42,
"minLength": 42,
"example": "0xe242bA5456b782919AFc85687422eEA2cB73B5d3",
"type": "string"
}
},
"contractType": {
"type": "array",
"description": "The type of the assets 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.",
"items": { "type": "number", "example": 0, "enum": [0, 1, 2, 3] }
},
"tokenAddress": {
"type": "array",
"description": "(Only if the assets are fungible tokens, NFTs, or Multi Tokens) The addresses of the tokens to transfer. Do not use if the assets are a native blockchain currency.",
"items": {
"maxLength": 42,
"minLength": 42,
"example": "0x782919AFc85eEA2cB736874225456bB5d3e242bA",
"type": "string"
}
},
"amount": {
"type": "array",
"description": "(Only if the assets are fungible tokens, Multi Tokens, or a native blockchain currency) The amounts of the assets to transfer. Do not use if the assets are NFTs.",
"items": {
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"tokenId": {
"type": "array",
"description": "(Only if the assets are Multi Tokens or NFTs) The IDs of the tokens to transfer. Do not use if the assets are fungible tokens or a native blockchain currency.",
"items": { "example": "100000", "type": "string", "maxLength": 256 }
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that owns the gas pump address key (\"master address\")"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the specific address from the mnemonic"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transfer transaction; if not present, the last known nonce will be used"
},
"fee": {
"description": "The custom defined fee; if not present, will be calculated automatically",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["custodialAddress", "chain", "contractType", "recipient", "signatureId"]
},
"TransferErc721KMS": {
"type": "object",
"properties": {
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC721 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "contractAddress", "signatureId", "tokenId"]
},
"KmsSignatureIds": {
"type": "object",
"properties": {
"signatureIds": {
"description": "List of the signature Ids to be used to sign transactions.",
"example": ["6d78dad2-518f-4e76-8255-8f1df0de6886", "26d3883e-4e17-48b3-a0ee-09a3e484ac83"],
"type": "array",
"items": { "type": "string", "format": "uuid" }
}
}
},
"PendingTransaction": {
"type": "object",
"properties": {
"id": {
"description": "ID of the pending transaction",
"example": "5e6645712b55823de7ea82f1",
"type": "string"
},
"chain": {
"type": "string",
"example": "ETH",
"description": "Blockchain of the transaction",
"enum": [
"BNB",
"BTC",
"ETH",
"XLM",
"XRP",
"BCH",
"LTC",
"DOGE",
"VET",
"BSC",
"MATIC",
"CELO",
"FLOW",
"TRON",
"ONE",
"XDC",
"EGLD",
"KLAY",
"SOL"
]
},
"hashes": {
"type": "array",
"description": "List of the signature Ids to be used to sign transaction. Those hashes should be in order of signing for the BTC, LTC or BCH blockchains.",
"items": {
"type": "string",
"description": "Signature hash representing wallet or private key managed in the Tatum KMS instance.",
"example": "1234987askdjfb1o2873ryskajfb1234987askdjfb1o2873ryskajfb1234987askdjfb1o2873ryskajfb"
}
},
"serializedTransaction": {
"type": "string",
"example": "alskdjfq8o27fbkasljfbq8o7b4fqo83f7bqejhafbo8q4f",
"description": "Serialized data of the transaction to be signed. It can be JSON, HEX or any other representation based on the blockchain."
},
"withdrawalId": {
"description": "ID of the pending off-chain withdrawal connected to this transaction",
"example": "5e6645712b55823de7ea82f1",
"type": "string"
},
"index": {
"type": "number",
"description": "In case of mnemonic type of signature Id, this is the index to the specific account that should be used for signature.",
"example": 1,
"minimum": 0
},
"txId": {
"description": "TX hash of successful transaction.",
"example": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9",
"type": "string"
},
"withdrawalResponses": {
"items": { "$ref": "#/components/schemas/ResponseData" },
"type": "array",
"description": "Additional information used for BTC, LTC, DOGE and BCH off-chain to blockchain transactions."
}
},
"required": ["id", "chain", "serializedTransaction", "hashes"]
},
"MintErc721": {
"type": "object",
"properties": {
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC721 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "url", "contractAddress", "fromPrivateKey", "tokenId"]
},
"MintErc721KMS": {
"type": "object",
"properties": {
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC721 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "url", "contractAddress", "signatureId", "tokenId"]
},
"MintMultipleErc721": {
"type": "object",
"properties": {
"to": {
"type": "array",
"description": "Blockchain address to send ERC721 token to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"type": "array",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "url", "contractAddress", "fromPrivateKey", "tokenId"]
},
"MintMultipleErc721KMS": {
"type": "object",
"properties": {
"to": {
"type": "array",
"description": "Blockchain address to send ERC721 token to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"type": "array",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "contractAddress", "tokenId", "url", "signatureId"]
},
"BurnErc721": {
"type": "object",
"properties": {
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "url", "contractAddress", "fromPrivateKey", "tokenId"]
},
"BurnErc721KMS": {
"type": "object",
"properties": {
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "url", "contractAddress", "tokenId", "signatureId"]
},
"TransferEthBlockchain": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additinal data, that can be passed to blockchain transaction as data property. Only for ETH transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from Ethereum Blockchain Account.",
"enum": [
"USDT",
"LEO",
"LINK",
"UNI",
"FREE",
"GMC",
"GMC_BSC",
"RMD",
"MKR",
"USDC",
"BAT",
"TUSD",
"BUSD",
"PAX",
"PAXG",
"MMY",
"WBTC",
"XCON",
"ETH"
],
"example": "ETH",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "currency", "fromPrivateKey", "amount"]
},
"EthEstimateGas": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 42,
"example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef",
"minLength": 42,
"description": "Sender address."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"contractAddress": {
"description": "Contract address of ERC20 token, if transaction is ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in Ether or ERC20.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additinal data, that can be passed to blockchain transaction as data property. Only for ETH transactions.",
"example": "My note to recipient.",
"pattern": "^(0x|0h)?[0-9A-F]+$"
}
},
"required": ["to", "amount", "from"]
},
"EthEstimateGasArray": {
"type": "object",
"required": ["estimations"],
"properties": {
"estimations": { "type": "array", "items": { "$ref": "#/components/schemas/EthEstimateGas" } }
}
},
"EthGasEstimation": {
"type": "object",
"required": ["gasLimit", "gasPrice", "estimations"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000"
},
"gasPrice": { "type": "string", "description": "Gas price in wei.", "example": "20000000000" },
"estimations": {
"type": "object",
"description": "Detailed estimations for safe (under 30 minutes), standard (under 5 minutes) and fast (under 2 minutes) transaction times.",
"required": ["safe", "standard", "fast", "baseFee"],
"properties": {
"safe": { "type": "string", "description": "Safe gas price in wei.", "example": "20000000000" },
"standard": {
"type": "string",
"description": "Standard gas price in wei.",
"example": "40000000000"
},
"fast": { "type": "string", "description": "Fast gas price in wei.", "example": "55000000000" },
"baseFee": {
"type": "string",
"description": "Base fee for EIP-1559 transactions in wei.",
"example": "55000000000"
}
}
}
}
},
"EthGasEstimationBatch": {
"type": "object",
"required": ["error", "result"],
"properties": {
"error": { "type": "boolean", "description": "If all estimations succeeded.", "example": false },
"result": {
"type": "array",
"items": {
"type": "object",
"required": ["error"],
"properties": {
"error": { "type": "boolean", "description": "If estimation succeeded.", "example": false },
"contractAddress": {
"description": "Contract address of ERC20 token, if transaction is ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"data": {
"type": "object",
"required": ["gasLimit", "gasPrice", "estimations"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in wei.",
"example": "20000000000"
},
"estimations": {
"type": "object",
"description": "Detailed estimations for safe (under 30 minutes), standard (under 5 minutes) and fast (under 2 minutes) transaction times.",
"required": ["safe", "standard", "fast", "baseFee"],
"properties": {
"safe": {
"type": "string",
"description": "Safe gas price in wei.",
"example": "20000000000"
},
"standard": {
"type": "string",
"description": "Standard gas price in wei.",
"example": "40000000000"
},
"fast": {
"type": "string",
"description": "Fast gas price in wei.",
"example": "55000000000"
},
"baseFee": {
"type": "string",
"description": "Base fee for EIP-1559 transactions in wei.",
"example": "55000000000"
}
}
}
}
},
"msg": {
"type": "string",
"description": "Error message. Present only if error - true.",
"example": "Provided address 0xt16360210b423d3a5205923d6e64a2d142d9f426 is invalid, the capitalization checksum test failed, or it's an indirect IBAN address which can't be converted."
}
}
}
}
},
"example": {
"error": true,
"result": [
{
"error": true,
"msg": "Provided address 0xt16360210b423d3a5205923d6e64a2d142d9f426 is invalid, the capitalization checksum test failed, or it's an indirect IBAN address which can't be converted."
},
{
"error": false,
"contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7",
"data": {
"gasLimit": "63185",
"gasPrice": "119104833751",
"estimations": {
"safe": "100833333333",
"standard": "104833333333",
"fast": "119104833751",
"baseFee": "119104833751"
}
}
}
]
}
},
"TransferEthBlockchainKMS": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additinal data, that can be passed to blockchain transaction as data property. Only for ETH transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from Ethereum Blockchain Account.",
"enum": [
"USDT",
"LEO",
"LINK",
"UNI",
"FREE",
"GMC",
"GMC_BSC",
"RMD",
"MKR",
"USDC",
"BAT",
"TUSD",
"BUSD",
"PAX",
"PAXG",
"MMY",
"WBTC",
"XCON",
"ETH"
],
"example": "ETH",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
}
},
"required": ["to", "amount", "currency", "signatureId"]
},
"CreateRecord": {
"type": "object",
"properties": {
"data": {
"type": "string",
"minLength": 1,
"maxLength": 130000,
"description": "Log data to be stored on a blockchain.",
"example": "My example log data."
},
"chain": {
"description": "Blockchain, where to store log data.",
"enum": ["ETH", "ONE", "XDC", "KLAY", "BSC", "MATIC"],
"example": "ETH",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of account, from which the transaction will be initiated. If not present, transaction fee will be debited from Tatum internal account and additional credits will be charged."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to store log on. If not defined, it will be stored on an address, from which the transaction was being made.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
}
},
"required": ["data", "chain"]
},
"CreateRecordCelo": {
"type": "object",
"properties": {
"data": {
"type": "string",
"minLength": 1,
"maxLength": 130000,
"description": "Log data to be stored on a blockchain.",
"example": "My example log data."
},
"chain": {
"description": "Blockchain, where to store log data.",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of account, from which the transaction will be initiated. If not present, transaction fee will be debited from Tatum internal account and additional credits will be charged."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to store log on. If not defined, it will be stored on an address, from which the transaction was being made.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
}
},
"required": ["data", "feeCurrency", "chain"]
},
"TransferErc20": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"address": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"maxLength": 38,
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"currency": {
"description": "ERC20 symbol. Required only for calls.",
"example": "MY_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
},
"privateKey": {
"type": "string",
"maxLength": 66,
"minLength": 66,
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"description": "Private key of sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "privateKey", "amount"]
},
"TransferErc20Mnemonic": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"address": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"maxLength": 38,
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"currency": {
"description": "ERC20 symbol. Required only for calls.",
"example": "MY_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key for sender address. Either mnemonic and index, or privateKey must be present - depends on the type of account and xpub.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "mnemonic", "index"]
},
"TransferErc20KMS": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"address": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"maxLength": 38,
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"currency": {
"description": "ERC20 symbol. Required only for calls.",
"example": "MY_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "signatureId"]
},
"TransferEth": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum | Polygon | KCS | XDC transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in Ether | MATIC | XDC | KCS.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"privateKey": {
"type": "string",
"maxLength": 66,
"minLength": 66,
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"description": "Private key of sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub."
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
},
"required": ["senderAccountId", "address", "amount", "privateKey"]
},
"TransferEthMnemonic": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum | Polygon | KCS | XDC transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in Ether | MATIC | XDC | KCS.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key for sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "mnemonic", "index"]
},
"TransferEthKMS": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum | Polygon | KCS | XDC transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in Ether | MATIC | XDC | KCS.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
},
"required": ["senderAccountId", "address", "signatureId", "amount"]
},
"TransferKCS": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to KCS transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in KCS.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"minLength": 66,
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"description": "Private key of sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub."
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
},
"required": ["senderAccountId", "address", "amount", "fromPrivateKey"]
},
"TransferKCSMnemonic": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to KCS transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in KCS.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key for sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "mnemonic", "index"]
},
"TransferKCSKMS": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to KCS transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in KCS.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
},
"required": ["senderAccountId", "address", "signatureId", "amount"]
},
"TransferBsc": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Binance Smart Chain transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"minLength": 66,
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"description": "Private key of sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub."
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
},
"required": ["senderAccountId", "address", "amount", "fromPrivateKey"]
},
"TransferBscMnemonic": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Binance Smart Chain transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key for sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "mnemonic", "index"]
},
"TransferBscKMS": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Binance Smart Chain transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
},
"required": ["senderAccountId", "address", "signatureId", "amount"]
},
"TransferCelo": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"minLength": 66,
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"description": "Private key of sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub."
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
},
"required": ["senderAccountId", "address", "amount", "feeCurrency", "fromPrivateKey"]
},
"TransferCeloMnemonic": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key for sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "mnemonic", "feeCurrency", "index"]
},
"TransferCeloKMS": {
"type": "object",
"properties": {
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
},
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei. If not set, automatic calculation will be used.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
},
"required": ["senderAccountId", "address", "signatureId", "feeCurrency", "amount"]
},
"TransferTron": {
"type": "object",
"properties": {
"address": {
"description": "Blockchain address to send assets",
"example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW",
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"amount": {
"description": "Amount to be sent in Tron.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"minLength": 64,
"example": "e75d702ce00987633f8009fbb1eabb5b187cb5b50fe9179a8d6cee6bab076b66",
"description": "Private key of sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub."
},
"fee": {
"description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 2.5 TRX is used.",
"example": "2.5",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "fromPrivateKey"]
},
"TransferTronMnemonic": {
"type": "object",
"properties": {
"address": {
"description": "Blockchain address to send assets",
"example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW",
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"amount": {
"description": "Amount to be sent in Tron.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"fee": {
"description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 2.5 TRX is used.",
"example": "2.5",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key for sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "mnemonic", "index"]
},
"TransferTronKMS": {
"type": "object",
"properties": {
"address": {
"description": "Blockchain address to send assets to",
"example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW",
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"amount": {
"description": "Amount to be sent in Tron.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"fee": {
"description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 2.5 TRX is used.",
"example": "2.5",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"from": {
"description": "Blockchain address to send assets from",
"example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW",
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "from", "address", "signatureId", "amount"]
},
"TransferAdaKeyPair": {
"properties": {
"senderAccountId": {
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"maxLength": 24,
"minLength": 24,
"type": "string"
},
"address": {
"description": "Blockchain address to send assets to.",
"example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7",
"maxLength": 150,
"minLength": 1,
"type": "string"
},
"amount": {
"description": "Amount to be withdrawn to blockchain.",
"maxLength": 38,
"example": "0.001",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"fee": {
"description": "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",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"keyPair": {
"description": "Array of assigned blockchain addresses with their private keys.\nEither mnemonic, keyPair or signature Id must be present - depends on the type of account and xpub.\nTatum KMS does not support keyPair type of off-chain transaction, only mnemonic based.\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Blockchain address assigned to account withdrawal is made from.",
"maxLength": 150,
"minLength": 30
},
"privateKey": {
"type": "string",
"description": "Private key of blockchain address.",
"maxLength": 192,
"example": "7808a501e1bbc9926ac8ac6981e47cb0401288ae331a1f2333d1bed46c5b3051b5f875c39477b05bc3a43a3800b763f616ae3646f21df0ab5d95db944e71f5cfa8082d5c4e6241d49b17b2b6173f01bb3fd03be012cc8908ceea9e559e33e4fc",
"minLength": 192
}
}
}
},
"attr": {
"description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used.",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"maxLength": 500,
"minLength": 1,
"type": "string"
}
},
"required": ["amount", "senderAccountId", "address", "keyPair", "attr"],
"type": "object"
},
"TransferAdaMnemonic": {
"type": "object",
"properties": {
"address": {
"description": "Blockchain address to send assets",
"example": "addr1qyyxyhaa2e7kxeqcc72w7f747zqlgwwwstlzsg9umuxc40wnhawldxl4nan95rhtlcnju9q2r8j9qz8vslwsmrkj5r4spxhep9",
"maxLength": 90,
"minLength": 110,
"type": "string"
},
"amount": {
"description": "Amount to be sent in ADA.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"fee": {
"description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 1 ADA is used.",
"example": "2.5",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key for sender address. Either mnemonic and index, privateKey or signature Id must be present - depends on the type of account and xpub.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"xpub": {
"description": "Extended public key (xpub) of the wallet associated with the accounts. Should be present, when mnemonic is used.",
"maxLength": 192,
"minLength": 1,
"example": "41253768cd7c5831988e580cfc7eeecaa78bf52a1ede2bd2f245406605adfbadd5911ab567bc3dc7713e29c2c14bb898b24bb1f01a4992605343ad14703037b9",
"type": "string"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "mnemonic", "xpub", "index"]
},
"TransferAdaKMS": {
"type": "object",
"properties": {
"address": {
"description": "Blockchain address to send assets to",
"example": "addr1qyyxyhaa2e7kxeqcc72w7f747zqlgwwwstlzsg9umuxc40wnhawldxl4nan95rhtlcnju9q2r8j9qz8vslwsmrkj5r4spxhep9",
"maxLength": 90,
"minLength": 110,
"type": "string"
},
"amount": {
"description": "Amount to be sent in ADA.",
"maxLength": 38,
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"fee": {
"description": "Fee to be submitted as a transaction fee to blockchain. If none is set, default value of 1 ADA is used.",
"example": "2.5",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"from": {
"description": "Blockchain address to send assets from",
"example": "addr1qyyxyhaa2e7kxeqcc72w7f747zqlgwwwstlzsg9umuxc40wnhawldxl4nan95rhtlcnju9q2r8j9qz8vslwsmrkj5r4spxhep9",
"maxLength": 90,
"minLength": 110,
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the mnemonic / private key associated in signing application.\nWhen hash identifies mnemonic, index must be present to represent specific account to pay from.\nPrivate key, mnemonic or signature Id must be present.\n"
},
"xpub": {
"description": "Extended public key (xpub) of the wallet associated with the accounts. XPub or attr must be used with signatureId.",
"maxLength": 192,
"minLength": 1,
"example": "41253768cd7c5831988e580cfc7eeecaa78bf52a1ede2bd2f245406605adfbadd5911ab567bc3dc7713e29c2c14bb898b24bb1f01a4992605343ad14703037b9",
"type": "string"
},
"attr": {
"description": "Used to parametrize withdrawal as a change address for left coins from transaction. XPub or attr must be used with signatureId.",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"index": {
"description": "Derivation index of sender address.",
"maximum": 2147483647,
"example": 0,
"type": "integer"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "from", "address", "signatureId", "amount"]
},
"TransferXrp": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"account": {
"maxLength": 100,
"minLength": 1,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XRP.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"attr": {
"description": "Destination tag of the recipient account, if any. Must be stringified uint32.",
"example": "12355",
"type": "string"
},
"sourceTag": {
"description": "Source tag of sender account, if any.",
"example": 12355,
"type": "integer"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"secret": {
"maxLength": 29,
"minLength": 29,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "snSFTHdvSYQKKkYntvEt8cnmZuPJB",
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["account", "senderAccountId", "address", "amount", "secret"]
},
"TransferXrpKMS": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"account": {
"maxLength": 100,
"minLength": 1,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XRP.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"attr": {
"description": "Destination tag of the recipient account, if any. Must be stringified uint32.",
"example": "12355",
"type": "string"
},
"sourceTag": {
"description": "Source tag of sender account, if any.",
"example": 12355,
"type": "integer"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["account", "senderAccountId", "address", "signatureId", "amount"]
},
"TransferBnb": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": "tbnb1q82g2h9q0kfe7sysnj5w7nlak92csfjztymp39",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in BNB.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"attr": {
"description": "Memo of the recipient account, if any.",
"example": "12355",
"type": "string"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"minLength": 64,
"example": "8ac4b14b38d8a5af58019088ce5a24b764536bccd1981cf79d3e09e9d1f2ad31",
"description": "Private key of sender address."
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "address", "amount", "fromPrivateKey"]
},
"TransferBnbKMS": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": "tbnb1q82g2h9q0kfe7sysnj5w7nlak92csfjztymp39",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in BNB.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"attr": {
"description": "Memo of the recipient account, if any.",
"example": "12355",
"type": "string"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"fromAddress": {
"description": "Blockchain address to send from.",
"example": "tbnb1q82g2h9q0kfe7sysnj5w7nlak92csfjztymp39",
"maxLength": 50,
"minLength": 42,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["senderAccountId", "fromAddress", "address", "amount", "signatureId"]
},
"CreateXlmAsset": {
"type": "object",
"properties": {
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets.",
"example": "GC5LAVZ5UPLIFDH6SI33PNVL5TKWA4ODXTI3WEF5JM6LRM5MNGVJ56TT",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"token": {
"description": "Asset name.",
"example": "TOKEN123",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,12}$",
"maxLength": 12,
"minLength": 1
},
"basePair": {
"description": "Base pair for Asset. Transaction value will be calculated according to this base pair. e.g. 1 TOKEN123 is equal to 1 EUR, if basePair is set to EUR.",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BAT",
"BBD",
"BCH",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DOGE",
"DZD",
"EGP",
"ERN",
"ETB",
"ETH",
"EUR",
"FJD",
"FKP",
"FLOW",
"FUSD",
"FREE",
"GMC",
"GMC_BSC",
"RMD",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LEO",
"LINK",
"LKR",
"LRD",
"LSL",
"LTC",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MKR",
"MMK",
"MMY",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PAX",
"PAXG",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TRON",
"TUSD",
"BUSD",
"TWD",
"TZS",
"UAH",
"UGX",
"UNI",
"USD",
"USDC",
"USDT",
"USDT_TRON",
"USDT_MATIC",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WBTC",
"WST",
"XAF",
"XAG",
"XAU",
"XCD",
"XCON",
"XDR",
"XLM",
"XOF",
"XPF",
"XRP",
"YER",
"ZAR",
"ZMK",
"ZMW",
"ZWL"
],
"example": "EUR",
"maxLength": 50,
"minLength": 3,
"type": "string"
}
},
"required": ["basePair", "issuerAccount", "token"]
},
"CreateBnbAsset": {
"type": "object",
"properties": {
"token": {
"description": "Asset name.",
"example": "NNB-B90",
"type": "string",
"pattern": "^[a-zA-Z0-9\\-]{1,12}$",
"maxLength": 12,
"minLength": 1
},
"basePair": {
"description": "Base pair for Asset. Transaction value will be calculated according to this base pair. e.g. 1 TOKEN123 is equal to 1 EUR, if basePair is set to EUR.",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BAT",
"BBD",
"BCH",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DOGE",
"DZD",
"EGP",
"ERN",
"ETB",
"ETH",
"EUR",
"FJD",
"FKP",
"FLOW",
"FUSD",
"FREE",
"GMC",
"GMC_BSC",
"RMD",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LEO",
"LINK",
"LKR",
"LRD",
"LSL",
"LTC",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MKR",
"MMK",
"MMY",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PAX",
"PAXG",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TRON",
"TUSD",
"BUSD",
"TWD",
"TZS",
"UAH",
"UGX",
"UNI",
"USD",
"USDC",
"USDT",
"USDT_TRON",
"USDT_MATIC",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WBTC",
"WST",
"XAF",
"XAG",
"XAU",
"XCD",
"XCON",
"XDR",
"XLM",
"XOF",
"XPF",
"XRP",
"YER",
"ZAR",
"ZMK",
"ZMW",
"ZWL"
],
"example": "EUR",
"maxLength": 50,
"minLength": 3,
"type": "string"
}
},
"required": ["basePair", "token"]
},
"CreateXrpAsset": {
"type": "object",
"properties": {
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets.",
"example": "rsCZjvenhxsFycrb33gPSfXdrTNAS5uiR1",
"maxLength": 34,
"minLength": 33,
"type": "string"
},
"token": {
"description": "Asset name.",
"example": "DA39A3EE5E6B4B0D3255BFEF95601890AFD80709",
"type": "string",
"pattern": "^[A-F0-9]{40}$",
"maxLength": 40,
"minLength": 40
},
"basePair": {
"description": "Base pair for Asset. Transaction value will be calculated according to this base pair. e.g. 1 TOKEN123 is equal to 1 EUR, if basePair is set to EUR.",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BAT",
"BBD",
"BCH",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DOGE",
"DZD",
"EGP",
"ERN",
"ETB",
"ETH",
"EUR",
"FJD",
"FKP",
"FLOW",
"FUSD",
"FREE",
"GMC",
"GMC_BSC",
"RMD",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LEO",
"LINK",
"LKR",
"LRD",
"LSL",
"LTC",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MKR",
"MMK",
"MMY",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PAX",
"PAXG",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TRON",
"TUSD",
"BUSD",
"TWD",
"TZS",
"UAH",
"UGX",
"UNI",
"USD",
"USDC",
"USDT",
"USDT_TRON",
"USDT_MATIC",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WBTC",
"WST",
"XAF",
"XAG",
"XAU",
"XCD",
"XCON",
"XDR",
"XLM",
"XOF",
"XPF",
"XRP",
"YER",
"ZAR",
"ZMK",
"ZMW",
"ZWL"
],
"example": "EUR",
"maxLength": 50,
"minLength": 3,
"type": "string"
}
},
"required": ["basePair", "issuerAccount", "token"]
},
"TransferXlm": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"fromAccount": {
"description": "Blockchain account to send from",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XLM or XLM-based Asset.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"secret": {
"maxLength": 56,
"minLength": 56,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"attr": {
"description": "Short message to recipient. Usually used as an account discriminator. It can be either 28 characters long ASCII text, 64 characters long HEX string or uint64 number. When using as an account disciminator in Tatum Offchain ledger, can be in format of destination_acc|source_acc.",
"example": "12355",
"pattern": "^[ -~]{0,64}$",
"type": "string",
"maxLength": 64
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["fromAccount", "senderAccountId", "address", "secret", "amount"]
},
"TransferXlmKMS": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"fromAccount": {
"description": "Blockchain account to send from",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XLM or XLM-based Asset.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"attr": {
"description": "Short message to recipient. Usually used as an account discriminator. It can be either 28 characters long ASCII text, 64 characters long HEX string or uint64 number. When using as an account disciminator in Tatum Offchain ledger, can be in format of destination_acc|source_acc.",
"example": "12355",
"pattern": "^[ -~]{0,64}$",
"type": "string",
"maxLength": 64
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["fromAccount", "senderAccountId", "address", "amount", "signatureId"]
},
"TransferSol": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"from": {
"description": "Blockchain account to send from",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"maxLength": 43,
"minLength": 44,
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": "9B5XszUGdMaxCZ7uSQhPzdks5ZQSmWxrmzCSvtJ6Ns6g",
"maxLength": 43,
"minLength": 44,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in SOL / USDC_SOL or custom SPL token based on the senderAccountId currency type.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"privateKey": {
"maxLength": 128,
"minLength": 87,
"description": "Private key for account. Private key, or signature Id must be present.",
"example": "zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv",
"type": "string"
},
"fee": {
"description": "Fee to be charged for the operation. For SOL, fee is decided by the blockchain, but default SOL fee is 0.000005. This fee will be only charged on top of the withdrawal amount to the virtual account.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["from", "senderAccountId", "address", "privateKey", "amount"]
},
"TransferSolKMS": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"from": {
"description": "Blockchain account to send from",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"maxLength": 43,
"minLength": 44,
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": "9B5XszUGdMaxCZ7uSQhPzdks5ZQSmWxrmzCSvtJ6Ns6g",
"maxLength": 43,
"minLength": 44,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in SOL.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"fee": {
"description": "Fee to be charged for the operation. For SOL, fee is decided by the blockchain, but default SOL fee is 0.000005. This fee will be only charged on top of the withdrawal amount to the virtual account.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["from", "senderAccountId", "address", "signatureId", "amount"]
},
"TransferFlowPK": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": 10762710243615955000,
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in Flow.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"privateKey": {
"maxLength": 64,
"minLength": 64,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "37afa218d41d9cd6a2c6f2b96d9eaa3ad96c598252bc50e4d45d62f9356a51f8",
"type": "string"
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["account", "senderAccountId", "address", "privateKey", "amount"]
},
"TransferFlowKMS": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": 10762710243615955000,
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in Flow.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["account", "senderAccountId", "address", "amount", "signatureId"]
},
"TransferAlgo": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "The ID of the virtual account to send Algos from",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"account": {
"description": "The blockchain address of the Algorand wallet (account) associated with the virtual account",
"example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"address": {
"description": "The blockchain address to send Algos to",
"example": "5YVZBUH3STSQ5ABCTLEIEIJ7QOZFILM2DLAEEA4ZL6CU55ODZIQXO5EMYM",
"maxLength": 58,
"minLength": 58,
"type": "string"
},
"amount": {
"description": "The amount to send in Algos",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fee": { "description": "The transaction fee in Algos", "type": "string", "example": "0.001" },
"privateKey": {
"maxLength": 103,
"minLength": 103,
"description": "The secret of the Algorand wallet (account). Secret, or signature Id must be present.",
"example": "NBYMCVEEDFYV3TPWVRE6APE7PKHUJD4XAKXCKNCLKGUXOC3LFNJGZQCJCRA53HB7ZAHF6NFJH2QIVQ5USQNWG35QCJLD4KZ5IWMB24Q",
"type": "string"
},
"compliant": {
"description": "Compliance check; if the withdrawal is not compliant, it will not be processed",
"example": false,
"type": "boolean"
},
"paymentId": {
"description": "The identifier of the Algo transfer that is shown on the virtual account for the created transaction",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "The note for the recipient; must not contain spaces",
"example": "Helloworld",
"type": "string"
}
},
"required": ["account", "senderAccountId", "address", "privateKey", "amount", "fee"]
},
"TransferAlgoKMS": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "The ID of the virtual account to send Algos from",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"account": {
"description": "The blockchain address of the Algorand wallet (account) associated with the virtual account",
"example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y",
"maxLength": 58,
"minLength": 58,
"type": "string"
},
"address": {
"description": "The blockchain address to send Algos to",
"example": "5YVZBUH3STSQ5ABCTLEIEIJ7QOZFILM2DLAEEA4ZL6CU55ODZIQXO5EMYM",
"maxLength": 58,
"minLength": 58,
"type": "string"
},
"amount": {
"description": "The amount to send in Algos",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fee": { "description": "The transaction fee in Algos", "type": "string", "example": "0.001" },
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The identifier of the secret of the Algorand wallet (account) in the signing application. Secret, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"compliant": {
"description": "Compliance check; if the withdrawal is not compliant, it will not be processed",
"example": false,
"type": "boolean"
},
"paymentId": {
"description": "The identifier of the Algo transfer that is shown on the virtual account for the created transaction",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "The note for the recipient; must not contain spaces",
"example": "Helloworld",
"type": "string"
}
},
"required": ["account", "senderAccountId", "address", "amount", "signatureId", "fee"]
},
"TransferFlowMnemonic": {
"type": "object",
"properties": {
"senderAccountId": {
"maxLength": 24,
"minLength": 24,
"description": "Sender account ID",
"example": "61b3bffddfb389cde19c73be",
"type": "string"
},
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"address": {
"description": "Blockchain address to send assets",
"example": "0x955cd3f17b2fd8ae",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in Flow.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "Index to the specific address from mnemonic."
},
"compliant": {
"description": "Compliance check, if withdrawal is not compliant, it will not be processed.",
"example": false,
"type": "boolean"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "1234",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"senderNote": {
"maxLength": 500,
"minLength": 1,
"description": "Note visible to owner of withdrawing account.",
"example": "Sender note",
"type": "string"
}
},
"required": ["account", "senderAccountId", "address", "amount", "mnemonic", "index"]
},
"FlowTransactionPK": {
"type": "object",
"properties": {
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"currency": { "type": "string", "description": "Type of asset to send", "enum": ["FLOW", "FUSD"] },
"to": {
"description": "Blockchain address to send assets",
"example": "0x955cd3f17b2fd8ae",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in Flow.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"privateKey": {
"maxLength": 64,
"minLength": 64,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "37afa218d41d9cd6a2c6f2b96d9eaa3ad96c598252bc50e4d45d62f9356a51f8",
"type": "string"
}
},
"required": ["account", "address", "privateKey", "currency", "amount"]
},
"FlowTransactionKMS": {
"type": "object",
"properties": {
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"currency": { "type": "string", "description": "Type of asset to send", "enum": ["FLOW", "FUSD"] },
"to": {
"description": "Blockchain address to send assets",
"example": "0x955cd3f17b2fd8ae",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in Flow.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
}
},
"required": ["account", "currency", "address", "amount", "signatureId"]
},
"FlowTransactionMnemonic": {
"type": "object",
"properties": {
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"currency": { "type": "string", "description": "Type of asset to send", "enum": ["FLOW", "FUSD"] },
"to": {
"description": "Blockchain address to send assets",
"example": "0x955cd3f17b2fd8ae",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in Flow.",
"maxLength": 38,
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "Index to the specific address from mnemonic."
}
},
"required": ["account", "currency", "address", "amount", "mnemonic", "index"]
},
"FlowCustomTransactionPK": {
"type": "object",
"properties": {
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"transaction": {
"description": "Transaction string to send to the chain.",
"example": "transaction(publicKey: String) {\n prepare(signer: AuthAccount) {\n signer.addPublicKey(publicKey.decodeHex())\n }\n}\n",
"maxLength": 500000,
"minLength": 1,
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value of the argument. In case of Array type, it could be list of strings."
},
"type": {
"description": "Type of the argument",
"maxLength": 38,
"type": "string",
"enum": [
"Identity",
"UInt",
"Int",
"UInt8",
"Int8",
"UInt16",
"Int16",
"UInt32",
"Int32",
"UInt64",
"Int64",
"UInt128",
"Int128",
"UInt256",
"Int256",
"Word8",
"Word16",
"Word32",
"Word64",
"UFix64",
"Fix64",
"String",
"Character",
"Bool",
"Address",
"Void",
"Optional",
"Reference",
"Array",
"Dictionary",
"Event",
"Resource",
"Struct"
]
},
"subType": {
"description": "Type of the argument",
"maxLength": 38,
"type": "string",
"enum": [
"Identity",
"UInt",
"Int",
"UInt8",
"Int8",
"UInt16",
"Int16",
"UInt32",
"Int32",
"UInt64",
"Int64",
"UInt128",
"Int128",
"UInt256",
"Int256",
"Word8",
"Word16",
"Word32",
"Word64",
"UFix64",
"Fix64",
"String",
"Character",
"Bool",
"Address",
"Void",
"Optional",
"Reference",
"Array",
"Dictionary",
"Event",
"Resource",
"Struct"
]
}
},
"required": ["type", "value"]
}
},
"privateKey": {
"maxLength": 64,
"minLength": 64,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "37afa218d41d9cd6a2c6f2b96d9eaa3ad96c598252bc50e4d45d62f9356a51f8",
"type": "string"
}
},
"required": ["account", "transaction", "privateKey", "currency", "args"]
},
"FlowCustomTransactionKMS": {
"type": "object",
"properties": {
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"transaction": {
"description": "Transaction string to send to the chain.",
"example": "transaction(publicKey: String) {\n prepare(signer: AuthAccount) {\n signer.addPublicKey(publicKey.decodeHex())\n }\n}\n",
"maxLength": 500000,
"minLength": 1,
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value of the argument. In case of Array type, it could be list of strings."
},
"type": {
"description": "Type of the argument",
"maxLength": 38,
"type": "string",
"enum": [
"Identity",
"UInt",
"Int",
"UInt8",
"Int8",
"UInt16",
"Int16",
"UInt32",
"Int32",
"UInt64",
"Int64",
"UInt128",
"Int128",
"UInt256",
"Int256",
"Word8",
"Word16",
"Word32",
"Word64",
"UFix64",
"Fix64",
"String",
"Character",
"Bool",
"Address",
"Void",
"Optional",
"Reference",
"Array",
"Dictionary",
"Event",
"Resource",
"Struct"
]
},
"subType": {
"description": "Type of the argument",
"maxLength": 38,
"type": "string",
"enum": [
"Identity",
"UInt",
"Int",
"UInt8",
"Int8",
"UInt16",
"Int16",
"UInt32",
"Int32",
"UInt64",
"Int64",
"UInt128",
"Int128",
"UInt256",
"Int256",
"Word8",
"Word16",
"Word32",
"Word64",
"UFix64",
"Fix64",
"String",
"Character",
"Bool",
"Address",
"Void",
"Optional",
"Reference",
"Array",
"Dictionary",
"Event",
"Resource",
"Struct"
]
}
},
"required": ["type", "value"]
}
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
}
},
"required": ["account", "currency", "transaction", "args", "signatureId"]
},
"FlowCustomTransactionMnemonic": {
"type": "object",
"properties": {
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"transaction": {
"description": "Transaction string to send to the chain.",
"example": "transaction(publicKey: String) {\n prepare(signer: AuthAccount) {\n signer.addPublicKey(publicKey.decodeHex())\n }\n}\n",
"maxLength": 500000,
"minLength": 1,
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value of the argument. In case of Array type, it could be list of strings."
},
"type": {
"description": "Type of the argument",
"maxLength": 38,
"type": "string",
"enum": [
"Identity",
"UInt",
"Int",
"UInt8",
"Int8",
"UInt16",
"Int16",
"UInt32",
"Int32",
"UInt64",
"Int64",
"UInt128",
"Int128",
"UInt256",
"Int256",
"Word8",
"Word16",
"Word32",
"Word64",
"UFix64",
"Fix64",
"String",
"Character",
"Bool",
"Address",
"Void",
"Optional",
"Reference",
"Array",
"Dictionary",
"Event",
"Resource",
"Struct"
]
},
"subType": {
"description": "Type of the argument",
"maxLength": 38,
"type": "string",
"enum": [
"Identity",
"UInt",
"Int",
"UInt8",
"Int8",
"UInt16",
"Int16",
"UInt32",
"Int32",
"UInt64",
"Int64",
"UInt128",
"Int128",
"UInt256",
"Int256",
"Word8",
"Word16",
"Word32",
"Word64",
"UFix64",
"Fix64",
"String",
"Character",
"Bool",
"Address",
"Void",
"Optional",
"Reference",
"Array",
"Dictionary",
"Event",
"Resource",
"Struct"
]
}
},
"required": ["type", "value"]
}
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "Index to the specific address from mnemonic."
}
},
"required": ["account", "transaction", "args", "mnemonic", "index"]
},
"FlowCreateAddressFromPubKeySecret": {
"type": "object",
"properties": {
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"publicKey": {
"description": "Public key to be used",
"example": "968c3ce11e871cb2b7161b282655ee5fcb051f3c04894705d771bf11c6fbebfc6556ab8a0c04f45ea56281312336d0668529077c9d66891a6cad3db877acbe90",
"maxLength": 128,
"minLength": 128,
"type": "string"
},
"privateKey": {
"maxLength": 64,
"minLength": 64,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "37afa218d41d9cd6a2c6f2b96d9eaa3ad96c598252bc50e4d45d62f9356a51f8",
"type": "string"
}
},
"required": ["account", "privateKey", "publicKey"]
},
"FlowCreateAddressFromPubKeyKMS": {
"type": "object",
"properties": {
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"publicKey": {
"description": "Public key to be used",
"example": "968c3ce11e871cb2b7161b282655ee5fcb051f3c04894705d771bf11c6fbebfc6556ab8a0c04f45ea56281312336d0668529077c9d66891a6cad3db877acbe90",
"maxLength": 128,
"minLength": 128,
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
}
},
"required": ["account", "publicKey", "signatureId"]
},
"FlowCreateAddressFromPubKeyMnemonic": {
"type": "object",
"properties": {
"account": {
"description": "Blockchain account to send from",
"example": "0x955cd3f17b2fd8ad",
"maxLength": 18,
"minLength": 18,
"type": "string"
},
"publicKey": {
"description": "Public key to be used",
"example": "968c3ce11e871cb2b7161b282655ee5fcb051f3c04894705d771bf11c6fbebfc6556ab8a0c04f45ea56281312336d0668529077c9d66891a6cad3db877acbe90",
"maxLength": 128,
"minLength": 128,
"type": "string"
},
"weight": {
"description": "Weight of the key. If not set, default 1000 will be used.",
"example": 1000,
"minimum": 0,
"maximum": 1000,
"type": "number"
},
"mnemonic": {
"maxLength": 500,
"minLength": 1,
"description": "Mnemonic to generate private key.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "Index to the specific address from mnemonic."
}
},
"required": ["account", "publicKey", "mnemonic", "index"]
},
"TransferXrpBlockchain": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 34,
"minLength": 33,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"to": {
"description": "Blockchain address to send assets",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"maxLength": 34,
"minLength": 33,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XRP.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromSecret": {
"maxLength": 29,
"minLength": 29,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "snSFTHdvSYQKKkYntvEt8cnmZuPJB",
"type": "string"
},
"fee": {
"description": "Fee to be paid, in XRP. If omitted, current fee will be calculated.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"sourceTag": {
"description": "Source tag of sender account, if any.",
"example": 12355,
"type": "integer"
},
"destinationTag": {
"description": "Destination tag of recipient account, if any.",
"example": 12355,
"type": "integer"
}
},
"required": ["fromAccount", "to", "amount", "fromSecret"]
},
"TransferXrpBlockchainAsset": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 34,
"minLength": 33,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"to": {
"description": "Blockchain address to send assets",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"maxLength": 34,
"minLength": 33,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XRP.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromSecret": {
"maxLength": 29,
"minLength": 29,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "snSFTHdvSYQKKkYntvEt8cnmZuPJB",
"type": "string"
},
"fee": {
"description": "Fee to be paid, in XRP. If omitted, current fee will be calculated.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"sourceTag": {
"description": "Source tag of sender account, if any.",
"example": 12355,
"type": "integer"
},
"destinationTag": {
"description": "Destination tag of recipient account, if any.",
"example": 12355,
"type": "integer"
},
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets to create trust line for.",
"example": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc",
"maxLength": 34,
"minLength": 33,
"type": "string"
},
"token": {
"description": "Asset name. Must be 160bit HEX string, e.g. SHA1.",
"example": "DA39A3EE5E6B4B0D3255BFEF95601890AFD80709",
"type": "string",
"pattern": "^[A-F0-9]{40}$",
"maxLength": 40,
"minLength": 40
}
},
"required": ["fromAccount", "to", "amount", "fromSecret", "issuerAccount", "token"]
},
"TransferXrpBlockchainKMS": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 34,
"minLength": 33,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"to": {
"description": "Blockchain address to send assets",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"maxLength": 34,
"minLength": 33,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XRP.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"fee": {
"description": "Fee to be paid, in XRP. If omitted, current fee will be calculated.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"sourceTag": {
"description": "Source tag of sender account, if any.",
"example": 12355,
"type": "integer"
},
"destinationTag": {
"description": "Destination tag of recipient account, if any.",
"example": 12355,
"type": "integer"
}
},
"required": ["fromAccount", "to", "amount", "signatureId"]
},
"TransferXrpBlockchainAssetKMS": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 34,
"minLength": 33,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"to": {
"description": "Blockchain address to send assets",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"maxLength": 34,
"minLength": 33,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XRP.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"fee": {
"description": "Fee to be paid, in XRP. If omitted, current fee will be calculated.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"sourceTag": {
"description": "Source tag of sender account, if any.",
"example": 12355,
"type": "integer"
},
"destinationTag": {
"description": "Destination tag of recipient account, if any.",
"example": 12355,
"type": "integer"
},
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets to create trust line for.",
"example": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc",
"maxLength": 34,
"minLength": 33,
"type": "string"
},
"token": {
"description": "Asset name. Must be 160bit HEX string, e.g. SHA1.",
"example": "DA39A3EE5E6B4B0D3255BFEF95601890AFD80709",
"type": "string",
"pattern": "^[A-F0-9]{40}$",
"maxLength": 40,
"minLength": 40
}
},
"required": ["fromAccount", "to", "amount", "signatureId", "issuerAccount", "token"]
},
"TransferXlmBlockchain": {
"type": "object",
"properties": {
"fromAccount": {
"description": "Blockchain account to send assets from",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"to": {
"description": "Blockchain address to send assets",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XLM.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromSecret": {
"maxLength": 56,
"minLength": 56,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED",
"type": "string"
},
"initialize": {
"type": "boolean",
"default": false,
"example": false,
"description": "Set to true, if the destination address is not yet initialized and should be funded for the first time."
},
"message": {
"description": "Short message to recipient. It can be either 28 characters long ASCII text, 64 characters long HEX string or uint64 number.",
"example": "12355",
"pattern": "^[ -~]{0,64}$",
"type": "string",
"maxLength": 64
}
},
"required": ["fromAccount", "fromSecret", "to", "amount"]
},
"TransferXlmBlockchainAsset": {
"type": "object",
"properties": {
"fromAccount": {
"description": "Blockchain account to send assets from",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"to": {
"description": "Blockchain address to send assets",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XLM.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromSecret": {
"maxLength": 56,
"minLength": 56,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED",
"type": "string"
},
"initialize": {
"type": "boolean",
"default": false,
"example": false,
"description": "Set to true, if the destination address is not yet initialized and should be funded for the first time."
},
"token": {
"description": "Asset name. If not defined, transaction is being sent in native XLM asset.",
"example": "TOKEN123",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,12}$",
"maxLength": 12,
"minLength": 1
},
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets to send, if not native XLM asset.",
"example": "GC5LAVZ5UPLIFDH6SI33PNVL5TKWA4ODXTI3WEF5JM6LRM5MNGVJ56TT",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"message": {
"description": "Short message to recipient. It can be either 28 characters long ASCII text, 64 characters long HEX string or uint64 number.",
"example": "12355",
"pattern": "^[ -~]{0,64}$",
"type": "string",
"maxLength": 64
}
},
"required": ["fromAccount", "fromSecret", "token", "issuerAccount", "to", "amount"]
},
"TransferXlmBlockchainKMS": {
"type": "object",
"properties": {
"fromAccount": {
"description": "Blockchain account to send assets from",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"to": {
"description": "Blockchain address to send assets",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XLM.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"initialize": {
"type": "boolean",
"default": false,
"example": false,
"description": "Set to true, if the destination address is not yet initialized and should be funded for the first time."
},
"message": {
"description": "Short message to recipient. It can be either 28 characters long ASCII text, 64 characters long HEX string or uint64 number.",
"example": "12355",
"pattern": "^[ -~]{0,64}$",
"type": "string",
"maxLength": 64
}
},
"required": ["fromAccount", "signatureId", "to", "amount"]
},
"TransferXlmBlockchainKMSAsset": {
"type": "object",
"properties": {
"fromAccount": {
"description": "Blockchain account to send assets from",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"to": {
"description": "Blockchain address to send assets",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"amount": {
"description": "Amount to be sent, in XLM.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"initialize": {
"type": "boolean",
"default": false,
"example": false,
"description": "Set to true, if the destination address is not yet initialized and should be funded for the first time."
},
"token": {
"description": "Asset name. If not defined, transaction is being sent in native XLM asset.",
"example": "TOKEN123",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,12}$",
"maxLength": 12,
"minLength": 1
},
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets to send, if not native XLM asset.",
"example": "GC5LAVZ5UPLIFDH6SI33PNVL5TKWA4ODXTI3WEF5JM6LRM5MNGVJ56TT",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"message": {
"description": "Short message to recipient. It can be either 28 characters long ASCII text, 64 characters long HEX string or uint64 number.",
"example": "12355",
"pattern": "^[ -~]{0,64}$",
"type": "string",
"maxLength": 64
}
},
"required": ["fromAccount", "signatureId", "token", "issuerAccount", "to", "amount"]
},
"TrustLineXlmBlockchain": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 56,
"minLength": 56,
"description": "XLM account address. Must be the one used for generating deposit tags.",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"type": "string"
},
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets to create trust line for.",
"example": "GC5LAVZ5UPLIFDH6SI33PNVL5TKWA4ODXTI3WEF5JM6LRM5MNGVJ56TT",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"token": {
"description": "Asset name.",
"example": "TOKEN123",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,12}$",
"maxLength": 12,
"minLength": 1
},
"fromSecret": {
"maxLength": 56,
"minLength": 56,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED",
"type": "string"
},
"limit": {
"description": "Amount of the assets to be permitted to send over this trust line. 0 means deletion of the trust line. When no limit is specified, maximum amount available is permitted.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["fromAccount", "issuerAccount", "fromSecret", "token"]
},
"TrustLineXlmBlockchainKMS": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 56,
"minLength": 56,
"description": "XLM account address. Must be the one used for generating deposit tags.",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H",
"type": "string"
},
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets to create trust line for.",
"example": "GC5LAVZ5UPLIFDH6SI33PNVL5TKWA4ODXTI3WEF5JM6LRM5MNGVJ56TT",
"maxLength": 56,
"minLength": 56,
"type": "string"
},
"token": {
"description": "Asset name.",
"example": "TOKEN123",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,12}$",
"maxLength": 12,
"minLength": 1
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"limit": {
"description": "Amount of the assets to be permitted to send over this trust line. 0 means deletion of the trust line. When no limit is specified, maximum amount available is permitted.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["fromAccount", "issuerAccount", "signatureId", "token"]
},
"TrustLineXrpBlockchain": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 34,
"minLength": 33,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets to create trust line for.",
"example": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc",
"maxLength": 34,
"minLength": 33,
"type": "string"
},
"limit": {
"description": "Amount of the assets to be permitted to send over this trust line. 0 means deletion of the trust line.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"token": {
"description": "Asset name. Must be 160bit HEX string, e.g. SHA1.",
"example": "DA39A3EE5E6B4B0D3255BFEF95601890AFD80709",
"type": "string",
"pattern": "^[A-F0-9]{40}$",
"maxLength": 40,
"minLength": 40
},
"fromSecret": {
"maxLength": 29,
"minLength": 29,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "snSFTHdvSYQKKkYntvEt8cnmZuPJB",
"type": "string"
},
"fee": {
"description": "Fee to be paid, in XRP. If omitted, current fee will be calculated.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["fromAccount", "issuerAccount", "limit", "token", "fromSecret"]
},
"TrustLineXrpBlockchainKMS": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 34,
"minLength": 33,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"issuerAccount": {
"description": "Blockchain address of the issuer of the assets to create trust line for.",
"example": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc",
"maxLength": 34,
"minLength": 33,
"type": "string"
},
"limit": {
"description": "Amount of the assets to be permitted to send over this trust line. 0 means deletion of the trust line.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"token": {
"description": "Asset name. Must be 160bit HEX string, e.g. SHA1.",
"example": "DA39A3EE5E6B4B0D3255BFEF95601890AFD80709",
"type": "string",
"pattern": "^[A-F0-9]{40}$",
"maxLength": 40,
"minLength": 40
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the secret associated in signing application. Secret, or signature Id must be present."
},
"fee": {
"description": "Fee to be paid, in XRP. If omitted, current fee will be calculated.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["fromAccount", "issuerAccount", "limit", "token", "signatureId"]
},
"AccountSettingsXrpBlockchain": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 34,
"minLength": 33,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"fromSecret": {
"maxLength": 29,
"minLength": 29,
"description": "Secret for account. Secret, or signature Id must be present.",
"example": "snSFTHdvSYQKKkYntvEt8cnmZuPJB",
"type": "string"
},
"fee": {
"description": "Fee to be paid, in XRP. If omitted, current fee will be calculated.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"rippling": {
"description": "Should be true, if an account is the issuer of assets.",
"example": true,
"type": "boolean"
},
"requireDestinationTag": {
"description": "Should be true, if an account should support off-chain processing.",
"example": true,
"type": "boolean"
}
},
"required": ["fromAccount", "fromSecret"]
},
"AccountSettingsXrpBlockchainKMS": {
"type": "object",
"properties": {
"fromAccount": {
"maxLength": 34,
"minLength": 33,
"description": "XRP account address. Must be the one used for generating deposit tags.",
"example": "rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Secret or signature Id must be present."
},
"fee": {
"description": "Fee to be paid, in XRP. If omitted, current fee will be calculated.",
"example": "10000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"rippling": {
"description": "Should be true, if an account is the issuer of assets.",
"example": true,
"type": "boolean"
},
"requireDestinationTag": {
"description": "Should be true, if an account should support off-chain processing.",
"example": true,
"type": "boolean"
}
},
"required": ["fromAccount", "signatureId"]
},
"DeployCeloErc20OffchainMnemXpub": {
"allOf": [
{ "$ref": "#/components/schemas/DeployErc20OffchainMnemXpub" },
{
"type": "object",
"required": ["feeCurrency"],
"properties": {
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
}
}
]
},
"DeployCeloErc20OffchainMnemonicAddress": {
"allOf": [
{ "$ref": "#/components/schemas/DeployErc20OffchainMnemonicAddress" },
{
"type": "object",
"required": ["feeCurrency"],
"properties": {
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
}
}
]
},
"DeployCeloErc20OffchainPKXpub": {
"allOf": [
{ "$ref": "#/components/schemas/DeployErc20OffchainPKXpub" },
{
"type": "object",
"required": ["feeCurrency"],
"properties": {
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
}
}
]
},
"DeployCeloErc20OffchainPKAddress": {
"allOf": [
{ "$ref": "#/components/schemas/DeployErc20OffchainPKAddress" },
{
"type": "object",
"required": ["feeCurrency"],
"properties": {
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
}
}
]
},
"DeployCeloErc20OffchainKMSAddress": {
"allOf": [
{ "$ref": "#/components/schemas/DeployErc20OffchainKMSAddress" },
{
"type": "object",
"required": ["feeCurrency"],
"properties": {
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
}
}
]
},
"DeployCeloErc20OffchainKMSXpub": {
"allOf": [
{ "$ref": "#/components/schemas/DeployErc20OffchainKMSXpub" },
{
"type": "object",
"required": ["feeCurrency"],
"properties": {
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
}
}
]
},
"VetEstimateGas": {
"type": "object",
"required": ["from", "to", "value"],
"properties": {
"from": {
"description": "Sender account address.",
"type": "string",
"maxLength": 50,
"example": "0x5034aa590125b64023a0262112b98d72e3c8e40e"
},
"to": {
"type": "string",
"description": "Recipient account address.",
"maxLength": 50,
"example": "0x5034aa590125b64023a0262112b98d72e3c8e40e"
},
"value": { "type": "string", "description": "Amount to send.", "maxLength": 50, "example": "140" },
"data": { "type": "string", "description": "Data to send to Smart Contract", "maxLength": 10000 },
"nonce": { "type": "number", "description": "Nonce", "example": 12345 }
}
},
"TransferVetBlockchain": {
"type": "object",
"properties": {
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"amount": {
"description": "Amount to be sent in VET",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"minLength": 6,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"data": {
"type": "string",
"maxLength": 10000,
"description": "Additinal data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction.",
"example": "40000",
"pattern": "^[+]?\\d+$"
}
}
}
},
"required": ["to", "amount", "fromPrivateKey"]
},
"TransferVetBlockchainKMS": {
"type": "object",
"properties": {
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"amount": {
"description": "Amount to be sent in VET",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"data": {
"type": "string",
"maxLength": 10000,
"description": "Additinal data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction.",
"example": "40000",
"pattern": "^[+]?\\d+$"
}
}
}
},
"required": ["to", "amount", "signatureId"]
},
"XlmWallet": {
"type": "object",
"required": ["address", "secret"],
"properties": {
"address": {
"description": "Generated account address.",
"example": "GDKYMXOAJ5MK4EVIHHNWRGAAOUZMNZYAETMHFCD6JCVBPZ77TUAZFPKT",
"type": "string"
},
"secret": {
"description": "Generated secret for account.",
"example": "SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED",
"type": "string"
}
}
},
"BnbWallet": {
"type": "object",
"properties": {
"address": {
"description": "Generated account address.",
"example": "tbnb1sfj9981j2eo1ij2e09",
"type": "string"
},
"privateKey": {
"description": "Generated private key for account.",
"example": "cTmS2jBWXgFaXZ2xG9jhn67TiyTshnMp3UedamzEhGm6BZV1vLgQ",
"type": "string"
}
}
},
"XlmTx": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for this transaction.",
"example": "749e4f8933221b9942ef38a02856803f379789ec8d971f1f60535db70135673e"
},
"paging_token": {
"type": "string",
"description": "A cursor value for use in pagination.",
"example": "438086668288"
},
"successful": {
"type": "boolean",
"description": "Indicates if this transaction was successful or not.",
"example": true
},
"hash": {
"type": "string",
"description": "A hex-encoded SHA-256 hash of this transaction’s XDR-encoded form.",
"example": "749e4f8933221b9942ef38a02856803f379789ec8d971f1f60535db70135673e"
},
"ledger": {
"type": "number",
"description": "The sequence number of the ledger that this transaction was included in.",
"example": 102
},
"created_at": {
"type": "string",
"description": "The date this transaction was created.",
"example": "2019-10-30T09:34:07Z"
},
"source_account": {
"type": "string",
"description": "The account that originates the transaction.",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H"
},
"source_account_sequence": {
"type": "string",
"description": "The source account’s sequence number that this transaction consumed.",
"example": "1"
},
"fee_paid": {
"type": "number",
"description": "The fee (in stroops) paid by the source account to apply this transaction to the ledger.",
"example": 1000
},
"fee_charged": { "type": "number", "example": 1000 },
"max_fee": {
"type": "number",
"description": "The maximum fee (in stroops) that the source account was willing to pay.",
"example": 1000
},
"operation_count": {
"type": "number",
"description": "The number of operations contained within this transaction.",
"example": 10
},
"envelope_xdr": {
"type": "string",
"description": "A base64 encoded string of the raw TransactionEnvelope XDR struct for this transaction.",
"example": "AAAAAGL8HQvQkbK2HA3WVjRrKmjX00fG8sLI7m0ERwJW/AX3AAAD6AAAAAAAAAABAAAAAAAAAAAAAAAKAAAAAAAAAAAAAAAAEH3Rayw4M0iCLoEe96rPFNGYim8AVHJU0z4ebYZW4JwBY0V4XYoAAAAAAAAAAAAAAAAAAN2+SherpNcNX0imC680fIBdpQfgBwIuqFOgmlobpwLJAAAAF0h26AAAAAAAAAAAAAAAAAAAlRt2go9sp7E1a5ZWvr7vin4UPrFQThpQax1lOFm33AAAABdIdugAAAAAAAAAAAAAAAAAmv+knlR6JR2VqWeU0k/4FgvZ/tSV5DEY4gu0iOTKgpUAAAAXSHboAAAAAAAAAAAAAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAAF0h26AAAAAABAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAABgAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bf/////////8AAAABAAAAAJr/pJ5UeiUdlalnlNJP+BYL2f7UleQxGOILtIjkyoKVAAAABgAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bf/////////8AAAABAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAAAQAAAAAAlRt2go9sp7E1a5ZWvr7vin4UPrFQThpQax1lOFm33AAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAJGE5yoAAAAAABAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAAAQAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAJGE5yoAAAAAAAAAAAAAAAAABKBB+2UBMP/abwcm/M1TXO+/JQWhPwkalgqizKmXyRIQx9cN3sY5YAAAAAAAAAAARW/AX3AAAAQDX5vrTLWyUxzrvpeEghwlfZYjb8PhnV+vjXAQE+iCNotx2S0qDtnNppNy9p0qlsXtKKyZqn036kHMFGQ7RxBQ3GYc0bAAAAQOquRvJeUiQ8uDcNGUnIxXT0xaHe91JZHCVjPEm6j9Biii954p9o7Muer9B9ipn6O4Y+4oiF9NbUxyeqh1VJnQw4WbfcAAAAQG/GEctb+uefyEvdeP8V61fCvvdGCW7KoH7iLXxtvanGk9CyydtRGEIxu66hPdUKKbXpXPEKWvnAAp5V+XQqjQnkyoKVAAAAQNTyKwB94kyBjjczpFwMFVtbhHtugo+DYeQKN13jQUjWQDSgistLE+TDrxlxW0qiIhl/GkOdVLMtG6YhfZeVOQU="
},
"result_xdr": {
"type": "string",
"description": "A base64 encoded string of the raw TransactionResult XDR struct for this transaction.",
"example": "AAAAAAAAA+gAAAAAAAAACgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAABAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAA="
},
"result_meta_xdr": {
"type": "string",
"description": "A base64 encoded string of the raw TransactionMeta XDR struct for this transaction",
"example": "AAAAAQAAAAAAAAAKAAAAAwAAAAMAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9w3gtrOnY/wYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wx9cTtJ2fwYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABmAAAAAAAAAAAQfdFrLDgzSIIugR73qs8U0ZiKbwBUclTTPh5thlbgnAFjRXhdigAAAAAAZgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMAAAADAAAAZgAAAAAAAAAAYvwdC9CRsrYcDdZWNGsqaNfTR8bywsjubQRHAlb8BfcMfXE7Sdn8GAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAZgAAAAAAAAAAYvwdC9CRsrYcDdZWNGsqaNfTR8bywsjubQRHAlb8BfcMfXEkAWMUGAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZgAAAAAAAAAA3b5KF6uk1w1fSKYLrzR8gF2lB+AHAi6oU6CaWhunAskAAAAXSHboAAAAAGYAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAADAAAAAwAAAGYAAAAAAAAAAGL8HQvQkbK2HA3WVjRrKmjX00fG8sLI7m0ERwJW/AX3DH1xJAFjFBgAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAAGYAAAAAAAAAAGL8HQvQkbK2HA3WVjRrKmjX00fG8sLI7m0ERwJW/AX3DH1xDLjsLBgAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGYAAAAAAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAAF0h26AAAAABmAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAwAAAAMAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wx9cQy47CwYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wx9cPVwdUQYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABmAAAAAAAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAABdIdugAAAAAZgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMAAAADAAAAZgAAAAAAAAAAYvwdC9CRsrYcDdZWNGsqaNfTR8bywsjubQRHAlb8BfcMfXD1cHVEGAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAZgAAAAAAAAAAYvwdC9CRsrYcDdZWNGsqaNfTR8bywsjubQRHAlb8BfcMfXDeJ/5cGAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZgAAAAAAAAAA2lpYuiO4618LRyYyH4O9BN88OuR9eFuVBN0VesZhzRsAAAAXSHboAAAAAGYAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAADAAAAAwAAAGYAAAAAAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAAF0h26AAAAABmAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAAGYAAAAAAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAAF0h26AAAAABmAAAAAAAAAAEAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGYAAAABAAAAAACVG3aCj2ynsTVrlla+vu+KfhQ+sVBOGlBrHWU4WbfcAAAAAVRFU1QAAAAA2lpYuiO4618LRyYyH4O9BN88OuR9eFuVBN0VesZhzRsAAAAAAAAAAH//////////AAAAAQAAAAAAAAAAAAAAAwAAAAMAAABmAAAAAAAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAABdIdugAAAAAZgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAABdIdugAAAAAZgAAAAAAAAABAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABmAAAAAQAAAACa/6SeVHolHZWpZ5TST/gWC9n+1JXkMRjiC7SI5MqClQAAAAFURVNUAAAAANpaWLojuOtfC0cmMh+DvQTfPDrkfXhblQTdFXrGYc0bAAAAAAAAAAB//////////wAAAAEAAAAAAAAAAAAAAAIAAAADAAAAZgAAAAEAAAAAAJUbdoKPbKexNWuWVr6+74p+FD6xUE4aUGsdZThZt9wAAAABVEVTVAAAAADaWli6I7jrXwtHJjIfg70E3zw65H14W5UE3RV6xmHNGwAAAAAAAAAAf/////////8AAAABAAAAAAAAAAAAAAABAAAAZgAAAAEAAAAAAJUbdoKPbKexNWuWVr6+74p+FD6xUE4aUGsdZThZt9wAAAABVEVTVAAAAADaWli6I7jrXwtHJjIfg70E3zw65H14W5UE3RV6xmHNGwAACRhOcqAAf/////////8AAAABAAAAAAAAAAAAAAACAAAAAwAAAGYAAAABAAAAAJr/pJ5UeiUdlalnlNJP+BYL2f7UleQxGOILtIjkyoKVAAAAAVRFU1QAAAAA2lpYuiO4618LRyYyH4O9BN88OuR9eFuVBN0VesZhzRsAAAAAAAAAAH//////////AAAAAQAAAAAAAAAAAAAAAQAAAGYAAAABAAAAAJr/pJ5UeiUdlalnlNJP+BYL2f7UleQxGOILtIjkyoKVAAAAAVRFU1QAAAAA2lpYuiO4618LRyYyH4O9BN88OuR9eFuVBN0VesZhzRsAAAkYTnKgAH//////////AAAAAQAAAAAAAAAAAAAAAwAAAAMAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wx9cN4n/lwYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9wAAAAA7msYYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABmAAAAAAAAAABKBB+2UBMP/abwcm/M1TXO+/JQWhPwkalgqizKmXyRIQx9cN3sY5YAAAAAZgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA=="
},
"fee_meta_xdr": {
"type": "string",
"description": "A base64 encoded string of the raw LedgerEntryChanges XDR struct produced by taking fees for this transaction.",
"example": "AAAAAgAAAAMAAAABAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9w3gtrOnZAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAABmAAAAAAAAAABi/B0L0JGythwN1lY0aypo19NHxvLCyO5tBEcCVvwF9w3gtrOnY/wYAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA=="
},
"memo": {
"type": "string",
"description": "The optional memo attached to a transaction. Usually used as an account distiguisher.",
"example": "12345"
},
"memo_type": {
"type": "string",
"description": "The type of memo.",
"example": "MEMO_TEXT",
"enum": ["MEMO_TEXT", "MEMO_ID", "MEMO_HASH", "MEMO_RETURN"]
},
"signatures": {
"type": "array",
"description": "An array of signatures used to sign this transaction.",
"items": { "type": "string" },
"example": [
"Nfm+tMtbJTHOu+l4SCHCV9liNvw+GdX6+NcBAT6II2i3HZLSoO2c2mk3L2nSqWxe0orJmqfTfqQcwUZDtHEFDQ==",
"6q5G8l5SJDy4Nw0ZScjFdPTFod73UlkcJWM8SbqP0GKKL3nin2jsy56v0H2Kmfo7hj7iiIX01tTHJ6qHVUmdDA==",
"b8YRy1v655/IS914/xXrV8K+90YJbsqgfuItfG29qcaT0LLJ21EYQjG7rqE91Qoptelc8Qpa+cACnlX5dCqNCQ==",
"1PIrAH3iTIGONzOkXAwVW1uEe26Cj4Nh5Ao3XeNBSNZANKCKy0sT5MOvGXFbSqIiGX8aQ51Usy0bpiF9l5U5BQ=="
]
}
}
},
"XlmAccount": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for this account.",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H"
},
"account_id": {
"type": "string",
"description": "This account’s public key encoded in a base32 string representation.",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H"
},
"sequence": {
"type": "string",
"description": "This account’s current sequence number. For use when submitting this account’s next transaction.",
"example": "1"
},
"subentry_count": {
"type": "number",
"description": "The number of subentries on this account.",
"example": 0
},
"last_modified_ledger": {
"type": "number",
"description": "The ID of the last ledger that included changes to this account.",
"example": 102
},
"thresholds": {
"properties": {
"low_threshold": {
"type": "number",
"description": "The weight required for a valid transaction including the Allow Trust and Bump Sequence operations.",
"example": 0
},
"med_threshold": {
"type": "number",
"description": "The weight required for a valid transaction including the Create Account, Payment, Path Payment, Manage Buy Offer, Manage Sell Offer, Create Passive Sell Offer, Change Trust, Inflation, and Manage Data operations.",
"example": 0
},
"high_threshold": {
"type": "number",
"description": "The weight required for a valid transaction including the Account Merge and Set Options operations.",
"example": 0
}
},
"type": "object",
"description": "Operations have varying levels of access. This field specifies thresholds for different access levels, as well as the weight of the master key."
},
"flags": {
"properties": {
"auth_required": {
"type": "boolean",
"description": "If set to true, anyone who wants to hold an asset issued by this account must first be approved by this account.",
"example": false
},
"auth_revocable": {
"type": "boolean",
"description": "If set to true, this account can freeze the balance of a holder of an asset issued by this account.",
"example": false
},
"auth_immutable": {
"type": "boolean",
"description": "If set to true, none of the following flags can be changed.",
"example": false
}
},
"type": "object",
"description": "Flags denote the enabling/disabling of certain asset issuer privileges."
},
"balances": {
"type": "array",
"description": "The assets this account holds.",
"items": {
"type": "object",
"properties": {
"balance": {
"type": "string",
"description": "The number of units of an asset held by this account.",
"example": "99.9999000"
},
"limit": {
"type": "string",
"description": "The maximum amount of this asset that this account is willing to accept. Specified when opening a trustline.",
"example": "99.9999000"
},
"buying_liabilities": {
"type": "string",
"description": "The sum of all buy offers owned by this account for this asset.",
"example": "0.0000000"
},
"selling_liabilities": {
"type": "string",
"description": "The sum of all sell offers owned by this account for this asset.",
"example": "0.0000000"
},
"asset_type": {
"type": "string",
"description": "Either native, credit_alphanum4, or credit_alphanum12.",
"example": "native"
},
"asset_code": {
"type": "string",
"description": "The code for this asset.",
"example": "EURT"
},
"asset_issuer": {
"type": "string",
"description": "The Stellar address of this asset’s issuer.",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H"
}
}
}
},
"signers": {
"type": "array",
"description": "The public keys and associated weights that can be used to authorize transactions for this account. Used for multi-sig.",
"items": {
"type": "object",
"properties": {
"weight": {
"type": "number",
"description": "The numerical weight of a signer. Used to determine if a transaction meets the threshold requirements.",
"example": 1
},
"key": {
"type": "string",
"description": "A hash of characters dependent on the signer type.",
"example": "GBRPYHIL2CI3FNQ4BXLFMNDLFJUNPU2HY3ZMFSHONUCEOASW7QC7OX2H"
},
"type": {
"type": "string",
"description": "The type of hash for this signer.",
"example": "ed25519_public_key",
"enum": ["sha256_hash", "ed25519_public_key", "preauth_tx"]
}
}
}
},
"data": { "properties": {}, "type": "object", "description": "An array of account data fields." }
}
},
"XlmLedger": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for this ledger.",
"example": "63d98f536ee68d1b27b5b89f23af5311b7569a24faf1403ad0b52b633b07be99"
},
"paging_token": {
"type": "string",
"description": "A cursor value for use in pagination.",
"example": "4294967296"
},
"hash": {
"type": "string",
"description": "A hex-encoded SHA-256 hash of this ledger’s XDR-encoded form.",
"example": "63d98f536ee68d1b27b5b89f23af5311b7569a24faf1403ad0b52b633b07be99"
},
"sequence": {
"type": "number",
"description": "The sequence number of this ledger, and the parameter used in Horizon calls that require a ledger number.",
"example": 1
},
"successful_transaction_count": {
"type": "number",
"description": "The number of successful transactions in this ledger.",
"example": 0
},
"failed_transaction_count": {
"type": "number",
"description": "The number of failed transactions in this ledger.",
"example": 0
},
"operation_count": {
"type": "number",
"description": "The number of operations applied in this ledger.",
"example": 0
},
"closed_at": {
"type": "string",
"description": "An ISO 8601 formatted string of when this ledger was closed.",
"example": "1970-01-01T00:00:00Z"
},
"total_coins": {
"type": "string",
"description": "The total number of lumens in circulation.",
"example": "100000000000.0000000"
},
"fee_pool": {
"type": "string",
"description": "The sum of all transaction fees.",
"example": "0.0000000"
},
"base_fee_in_stroops": {
"type": "number",
"description": "The fee the network charges per operation in a transaction.",
"example": 100
},
"base_reserve_in_stroops": {
"type": "number",
"description": "The reserve the network uses when calculating an account’s minimum balance.",
"example": 100000000
},
"max_tx_set_size": {
"type": "number",
"description": "The maximum number of transactions validators have agreed to process in a given ledger.",
"example": 100
},
"protocol_version": {
"type": "number",
"description": "The protocol version that the Stellar network was running when this ledger was committed.",
"example": 0
},
"header_xdr": {
"type": "string",
"description": "A base64 encoded string of the raw LedgerHeader xdr struct for this ledger.",
"example": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABXKi4y/ySKB7DnD9H20xjB+s0gtswIwz1XdSWYaBJaFgAAAAEN4Lazp2QAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZAX14QAAAABkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
}
},
"VetBlock": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"format": "uint32",
"description": "block number (height)",
"example": 325324
},
"id": {
"type": "string",
"format": "bytes32",
"description": "block identifier",
"example": "0x0004f6cc88bb4626a92907718e82f255b8fa511453a78e8797eb8cea3393b215"
},
"size": {
"type": "integer",
"format": "uint32",
"description": "RLP encoded block size in bytes",
"example": 373
},
"parentID": {
"type": "string",
"format": "bytes32",
"description": "parent block ID",
"example": "0x0004f6cb730dbd90fed09d165bfdf33cc0eed47ec068938f6ee7b7c12a4ea98d"
},
"timestamp": {
"type": "integer",
"format": "uint64",
"description": "block unix timestamp",
"example": 1533267900
},
"gasLimit": {
"type": "integer",
"format": "uint64",
"description": "block gas limit (max allowed accumulative gas usage of transactions)",
"example": 11253579
},
"beneficiary": {
"type": "string",
"format": "bytes32",
"description": "Address of account to receive block reward",
"example": "0xb4094c25f86d628fdd571afc4077f0d0196afb48"
},
"gasUsed": {
"type": "integer",
"format": "uint64",
"description": "accumulative gas usage of transactions",
"example": 21000
},
"totalScore": {
"type": "integer",
"format": "uint64",
"description": "sum of all ancestral blocks' score",
"example": 1029988
},
"txsRoot": {
"type": "string",
"format": "bytes32",
"description": "root hash of transactions in the block",
"example": "0x89dfd9fcd10c9e53d68592cf8b540b280b72d381b868523223992f3e09a806bb"
},
"txsFeatures": {
"type": "integer",
"format": "uint32",
"description": "supported txs features bitset",
"example": 0
},
"stateRoot": {
"type": "string",
"format": "bytes32",
"description": "root hash of accounts state",
"example": "0x86bcc6d214bc9d8d0dedba1012a63c8317d19ce97f60c8a2ef5c59bbd40d4261"
},
"receiptsRoot": {
"type": "string",
"format": "bytes32",
"description": "root hash of transaction receipts",
"example": "0x15787e2533c470e8a688e6cd17a1ee12d8457778d5f82d2c109e2d6226d8e54e"
},
"signer": {
"type": "string",
"format": "bytes20",
"description": "the one who signed this block",
"example": "0xab7b27fc9e7d29f9f2e5bd361747a5515d0cc2d1"
},
"transactions": {
"type": "array",
"description": "transactions IDs",
"items": {
"type": "string",
"format": "bytes32",
"description": "transaction ID",
"example": "0x284bba50ef777889ff1a367ed0b38d5e5626714477c40de38d71cedd6f9fa477"
}
}
}
},
"VetTx": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "0x24f691abab680972437028af22bc7a43c3fbe8d6d7eefc420dea2daf554758a7"
},
"chainTag": { "type": "string", "example": "0x27" },
"blockRef": { "type": "string", "example": "0x0011bbb748852599" },
"expiration": { "type": "number", "example": 720 },
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"to": { "type": "string", "example": "0xc6a3007e8e0d959ada56eaa003ebd1d61364cb4f" },
"value": { "type": "string", "example": "115070300000000000000000000" },
"data": { "type": "string", "example": "0x" }
}
}
},
"gasPriceCoef": { "type": "number", "example": 120 },
"gas": { "type": "number", "example": 21000 },
"origin": { "type": "string", "example": "0x5034aa590125b64023a0262112b98d72e3c8e40e" },
"nonce": { "type": "string", "example": "0x48ca1882cf3726ee" },
"size": { "type": "number", "example": 132 },
"meta": {
"properties": {
"blockID": {
"type": "string",
"example": "0x0011bbb9925da1b54035e2a870abe336bc79a3b083303646b87a3315c11c963b"
},
"blockNumber": { "type": "number", "example": 1162169 },
"blockTimestamp": { "type": "number", "example": 1541643760 }
},
"type": "object"
},
"blockNumber": { "type": "number" }
}
},
"VetTxReceipt": {
"type": "object",
"properties": {
"gasUsed": { "type": "number", "example": 21000 },
"gasPayer": { "type": "string", "example": "0x5034aa590125b64023a0262112b98d72e3c8e40e" },
"paid": { "type": "string", "example": "0x1ac942860d7100728" },
"reward": { "type": "string", "example": "0x8092d8e9da1e688c" },
"reverted": { "type": "boolean", "example": false },
"meta": {
"properties": {
"blockID": {
"type": "string",
"example": "0x0011bbb9925da1b54035e2a870abe336bc79a3b083303646b87a3315c11c963b"
},
"blockNumber": { "type": "number", "example": 1162169 },
"blockTimestamp": { "type": "number", "example": 1541643760 },
"txID": {
"type": "string",
"example": "0x24f691abab680972437028af22bc7a43c3fbe8d6d7eefc420dea2daf554758a7"
},
"txOrigin": { "type": "string", "example": "0x5034aa590125b64023a0262112b98d72e3c8e40e" }
},
"type": "object"
},
"outputs": {
"description": "List of recipient addresses and amounts to send to each of them.",
"type": "array",
"items": {
"type": "object",
"properties": {
"events": { "type": "array", "items": { "type": "object" }, "example": [] },
"transfers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sender": { "type": "string", "example": "0x5034aa590125b64023a0262112b98d72e3c8e40e" },
"recipient": {
"type": "string",
"example": "0xc6a3007e8e0d959ada56eaa003ebd1d61364cb4f"
},
"amount": { "type": "string", "example": "0x5f2f157661ad625bf00000" }
}
}
}
}
}
},
"blockNumber": { "type": "number", "example": 1162169 },
"blockHash": {
"type": "string",
"example": "0x0011bbb9925da1b54035e2a870abe336bc79a3b083303646b87a3315c11c963b"
},
"transactionHash": {
"type": "string",
"example": "0x24f691abab680972437028af22bc7a43c3fbe8d6d7eefc420dea2daf554758a7"
},
"status": { "type": "string", "example": "0x1" }
}
},
"GenerateCustodialWalletBatch": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["ETH", "MATIC", "BSC", "ONE", "XDC", "KLAY"],
"example": "MATIC",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of account, from which the transaction will be initiated."
},
"batchCount": {
"type": "number",
"maximum": 270,
"minimum": 0,
"description": "Number of addresses to generate."
},
"owner": {
"type": "string",
"minLength": 42,
"maxLength": 43,
"description": "Owner of the addresses.",
"example": "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to the transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "fromPrivateKey", "batchCount", "owner"]
},
"GenerateCustodialWalletBatchPayer": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["ETH", "MATIC", "BSC", "ONE", "CELO"],
"example": "MATIC",
"type": "string"
},
"feesCovered": {
"type": "boolean",
"example": true,
"description": "If set to true, blockchain fees will be covered from credits."
},
"batchCount": {
"type": "number",
"maximum": 270,
"minimum": 0,
"description": "Number of addresses to generate."
},
"owner": {
"type": "string",
"minLength": 42,
"maxLength": 43,
"description": "Owner of the addresses.",
"example": "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea"
}
},
"required": ["chain", "fromPrivateKey", "batchCount", "owner", "feesCovered"]
},
"GenerateCustodialWalletBatchKMS": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["MATIC", "ETH", "ONE", "XDC", "KLAY", "BSC"],
"example": "MATIC",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"batchCount": {
"type": "number",
"maximum": 270,
"minimum": 0,
"description": "Number of addresses to generate."
},
"owner": {
"type": "string",
"minLength": 42,
"maxLength": 43,
"description": "Owner of the addresses.",
"example": "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to the transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "signatureId", "owner", "batchCount"]
},
"GenerateCustodialWalletBatchCelo": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of account, from which the transaction will be initiated."
},
"batchCount": {
"type": "number",
"maximum": 270,
"minimum": 0,
"description": "Number of addresses to generate."
},
"owner": {
"type": "string",
"minLength": 42,
"maxLength": 43,
"description": "Owner of the addresses.",
"example": "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to the transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "feeCurrency", "fromPrivateKey", "batchCount", "owner"]
},
"GenerateCustodialWalletBatchCeloKMS": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"batchCount": {
"type": "number",
"maximum": 270,
"minimum": 0,
"description": "Number of addresses to generate."
},
"owner": {
"type": "string",
"minLength": 42,
"maxLength": 43,
"description": "Owner of the addresses.",
"example": "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to the transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "feeCurrency", "signatureId", "batchCount", "owner"]
},
"GenerateCustodialWalletBatchTron": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["TRON"],
"example": "TRON",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 64,
"description": "Private key of account, from which the transaction will be initiated."
},
"batchCount": {
"type": "number",
"example": 50,
"description": "Number of addresses to generate."
},
"owner": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Owner of the addresses.",
"example": "TGXh2YJhfwchMGKuzfEJ27W1VEJRKnMdy9"
},
"feeLimit": {
"type": "number",
"minimum": 5,
"example": 100,
"description": "Fee limit to be set, in TRX"
}
},
"required": ["chain", "feeLimit", "fromPrivateKey", "batchCount", "owner"]
},
"GenerateCustodialWalletBatchTronKMS": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["TRON"],
"example": "TRON",
"type": "string"
},
"from": {
"type": "string",
"description": "Sender address.",
"example": "TGXh2YJhfwchMGKuzfEJ27W1VEJRKnMdy9"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"batchCount": {
"type": "number",
"example": 50,
"description": "Number of addresses to generate."
},
"owner": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Owner of the addresses.",
"example": "TGXh2YJhfwchMGKuzfEJ27W1VEJRKnMdy9"
},
"feeLimit": {
"type": "number",
"example": 100,
"minimum": 5,
"description": "Fee limit to be set, in TRX"
}
},
"required": ["chain", "signatureId", "batchCount", "from", "feeLimit", "owner"]
},
"GenerateCustodialWalletTronKMS": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["TRON"],
"example": "TRON",
"type": "string"
},
"feeLimit": {
"type": "number",
"minimum": 0,
"description": "Fee in TRX to be paid.",
"example": 0.01
},
"from": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Sender address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"enableFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC20 tokens, it should be marked as true."
},
"enableNonFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC721 tokens, it should be marked as true."
},
"enableSemiFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC1155 tokens, it should be marked as true. Not supported for TRON."
},
"enableBatchTransactions": {
"type": "boolean",
"example": false,
"description": "If address should support batch transfers of the assets, it should be marked as true."
}
},
"required": [
"chain",
"feeLimit",
"signatureId",
"from",
"enableFungibleTokens",
"enableNonFungibleTokens",
"enableSemiFungibleTokens",
"enableBatchTransactions"
]
},
"GenerateCustodialWalletCelo": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of account, from which the transaction will be initiated."
},
"enableFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC20 tokens, it should be marked as true."
},
"enableNonFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC721 tokens, it should be marked as true."
},
"enableSemiFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC1155 tokens, it should be marked as true."
},
"enableBatchTransactions": {
"type": "boolean",
"example": false,
"description": "If address should support batch transfers of the assets, it should be marked as true."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to the transaction. If not present, last known nonce will be used."
}
},
"required": [
"chain",
"feeCurrency",
"fromPrivateKey",
"enableFungibleTokens",
"enableNonFungibleTokens",
"enableSemiFungibleTokens",
"enableBatchTransactions"
]
},
"GenerateCustodialWallet": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["ETH", "ONE", "BSC", "MATIC"],
"example": "ETH",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of account, from which the transaction will be initiated."
},
"enableFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC20 tokens, it should be marked as true."
},
"enableNonFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC721 tokens, it should be marked as true."
},
"enableSemiFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC1155 tokens, it should be marked as true."
},
"enableBatchTransactions": {
"type": "boolean",
"example": false,
"description": "If address should support batch transfers of the assets, it should be marked as true."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to the transaction. If not present, last known nonce will be used."
}
},
"required": [
"chain",
"fromPrivateKey",
"enableFungibleTokens",
"enableNonFungibleTokens",
"enableSemiFungibleTokens",
"enableBatchTransactions"
]
},
"GenerateCustodialWalletKMS": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["ETH", "ONE", "BSC", "MATIC"],
"example": "ETH",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"enableFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC20 tokens, it should be marked as true."
},
"enableNonFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC721 tokens, it should be marked as true."
},
"enableSemiFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC1155 tokens, it should be marked as true."
},
"enableBatchTransactions": {
"type": "boolean",
"example": false,
"description": "If address should support batch transfers of the assets, it should be marked as true."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to the transaction. If not present, last known nonce will be used."
}
},
"required": [
"chain",
"signatureId",
"enableFungibleTokens",
"enableNonFungibleTokens",
"enableSemiFungibleTokens",
"enableBatchTransactions"
]
},
"GenerateCustodialWalletCeloKMS": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["CELO"],
"example": "CELO",
"type": "string"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"enableFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC20 tokens, it should be marked as true."
},
"enableNonFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC721 tokens, it should be marked as true."
},
"enableSemiFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC1155 tokens, it should be marked as true."
},
"enableBatchTransactions": {
"type": "boolean",
"example": false,
"description": "If address should support batch transfers of the assets, it should be marked as true."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to the transaction. If not present, last known nonce will be used."
}
},
"required": [
"chain",
"feeCurrency",
"signatureId",
"enableFungibleTokens",
"enableNonFungibleTokens",
"enableSemiFungibleTokens",
"enableBatchTransactions"
]
},
"GenerateCustodialWalletTron": {
"type": "object",
"properties": {
"chain": {
"description": "Blockchain to work with.",
"enum": ["TRON"],
"example": "TRON",
"type": "string"
},
"feeLimit": {
"type": "number",
"minimum": 0,
"description": "Fee in TRX to be paid.",
"example": 0.01
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701",
"minLength": 64,
"description": "Private key of account, from which the transaction will be initiated."
},
"enableFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC20 tokens, it should be marked as true."
},
"enableNonFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC721 tokens, it should be marked as true."
},
"enableSemiFungibleTokens": {
"type": "boolean",
"example": false,
"description": "If address should support ERC1155 tokens, it should be marked as true. Not supported for TRON."
},
"enableBatchTransactions": {
"type": "boolean",
"example": false,
"description": "If address should support batch transfers of the assets, it should be marked as true."
}
},
"required": [
"chain",
"feeLimit",
"fromPrivateKey",
"enableFungibleTokens",
"enableNonFungibleTokens",
"enableSemiFungibleTokens",
"enableBatchTransactions"
]
},
"TransactionHash": {
"type": "object",
"properties": {
"txId": {
"description": "TX hash of successful transaction.",
"example": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9",
"type": "string"
}
},
"required": ["txId"]
},
"Data": {
"type": "object",
"properties": {
"data": {
"description": "Result of the method, if the method was read only.",
"example": 2,
"oneOf": [
{ "type": "object" },
{ "type": "string" },
{ "type": "number" },
{ "type": "array" },
{ "type": "boolean" }
]
}
},
"required": ["data"]
},
"SignatureId": {
"type": "object",
"properties": {
"signatureId": {
"format": "uuid",
"description": "ID of prepared payment template to sign. This is should be stored on a client side to retrieve ID of the blockchain transaction, when signing application signs the transaction and broadcasts it to the blockchain.",
"example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6",
"type": "string"
}
},
"required": ["signatureId"]
},
"OffchainTransactionResult": {
"type": "object",
"properties": {
"id": {
"description": "ID of withdrawal. If transaction is not valid in blockchain, use this id to cancel withdrawal.",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"txId": {
"description": "TX hash of successful transaction.",
"example": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9",
"type": "string"
},
"completed": {
"description": "If set to \"true\", the withdrawal has been completed in the virtual account; if set to \"false\", the withdrawal has not been completed and you have to complete it manually",
"example": true,
"type": "boolean"
}
},
"required": ["txId", "id", "completed"]
},
"OffchainTransactionSignatureResult": {
"type": "object",
"properties": {
"signatureId": {
"description": "ID of prepared payment template to sign. This is should be stored on a client side to retrieve ID of the blockchain transaction, when signing application signs the transaction and broadcasts it to the blockchain.",
"example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6",
"format": "uuid",
"type": "string"
}
},
"required": ["id", "signatureId"]
},
"Url": {
"properties": { "url": { "description": "QR Code as data URL", "type": "string" } },
"type": "object"
},
"VirtualCurrency": {
"properties": {
"name": {
"description": "Virtual currency name. Must be prefixed with 'VC_'.",
"example": "VC_VIRTUAL",
"maxLength": 30,
"pattern": "^[a-zA-Z0-9_]+$",
"minLength": 1,
"type": "string"
},
"supply": {
"description": "Supply of virtual currency.",
"maxLength": 38,
"minLength": 1,
"example": "1000000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"basePair": {
"description": "Base pair for virtual currency. Transaction value will be calculated according to this base pair. e.g. 1 VC_VIRTUAL is equal to 1 BTC, if basePair is set to BTC.",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BAT",
"BBD",
"BCH",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DOGE",
"DZD",
"EGP",
"ERN",
"ETB",
"ETH",
"EUR",
"FJD",
"FKP",
"FLOW",
"FUSD",
"FREE",
"GMC",
"GMC_BSC",
"RMD",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LEO",
"LINK",
"LKR",
"LRD",
"LSL",
"LTC",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MKR",
"MMK",
"MMY",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PAX",
"PAXG",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TRON",
"TUSD",
"BUSD",
"TWD",
"TZS",
"UAH",
"UGX",
"UNI",
"USD",
"USDC",
"USDT",
"USDT_TRON",
"USDT_MATIC",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WBTC",
"WST",
"XAF",
"XAG",
"XAU",
"XCD",
"XCON",
"XDR",
"XLM",
"XOF",
"XPF",
"XRP",
"YER",
"ZAR",
"ZMK",
"ZMW",
"ZWL"
],
"example": "BTC",
"maxLength": 50,
"minLength": 3,
"type": "string"
},
"baseRate": {
"type": "number",
"example": 1,
"default": 1,
"minimum": 0,
"description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair."
},
"customer": { "$ref": "#/components/schemas/CustomerRegistration" },
"description": {
"description": "Used as a description within Tatum system.",
"example": "My Virtual Token description.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"accountCode": {
"description": "For bookkeeping to distinct account purpose.",
"maxLength": 50,
"example": "AC_1011_B",
"minLength": 1,
"type": "string"
},
"accountNumber": {
"description": "Account number from external system.",
"example": "1234567890",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"accountingCurrency": {
"description": "All transaction will be billed in this currency for created account associated with this currency. If not set, EUR is used. ISO-4217",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DOGE",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"FLOW",
"FUSD",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XCD",
"XDR",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMK",
"ZMW",
"ZWL"
],
"example": "USD",
"maxLength": 3,
"minLength": 3,
"type": "string"
}
},
"required": ["basePair", "name", "supply"],
"type": "object"
},
"VC": {
"properties": {
"name": {
"description": "Virtual currency name. Must be prefixed with 'VC_'.",
"example": "VC_VIRTUAL",
"type": "string"
},
"supply": { "description": "Supply of virtual currency.", "example": "1000000", "type": "string" },
"accountId": {
"description": "Virtual currency account.",
"example": "5e68c66581f2ee32bc354087",
"type": "string"
},
"baseRate": {
"type": "number",
"default": 1,
"description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair."
},
"basePair": {
"description": "Base pair for virtual currency. Transaction value will be calculated according to this base pair. e.g. 1 VC_VIRTUAL is equal to 1 BTC, if basePair is set to BTC.",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BAT",
"BBD",
"BCH",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DOGE",
"DZD",
"EGP",
"ERN",
"ETB",
"ETH",
"EUR",
"FJD",
"FKP",
"FLOW",
"FUSD",
"FREE",
"GMC",
"GMC_BSC",
"RMD",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LEO",
"LINK",
"LKR",
"LRD",
"LSL",
"LTC",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MKR",
"MMK",
"MMY",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PAX",
"PAXG",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TRON",
"TUSD",
"BUSD",
"TWD",
"TZS",
"UAH",
"UGX",
"UNI",
"USD",
"USDC",
"USDT",
"USDT_TRON",
"USDT_MATIC",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"WBTC",
"XCD",
"XCON",
"XDR",
"XLM",
"XOF",
"XPF",
"XRP",
"YER",
"ZAR",
"ZMK",
"ZMW",
"ZWL"
],
"example": "BTC",
"type": "string"
},
"customerId": {
"description": "ID of customer associated with virtual currency.",
"type": "string",
"example": "5e68c66581f2ee32bc354087"
},
"description": {
"description": "Used as a description within Tatum system.",
"example": "My Virtual Token description.",
"type": "string"
},
"erc20Address": {
"description": "Address of ERC20 token, when virtual currency is based on the Ethereum blockchain.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"issuerAccount": {
"description": "Blockchain account for XLM or XRP based virtual currencies, which is marked as the issuer of the custom blockchain asset.",
"example": "GDKYMXOAJ5MK4EVIHHNWRGAAOUZMNZYAETMHFCD6JCVBPZ77TUAZFPKT",
"type": "string"
},
"chain": {
"description": "Blockchain, on which this virtual currency is paired on. Not present, when Tatum's private ledger is used as a base ledger.",
"example": "ETH",
"type": "string",
"enum": ["ETH", "XRP", "XLM"]
},
"initialAddress": {
"description": "Ethereum address, where initial supply was minted, when virtual currency is based on the Ethereum blockchain.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
}
},
"required": ["basePair", "baseRate", "name", "accountId", "supply"],
"type": "object"
},
"VirtualCurrencyUpdate": {
"properties": {
"name": {
"description": "Virtual currency name, which will be updated. It is not possible to update the name of the virtual currency.",
"example": "VC_VIRTUAL",
"maxLength": 30,
"pattern": "^[a-zA-Z0-9_]+$",
"minLength": 1,
"type": "string"
},
"baseRate": {
"type": "number",
"example": 1,
"default": 1,
"minimum": 0,
"description": "Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair."
},
"basePair": {
"description": "Base pair for virtual currency. Transaction value will be calculated according to this base pair. e.g. 1 VC_VIRTUAL is equal to 1 BTC, if basePair is set to BTC.",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BAT",
"BBD",
"BCH",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DOGE",
"DZD",
"EGP",
"ERN",
"ETB",
"ETH",
"EUR",
"FJD",
"FKP",
"FLOW",
"FUSD",
"FREE",
"GMC",
"GMC_BSC",
"RMD",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LEO",
"LINK",
"LKR",
"LRD",
"LSL",
"LTC",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MKR",
"MMK",
"MMY",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PAX",
"PAXG",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TRON",
"TUSD",
"BUSD",
"TWD",
"TZS",
"UAH",
"UGX",
"UNI",
"USD",
"USDC",
"USDT",
"USDT_TRON",
"USDT_MATIC",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"WBTC",
"XCD",
"XCON",
"XDR",
"XLM",
"XOF",
"XPF",
"XRP",
"YER",
"ZAR",
"ZMK",
"ZMW",
"ZWL"
],
"example": "EUR",
"maxLength": 50,
"minLength": 3,
"type": "string"
}
},
"required": ["name"],
"type": "object"
},
"VirtualCurrencyOperation": {
"properties": {
"accountId": {
"description": "Ledger account with currency of the virtual currency, on which the operation will be performed.",
"example": "5e68c66581f2ee32bc354087",
"maxLength": 24,
"minLength": 24,
"type": "string"
},
"amount": {
"description": "Amount of virtual currency to operate within this operation.",
"maxLength": 38,
"example": "1.5",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"paymentId": {
"description": "Identifier of the payment, shown for created Transaction within Tatum sender account.",
"example": "My Payment",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"reference": {
"description": "Reference of the payment.",
"example": "akjsndakjsdn-asd-kjasnd-asdkn-asdjnasjkdn",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"transactionCode": {
"description": "For bookkeeping to distinct transaction purpose.",
"example": "1_01_EXTERNAL_CODE",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"recipientNote": {
"description": "Note visible to both, sender and recipient. Available for both Mint and Revoke operations",
"example": "Private note",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"counterAccount": {
"description": "External account identifier. By default, there is no counterAccount present in the transaction.",
"example": "5e6645712b55823de7ea82f1",
"maxLength": 24,
"minLength": 24,
"type": "string"
},
"senderNote": {
"description": "Note visible to sender. Available in Revoke operation.",
"example": "Sender note",
"maxLength": 500,
"minLength": 1,
"type": "string"
}
},
"required": ["accountId", "amount"],
"type": "object"
},
"Wallet": {
"type": "object",
"properties": {
"mnemonic": {
"description": "Generated mnemonic for wallet.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"xpub": {
"description": "Generated Extended public key for wallet with derivation path according to BIP44. This key can be used to generate addresses.",
"example": "xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid",
"type": "string"
}
}
},
"GeneratedAddress": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Ethereum address",
"example": "0xa7673161CbfE0116A4De9E341f8465940c2211d4"
}
}
},
"Withdrawal": {
"properties": {
"senderAccountId": {
"description": "Sender account ID",
"example": "5e68c66581f2ee32bc354087",
"maxLength": 24,
"minLength": 24,
"type": "string"
},
"address": {
"description": "Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.",
"example": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7",
"maxLength": 10000,
"minLength": 1,
"type": "string"
},
"amount": {
"description": "Amount to be withdrawn to blockchain.",
"maxLength": 38,
"example": "0.001",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"attr": {
"description": "Used to parametrize withdrawal. Used for XRP withdrawal to define destination tag of recipient, or XLM memo of the recipient, if needed.
\nFor Bitcoin, Litecoin, Bitcoin Cash, used as a change address for left coins from transaction.
Used to parametrize withdrawal. Used for XRP withdrawal to define destination tag of recipient, or XLM memo of the recipient, if needed.
\nFor Bitcoin, Litecoin, Bitcoin Cash, used as a change address for left coins from transaction.
from parameter",
"minimum": 0,
"example": 200
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address that will pay the gas fee for the activation transaction"
}
},
"required": ["chain", "owner", "from", "to", "fromPrivateKey"]
},
"ActivateGasPumpTatum": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "The blockchain to work with",
"enum": ["BSC", "CELO", "ETH", "MATIC", "KLAY", "ONE", "TRON"]
},
"owner": {
"type": "string",
"description": "The blockchain address that owns the precalculated gas pump addresses and is used to pay gas fees for operations made on the gas pump addresses; can be referred to as \"master address\"",
"example": "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
},
"from": {
"type": "integer",
"description": "The start index of the range of gas pump addresses to activate",
"minimum": 0,
"example": 0
},
"to": {
"type": "integer",
"description": "The end index of the range of gas pump addresses to activate; must be greater than or equal to the value in the from parameter",
"minimum": 0,
"example": 200
}
},
"required": ["chain", "owner", "from", "to"]
},
"ActivateGasPumpKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "The blockchain to work with",
"enum": ["BSC", "ETH", "KLAY", "MATIC"]
},
"owner": {
"type": "string",
"description": "The blockchain address that owns the precalculated gas pump addresses and is used to pay gas fees for operations made on the gas pump addresses; can be referred to as \"master address\"",
"example": "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
},
"from": {
"type": "integer",
"description": "The start index of the range of gas pump addresses to activate",
"minimum": 0,
"example": 0
},
"to": {
"type": "integer",
"description": "The end index of the range of gas pump addresses to activate; must be greater than or equal to the value in the from parameter",
"minimum": 0,
"example": 200
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that will pay the gas fee for the activation transaction"
}
},
"required": ["chain", "owner", "from", "to", "signatureId"]
},
"ActivateGasPumpCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "The blockchain to work with",
"enum": ["CELO"]
},
"owner": {
"type": "string",
"description": "The blockchain address that owns the precalculated gas pump addresses and is used to pay gas fees for operations made on the gas pump addresses; can be referred to as \"master address\"",
"example": "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
},
"from": {
"type": "integer",
"description": "The start index of the range of gas pump addresses to activate",
"minimum": 0,
"example": 0
},
"to": {
"type": "integer",
"description": "The end index of the range of gas pump addresses to activate; must be greater than or equal to the value in the from parameter",
"minimum": 0,
"example": 200
},
"feeCurrency": {
"type": "string",
"description": "The currency to pay for the gas fee",
"enum": ["CELO", "CUSD", "CEUR"]
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address that will pay the gas fee for the activation transaction"
}
},
"required": ["chain", "owner", "from", "to", "feeCurrency", "fromPrivateKey"]
},
"ActivateGasPumpCeloKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "The blockchain to work with",
"enum": ["CELO"]
},
"owner": {
"type": "string",
"description": "The blockchain address that owns the precalculated gas pump addresses and is used to pay gas fees for operations made on the gas pump addresses; can be referred to as \"master address\"",
"example": "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
},
"from": {
"type": "integer",
"description": "The start index of the range of gas pump addresses to activate",
"minimum": 0,
"example": 0
},
"to": {
"type": "integer",
"description": "The end index of the range of gas pump addresses to activate; must be greater than or equal to the value in the from parameter",
"minimum": 0,
"example": 200
},
"feeCurrency": {
"type": "string",
"description": "The currency to pay for the gas fee",
"enum": ["CELO", "CUSD", "CEUR"]
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that will pay the gas fee for the activation transaction"
}
},
"required": ["chain", "owner", "from", "to", "feeCurrency", "signatureId"]
},
"ActivateGasPumpTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "The blockchain to work with",
"enum": ["TRON"]
},
"owner": {
"type": "string",
"description": "The blockchain address that owns the precalculated gas pump addresses and is used to pay gas fees for operations made on the gas pump addresses; can be referred to as \"master address\"",
"example": "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
},
"from": {
"type": "integer",
"description": "The start index of the range of gas pump addresses to activate",
"minimum": 0,
"example": 0
},
"to": {
"type": "integer",
"description": "The end index of the range of gas pump addresses to activate; must be greater than or equal to the value in the from parameter",
"minimum": 0,
"example": 200
},
"feeLimit": {
"type": "number",
"description": "The maximum amount to be paid as the gas fee (in TRX)",
"example": 600
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "e26c1595086cd52f2bc61774c7228b841db66b4b9b0ed36dc29dbc90595dd5b6",
"minLength": 64,
"description": "The private key of the blockchain address that will pay the gas fee for the activation transaction"
}
},
"required": ["chain", "owner", "from", "to", "feeLimit", "fromPrivateKey"]
},
"ActivateGasPumpTronKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "The blockchain to work with",
"enum": ["TRON"]
},
"owner": {
"type": "string",
"description": "The blockchain address that owns the precalculated gas pump addresses and is used to pay gas fees for operations made on the gas pump addresses; can be referred to as \"master address\"",
"example": "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
},
"from": {
"type": "integer",
"description": "The start index of the range of gas pump addresses to activate",
"minimum": 0,
"example": 0
},
"to": {
"type": "integer",
"description": "The end index of the range of gas pump addresses to activate; must be greater than or equal to the value in the from parameter",
"minimum": 0,
"example": 200
},
"feeLimit": {
"type": "number",
"description": "The maximum amount to be paid as the gas fee (in TRX)",
"example": 600
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address that will pay the gas fee for the activation transaction"
}
},
"required": ["chain", "owner", "from", "to", "feeLimit", "signatureId"]
},
"CreateGasPump": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "The blockchain to work with",
"enum": ["BSC", "ETH", "MATIC", "KLAY", "TRON"]
},
"owner": {
"type": "string",
"description": "The blockchain address that will own the precalculated gas pump addresses and will be used to pay gas fees for operations made on the gas pump addresses; can be referred to as \"master address\"",
"example": "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
},
"from": {
"type": "integer",
"description": "The start index of the range of gas pump addresses to precalculate",
"minimum": 0,
"example": 0
},
"to": {
"type": "integer",
"description": "The end index of the range of gas pump addresses to precalculate; must be greater than or equal to the value in the from parameter",
"minimum": 0,
"example": 1000
}
},
"required": ["chain", "owner", "from", "to"]
},
"GasPumpTrxOut": {
"type": "object",
"properties": {
"valid": {
"type": "array",
"description": "Activated gas pump addresses",
"example": "0x602c79718b16e442de58778e148d0b1084e3b2df",
"items": { "$ref": "#/components/schemas/GasPumpAddress" }
},
"invalid": {
"type": "array",
"description": "Not activated gas pump addresses",
"items": { "$ref": "#/components/schemas/InvalidGasPumpAddress" }
}
}
},
"InvalidGasPumpAddress": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "A not activated gas pump address",
"example": "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
},
"reason": {
"type": "string",
"description": "The reason why the gas pump address did not get activated",
"example": "Wallet already exists"
}
}
},
"TransferManagedAddress": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"description": "Blockchain to work on",
"example": "SOL",
"enum": ["SOL"]
},
"txData": {
"type": "string",
"minLength": 1,
"maxLength": 500000,
"description": "Hex serialized data representing transaction, which should be signed using one of the managed wallets.",
"example": "020001044a22af97a838a504e6f7c0b18d779afcea612da50794cc1dac641861fc1ab14afa5cacaf91c298694e64bb5496916c3c68a32affb92d4bcd2736fbb00169d57bd840de2a454960308f688cd3ee308c1fa01ecfa0b03770aaaf3b52d71d46c31d000000000000000000000000000000000000000000000000000000000000000060d38e0da20dc5900b7e902c918eae6a95e2d90af154b53a422f4ab26b050f4f01030201020c02000000e803000000000000"
},
"walletIds": {
"type": "array",
"items": {
"type": "object",
"required": ["key", "type"],
"properties": {
"key": {
"type": "string",
"description": "Wallet ID of wallet, which should be used for signing. In case of RAW type of the wallet, this represents the private key which will be used for signatures.",
"example": "0b1eae3d-2520-4903-8bbf-5dec3ad2a5d4"
},
"type": {
"type": "string",
"example": "MANAGED",
"description": "Type of the wallet to be used - RAW represents native private key, MANAGED represents ID of the managed wallet.",
"enum": ["MANAGED", "RAW"]
}
}
}
}
},
"required": ["chain", "txData", "walletIds"]
},
"CustodialManagedAddress": {
"type": "object",
"required": ["address", "walletId", "chain"],
"properties": {
"address": {
"type": "string",
"description": "Blockchain address",
"example": "8oJ8KRL87ja7DjPSsmBG1KtfrpsfLGDMJDGzev68DGqx"
},
"walletId": {
"type": "string",
"format": "uuid",
"example": "52901013-94ab-4124-8645-acba4ee90bb8",
"description": "Unique identifier of the managed address"
},
"chain": {
"type": "string",
"description": "Blockchain of the address",
"example": "SOL",
"enum": ["BSC", "ETH", "KLAY", "ONE", "CELO", "MATIC", "SOL", "LTC", "BTC"]
},
"privateKey": {
"type": "string",
"example": "4jCFiqh3tLxKxt3vYW478qodivkCkSzqtpG4wqEaYkgdVC1o79a1VJTc5UiCmCmZBwoJmjaenfYH1ML7ra8vbNpA",
"description": "Private key of the address. Not present by default."
}
}
},
"TransferNftCelo": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "If token to be transferred is Royalty NFT token, this is a value to be paid as a cashback to the authors of the token.",
"example": "1"
},
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send NFT token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"provenance": {
"description": "True if the contract is provenance type",
"example": true,
"type": "boolean"
},
"provenanceData": {
"description": "data you want to store with transaction, optional and valid only if provenance contract",
"example": "test",
"type": "string"
},
"tokenPrice": {
"description": "current price of the token, valid only for provenance",
"example": "1",
"type": "string",
"maxLength": 256
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "tokenId", "fromPrivateKey"]
},
"TransferNftTron": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "If token to be transferred is Royalty NFT token, this is a value to be paid as a cashback to the authors of the token.",
"example": "1"
},
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"to": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to send NFT token to",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"contractAddress": {
"maxLength": 34,
"minLength": 34,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701",
"minLength": 64,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": ["chain", "to", "contractAddress", "tokenId", "fromPrivateKey", "feeLimit"]
},
"FlowMintedMultipleResult": {
"type": "object",
"properties": {
"txId": {
"type": "string",
"description": "Transaction ID",
"example": "d67787399d205139f4d6f42c2aa4fffdf6f247411fae3706e874fbba0ce04b1b"
},
"tokenId": {
"type": "array",
"items": { "type": "number", "description": "ID of the minted token", "example": 12345 }
}
}
},
"FlowMintedResult": {
"type": "object",
"properties": {
"txId": {
"type": "string",
"description": "Transaction ID",
"example": "d67787399d205139f4d6f42c2aa4fffdf6f247411fae3706e874fbba0ce04b1b"
},
"tokenId": { "type": "number", "description": "ID of the minted token", "example": 12345 }
}
},
"SolanaMintedResult": {
"type": "object",
"properties": {
"txId": {
"type": "string",
"description": "Transaction ID",
"example": "4kiRkAWjjr5t3rBKmYQ5d2e3xjgnRRttB5GtUz2F4sz5wwC7NnV74qCZ1KN1b37qsnjkKknsJPGXdcPhzHpkiMAs"
},
"nftAddress": {
"type": "string",
"description": "Address of the minted NFT contract",
"example": "4afZBmAneN2j6gDHH8zdrNWkCqfMC3XPH2cpFKtYMSVe"
},
"nftAccountAddress": {
"type": "string",
"description": "Address of the account owned by a mint recipient, which holds the minted NFT",
"example": "A8BSHPJcB5ZGCT6yo6pz2RYqnypTSpzTAFSBhtTQmsEE"
}
}
},
"AlgorandMintedResult": {
"type": "object",
"properties": {
"txId": {
"type": "string",
"description": "Transaction ID",
"example": "HQ32RQPJ7EAASLHPG5TTQEGETOEMN7BPND2TQMUMZWLIZBJWJ23A"
},
"assetIndex": {
"type": "number",
"description": "Identifier of the minted NFT",
"example": 88885810
},
"confirmed": {
"type": "boolean",
"description": "True, if transaction was included in the block within 5 rounds, false otherwise. False doesnt mean that transaction was not included, Tatum just doesn't wait for that much time.",
"example": true
}
}
},
"MintMultipleNftCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"type": "array",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"authorAddresses": {
"type": "array",
"description": "List of addresses for every token, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency CELO.",
"items": {
"type": "array",
"items": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"description": "Blockchain address to send royalties to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
}
}
},
"cashbackValues": {
"type": "array",
"description": "List of values for every token, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency.",
"items": {
"type": "array",
"items": {
"type": "string",
"description": "Value of the royalty to be paid.",
"example": "0.5"
}
}
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "url", "fromPrivateKey", "feeCurrency", "tokenId"]
},
"MintMultipleNftTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ"],
"items": { "maxLength": 34, "minLength": 34, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"type": "array",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 34,
"minLength": 34,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701",
"minLength": 64,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": ["chain", "to", "contractAddress", "url", "fromPrivateKey", "feeLimit", "tokenId"]
},
"DeployNftCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"name": {
"description": "Name of the NFT token",
"example": "My ERC721",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"provenance": {
"description": "True if the contract is provenance percentage royalty type. False by default. Details and sources avaiable here.",
"example": false,
"type": "boolean"
},
"cashback": {
"description": "True if the contract is fixed price royalty type. False by default. Details and sources avaiable here.",
"example": false,
"type": "boolean"
},
"publicMint": {
"description": "True if the contract is publicMint type. False by default.",
"example": true,
"type": "boolean"
},
"symbol": {
"description": "Symbol of the NFT token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Ethereum account address, from which gas for deployment of ERC721 will be paid. Private key, or signature Id must be present.",
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "name", "symbol", "feeCurrency", "fromPrivateKey"]
},
"DeployNftTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"name": {
"description": "Name of the NFT token",
"example": "My ERC721",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"symbol": {
"description": "Symbol of the NFT token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Ethereum account address, from which gas for deployment of ERC721 will be paid. Private key, or signature Id must be present.",
"type": "string",
"maxLength": 64,
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701",
"minLength": 64
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX. For deploy, around 580 TRX is consumed.",
"example": 600
}
},
"required": ["chain", "name", "symbol", "feeLimit", "fromPrivateKey"]
},
"DeployNftCeloKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"name": {
"description": "Name of the NFT token",
"example": "My ERC721",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"symbol": {
"description": "Symbol of the NFT token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": { "type": "number", "minimum": 0 },
"provenance": {
"description": "True if the contract is provenance percentage royalty type. False by default. Details and sources avaiable here.",
"example": false,
"type": "boolean"
},
"cashback": {
"description": "True if the contract is fixed price royalty type. False by default. Details and sources avaiable here.",
"example": false,
"type": "boolean"
},
"publicMint": {
"description": "True if the contract is publicMint type. False by default.",
"example": true,
"type": "boolean"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "name", "symbol", "feeCurrency", "signatureId"]
},
"DeployNftTronKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"account": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to perform transaction from",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"name": {
"description": "Name of the NFT token",
"example": "My ERC721",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"symbol": {
"description": "Symbol of the NFT token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX. For deploy, around 580 TRX is consumed.",
"example": 600
}
},
"required": ["chain", "name", "account", "symbol", "feeLimit", "signatureId"]
},
"MintMultipleNftKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"type": "array",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"authorAddresses": {
"type": "array",
"description": "List of addresses for every token, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency CELO.",
"items": {
"type": "array",
"items": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"description": "Blockchain address to send royalties to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
}
}
},
"cashbackValues": {
"type": "array",
"description": "List of values for every token, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency.",
"items": {
"type": "array",
"items": {
"type": "string",
"description": "Value of the royalty to be paid.",
"example": "0.5"
}
}
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "feeCurrency", "tokenId", "url", "signatureId"]
},
"MintMultipleNftKMSTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ"],
"items": { "maxLength": 34, "minLength": 34, "type": "string" }
},
"account": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to perform transaction from",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"type": "array",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 34,
"minLength": 34,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": ["chain", "to", "account", "contractAddress", "feeLimit", "tokenId", "url", "signatureId"]
},
"BurnNftCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "contractAddress", "feeCurrency", "fromPrivateKey", "tokenId"]
},
"BurnNftTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 34,
"minLength": 34,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701",
"minLength": 64,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": ["chain", "contractAddress", "feeLimit", "fromPrivateKey", "tokenId"]
},
"BurnNftKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "feeCurrency", "contractAddress", "tokenId", "signatureId"]
},
"BurnNftKMSTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"account": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to perform transaction from",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 34,
"minLength": 34,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": ["chain", "feeLimit", "contractAddress", "tokenId", "signatureId", "account"]
},
"BurnNftFlowPK": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"privateKey": {
"type": "string",
"maxLength": 64,
"example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 64,
"description": "Private key of sender address. Private key, mnemonic and index or signature Id must be present."
}
},
"required": ["chain", "contractAddress", "account", "privateKey", "tokenId"]
},
"BurnNftFlowMnemonic": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"mnemonic": {
"type": "string",
"maxLength": 500,
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"minLength": 1,
"description": "Mnemonic to generate private key of sender address."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "contractAddress", "account", "mnemonic", "index", "tokenId"]
},
"BurnNftFlowKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "contractAddress", "account", "signatureId", "tokenId"]
},
"MintMultipleNftFlowPK": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["0xc1b45bc27b9c61c3"],
"items": { "maxLength": 18, "minLength": 18, "type": "string" }
},
"url": {
"type": "array",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"privateKey": {
"type": "string",
"maxLength": 64,
"example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 64,
"description": "Private key of sender address. Private key, mnemonic and index or signature Id must be present."
}
},
"required": ["chain", "contractAddress", "account", "privateKey", "to", "url"]
},
"MintMultipleNftFlowMnemonic": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["0xc1b45bc27b9c61c3"],
"items": { "maxLength": 18, "minLength": 18, "type": "string" }
},
"url": {
"type": "array",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"mnemonic": {
"type": "string",
"maxLength": 500,
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"minLength": 1,
"description": "Mnemonic to generate private key of sender address."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "contractAddress", "account", "mnemonic", "index", "to", "url"]
},
"MintMultipleNftFlowKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["0xc1b45bc27b9c61c3"],
"items": { "maxLength": 18, "minLength": 18, "type": "string" }
},
"url": {
"type": "array",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "contractAddress", "account", "signatureId", "to", "url"]
},
"MintNftFlowPK": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"to": {
"type": "string",
"description": "Blockchain address to send NFT token to.",
"example": "0xc1b45bc27b9c61c3",
"maxLength": 18,
"minLength": 18
},
"url": {
"type": "string",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"maxLength": 256
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"privateKey": {
"type": "string",
"maxLength": 64,
"example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 64,
"description": "Private key of sender address. Private key, mnemonic and index or signature Id must be present."
}
},
"required": ["chain", "contractAddress", "account", "privateKey", "to", "url"]
},
"MintNftFlowMnemonic": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"to": {
"type": "string",
"description": "Blockchain address to send NFT token to.",
"example": "0xc1b45bc27b9c61c3",
"maxLength": 18,
"minLength": 18
},
"url": {
"type": "string",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"maxLength": 256
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"mnemonic": {
"type": "string",
"maxLength": 500,
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"minLength": 1,
"description": "Mnemonic to generate private key of sender address."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "contractAddress", "account", "mnemonic", "index", "to", "url"]
},
"MintNftFlowKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"to": {
"type": "string",
"description": "Blockchain address to send NFT token to.",
"example": "0xc1b45bc27b9c61c3",
"maxLength": 18,
"minLength": 18
},
"url": {
"type": "string",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"maxLength": 256
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "contractAddress", "account", "signatureId", "to", "url"]
},
"DeployNftFlowPK": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"privateKey": {
"type": "string",
"maxLength": 64,
"example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 64,
"description": "Private key of sender address. Private key, mnemonic and index or signature Id must be present."
}
},
"required": ["chain", "account", "privateKey"]
},
"DeployNftFlowMnemonic": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"mnemonic": {
"type": "string",
"maxLength": 500,
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"minLength": 1,
"description": "Mnemonic to generate private key of sender address."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "account", "mnemonic", "index"]
},
"DeployNftFlowKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "account", "signatureId"]
},
"TransferNftFlowPK": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"to": {
"type": "string",
"description": "Blockchain address to send NFT token to.",
"example": "0xc1b45bc27b9c61c3",
"maxLength": 18,
"minLength": 18
},
"tokenId": {
"description": "ID of token to be sent.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"privateKey": {
"type": "string",
"maxLength": 64,
"example": "05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 64,
"description": "Private key of sender address. Private key, mnemonic and index or signature Id must be present."
}
},
"required": ["chain", "contractAddress", "account", "privateKey", "to", "tokenId"]
},
"TransferNftFlowMnemonic": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"to": {
"type": "string",
"description": "Blockchain address to send NFT token to.",
"example": "0xc1b45bc27b9c61c3",
"maxLength": 18,
"minLength": 18
},
"tokenId": {
"description": "ID of token to be sent.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"mnemonic": {
"type": "string",
"maxLength": 500,
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"minLength": 1,
"description": "Mnemonic to generate private key of sender address."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "contractAddress", "account", "mnemonic", "index", "to", "tokenId"]
},
"TransferNftFlowKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "FLOW",
"description": "Chain to work with.",
"enum": ["FLOW"]
},
"to": {
"type": "string",
"description": "Blockchain address to send NFT token to.",
"example": "0xc1b45bc27b9c61c3",
"maxLength": 18,
"minLength": 18
},
"tokenId": {
"description": "ID of token to be sent.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 36,
"minLength": 36,
"description": "Address of NFT token",
"example": "17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f",
"type": "string"
},
"account": {
"type": "string",
"maxLength": 18,
"example": "0xc1b45bc27b9c61c3",
"minLength": 18,
"description": "Blockchain address of the sender account."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"description": "Derivation index of sender address.",
"example": 0,
"type": "integer",
"maximum": 2147483647
}
},
"required": ["chain", "contractAddress", "account", "signatureId", "to", "tokenId"]
},
"NftTx": {
"type": "object",
"properties": {
"blockNumber": { "type": "number", "example": 6541235, "description": "Block number" },
"txId": {
"type": "string",
"example": "0x955c1037608c7aecb6d1a3f150ce7d0a80536bcabb0deb69d62f55292cc4c372",
"description": "Transaction ID"
},
"contractAddress": {
"type": "string",
"example": "0x4f54fAD27F7F46C102Cd49b8E75C5593397cd9c3",
"description": "Contract address"
},
"tokenId": { "type": "string", "example": "1", "description": "ID of the token" },
"from": {
"type": "string",
"example": "0x780c3de0aba1b51f04cfe8a5d9d277d4ad032b8d",
"description": "Sender"
},
"to": {
"type": "string",
"example": "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea",
"description": "recipient"
}
},
"required": ["blockNumber", "txId", "contractAddress", "tokenId", "from", "to"]
},
"UpdateCashbackValueForAuthorNftCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"tokenId": {
"description": "ID of token to be updated.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"cashbackValue": {
"type": "string",
"description": "New royalty cashback to be set for the author of token with tokenId. If set to 0, royalty is disabled for this token.",
"example": "0.1"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "contractAddress", "feeCurrency", "fromPrivateKey", "tokenId", "cashbackValue"]
},
"UpdateCashbackValueForAuthorNftTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"tokenId": {
"description": "ID of token to be updated.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"cashbackValue": {
"type": "string",
"description": "New royalty cashback to be set for the author of token with tokenId. If set to 0, royalty is disabled for this token.",
"example": "0.1"
},
"contractAddress": {
"maxLength": 34,
"minLength": 34,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701",
"minLength": 64,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": ["chain", "contractAddress", "feeLimit", "fromPrivateKey", "tokenId", "cashbackValue"]
},
"UpdateCashbackValueForAuthorNftKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"tokenId": {
"description": "ID of token to be updated.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"cashbackValue": {
"type": "string",
"description": "New royalty cashback to be set for the author of token with tokenId. If set to 0, royalty is disabled for this token.",
"example": "0.1"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "feeCurrency", "contractAddress", "tokenId", "signatureId", "cashbackValue"]
},
"UpdateCashbackValueForAuthorNftKMSTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"account": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to perform transaction from",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"tokenId": {
"description": "ID of token to be updated.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"cashbackValue": {
"type": "string",
"description": "New royalty cashback to be set for the author of token with tokenId. If set to 0, royalty is disabled for this token.",
"example": "0.1"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": [
"chain",
"feeLimit",
"contractAddress",
"account",
"tokenId",
"signatureId",
"cashbackValue"
]
},
"TransferNftKMSCelo": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "If token to be transferred is Royalty NFT token, this is a value to be paid as a cashback to the authors of the token.",
"example": "1"
},
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send NFT token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"provenance": {
"description": "True if the contract is provenance type",
"example": true,
"type": "boolean"
},
"provenanceData": {
"description": "data you want to store with transaction, optional and valid only if provenance contract",
"example": "test",
"type": "string"
},
"tokenPrice": {
"description": "current price of the token, valid only for provenance",
"example": "1",
"type": "string",
"maxLength": 256
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "feeCurrency", "signatureId", "tokenId"]
},
"TransferNftKMSTron": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "If token to be transferred is Royalty NFT token, this is a value to be paid as a cashback to the authors of the token.",
"example": "1"
},
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"account": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to perform transaction from",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"to": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to send NFT token to",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"contractAddress": {
"maxLength": 34,
"minLength": 34,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": ["chain", "to", "contractAddress", "feeLimit", "signatureId", "tokenId", "account"]
},
"MintNftCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send NFT token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"erc20": {
"maxLength": 42,
"minLength": 42,
"description": "Address of custom ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"authorAddresses": {
"type": "array",
"description": "List of addresses, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency CELO.",
"items": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"description": "Blockchain address to send royalties to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
}
},
"provenance": {
"description": "True if the contract is provenance type",
"example": true,
"type": "boolean"
},
"cashbackValues": {
"type": "array",
"description": "List of values, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency and percentage value in case of provenance",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"fixedValues": {
"type": "array",
"description": "List of fixed values, if fixed value is greater than cashback value, it will be transferred to the authors instead.This is exact value in native blockhain currency.",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "url", "feeCurrency"]
},
"MintNftTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to send NFT token to",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"contractAddress": {
"maxLength": 34,
"minLength": 34,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"authorAddresses": {
"type": "array",
"description": "List of addresses, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency TRON.",
"items": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Blockchain address to send royalties to",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ"
}
},
"cashbackValues": {
"type": "array",
"description": "List of values, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency.",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701",
"minLength": 64,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": ["chain", "to", "url", "feeLimit", "contractAddress", "fromPrivateKey", "tokenId"]
},
"MintNftKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send NFT token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"erc20": {
"maxLength": 42,
"minLength": 42,
"description": "Address of custom ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"authorAddresses": {
"type": "array",
"description": "List of addresses, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency CELO.",
"items": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"description": "Blockchain address to send royalties to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
}
},
"provenance": {
"description": "True if the contract is provenance type",
"example": true,
"type": "boolean"
},
"cashbackValues": {
"type": "array",
"description": "List of values, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency and percentage value in case of provenance",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"fixedValues": {
"type": "array",
"description": "List of fixed values, if fixed value is greater than cashback value, it will be transferred to the authors instead.This is exact value in native blockhain currency.",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "url", "feeCurrency", "contractAddress", "signatureId", "tokenId"]
},
"MintNftKMSTron": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "TRON",
"description": "Chain to work with.",
"enum": ["TRON"]
},
"account": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to perform transaction from",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 34,
"minLength": 34,
"description": "Blockchain address to send NFT token to",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"contractAddress": {
"maxLength": 34,
"minLength": 34,
"description": "Address of NFT token",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ",
"type": "string"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"authorAddresses": {
"type": "array",
"description": "List of addresses, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency TRON.",
"items": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Blockchain address to send royalties to",
"example": "TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ"
}
},
"cashbackValues": {
"type": "array",
"description": "List of values, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency.",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"feeLimit": {
"type": "number",
"description": "Max limit for fee to be paid, in TRX.",
"example": 600
}
},
"required": ["chain", "account", "to", "url", "feeLimit", "contractAddress", "signatureId", "tokenId"]
},
"TransferNft": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "If token to be transferred is Royalty NFT token, this is a value to be paid as a cashback to the authors of the token.",
"example": "1"
},
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"to": {
"maxLength": 58,
"minLength": 42,
"description": "Blockchain address to send NFT token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"contractAddress": {
"maxLength": 42,
"minLength": 1,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"provenance": {
"description": "True if the contract is provenance type",
"example": true,
"type": "boolean"
},
"provenanceData": {
"description": "data you want to store with transaction, optional and valid only if provenance contract",
"example": "test",
"type": "string"
},
"tokenPrice": {
"description": "current price of the token, valid only for provenance",
"example": "1",
"type": "string",
"maxLength": 256
},
"fromPrivateKey": {
"type": "string",
"maxLength": 103,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used. Setting nonce is not necessary in Algorand"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically. Setting fee is not necessary in Algorand.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "contractAddress", "tokenId", "fromPrivateKey"]
},
"TransferNftAlgo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ALGO",
"description": "Chain to work with.",
"enum": ["ALGO"]
},
"to": {
"maxLength": 58,
"minLength": 58,
"description": "Blockchain address to send NFT token to",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string"
},
"contractAddress": {
"description": "AssetID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"fromPrivateKey": {
"type": "string",
"maxLength": 103,
"example": "72TCV5BRQPBMSAFPYO3CPWVDBYWNGAYNMTW5QHENOMQF7I6QLNMJWCJZ7A3V5YKD7QD6ZZPEHG2PV2ZVVEDDO6BCRGXWIL3DIUMSUCI",
"minLength": 106,
"description": "Private key of sender address."
}
},
"required": ["to", "chain", "contractAddress", "fromPrivateKey"]
},
"TransferNftAlgoExpress": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ALGO",
"description": "Chain to work with.",
"enum": ["ALGO"]
},
"to": {
"maxLength": 58,
"minLength": 58,
"description": "Blockchain address to send NFT token to",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string"
},
"contractAddress": {
"description": "AssetID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
}
},
"required": ["to", "chain", "contractAddress"]
},
"TransferNftSolana": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "Chain to work with.",
"enum": ["SOL"]
},
"from": {
"maxLength": 44,
"minLength": 44,
"description": "Blockchain address to send NFT token from. From this address, transaction fee will be paid.",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"to": {
"maxLength": 44,
"minLength": 44,
"description": "Blockchain address to send NFT token to",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"contractAddress": {
"maxLength": 44,
"minLength": 44,
"description": "Address of NFT token",
"example": "3tzudv5KaoqmieWiBUqzWokKEtTvx1wQMapVKeH7CHaq",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 128,
"example": "3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad",
"minLength": 128,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "from", "chain", "contractAddress", "fromPrivateKey"]
},
"TransferNftAlgoKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ALGO",
"description": "Chain to work with.",
"enum": ["ALGO"]
},
"from": {
"maxLength": 58,
"minLength": 58,
"description": "Blockchain address to send NFT token from",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string"
},
"to": {
"maxLength": 58,
"minLength": 58,
"description": "Blockchain address to send NFT token to",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string"
},
"contractAddress": {
"description": "AssetID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "chain", "contractAddress", "from", "signatureId"]
},
"TransferNftSolanaKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "Chain to work with.",
"enum": ["SOL"]
},
"from": {
"maxLength": 44,
"minLength": 44,
"description": "Blockchain address to send NFT token from. From this address, transaction fee will be paid.",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"to": {
"maxLength": 44,
"minLength": 44,
"description": "Blockchain address to send NFT token to",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"contractAddress": {
"maxLength": 44,
"minLength": 44,
"description": "Address of NFT token",
"example": "3tzudv5KaoqmieWiBUqzWokKEtTvx1wQMapVKeH7CHaq",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "from", "chain", "contractAddress", "signatureId"]
},
"DeployNft": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"name": {
"description": "Name of the NFT token",
"example": "My ERC721",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"symbol": {
"description": "Symbol of the NFT token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Ethereum account address, from which gas for deployment of ERC721 will be paid. Private key, or signature Id must be present.",
"type": "string",
"maxLength": 103,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66
},
"provenance": {
"description": "True if the contract is provenance percentage royalty type. False by default. Details and sources avaiable here.",
"example": false,
"type": "boolean"
},
"cashback": {
"description": "True if the contract is fixed price royalty type. False by default. Details and sources avaiable here.",
"example": false,
"type": "boolean"
},
"publicMint": {
"description": "True if the contract is publicMint type. False by default.",
"example": true,
"type": "boolean"
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["name", "chain", "symbol", "fromPrivateKey"]
},
"DeployNftKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"name": {
"description": "Name of the NFT token",
"example": "My ERC721",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"provenance": {
"description": "True if the contract is provenance percentage royalty type. False by default. Details and sources avaiable here.",
"example": false,
"type": "boolean"
},
"cashback": {
"description": "True if the contract is fixed price royalty type. False by default. Details and sources avaiable here.",
"example": false,
"type": "boolean"
},
"publicMint": {
"description": "True if the contract is publicMint type. False by default.",
"example": true,
"type": "boolean"
},
"symbol": {
"description": "Symbol of the NFT token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["name", "chain", "symbol", "signatureId"]
},
"TransferNftKMS": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "If token to be transferred is Royalty NFT token, this is a value to be paid as a cashback to the authors of the token.",
"example": "1"
},
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send NFT token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"provenance": {
"description": "True if the contract is provenance type",
"example": true,
"type": "boolean"
},
"provenanceData": {
"description": "data you want to store with transaction, optional and valid only if provenance contract",
"example": "test",
"type": "string"
},
"tokenPrice": {
"description": "current price of the token, valid only for provenance",
"example": "1",
"type": "string",
"maxLength": 256
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "contractAddress", "signatureId", "tokenId"]
},
"MintNft": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send NFT token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"erc20": {
"maxLength": 42,
"minLength": 42,
"description": "Address of custom ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"provenance": {
"description": "True if the contract is provenance type",
"example": true,
"type": "boolean"
},
"authorAddresses": {
"type": "array",
"description": "List of addresses, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency, like BSC or ETH.",
"items": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"description": "Blockchain address to send royalties to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
}
},
"cashbackValues": {
"type": "array",
"description": "List of values, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency and percentage value in case of provenance",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"fixedValues": {
"type": "array",
"description": "List of fixed values, if fixed value is greater than cashback value, it will be transferred to the authors instead.This is exact value in native blockhain currency.",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "fromPrivateKey", "tokenId"]
},
"MintNftMinter": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "The blockchain to work with",
"enum": ["BSC", "CELO", "ETH", "KLAY", "MATIC", "ONE"]
},
"tokenId": {
"description": "The token ID of the NFT",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address to send the NFT to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address of the smart contract to build the NFT on",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"minter": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address of the NFT minter",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"url": {
"description": "The link to the NFT metadata (see https://eips.ethereum.org/EIPS/eip-721#specification for more details)",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
}
},
"required": ["to", "chain", "url", "minter", "tokenId", "contractAddress"]
},
"MintNftExpress": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "CELO", "ONE", "KLAY", "BSC"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send NFT token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
}
},
"required": ["to", "chain", "url"]
},
"MintNftExpressAlgorand": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ALGO",
"description": "Chain to work with.",
"enum": ["ALGO"]
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"name": {
"description": "Name of the NFT.",
"example": "My Crazy NFT",
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"attr": {
"type": "object",
"properties": {
"assetUnit": {
"description": "NFT unit name.",
"example": "USDT",
"type": "string",
"maxLength": 8,
"minLength": 1
},
"clawback": {
"description": "Address of clawback account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"manager": {
"description": "Address of manager account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"reserve": {
"description": "Address of reserve account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"freeze": {
"description": "Address of freeze account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
}
}
}
},
"required": ["name", "chain", "url"]
},
"MintNftAlgorand": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ALGO",
"description": "Chain to work with.",
"enum": ["ALGO"]
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"name": {
"description": "Name of the NFT.",
"example": "My Crazy NFT",
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 103,
"example": "EPD5VYFGXWNZ2PY4AQNPD3E3LMAXISKNMGR4IJ44YI74QL5AMNTAIJNQ6Q373RDANF2YERVFQY3C5CKK7VUJDJR4DT6EPP5HZQUPORQ",
"minLength": 103,
"description": "Private key of minting address."
},
"attr": {
"type": "object",
"properties": {
"assetUnit": {
"description": "NFT unit name.",
"example": "USDT",
"type": "string",
"maxLength": 8,
"minLength": 1
},
"clawback": {
"description": "Address of clawback account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"manager": {
"description": "Address of manager account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"reserve": {
"description": "Address of reserve account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"freeze": {
"description": "Address of freeze account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
}
}
}
},
"required": ["name", "chain", "url", "fromPrivateKey"]
},
"MintNftAlgorandKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ALGO",
"description": "Chain to work with.",
"enum": ["ALGO"]
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"name": {
"description": "Name of the NFT.",
"example": "My Crazy NFT",
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"from": {
"description": "Address of the minting account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"attr": {
"type": "object",
"properties": {
"assetUnit": {
"description": "NFT unit name.",
"example": "USDT",
"type": "string",
"maxLength": 8,
"minLength": 1
},
"clawback": {
"description": "Address of clawback account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"manager": {
"description": "Address of manager account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"reserve": {
"description": "Address of reserve account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
},
"freeze": {
"description": "Address of freeze account.",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string",
"maxLength": 58,
"minLength": 58
}
}
}
},
"required": ["name", "chain", "url", "from", "signatureId"]
},
"MintNftKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send NFT token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"erc20": {
"maxLength": 42,
"minLength": 42,
"description": "Address of custom ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"provenance": {
"description": "True if the contract is provenance type",
"example": true,
"type": "boolean"
},
"authorAddresses": {
"type": "array",
"description": "List of addresses, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency, like BSC or ETH.",
"items": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"description": "Blockchain address to send royalties to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
}
},
"cashbackValues": {
"type": "array",
"description": "List of values, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency and percentage value in case of provenance",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"fixedValues": {
"type": "array",
"description": "List of fixed values, if fixed value is greater than cashback value, it will be transferred to the authors instead.This is exact value in native blockhain currency.",
"items": { "type": "string", "description": "Value of the royalty to be paid.", "example": "0.5" }
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "contractAddress", "signatureId", "tokenId"]
},
"MintNftSolana": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "The blockchain to work with",
"enum": ["SOL"]
},
"to": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address to send the NFT to",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"from": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address to mint the NFT from. The transaction fee will be paid from this address.",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 128,
"example": "3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad",
"minLength": 64,
"description": "The private key of the sender's address"
},
"collectionVerifierPrivateKey": {
"type": "string",
"maxLength": 128,
"example": "3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad",
"minLength": 64,
"description": "The private key of the collection verifier (owner) who will verify the NFT in the NFT collection where the NFT is minted in. The blockchain address of this collection is specified in the collection parameter in the metadata section of the request body. To know more about Solana collections and verification, refer to the Solana user documentation."
},
"metadata": { "$ref": "#/components/schemas/SolanaNftMetadata" }
},
"required": ["to", "chain", "fromPrivateKey", "from", "metadata"]
},
"VerifySolanaNFT": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "The blockchain to work with",
"enum": ["SOL"]
},
"nftAddress": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address of the NFT to verify",
"example": "CHw1Fy5YdbaaosLXrrxhuc3X3fpssMqDQm9XwJh9LPGe",
"type": "string"
},
"collectionAddress": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address of the NFT collection where the NFT should be verified in. The collection must be a sized collection that was introduced in Version 1.3 of the Metaplex Token Metadata program.",
"example": "CHw1Fy5YdbaaosLXrrxhuc3X3fpssMqDQm9XwJh9LPGe",
"type": "string"
},
"from": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address of the collection verifier on behalf of whom the transaction will be originated. The transaction fee will be paid from this address.",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 128,
"example": "3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad",
"minLength": 64,
"description": "The private key of the collection verifier's address"
}
},
"required": ["collectionAddress", "chain", "fromPrivateKey", "from", "nftAddress"]
},
"VerifySolanaNFTKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "The blockchain to work with",
"enum": ["SOL"]
},
"nftAddress": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address of the NFT to verify",
"example": "CHw1Fy5YdbaaosLXrrxhuc3X3fpssMqDQm9XwJh9LPGe",
"type": "string"
},
"collectionAddress": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address of the NFT collection where the NFT should be verified in. The collection must be a sized collection that was introduced in Version 1.3 of the Metaplex Token Metadata program.",
"example": "CHw1Fy5YdbaaosLXrrxhuc3X3fpssMqDQm9XwJh9LPGe",
"type": "string"
},
"from": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address of the collection verifier on behalf of whom the transaction will be originated. The transaction fee will be paid from this address.",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["collectionAddress", "chain", "signatureId", "from", "nftAddress"]
},
"MintNftExpressSolana": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "Chain to work with.",
"enum": ["SOL"]
},
"to": {
"maxLength": 44,
"minLength": 43,
"description": "Blockchain address to send NFT token to",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"metadata": { "$ref": "#/components/schemas/SolanaNftExpressMetadata" }
},
"required": ["to", "chain", "metadata"]
},
"MintNftSolanaKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "Chain to work with.",
"enum": ["SOL"]
},
"to": {
"maxLength": 44,
"minLength": 43,
"description": "Blockchain address to send NFT token to",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"from": {
"maxLength": 44,
"minLength": 43,
"description": "Blockchain address to mint NFT token from. From this account, transaction fee will be paid.",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"metadata": { "$ref": "#/components/schemas/SolanaNftMetadataKMS" }
},
"required": ["to", "chain", "signatureId", "metadata", "from"]
},
"SolanaNftMetadataCreator": {
"type": "object",
"required": ["address", "verified", "share"],
"properties": {
"address": {
"type": "string",
"description": "The blockchain address of the NFT creator",
"maxLength": 44,
"minLength": 43,
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ"
},
"verified": {
"type": "boolean",
"description": "If set to true, the NFT creator was verified. Only the address whose private key was used during the minting of the NFT can be a verified creator. If you are minting the NFT using NFT Express, set this parameter to false.",
"example": true
},
"share": {
"type": "number",
"description": "The share to be sent to the NFT creator (in %)",
"example": 100
}
}
},
"SolanaNftMetadata": {
"type": "object",
"required": ["name", "symbol", "uri", "sellerFeeBasisPoints"],
"properties": {
"name": {
"type": "string",
"description": "Name of the NFT token.",
"example": "My NFT.",
"maxLength": 255
},
"symbol": {
"type": "string",
"description": "Symbol of the NFT token.",
"example": "NFT_SYMBOL",
"maxLength": 255
},
"sellerFeeBasisPoints": {
"type": "number",
"description": "Basis points of the seller fee.",
"example": 0
},
"uri": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 500
},
"collection": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address of the NFT collection where the NFT will be minted in. Specify the private key of the collection verifier in the collectionVerifierPrivateKey parameter of the request body to get the NFT verified in the collection after the NFT has been minted. To know more about Solana collections and verification, refer to the Solana user documentation.",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"mutable": {
"type": "boolean",
"default": true,
"description": "If NFT metadata are mutable or not. Defaults to true."
},
"creators": {
"type": "array",
"description": "Royalty receivers for NFT transfers.",
"items": { "$ref": "#/components/schemas/SolanaNftMetadataCreator" }
}
}
},
"SolanaNftMetadataKMS": {
"type": "object",
"required": ["name", "symbol", "uri", "sellerFeeBasisPoints"],
"properties": {
"name": {
"type": "string",
"description": "Name of the NFT token.",
"example": "My NFT.",
"maxLength": 255
},
"symbol": {
"type": "string",
"description": "Symbol of the NFT token.",
"example": "NFT_SYMBOL",
"maxLength": 255
},
"sellerFeeBasisPoints": {
"type": "number",
"description": "Basis points of the seller fee.",
"example": 0
},
"uri": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 500
},
"collection": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address of the NFT collection where the NFT will be minted in. The minted NFT will get verified in the collection on behalf of the blockchain address specified in the from parameter. To know more about Solana collections and verification, refer to the Solana user documentation and NFT verification API.",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"mutable": {
"type": "boolean",
"default": true,
"description": "If NFT metadata are mutable or not. Defaults to true."
},
"creators": {
"type": "array",
"description": "Royalty receivers for NFT transfers.",
"items": { "$ref": "#/components/schemas/SolanaNftMetadataCreator" }
}
}
},
"SolanaNftExpressMetadata": {
"type": "object",
"required": ["name", "symbol", "uri", "sellerFeeBasisPoints"],
"properties": {
"name": {
"type": "string",
"description": "Name of the NFT token.",
"example": "My NFT.",
"maxLength": 255
},
"symbol": {
"type": "string",
"description": "Symbol of the NFT token.",
"example": "NFT_SYMBOL",
"maxLength": 255
},
"sellerFeeBasisPoints": {
"type": "number",
"description": "Basis points of the seller fee.",
"example": 0
},
"uri": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 500
},
"collection": {
"maxLength": 44,
"minLength": 43,
"description": "The blockchain address of the NFT collection where the NFT will be minted in. By default, the NFT is minted as not verified (is not considered a part of the collection). To verify the NFT in the collection, use the NFT verification API. To know more about Solana collections and verification, refer to the Solana user documentation.",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"mutable": {
"type": "boolean",
"default": true,
"description": "If NFT metadata are mutable or not. Defaults to true."
},
"creators": {
"type": "array",
"description": "Royalty receivers for NFT transfers.",
"items": { "$ref": "#/components/schemas/SolanaNftMetadataCreator" }
}
}
},
"MintMultipleNft": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"type": "array",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"authorAddresses": {
"type": "array",
"description": "List of addresses for every token, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency, ETH or BSC.",
"items": {
"type": "array",
"items": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"description": "Blockchain address to send royalties to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
}
}
},
"cashbackValues": {
"type": "array",
"description": "List of values for every token, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency.",
"items": {
"type": "array",
"items": {
"type": "string",
"description": "Value of the royalty to be paid.",
"example": "0.5"
}
}
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "contractAddress", "fromPrivateKey", "tokenId"]
},
"MintMultipleNftMinter": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "CELO", "KCS", "ONE", "KLAY", "BSC"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"minter": {
"maxLength": 42,
"minLength": 43,
"description": "Address of NFT minter, which will be used to mint the tokens. From this address, transaction fees will be deducted.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"url": {
"type": "array",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas, only valid for CELO chain.",
"enum": ["CELO"]
}
},
"required": ["to", "chain", "url", "contractAddress", "minter", "tokenId"]
},
"MintMultipleNftKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"to": {
"type": "array",
"description": "Blockchain address to send NFT token to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"type": "array",
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"authorAddresses": {
"type": "array",
"description": "List of addresses for every token, where royalty cashback for every transfer of this NFT will be send. Royalties are paid in native blockchain currency, ETH or BSC.",
"items": {
"type": "array",
"items": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"description": "Blockchain address to send royalties to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
}
}
},
"cashbackValues": {
"type": "array",
"description": "List of values for every token, which will be paid as a royalty for author of the NFT token with every token transfer. This is exact value in native blockhain currency.",
"items": {
"type": "array",
"items": {
"type": "string",
"description": "Value of the royalty to be paid.",
"example": "0.5"
}
}
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "contractAddress", "tokenId", "url", "signatureId"]
},
"BurnNft": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC", "ALGO"]
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 1,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 103,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "contractAddress", "fromPrivateKey", "tokenId"]
},
"AddNftMinter": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "CELO", "ONE", "KLAY", "BSC"]
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"minter": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT minter",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas, only valid for CELO chain.",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["minter", "chain", "url", "contractAddress", "fromPrivateKey"]
},
"UpdateCashbackValueForAuthorNftKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"tokenId": {
"description": "ID of token to be updated.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"cashbackValue": {
"type": "string",
"description": "New royalty cashback to be set for the author of token with tokenId. If set to 0, royalty is disabled for this token.",
"example": "0.1"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "contractAddress", "tokenId", "cashbackValue", "signatureId"]
},
"UpdateCashbackValueForAuthorNft": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"tokenId": {
"description": "ID of token to be updated.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"cashbackValue": {
"type": "string",
"description": "New royalty cashback to be set for the author of token with tokenId. If set to 0, royalty is disabled for this token.",
"example": "0.1"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "cashbackValue", "contractAddress", "fromPrivateKey", "tokenId"]
},
"BurnNftKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "ONE", "KLAY", "BSC"]
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "contractAddress", "tokenId", "signatureId"]
},
"AddNftMinterKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "CELO", "ONE", "KLAY", "BSC"]
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"minter": {
"maxLength": 42,
"minLength": 42,
"description": "Address of NFT minter",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas, only valid for CELO chain.",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "url", "contractAddress", "minter", "signatureId"]
},
"ChainDeployErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "MATIC", "KLAY", "XDC", "ONE"]
},
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Initial supply of ERC20 token. If totalCap is not defined, this will be the total cap.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Ethereum blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 43,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Ethereum account address, from which the fee for the deployment of ERC20 will be paid. Private key, or signature Id must be present.",
"type": "string",
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"maxLength": 66,
"minLength": 66
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "name", "symbol", "address", "supply", "fromPrivateKey", "digits"]
},
"ChainDeploySolanaSpl": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "Chain to work with.",
"enum": ["SOL"]
},
"supply": {
"description": "Initial supply of SPL token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 0,
"type": "number"
},
"address": {
"description": "Address on Solana blockchain, where all created SPL tokens will be transferred.",
"maxLength": 43,
"minLength": 44,
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"from": {
"description": "Address on Solana blockchain, from which the fee for the deployment of SPL will be paid.",
"maxLength": 43,
"minLength": 44,
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Solana account address, from which the fee for the deployment of SPL will be paid. Private key, or signature Id must be present.",
"type": "string",
"example": "3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad",
"maxLength": 103,
"minLength": 128
}
},
"required": ["chain", "from", "address", "supply", "fromPrivateKey", "digits"]
},
"ChainDeploySolanaSplKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "Chain to work with.",
"enum": ["SOL"]
},
"supply": {
"description": "Initial supply of SPL token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 0,
"type": "number"
},
"address": {
"description": "Address on Solana blockchain, where all created SPL tokens will be transferred.",
"maxLength": 43,
"minLength": 44,
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"from": {
"description": "Address on Solana blockchain, from which the fee for the deployment of SPL will be paid.",
"maxLength": 43,
"minLength": 44,
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["chain", "from", "address", "supply", "signatureId", "digits"]
},
"FungibleTx": {
"type": "object",
"properties": {
"blockNumber": { "type": "number", "example": 6541235, "description": "Block number" },
"txId": {
"type": "string",
"example": "0x955c1037608c7aecb6d1a3f150ce7d0a80536bcabb0deb69d62f55292cc4c372",
"description": "Transaction ID"
},
"contractAddress": {
"type": "string",
"example": "0x4f54fAD27F7F46C102Cd49b8E75C5593397cd9c3",
"description": "Contract address"
},
"amount": {
"type": "string",
"example": "1",
"description": "Amount of tokens transferred, in smallest decimals"
},
"from": {
"type": "string",
"example": "0x780c3de0aba1b51f04cfe8a5d9d277d4ad032b8d",
"description": "Sender"
},
"to": {
"type": "string",
"example": "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea",
"description": "recipient"
}
},
"required": ["txId", "blockNumber", "contractAddress", "amount", "from", "to"]
},
"ChainDeployErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "MATIC", "KLAY", "XDC", "ONE"]
},
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Ethereum blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 43,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "name", "symbol", "address", "supply", "signatureId", "digits"]
},
"ChainDeployKcsErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "KCS",
"description": "Chain to work with.",
"enum": ["KCS"]
},
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Initial supply of ERC20 token. If totalCap is not defined, this will be the total cap.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Ethereum blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 43,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Ethereum account address, from which the fee for the deployment of ERC20 will be paid. Private key, or signature Id must be present.",
"type": "string",
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"maxLength": 66,
"minLength": 66
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "name", "symbol", "address", "supply", "fromPrivateKey", "digits"]
},
"ChainDeployKcsErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "KCS",
"description": "Chain to work with.",
"enum": ["KCS"]
},
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Ethereum blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 43,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "name", "symbol", "address", "supply", "signatureId", "digits"]
},
"ChainDeployCeloErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Ethereum blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 42,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Ethereum account address, from which the fee for the deployment of ERC20 will be paid. Private key, or signature Id must be present.",
"type": "string",
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"maxLength": 66,
"minLength": 66
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": [
"chain",
"name",
"symbol",
"address",
"supply",
"fromPrivateKey",
"digits",
"feeCurrency"
]
},
"ChainDeployCeloErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Ethereum blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 42,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "name", "symbol", "address", "supply", "signatureId", "digits", "feeCurrency"]
},
"ChainMintErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "MATIC", "KLAY", "XDC", "ONE"]
},
"amount": {
"description": "Amount to be minted and transfered to the recipient.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"to": {
"maxLength": 43,
"minLength": 42,
"description": "Blockchain address to send ERC-20 tokens to.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "to", "amount", "contractAddress", "fromPrivateKey"]
},
"ChainMintKcsErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "KCS",
"description": "Chain to work with.",
"enum": ["KCS"]
},
"amount": {
"description": "Amount to be minted and transfered to the recipient.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"to": {
"maxLength": 43,
"minLength": 42,
"description": "Blockchain address to send ERC-20 tokens to.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "to", "amount", "contractAddress", "fromPrivateKey"]
},
"ChainMintErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "XDC"]
},
"amount": {
"description": "Amount to be minted and transfered to the recipient.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"to": {
"maxLength": 43,
"minLength": 42,
"description": "Blockchain address to send ERC-20 tokens to.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "to", "amount", "contractAddress", "signatureId"]
},
"ChainMintKcsErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "KCS",
"description": "Chain to work with.",
"enum": ["KCS"]
},
"amount": {
"description": "Amount to be minted and transfered to the recipient.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"to": {
"maxLength": 43,
"minLength": 42,
"description": "Blockchain address to send ERC-20 tokens to.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "to", "amount", "contractAddress", "signatureId"]
},
"ChainMintCeloErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"amount": {
"description": "Amount to be minted and transfered to the recipient.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC-20 tokens to.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "amount", "feeCurrency", "contractAddress", "fromPrivateKey"]
},
"ChainMintCeloErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"amount": {
"description": "Amount to be minted and transfered to the recipient.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC-20 tokens to.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "amount", "feeCurrency", "contractAddress", "signatureId"]
},
"ApproveErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "MATIC", "KLAY", "ONE"]
},
"amount": {
"description": "Amount to be approved for the spender.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"spender": {
"maxLength": 43,
"minLength": 42,
"description": "Blockchain address of the new spender.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "spender", "amount", "contractAddress", "fromPrivateKey"]
},
"ApproveErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "MATIC", "KLAY", "ONE"]
},
"amount": {
"description": "Amount to be approved for the spender.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"spender": {
"maxLength": 43,
"minLength": 42,
"description": "Blockchain address of the new spender.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "spender", "amount", "contractAddress", "signatureId"]
},
"ApproveCeloErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"amount": {
"description": "Amount to be approved for the spender.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"spender": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address of the new spender.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "spender", "amount", "feeCurrency", "contractAddress", "fromPrivateKey"]
},
"ApproveCeloErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"amount": {
"description": "Amount to be approved for the spender.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"spender": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address of the new spender.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "spender", "amount", "feeCurrency", "contractAddress", "signatureId"]
},
"ChainBurnErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "MATIC", "KLAY", "XDC", "ONE", "ALGO"]
},
"amount": {
"description": "Amount of tokens to be destroyed.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "contractAddress", "fromPrivateKey", "amount"]
},
"ChainBurnErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "XDC", "ALGO"]
},
"amount": {
"description": "Amount of tokens to be destroyed.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "contractAddress", "signatureId", "amount"]
},
"ChainBurnKcsErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "KCS",
"description": "Chain to work with.",
"enum": ["KCS"]
},
"amount": {
"description": "Amount of tokens to be destroyed.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "contractAddress", "fromPrivateKey", "amount"]
},
"ChainBurnKcsErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "KCS",
"description": "Chain to work with.",
"enum": ["KCS"]
},
"amount": {
"description": "Amount of tokens to be destroyed.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
}
},
"required": ["chain", "contractAddress", "signatureId", "amount"]
},
"ChainBurnCeloErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"amount": {
"description": "Amount of tokens to be destroyed.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "contractAddress", "feeCurrency", "fromPrivateKey", "amount"]
},
"ChainBurnCeloErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"amount": {
"description": "Amount of tokens to be destroyed.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "contractAddress", "feeCurrency", "signatureId", "amount"]
},
"ChainTransferAlgoErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ALGO",
"description": "Chain to work with.",
"enum": ["ALGO"]
},
"to": {
"maxLength": 58,
"minLength": 42,
"description": "Blockchain address to send ERC20 token to",
"example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 1,
"description": "assetIndex - asset index uniquely specifying the asset",
"example": "1",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 103,
"example": "72TCV5BRQPBMSAFPYO3CPWVDBYWNGAYNMTW5QHENOMQF7I6QLNMJWCJZ7A3V5YKD7QD6ZZPEHG2PV2ZVVEDDO6BCRGXWIL3DIUMSUCI",
"minLength": 103,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["chain", "currency", "to", "contractAddress", "fromPrivateKey", "amount"]
},
"ChainTransferAlgoErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ALGO",
"description": "Chain to work with.",
"enum": ["ALGO"]
},
"to": {
"maxLength": 58,
"minLength": 42,
"description": "Blockchain address to send ERC20 token to",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 1,
"description": "assetIndex - asset index uniquely specifying the asset",
"example": "1",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"from": {
"maxLength": 58,
"minLength": 42,
"description": "Blockchain address to send ERC20 token to",
"example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y",
"type": "string"
}
},
"required": ["chain", "currency", "to", "contractAddress", "signatureId", "amount", "from"]
},
"ChainTransferEthErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "MATIC", "KLAY", "XDC", "ONE"]
},
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "currency", "to", "contractAddress", "digits", "fromPrivateKey", "amount"]
},
"ChainTransferSolanaSpl": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "Chain to work with.",
"enum": ["SOL"]
},
"to": {
"description": "Address on Solana blockchain, where SPL tokens will be transferred.",
"maxLength": 43,
"minLength": 44,
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 44,
"description": "Address of SPL token",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"digits": {
"description": "Number of decimal points that SPL token has.",
"example": 18,
"maximum": 30,
"minimum": 0,
"type": "number"
},
"from": {
"description": "Address on the Solana blockchain, from which the token will be transferred.",
"maxLength": 44,
"minLength": 43,
"example": "BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 103,
"example": "3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad",
"minLength": 128,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": [
"chain",
"currency",
"to",
"contractAddress",
"digits",
"fromPrivateKey",
"from",
"amount"
]
},
"ChainTransferSolanaSplKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "SOL",
"description": "Chain to work with.",
"enum": ["SOL"]
},
"to": {
"description": "Address on Solana blockchain, where SPL tokens will be transferred.",
"maxLength": 43,
"minLength": 44,
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 44,
"description": "Address of SPL token",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"type": "string"
},
"digits": {
"description": "Number of decimal points that SPL token has.",
"example": 18,
"maximum": 30,
"minimum": 0,
"type": "number"
},
"from": {
"description": "Address on the Solana blockchain, from which the token will be transferred.",
"maxLength": 44,
"minLength": 43,
"example": "BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["chain", "currency", "to", "contractAddress", "digits", "signatureId", "from", "amount"]
},
"ChainTransferEthErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "MATIC", "KLAY", "XDC", "ONE"]
},
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "currency", "to", "contractAddress", "digits", "signatureId", "amount"]
},
"ChainTransferKcsEthErc20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "KCS",
"description": "Chain to work with.",
"enum": ["KCS"]
},
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "currency", "to", "contractAddress", "digits", "fromPrivateKey", "amount"]
},
"ChainTransferKcsEthErc20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "KCS",
"description": "Chain to work with.",
"enum": ["KCS"]
},
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "currency", "to", "contractAddress", "digits", "signatureId", "amount"]
},
"ChainTransferBscBep20": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "BSC",
"description": "Chain to work with.",
"enum": ["BSC"]
},
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send BEP20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of BEP20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that BEP20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to BSC transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "to", "contractAddress", "digits", "fromPrivateKey", "amount"]
},
"ChainTransferBscBep20KMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "BSC",
"description": "Chain to work with.",
"enum": ["BSC"]
},
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send BEP20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of BEP20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that BEP20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to BSC transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "to", "contractAddress", "digits", "signatureId", "amount"]
},
"ChainTransferCeloErc20Token": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "digits", "feeCurrency", "fromPrivateKey", "amount"]
},
"ChainTransferCeloErc20TokenKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "digits", "feeCurrency", "signatureId", "amount"]
},
"ChainCallSmartContractMethod": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "BSC", "XDC"]
},
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": { "type": "object", "description": "ABI of the method to invoke." },
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["chain", "contractAddress", "params", "methodABI", "fromPrivateKey", "methodName"]
},
"CallCeloSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"amount": {
"description": "Amount of the assets to be sent.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["contractAddress", "params", "methodABI", "fromPrivateKey", "methodName", "feeCurrency"]
},
"TransferMultiTokenCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"amount": {
"description": "Amount of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "tokenId", "fromPrivateKey", "amount", "feeCurrency"]
},
"MultiTx": {
"type": "object",
"properties": {
"blockNumber": { "type": "number", "example": 6541235, "description": "Block number" },
"txId": {
"type": "string",
"example": "0x955c1037608c7aecb6d1a3f150ce7d0a80536bcabb0deb69d62f55292cc4c372",
"description": "Transaction ID"
},
"contractAddress": {
"type": "string",
"example": "0x4f54fAD27F7F46C102Cd49b8E75C5593397cd9c3",
"description": "Contract address"
},
"tokenId": { "type": "string", "example": "1", "description": "ID of the token" },
"amount": { "type": "string", "example": "1", "description": "Amount of tokens transferred." },
"from": {
"type": "string",
"example": "0x780c3de0aba1b51f04cfe8a5d9d277d4ad032b8d",
"description": "Sender"
},
"operator": {
"type": "string",
"example": "0x780c3de0aba1b51f04cfe8a5d9d277d4ad032b8d",
"description": "Operator"
},
"to": {
"type": "string",
"example": "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea",
"description": "recipient"
}
},
"required": ["blockNumber", "txId", "contractAddress", "tokenId", "from", "to", "amount", "operator"]
},
"TransferMultiTokenBatchCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": ["100000"],
"type": "array",
"items": { "type": "string", "maxLength": 32 }
},
"amounts": {
"description": "Amount of token to be transferred",
"example": ["100000"],
"type": "array",
"items": { "type": "string", "maxLength": 32 }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "tokenId", "amounts", "fromPrivateKey"]
},
"DeployMultiTokenCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"uri": {
"description": "URI of the Multi Token contract",
"example": "example.com",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"publicMint": {
"description": "True if the contract is publicMint type",
"example": true,
"type": "boolean"
},
"fromPrivateKey": {
"description": "Private key of account address, from which gas for deployment of ERC1155 will be paid. Private key, or signature Id must be present.",
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "uri", "feeCurrency", "fromPrivateKey"]
},
"DeployMultiTokenCeloKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"uri": {
"description": "URI of the Multi Token contract",
"example": "example.com",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"publicMint": {
"description": "True if the contract is publicMint type",
"example": true,
"type": "boolean"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": { "type": "number", "minimum": 0 },
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "uri", "feeCurrency", "signatureId"]
},
"MintMultiTokenBatchKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"type": "array",
"description": "The blockchain address to send the Multi Tokens to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "The IDs of the Multi Tokens to be created.",
"example": [["100000", "100001"]],
"items": { "type": "array", "items": { "type": "string", "maxLength": 32 } }
},
"amounts": {
"type": "array",
"description": "The amounts of the Multi Tokens to be created.",
"example": [["100", "100"]],
"items": { "type": "array", "items": { "type": "string", "maxLength": 32 } }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the Multi Token smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "feeCurrency", "tokenId", "amounts", "signatureId"]
},
"BurnMultiTokenCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"account": {
"maxLength": 42,
"minLength": 42,
"description": "Address of holder",
"example": "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f",
"type": "string"
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"amount": {
"description": "amount of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": [
"chain",
"contractAddress",
"feeCurrency",
"fromPrivateKey",
"tokenId",
"amount",
"account"
]
},
"BurnMultiTokenBatchCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"account": {
"maxLength": 42,
"minLength": 42,
"description": "Address of holder",
"example": "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f",
"type": "string"
},
"tokenId": {
"description": "The IDs of the Multi Tokens to be destroyed.",
"example": ["100000"],
"type": "array",
"items": { "type": "string", "maxLength": 32 }
},
"amounts": {
"description": "The amounts of the Multi Tokens to be destroyed.",
"example": ["100000"],
"type": "array",
"items": { "type": "string" }
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the Multi Token smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": [
"chain",
"contractAddress",
"feeCurrency",
"fromPrivateKey",
"tokenId",
"amounts",
"account"
]
},
"BurnMultiTokenKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"account": {
"maxLength": 42,
"minLength": 42,
"description": "Address of holder",
"example": "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f",
"type": "string"
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"amount": {
"description": "amount of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "feeCurrency", "contractAddress", "tokenId", "amount", "signatureId", "account"]
},
"AddMultiTokenMinterKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "KLAY", "CELO", "ONE", "BSC"]
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of MultiToken token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"minter": {
"maxLength": 42,
"minLength": 42,
"description": "Address of MultiToken minter",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas, only valid for CELO chain.",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "url", "contractAddress", "minter", "signatureId"]
},
"AddMultiTokenMinter": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "MATIC", "KCS", "KLAY", "CELO", "ONE", "BSC"]
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of MultiToken token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"minter": {
"maxLength": 42,
"minLength": 42,
"description": "Address of MultiToken minter",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Ethereum transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas, only valid for CELO chain.",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["minter", "chain", "url", "contractAddress", "fromPrivateKey"]
},
"BurnMultiTokenBatchKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"account": {
"maxLength": 42,
"minLength": 42,
"description": "Address of holder",
"example": "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f",
"type": "string"
},
"tokenId": {
"description": "The IDs of the Multi Tokens to be destroyed.",
"example": ["100000"],
"type": "array",
"items": { "type": "string", "maxLength": 32 }
},
"amounts": {
"description": "The amounts of the Multi Tokens to be destroyed.",
"example": ["100000"],
"type": "array",
"items": { "type": "string" }
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the Multi Token smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": [
"chain",
"feeCurrency",
"contractAddress",
"tokenId",
"amounts",
"account",
"signatureId"
]
},
"TransferMultiTokenKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"amount": {
"description": "amount of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "feeCurrency", "signatureId", "tokenId", "amount"]
},
"TransferMultiTokenBatchKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": ["100000"],
"type": "array",
"items": { "type": "string" }
},
"amounts": {
"description": "amounts of token.",
"example": ["100000"],
"type": "array",
"items": { "type": "string" }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "contractAddress", "feeCurrency", "signatureId", "tokenId", "amounts"]
},
"MintMultiTokenCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"amount": {
"description": "amount of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "tokenId", "amount", "feeCurrency", "contractAddress", "fromPrivateKey"]
},
"MintMultiTokenBatchCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"tokenId": {
"type": "array",
"description": "The IDs of the Multi Tokens to be created.",
"example": [["100000", "100001"]],
"items": { "type": "array", "items": { "type": "string", "maxLength": 32 } }
},
"amounts": {
"type": "array",
"description": "The amounts of the Multi Tokens to be created.",
"example": [["100", "100"]],
"items": { "type": "array", "items": { "type": "string", "maxLength": 32 } }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"to": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address to send the Multi Tokens to",
"example": ["0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"],
"type": "array",
"items": { "type": "string" }
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the Multi Token smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "tokenId", "amounts", "feeCurrency", "contractAddress", "fromPrivateKey"]
},
"MintMultiTokenKMSCelo": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "CELO",
"description": "Chain to work with.",
"enum": ["CELO"]
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"amount": {
"description": "amount of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["chain", "to", "tokenId", "amount", "feeCurrency", "contractAddress", "signatureId"]
},
"TransferMultiToken": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC", "ALGO"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"amount": {
"description": "amount of token.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "contractAddress", "tokenId", "fromPrivateKey", "amount"]
},
"TransferMultiTokenBatch": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": ["100000"],
"type": "array",
"items": { "type": "string", "maxLength": 256 }
},
"amounts": {
"description": "amounts of token.",
"example": ["100000"],
"type": "array",
"maxLength": 256,
"items": { "type": "string", "maxLength": 32 }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "contractAddress", "tokenId", "amounts", "fromPrivateKey"]
},
"DeployMultiToken": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC"]
},
"uri": {
"description": "URI of the Multi Token token",
"example": "example.com",
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of account address, from which gas for deployment of ERC1155 will be paid. Private key, or signature Id must be present.",
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66
},
"publicMint": {
"description": "True if the contract is publicMint type",
"example": true,
"type": "boolean"
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["uri", "chain", "fromPrivateKey"]
},
"DeployMultiTokenKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC"]
},
"uri": {
"description": "URI of the Multi Token token",
"example": "example.com",
"type": "string"
},
"publicMint": {
"description": "True if the contract is publicMint type",
"example": true,
"type": "boolean"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["uri", "chain", "signatureId"]
},
"TransferMultiTokenKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC", "ALGO"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"amount": {
"description": "amount of token.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "contractAddress", "signatureId", "tokenId", "amount"]
},
"TransferMultiTokenBatchKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC"]
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": ["100000"],
"type": "array",
"items": { "type": "string", "maxLength": 256 }
},
"amount": {
"description": "amount of token.",
"example": ["100000"],
"type": "array",
"maxLength": 256,
"items": { "type": "string", "maxLength": 32 }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "contractAddress", "signatureId", "tokenId", "amount"]
},
"MintMultiToken": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC", "ALGO"]
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "amount of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "contractAddress", "fromPrivateKey", "tokenId", "amount"]
},
"MintMultiTokenKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC", "ALGO"]
},
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send Multi Token token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "amount of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "contractAddress", "signatureId", "tokenId", "amount"]
},
"MintMultiTokenBatch": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC"]
},
"to": {
"type": "array",
"description": "The blockchain address to send the Multi Tokens to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "The IDs of the Multi Tokens to be created.",
"example": [["100000", "100001"]],
"items": { "type": "array", "items": { "type": "string", "maxLength": 32 } }
},
"amounts": {
"type": "array",
"description": "The amounts of the Multi Tokens to be created.",
"example": [["100", "100"]],
"items": { "type": "array", "items": { "type": "string", "maxLength": 32 } }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the Multi Token smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "url", "contractAddress", "fromPrivateKey", "tokenId", "amounts"]
},
"MintMultiTokenBatchKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC"]
},
"to": {
"type": "array",
"description": "The blockchain address to send the Multi Tokens to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "The IDs of the Multi Tokens to be created.",
"example": [["100000", "100001"]],
"items": { "type": "array", "items": { "type": "string", "maxLength": 32 } }
},
"amounts": {
"type": "array",
"description": "The amounts of the Multi Tokens to be created.",
"example": [["100", "100"]],
"items": { "type": "array", "items": { "type": "string", "maxLength": 32 } }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the Multi Token smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "chain", "contractAddress", "tokenId", "url", "signatureId", "amounts"]
},
"BurnMultiToken": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC", "ALGO"]
},
"account": {
"maxLength": 42,
"minLength": 42,
"description": "Address of holder",
"example": "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f",
"type": "string"
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 103,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"amount": {
"description": "amount of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["account", "chain", "contractAddress", "fromPrivateKey", "tokenId", "amount"]
},
"BurnMultiTokenBatch": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC"]
},
"account": {
"maxLength": 42,
"minLength": 42,
"description": "Address of holder",
"example": "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f",
"type": "string"
},
"tokenId": {
"description": "The IDs of the Multi Tokens to be destroyed.",
"example": ["1000", "1001"],
"type": "array",
"items": { "type": "string", "maxLength": 32 }
},
"amounts": {
"description": "The amounts of the Multi Tokens to be destroyed.",
"example": ["10", "10"],
"type": "array",
"items": { "type": "string" }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the Multi Token smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["account", "amounts", "chain", "url", "contractAddress", "fromPrivateKey", "tokenId"]
},
"BurnMultiTokenKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC", "ALGO"]
},
"account": {
"maxLength": 42,
"minLength": 42,
"description": "Address of holder",
"example": "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f",
"type": "string"
},
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"amount": {
"description": "amount of token to be destroyed.",
"example": "100",
"type": "string",
"maxLength": 32
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of Multi Token token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["account", "chain", "amount", "contractAddress", "tokenId", "signatureId"]
},
"BurnMultiTokenBatchKMS": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"example": "ETH",
"description": "Chain to work with.",
"enum": ["ETH", "ONE", "MATIC", "KCS", "KLAY", "BSC"]
},
"account": {
"maxLength": 42,
"minLength": 42,
"description": "Address of holder",
"example": "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f",
"type": "string"
},
"tokenId": {
"description": "The IDs of the Multi Tokens to be destroyed.",
"example": ["100", "101"],
"type": "array",
"items": { "type": "string", "maxLength": 32 }
},
"amounts": {
"description": "The amounts of the Multi Tokens to be destroyed.",
"example": ["10", "10"],
"type": "array",
"items": { "type": "string" }
},
"data": { "description": "Data in bytes", "example": "0x1234", "type": "string" },
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the Multi Token smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["account", "chain", "amounts", "contractAddress", "tokenId", "signatureId"]
},
"SolanaBlock": {
"type": "object",
"properties": {
"blockHeight": { "type": "number", "example": 94778421 },
"blockTime": { "type": "number", "example": 1638279333 },
"blockhash": { "type": "string", "example": "Ch7qVhCkSqEvhWE8xzJZbJKRcsH6wtTjfiMJdt9eKiD7" },
"parentSlot": { "type": "number", "example": 97742681 },
"previousBlockhash": {
"type": "string",
"example": "C3vsoVwVWx7yPRhsNoKpcm2CJTrnVcvimdC4bd3jTPbj"
},
"rewards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"commission": { "type": "string", "format": "nullable" },
"lamports": { "type": "number", "example": 7 },
"postBalance": { "type": "number", "example": 10149491708073344 },
"pubkey": { "type": "string", "example": "ETSKPSzESbVdmtUn67LA2p9J1gPCSEgYvmJS9pNNWQqR" },
"rewardType": { "type": "string", "example": "Rent" }
}
}
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"err": { "type": "string", "format": "nullable" },
"fee": { "type": "number", "example": 5000 },
"innerInstructions": { "type": "array", "items": { "type": "object" } },
"logMessages": {
"type": "array",
"items": {
"type": "string",
"example": "Program Vote111111111111111111111111111111111111111 invoke [1]"
}
},
"postBalances": {
"type": "array",
"items": { "type": "number", "example": 1101768559544744 }
},
"postTokenBalances": {
"type": "array",
"items": { "type": "number", "example": 1101768559549744 }
},
"preBalances": {
"type": "array",
"items": { "type": "number", "example": 1101768559549744 }
},
"preTokenBalances": {
"type": "array",
"items": { "type": "number", "example": 1101768559549744 }
}
}
},
"transaction": {
"type": "object",
"properties": {
"message": {
"type": "object",
"properties": {
"header": {
"type": "object",
"properties": {
"numReadonlySignedAccounts": { "type": "number", "example": 0 },
"numReadonlyUnsignedAccounts": { "type": "number", "example": 3 },
"numRequiredSignatures": { "type": "number", "example": 1 }
}
},
"accountKeys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_bn": {
"type": "string",
"example": "0974de54f77afa9ad3d474909f6ce095b9623a359a5d08cc807b8a92dd5e1f96"
}
}
}
},
"recentBlockhash": {
"type": "string",
"example": "C3vsoVwVWx7yPRhsNoKpcm2CJTrnVcvimdC4bd3jTPbj"
},
"instructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accounts": { "type": "array", "items": { "type": "number", "example": 1 } },
"data": {
"type": "string",
"example": "2ZjTR1vUs2pHXyTM4rXnJowxekwfBcBJwsE4EameG3Sapvgfit27vrBd8k8QYCoTtMgfHEJLDqWEWBYUYVd"
},
"programIdIndex": { "type": "number", "example": 4 }
}
}
},
"indexToProgramIds": { "type": "object" }
}
},
"signatures": {
"type": "array",
"items": {
"type": "string",
"example": "5FPSzkTsjZDBigU3ZagvkcwSPimt4K6voqrN9uUNVzWDBeRXWVH3uMarDPpSfrS7sFQeyKyDd5KpbdCrL3EWEP59"
}
}
}
}
}
}
}
}
},
"SolanaTx": {
"type": "object",
"properties": {
"blockTime": { "type": "number", "example": 1638279975 },
"meta": {
"type": "object",
"properties": {
"err": { "type": "string", "format": "nullable" },
"fee": { "type": "number", "example": 5000 },
"innerInstructions": { "type": "array", "items": { "type": "object" } },
"logMessages": {
"type": "array",
"items": {
"type": "string",
"example": "Program 11111111111111111111111111111111 invoke [1]"
}
},
"postBalances": { "type": "array", "items": { "type": "number", "example": 987013800 } },
"postTokenBalances": { "type": "array", "items": { "type": "number", "example": 12345321 } },
"preBalances": { "type": "array", "items": { "type": "number", "example": 988018800 } },
"preTokenBalances": { "type": "array", "items": { "type": "number", "example": 12345321 } },
"rewards": { "type": "array", "items": { "type": "object" } },
"status": {
"type": "object",
"properties": { "Ok": { "type": "string", "format": "nullable" } }
}
}
},
"slot": { "type": "number", "example": 97744333 },
"transaction": {
"type": "object",
"properties": {
"message": {
"type": "object",
"properties": {
"header": {
"type": "object",
"properties": {
"numReadonlySignedAccounts": { "type": "number", "example": 0 },
"numReadonlyUnsignedAccounts": { "type": "number", "example": 1 },
"numRequiredSignatures": { "type": "number", "example": 1 }
}
},
"accountKeys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_bn": {
"type": "string",
"example": "de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad"
}
}
}
},
"recentBlockhash": {
"type": "string",
"example": "4pMdFUHg8bqTv19So2ZdvorGWqHwzFBmZL5wf8gDJ8Eh"
},
"instructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accounts": { "type": "array", "items": { "type": "number", "example": 0 } },
"data": { "type": "string", "example": "3Bxs4Bc3VYuGVB19" },
"programIdIndex": { "type": "number", "example": 2 }
}
}
},
"indexToProgramIds": { "type": "object" }
}
},
"signatures": {
"type": "array",
"items": {
"type": "string",
"example": "2ast4sMbp796obAKq5XDZnKf2truXdxC2u75c6UnzBeK5bZ7BjjZoE5uMy9pyr3dzxoakE67NvB7Cdgn21zE3BVG"
}
}
}
}
}
},
"Error403SolanaBroadcast": {
"properties": {
"errorCode": {
"description": "solana.broadcast.failed",
"example": "Solana.broadcast.failed",
"type": "string"
},
"message": {
"description": "Unable to broadcast transaction due to ${error}.",
"example": "Unable to broadcast transaction due to ${error}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403SolanaBroadcastConfirm": {
"properties": {
"errorCode": {
"description": "solana.broadcast.confirm.failed",
"example": "Solana.broadcast.confirm.failed",
"type": "string"
},
"message": {
"description": "Unexpected error occurred. Reason: ${error}.",
"example": "Unexpected error occurred. Reason: ${error}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403SolanaBep20NotFound": {
"properties": {
"errorCode": {
"description": "erc20.token.notFound",
"example": "erc20.token.notFound",
"type": "string"
},
"message": {
"description": "No such ERC20 currency ${name}.",
"example": "No such ERC20 currency ${name}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403SolanaTxHash": {
"properties": {
"errorCode": {
"description": "solana.transaction.hash",
"example": "solana.transaction.hash",
"type": "string"
},
"message": {
"description": "Unable to calculate transaction hash. ${error}",
"example": "Unable to calculate transaction hash. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403SolanaTxSign": {
"properties": {
"errorCode": {
"description": "solana.transaction.sign",
"example": "solana.transaction.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction. ${error}",
"example": "Unable to sign transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403SolanaTxBody": {
"properties": {
"errorCode": {
"description": "solana.transaction.body",
"example": "Solana.transaction.body",
"type": "string"
},
"message": {
"description": "Either currency, or tokenAddress must be defined.",
"example": "Either currency, or tokenAddress must be defined.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"TransferSolanaBlockchain": {
"type": "object",
"properties": {
"from": {
"description": "Blockchain address to send assets from",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"maxLength": 44,
"minLength": 44,
"type": "string"
},
"to": {
"description": "Blockchain address to send assets to",
"example": "FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU",
"maxLength": 44,
"minLength": 44,
"type": "string"
},
"amount": {
"description": "Amount to be sent in SOL.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 128,
"example": "zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv",
"minLength": 87,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "from", "fromPrivateKey"]
},
"TransferSolanaBlockchainKMS": {
"type": "object",
"properties": {
"from": {
"description": "Blockchain address to send assets from",
"example": "FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ",
"maxLength": 44,
"minLength": 44,
"type": "string"
},
"to": {
"description": "Blockchain address to send assets to",
"example": "FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU",
"maxLength": 44,
"minLength": 44,
"type": "string"
},
"amount": {
"description": "Amount to be sent in SOL.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "from", "signatureId"]
},
"SolanaBroadcastConfirm": {
"properties": {
"txData": {
"description": "Raw signed transaction to be published to network.",
"example": "01de391b34567fc65080dfe9e27170e2f9ac1cd1719878719feb74bb422d1795201df71fcf7349f5",
"maxLength": 500000,
"minLength": 1,
"type": "string"
},
"options": {
"description": "Options for sending and waiting for a transaction",
"type": "object",
"properties": {
"commitment": {
"type": "string",
"description": "Commitment to waiting for transaction confirmation",
"example": "confirmed",
"enum": ["confirmed", "finalized"]
},
"preflightCommitment": {
"type": "string",
"description": "Preflight Commitment.",
"example": "finalized",
"enum": ["confirmed", "finalized", "processed", "recent", "single", "singleGossip", "max"]
}
}
}
},
"required": ["txData"],
"type": "object"
},
"SolanaTransactionHashWithConfirm": {
"type": "object",
"properties": {
"txId": {
"description": "TX hash of successful transaction.",
"example": "5Sh63rNFg6iR9YUGPwEkbAg4kYSWnf5eRS2wcLG1Gc6psj27SGK3LNuN9jNSPKn3JoChgmq8pSirHWsPPWzy2PFw",
"type": "string"
},
"confirmed": {
"description": "Indicates whether or not the transferred commitment has been fulfilled",
"example": false,
"type": "boolean"
}
},
"required": ["txId", "confirmed"]
},
"BscBlock": {
"type": "object",
"properties": {
"difficulty": {
"description": "Difficulty for this block.",
"type": "string",
"example": "3296820833"
},
"extraData": {
"description": "The 'extra data' field of this block.",
"type": "string",
"example": "0x"
},
"gasLimit": {
"description": "The maximum gas allowed in this block.",
"type": "number",
"example": 8000000
},
"gasUsed": {
"description": "The total used gas by all transactions in this block.",
"type": "number",
"example": 7985124
},
"hash": {
"description": "Hash of the block. 'null' when its pending block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"logsBloom": {
"description": "The bloom filter for the logs of the block. 'null' when its pending block.",
"type": "string",
"example": "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
},
"miner": {
"description": "The address of the beneficiary to whom the mining rewards were given.",
"type": "string",
"example": "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
},
"mixHash": {
"description": "",
"type": "string",
"example": "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
},
"nonce": {
"description": "Hash of the generated proof-of-work. 'null' when its pending block.",
"type": "string",
"example": "0xfa1692f52a7ac672"
},
"number": {
"description": "The block number. 'null' when its pending block.",
"type": "number",
"example": 6470657
},
"parentHash": {
"description": "Hash of the parent block.",
"type": "string",
"example": "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
},
"receiptsRoot": {
"description": "",
"type": "string",
"example": "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
},
"sha3Uncles": {
"description": "SHA3 of the uncles data in the block.",
"type": "string",
"example": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
},
"size": { "description": "The size of this block in bytes.", "type": "number", "example": 15296 },
"stateRoot": {
"description": "The root of the final state trie of the block.",
"type": "string",
"example": "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
},
"timestamp": {
"description": "The unix timestamp for when the block was collated.",
"type": "number",
"example": 1569600592
},
"totalDifficulty": {
"description": "Total difficulty of the chain until this block.",
"type": "string",
"example": "23329673338013873"
},
"transactions": {
"description": "Array of transactions.",
"type": "array",
"items": { "$ref": "#/components/schemas/BscTx" }
},
"transactionsRoot": {
"description": "The root of the transaction trie of the block.",
"type": "string",
"example": "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
}
}
},
"BscTx": {
"type": "object",
"properties": {
"blockHash": {
"description": "Hash of the block where this transaction was in.",
"type": "string",
"example": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
},
"status": {
"type": "boolean",
"example": true,
"description": "TRUE if the transaction was successful, FALSE, if the EVM reverted the transaction."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"from": {
"type": "string",
"description": "Address of the sender.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"gas": { "type": "number", "description": "Gas provided by the sender.", "example": 21000 },
"gasPrice": {
"type": "string",
"description": "Gas price provided by the sender in wei.",
"example": "1000000000"
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
},
"input": {
"type": "string",
"description": "The data sent along with the transaction.",
"example": "0x"
},
"nonce": {
"type": "number",
"description": "The number of transactions made by the sender prior to this one.",
"example": 26836405
},
"to": {
"type": "string",
"description": "Address of the receiver. 'null' when its a contract creation transaction.",
"example": "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transactions index position in the block.",
"example": 3
},
"value": {
"type": "string",
"description": "Value transferred in wei.",
"example": "1000000000000000000"
},
"gasUsed": {
"type": "number",
"description": "The amount of gas used by this specific transaction alone.",
"example": 21000
},
"cumulativeGasUsed": {
"type": "number",
"description": "The total amount of gas used when this transaction was executed in the block.",
"example": 314159
},
"contractAddress": {
"type": "string",
"description": "The contract address created, if the transaction was a contract creation, otherwise null.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"logs": {
"type": "array",
"description": "Log events, that happened in this transaction.",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "From which this event originated from.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"topics": {
"type": "array",
"description": "An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.",
"items": {
"type": "string",
"example": "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
}
},
"data": { "type": "string", "description": "The data containing non-indexed log parameter." },
"logIndex": {
"type": "number",
"description": "Integer of the event index position in the block."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"blockHash": {
"description": "Hash of the block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transaction’s index position, the event was created in."
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction this event was created in.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
}
}
}
}
}
},
"Error403BscBroadcast": {
"properties": {
"errorCode": {
"description": "bsc.broadcast.failed",
"example": "bsc.broadcast.failed",
"type": "string"
},
"message": {
"description": "Unable to broadcast transaction due to ${error}.",
"example": "Unable to broadcast transaction due to ${error}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscBep20NotFound": {
"properties": {
"errorCode": {
"description": "erc20.token.notFound",
"example": "erc20.token.notFound",
"type": "string"
},
"message": {
"description": "No such BEP20 currency ${name}.",
"example": "No such BEP20 currency ${name}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscBep20Set": {
"properties": {
"errorCode": {
"description": "erc20.address.set",
"example": "erc20.address.set",
"type": "string"
},
"message": {
"description": "BEP20 address was already set.",
"example": "BEP20 address was already set.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscMnemonicPrivateKey": {
"properties": {
"errorCode": {
"description": "private.mnemonic.missing",
"example": "private.mnemonic.missing",
"type": "string"
},
"message": {
"description": "Either mnemonic and index or private key must be present.",
"example": "Either mnemonic and index or private key must be present.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscBep20Unsupported": {
"properties": {
"errorCode": {
"description": "bsc.bep20.unsupported",
"example": "bsc.bep20.unsupported",
"type": "string"
},
"message": {
"description": "Unsupported ETH BEP20 blockchain.",
"example": "Unsupported ETH BEP20 blockchain.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscTxHash": {
"properties": {
"errorCode": {
"description": "bsc.transaction.hash",
"example": "bsc.transaction.hash",
"type": "string"
},
"message": {
"description": "Unable to calculate transaction hash. ${error}",
"example": "Unable to calculate transaction hash. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscTxSign": {
"properties": {
"errorCode": {
"description": "bsc.transaction.sign",
"example": "bsc.transaction.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction. ${error}",
"example": "Unable to sign transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscErc20TxSign": {
"properties": {
"errorCode": { "description": "bsc.bep20.sign", "example": "bsc.bep20.sign", "type": "string" },
"message": {
"description": "Unable to sign transaction for contract creation. ${error}",
"example": "Unable to sign transaction for contract creation. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscGasCalculation": {
"properties": {
"errorCode": {
"description": "bsc.transaction.gas",
"example": "bsc.transaction.gas",
"type": "string"
},
"message": {
"description": "Unable to calculate gas limit for transaction. ${error}",
"example": "Unable to calculate gas limit for transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscTxBody": {
"properties": {
"errorCode": {
"description": "bsc.transaction.body",
"example": "bsc.transaction.body",
"type": "string"
},
"message": {
"description": "Either currency, or tokenAddress must be defined.",
"example": "Either currency, or tokenAddress must be defined.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscScBody": {
"properties": {
"errorCode": { "description": "bsc.sc.invalid", "example": "bsc.sc.invalid", "type": "string" },
"message": {
"description": "Invalid parameters for smart contract invocation.",
"example": "Invalid parameters for smart contract invocation.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403BscGasPrice": {
"properties": {
"errorCode": { "description": "gas.price.failed", "example": "gas.price.failed", "type": "string" },
"message": {
"description": "Unable to obtain current GAS price.",
"example": "Unable to obtain current GAS price.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"TransferBep20Blockchain": {
"type": "object",
"properties": {
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Kcs transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "contractAddress", "digits", "fromPrivateKey", "amount"]
},
"TransferBep20BlockchainKMS": {
"type": "object",
"properties": {
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Kcs transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "contractAddress", "signatureId", "digits", "amount"]
},
"CallBscSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
},
"amount": {
"description": "Amount of the assets to be sent.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to BSC transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "fromPrivateKey", "methodName"]
},
"CallBscSmartContractReadMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
}
},
"required": ["contractAddress", "params", "methodABI", "methodName"]
},
"CallBscSmartContractMethodKMS": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": { "type": "object", "description": "ABI of the method to invoke." },
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to BSC transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "signatureId", "methodName"]
},
"TransferBscBlockchain": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for BSC transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to BSC transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from BSC Blockchain Account. BEP20 tokens BETH, BBTC, BADA, WBNB, BDOT, BXRP, BLTC, BBCH are available only for mainnet use.",
"enum": [
"BSC",
"BETH",
"BBTC",
"RMD",
"USDC_BSC",
"B2U_BSC",
"BADA",
"WBNB",
"GMC_BSC",
"BDOT",
"BXRP",
"BLTC",
"BBCH",
"HAG",
"CAKE",
"BUSD_BSC"
],
"example": "BSC",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "fromPrivateKey"]
},
"BscEstimateGas": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 42,
"example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef",
"minLength": 42,
"description": "Sender address."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in BSC.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient.",
"pattern": "^(0x|0h)?[0-9A-F]+$"
}
},
"required": ["to", "amount", "from"]
},
"TransferBscBlockchainKMS": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for BSC transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to BSC transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from BSC Blockchain Account. BEP20 tokens BETH, BBTC, BADA, WBNB, BDOT, BXRP, BLTC, BBCH are available only for mainnet use.",
"enum": ["BETH", "BBTC", "BADA", "WBNB", "BDOT", "BXRP", "BLTC", "BBCH", "BSC"],
"example": "BSC",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "signatureId"]
},
"DeployBep20": {
"type": "object",
"properties": {
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Kcs blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 42,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Kcs account address, from which the fee for the deployment of ERC20 will be paid. Private key, or signature Id must be present.",
"type": "string",
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"maxLength": 66,
"minLength": 66
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Kcs transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["name", "symbol", "address", "supply", "fromPrivateKey", "digits"]
},
"DeployBep20KMS": {
"type": "object",
"properties": {
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Kcs blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 42,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Kcs transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["name", "symbol", "address", "supply", "signatureId", "digits"]
},
"PolygonBlock": {
"type": "object",
"properties": {
"difficulty": {
"description": "Difficulty for this block.",
"type": "string",
"example": "3296820833"
},
"extraData": {
"description": "The 'extra data' field of this block.",
"type": "string",
"example": "0x"
},
"gasLimit": {
"description": "The maximum gas allowed in this block.",
"type": "number",
"example": 8000000
},
"gasUsed": {
"description": "The total used gas by all transactions in this block.",
"type": "number",
"example": 7985124
},
"hash": {
"description": "Hash of the block. 'null' when its pending block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"logsBloom": {
"description": "The bloom filter for the logs of the block. 'null' when its pending block.",
"type": "string",
"example": "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
},
"miner": {
"description": "The address of the beneficiary to whom the mining rewards were given.",
"type": "string",
"example": "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
},
"mixHash": {
"description": "",
"type": "string",
"example": "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
},
"nonce": {
"description": "Hash of the generated proof-of-work. 'null' when its pending block.",
"type": "string",
"example": "0xfa1692f52a7ac672"
},
"number": {
"description": "The block number. 'null' when its pending block.",
"type": "number",
"example": 6470657
},
"parentHash": {
"description": "Hash of the parent block.",
"type": "string",
"example": "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
},
"receiptsRoot": {
"description": "",
"type": "string",
"example": "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
},
"sha3Uncles": {
"description": "SHA3 of the uncles data in the block.",
"type": "string",
"example": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
},
"size": { "description": "The size of this block in bytes.", "type": "number", "example": 15296 },
"stateRoot": {
"description": "The root of the final state trie of the block.",
"type": "string",
"example": "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
},
"timestamp": {
"description": "The unix timestamp for when the block was collated.",
"type": "number",
"example": 1569600592
},
"totalDifficulty": {
"description": "Total difficulty of the chain until this block.",
"type": "string",
"example": "23329673338013873"
},
"transactions": {
"description": "Array of transactions.",
"type": "array",
"items": { "$ref": "#/components/schemas/PolygonTx" }
},
"transactionsRoot": {
"description": "The root of the transaction trie of the block.",
"type": "string",
"example": "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
}
}
},
"PolygonTx": {
"type": "object",
"properties": {
"blockHash": {
"description": "Hash of the block where this transaction was in.",
"type": "string",
"example": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
},
"status": {
"type": "boolean",
"example": true,
"description": "TRUE if the transaction was successful, FALSE, if the EVM reverted the transaction."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"from": {
"type": "string",
"description": "Address of the sender.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"gas": { "type": "number", "description": "Gas provided by the sender.", "example": 21000 },
"gasPrice": {
"type": "string",
"description": "Gas price provided by the sender in wei.",
"example": "1000000000"
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
},
"input": {
"type": "string",
"description": "The data sent along with the transaction.",
"example": "0x"
},
"nonce": {
"type": "number",
"description": "The number of transactions made by the sender prior to this one.",
"example": 26836405
},
"to": {
"type": "string",
"description": "Address of the receiver. 'null' when its a contract creation transaction.",
"example": "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transactions index position in the block.",
"example": 3
},
"value": {
"type": "string",
"description": "Value transferred in wei.",
"example": "1000000000000000000"
},
"gasUsed": {
"type": "number",
"description": "The amount of gas used by this specific transaction alone.",
"example": 21000
},
"cumulativeGasUsed": {
"type": "number",
"description": "The total amount of gas used when this transaction was executed in the block.",
"example": 314159
},
"contractAddress": {
"type": "string",
"description": "The contract address created, if the transaction was a contract creation, otherwise null.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"logs": {
"type": "array",
"description": "Log events, that happened in this transaction.",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "From which this event originated from.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"topics": {
"type": "array",
"description": "An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.",
"items": {
"type": "string",
"example": "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
}
},
"data": { "type": "string", "description": "The data containing non-indexed log parameter." },
"logIndex": {
"type": "number",
"description": "Integer of the event index position in the block."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"blockHash": {
"description": "Hash of the block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transaction’s index position, the event was created in."
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction this event was created in.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
}
}
}
}
}
},
"Error403PolygonBroadcast": {
"properties": {
"errorCode": {
"description": "polygon.broadcast.failed",
"example": "polygon.broadcast.failed",
"type": "string"
},
"message": {
"description": "Unable to broadcast transaction due to ${error}.",
"example": "Unable to broadcast transaction due to ${error}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonBep20NotFound": {
"properties": {
"errorCode": {
"description": "erc20.token.notFound",
"example": "erc20.token.notFound",
"type": "string"
},
"message": {
"description": "No such ERC20 currency ${name}.",
"example": "No such ERC20 currency ${name}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonBep20Set": {
"properties": {
"errorCode": {
"description": "erc20.address.set",
"example": "erc20.address.set",
"type": "string"
},
"message": {
"description": "ERC20 address was already set.",
"example": "ERC20 address was already set.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonMnemonicPrivateKey": {
"properties": {
"errorCode": {
"description": "private.mnemonic.missing",
"example": "private.mnemonic.missing",
"type": "string"
},
"message": {
"description": "Either mnemonic and index or private key must be present.",
"example": "Either mnemonic and index or private key must be present.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonBep20Unsupported": {
"properties": {
"errorCode": {
"description": "polygon.bep20.unsupported",
"example": "polygon.bep20.unsupported",
"type": "string"
},
"message": {
"description": "Unsupported ETH ERC20 blockchain.",
"example": "Unsupported ETH ERC20 blockchain.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonTxHash": {
"properties": {
"errorCode": {
"description": "polygon.transaction.hash",
"example": "polygon.transaction.hash",
"type": "string"
},
"message": {
"description": "Unable to calculate transaction hash. ${error}",
"example": "Unable to calculate transaction hash. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonTxSign": {
"properties": {
"errorCode": {
"description": "polygon.transaction.sign",
"example": "polygon.transaction.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction. ${error}",
"example": "Unable to sign transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonErc20TxSign": {
"properties": {
"errorCode": {
"description": "polygon.bep20.sign",
"example": "polygon.bep20.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction for contract creation. ${error}",
"example": "Unable to sign transaction for contract creation. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonGasCalculation": {
"properties": {
"errorCode": {
"description": "polygon.transaction.gas",
"example": "polygon.transaction.gas",
"type": "string"
},
"message": {
"description": "Unable to calculate gas limit for transaction. ${error}",
"example": "Unable to calculate gas limit for transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonTxBody": {
"properties": {
"errorCode": {
"description": "polygon.transaction.body",
"example": "polygon.transaction.body",
"type": "string"
},
"message": {
"description": "Either currency, or tokenAddress must be defined.",
"example": "Either currency, or tokenAddress must be defined.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonScBody": {
"properties": {
"errorCode": {
"description": "polygon.sc.invalid",
"example": "polygon.sc.invalid",
"type": "string"
},
"message": {
"description": "Invalid parameters for smart contract invocation.",
"example": "Invalid parameters for smart contract invocation.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403PolygonGasPrice": {
"properties": {
"errorCode": { "description": "gas.price.failed", "example": "gas.price.failed", "type": "string" },
"message": {
"description": "Unable to obtain current GAS price.",
"example": "Unable to obtain current GAS price.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"CallPolygonSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount of the assets to be sent.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Polygon transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "fromPrivateKey", "methodName"]
},
"CallPolygonSmartContractMethodCaller": {
"type": "object",
"properties": {
"caller": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the account, which will be sender and fee payer of this transaction",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount of the assets to be sent.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "fromPrivateKey", "methodName", "caller"]
},
"CallPolygonSmartContractReadMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
}
},
"required": ["contractAddress", "params", "methodABI", "methodName"]
},
"CallPolygonSmartContractMethodKMS": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": { "type": "object", "description": "ABI of the method to invoke." },
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Polygon transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "signatureId", "methodName"]
},
"TransferPolygonBlockchain": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for MATIC transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Polygon transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from Polygon Blockchain Account. ERC20 tokens USDC and USDT are available only for mainnet use.",
"enum": ["MATIC", "USDC_MATIC", "USDT_MATIC"],
"example": "MATIC",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "fromPrivateKey"]
},
"PolygonEstimateGas": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 42,
"example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef",
"minLength": 42,
"description": "Sender address."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in MATIC.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient.",
"pattern": "^(0x|0h)?[0-9A-F]+$"
}
},
"required": ["to", "amount", "from"]
},
"TransferPolygonBlockchainKMS": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for MATIC transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Polygon transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from Polygon Blockchain Account. ERC20 tokens BETH, BBTC, BADA, WMATIC, BDOT, BXRP, BLTC, BBCH are available only for mainnet use.",
"enum": ["BETH", "BBTC", "BADA", "WMATIC", "BDOT", "BXRP", "BLTC", "BBCH", "MATIC"],
"example": "MATIC",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "signatureId"]
},
"Error403Celo": {
"properties": {
"errorCode": { "description": "celo.error", "example": "celo.error", "type": "string" },
"message": {
"description": "Unexpected error occurred. Reason: ${reason}",
"example": "Unexpected error occurred. Reason: ${reason}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"TransferErc721Celo": {
"type": "object",
"properties": {
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC721 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "contractAddress", "tokenId", "fromPrivateKey"]
},
"TransferErc721KMSCelo": {
"type": "object",
"properties": {
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC721 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"tokenId": {
"description": "ID of token.",
"example": "100000",
"type": "string",
"maxLength": 256
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"example": 1,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "contractAddress", "feeCurrency", "signatureId", "tokenId"]
},
"MintErc721Celo": {
"type": "object",
"properties": {
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC721 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "url", "feeCurrency", "contractAddress", "fromPrivateKey", "tokenId"]
},
"MintErc721KMSCelo": {
"type": "object",
"properties": {
"tokenId": {
"description": "ID of token to be created.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC721 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"example": "https://my_token_data.com",
"type": "string",
"maxLength": 256
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "url", "feeCurrency", "contractAddress", "signatureId", "tokenId"]
},
"MintErc20Celo": {
"type": "object",
"properties": {
"amount": {
"description": "Amount to be minted and transfered to the recipient.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC-20 tokens to.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "amount", "feeCurrency", "contractAddress", "fromPrivateKey"]
},
"MintErc20KMSCelo": {
"type": "object",
"properties": {
"amount": {
"description": "Amount to be minted and transfered to the recipient.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"to": {
"maxLength": 42,
"minLength": 42,
"description": "Blockchain address to send ERC-20 tokens to.",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC-20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "amount", "feeCurrency", "contractAddress", "signatureId"]
},
"MintMultipleErc721Celo": {
"type": "object",
"properties": {
"to": {
"type": "array",
"description": "Blockchain address to send ERC721 token to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"type": "array",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "contractAddress", "url", "fromPrivateKey", "feeCurrency", "tokenId"]
},
"MintMultipleErc721KMSCelo": {
"type": "object",
"properties": {
"to": {
"type": "array",
"description": "Blockchain address to send ERC721 token to.",
"example": ["0x687422eEA2cB73B5d3e242bA5456b782919AFc85"],
"items": { "maxLength": 42, "minLength": 42, "type": "string" }
},
"tokenId": {
"type": "array",
"description": "ID of token to be created.",
"example": ["100000"],
"items": { "type": "string", "maxLength": 32 }
},
"url": {
"description": "Metadata of the token. See https://eips.ethereum.org/EIPS/eip-721#specification for more details.",
"type": "array",
"example": ["https://my_token_data.com"],
"items": { "type": "string", "maxLength": 256 }
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "contractAddress", "feeCurrency", "tokenId", "url", "signatureId"]
},
"BurnErc721Celo": {
"type": "object",
"properties": {
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["contractAddress", "feeCurrency", "fromPrivateKey", "tokenId"]
},
"BurnErc721KMSCelo": {
"type": "object",
"properties": {
"tokenId": {
"description": "ID of token to be destroyed.",
"example": "100000",
"type": "string",
"maxLength": 32
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["feeCurrency", "contractAddress", "tokenId", "signatureId"]
},
"BurnErc20Celo": {
"type": "object",
"properties": {
"amount": {
"description": "Amount of tokens to be destroyed.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["contractAddress", "feeCurrency", "fromPrivateKey", "amount"]
},
"BurnErc20KMSCelo": {
"type": "object",
"properties": {
"amount": {
"description": "Amount of tokens to be destroyed.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC721 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["feeCurrency", "contractAddress", "tokenId", "amount"]
},
"TransferCeloBlockchain": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additinal data, that can be passed to blockchain transaction as data property. Only for ETH transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"type": "string",
"description": "Currency of the transaction",
"enum": ["CELO", "CUSD", "CEUR"]
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"amount": {
"description": "Amount to be sent in Celoer.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "fromPrivateKey", "currency", "feeCurrency"]
},
"TransferCeloBlockchainKMS": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additinal data, that can be passed to blockchain transaction as data property. Only for ETH transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"currency": {
"type": "string",
"description": "Currency of the transaction",
"enum": ["CELO", "CUSD", "CEUR"]
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
},
"amount": {
"description": "Amount to be sent in Celoer.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "feeCurrency", "currency", "amount", "signatureId"]
},
"CeloEstimateGas": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 42,
"example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef",
"minLength": 42,
"description": "Sender address."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additinal data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient.",
"pattern": "^(0x|0h)?[0-9A-F]+$"
}
},
"required": ["to", "amount", "from"]
},
"CeloBlock": {
"type": "object",
"properties": {
"difficulty": {
"description": "Difficulty for this block.",
"type": "string",
"example": "3296820833"
},
"extraData": {
"description": "The 'extra data' field of this block.",
"type": "string",
"example": "0x"
},
"gasLimit": {
"description": "The maximum gas allowed in this block.",
"type": "number",
"example": 8000000
},
"gasUsed": {
"description": "The total used gas by all transactions in this block.",
"type": "number",
"example": 7985124
},
"hash": {
"description": "Hash of the block. 'null' when its pending block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"logsBloom": {
"description": "The bloom filter for the logs of the block. 'null' when its pending block.",
"type": "string",
"example": "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
},
"miner": {
"description": "The address of the beneficiary to whom the mining rewards were given.",
"type": "string",
"example": "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
},
"mixHash": {
"description": "",
"type": "string",
"example": "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
},
"nonce": {
"description": "Hash of the generated proof-of-work. 'null' when its pending block.",
"type": "string",
"example": "0xfa1692f52a7ac672"
},
"number": {
"description": "The block number. 'null' when its pending block.",
"type": "number",
"example": 6470657
},
"parentHash": {
"description": "Hash of the parent block.",
"type": "string",
"example": "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
},
"receiptsRoot": {
"description": "",
"type": "string",
"example": "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
},
"sha3Uncles": {
"description": "SHA3 of the uncles data in the block.",
"type": "string",
"example": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
},
"size": { "description": "The size of this block in bytes.", "type": "number", "example": 15296 },
"stateRoot": {
"description": "The root of the final state trie of the block.",
"type": "string",
"example": "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
},
"timestamp": {
"description": "The unix timestamp for when the block was collated.",
"type": "number",
"example": 1569600592
},
"totalDifficulty": {
"description": "Total difficulty of the chain until this block.",
"type": "string",
"example": "23329673338013873"
},
"transactions": {
"description": "Array of transactions.",
"type": "array",
"items": { "$ref": "#/components/schemas/CeloTx" }
},
"transactionsRoot": {
"description": "The root of the transaction trie of the block.",
"type": "string",
"example": "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
}
}
},
"CeloTx": {
"type": "object",
"properties": {
"blockHash": {
"description": "Hash of the block where this transaction was in.",
"type": "string",
"example": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
},
"status": {
"type": "boolean",
"example": true,
"description": "TRUE if the transaction was successful, FALSE, if the EVM reverted the transaction."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"from": {
"type": "string",
"description": "Address of the sender.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"gas": { "type": "number", "description": "Gas provided by the sender.", "example": 21000 },
"gasPrice": {
"type": "string",
"description": "Gas price provided by the sender in wei.",
"example": "1000000000"
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
},
"input": {
"type": "string",
"description": "The data sent along with the transaction.",
"example": "0x"
},
"nonce": {
"type": "number",
"description": "The number of transactions made by the sender prior to this one.",
"example": 26836405
},
"to": {
"type": "string",
"description": "Address of the receiver. 'null' when its a contract creation transaction.",
"example": "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transactions index position in the block.",
"example": 3
},
"value": {
"type": "string",
"description": "Value transferred in wei.",
"example": "1000000000000000000"
},
"gasUsed": {
"type": "number",
"description": "The amount of gas used by this specific transaction alone.",
"example": 21000
},
"cumulativeGasUsed": {
"type": "number",
"description": "The total amount of gas used when this transaction was executed in the block.",
"example": 314159
},
"contractAddress": {
"type": "string",
"description": "The contract address created, if the transaction was a contract creation, otherwise null.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"logs": {
"type": "array",
"description": "Log events, that happened in this transaction.",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "From which this event originated from.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"topics": {
"type": "array",
"description": "An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.",
"items": {
"type": "string",
"example": "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
}
},
"data": { "type": "string", "description": "The data containing non-indexed log parameter." },
"logIndex": {
"type": "number",
"description": "Integer of the event index position in the block."
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transaction’s index position, the event was created in."
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction this event was created in.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
}
}
}
}
}
},
"DeployErc721Celo": {
"type": "object",
"properties": {
"name": {
"description": "Name of the ERC721 token",
"example": "My ERC721",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"symbol": {
"description": "Symbol of the ERC721 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Celo account address, from which gas for deployment of ERC721 will be paid. Private key, or signature Id must be present.",
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["name", "symbol", "feeCurrency", "fromPrivateKey"]
},
"DeployErc721CeloKMS": {
"type": "object",
"properties": {
"name": {
"description": "Name of the ERC721 token",
"example": "My ERC721",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"symbol": {
"description": "Symbol of the ERC721 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": { "type": "number", "minimum": 0 },
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["name", "symbol", "feeCurrency", "signatureId"]
},
"DeployErc20Celo": {
"type": "object",
"properties": {
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Celo blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 42,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"fromPrivateKey": {
"description": "Private key of Celo account address, from which the fee for the deployment of ERC20 will be paid. Private key, or signature Id must be present.",
"type": "string",
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"maxLength": 66,
"minLength": 66
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["name", "symbol", "address", "supply", "fromPrivateKey", "digits", "feeCurrency"]
},
"DeployErc20KMSCelo": {
"type": "object",
"properties": {
"symbol": {
"description": "Symbol of the ERC20 token",
"example": "ERC_SYMBOL",
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the ERC20 token",
"example": "MyERC20",
"maxLength": 100,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"totalCap": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"supply": {
"description": "Max supply of ERC20 token.",
"maxLength": 38,
"example": "10000000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"digits": {
"description": "Number of decimal points",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"address": {
"description": "Address on Celo blockchain, where all created ERC20 tokens will be transferred.",
"maxLength": 42,
"minLength": 42,
"example": "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["name", "symbol", "address", "supply", "signatureId", "digits", "feeCurrency"]
},
"CallCeloReadSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
}
},
"required": ["contractAddress", "params", "methodABI", "methodName"]
},
"CallCeloSmartContractMethodKMS": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": { "type": "object", "description": "ABI of the method to invoke." },
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["contractAddress", "params", "methodABI", "signatureId", "methodName", "feeCurrency"]
},
"TransferErc20Celo": {
"type": "object",
"properties": {
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "contractAddress", "digits", "feeCurrency", "fromPrivateKey", "amount"]
},
"TransferErc20CeloKMS": {
"type": "object",
"properties": {
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Celo transaction. If not present, last known nonce will be used."
},
"feeCurrency": {
"type": "string",
"description": "Currency to pay for transaction gas",
"enum": ["CELO", "CUSD", "CEUR"]
}
},
"required": ["to", "contractAddress", "signatureId", "digits", "amount", "feeCurrency"]
},
"Error403CeloGasCalculation": {
"properties": {
"errorCode": {
"description": "celo.transaction.gas",
"example": "celo.transaction.gas",
"type": "string"
},
"message": {
"description": "Unable to calculate gas limit for transaction. ${error}",
"example": "Unable to calculate gas limit for transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403CeloTxBody": {
"properties": {
"errorCode": {
"description": "celo.transaction.body",
"example": "celo.transaction.body",
"type": "string"
},
"message": {
"description": "Either currency, or tokenAddress must be defined.",
"example": "Either currency, or tokenAddress must be defined.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"EgldBlock": {
"type": "object",
"properties": {
"nonce": { "description": "The block height.", "type": "number", "example": 5440076 },
"round": { "description": "The round number.", "type": "number", "example": 186582 },
"hash": {
"description": "Hash of the block.",
"type": "string",
"example": "bd2de3618929b696807f6ef8a619f93d29d639aec9277f9c6f8569a8487141b1"
},
"prevBlockHash": {
"description": "Hash of the previous block.",
"type": "string",
"example": "2a11aad21e933be58200839ff875f0ca7e955b8c483a0e117cb92409e5d2a5da"
},
"epoch": {
"description": "An epoch is a sequence of consecutive rounds during which the configuration of the network does not change (currently aprox. 24 hrs in length).",
"type": "number",
"example": 18
},
"numTxs": {
"description": "Number of transactions in current block.",
"type": "number",
"example": 8
},
"shardBlocks": {
"description": "Array of shard blocks",
"type": "array",
"items": { "$ref": "#/components/schemas/EgldShardBlock" }
},
"transactions": {
"description": "Array of transactions.",
"type": "array",
"items": { "$ref": "#/components/schemas/EgldTx" }
}
}
},
"EgldShardBlock": {
"type": "object",
"properties": {
"hash": {
"description": "The block hash.",
"type": "string",
"example": "a6f2ac15a6b1bafdde9afff2297cef49c4c523c516f8ee12fed54be070e9512b"
},
"nonce": { "description": "The block height.", "type": "number", "example": 5440070 },
"shard": { "description": "The shard number.", "type": "number", "example": 1 }
}
},
"EgldTx": {
"type": "object",
"properties": {
"type": { "type": "string", "description": "Type of transaction.", "example": null },
"nonce": { "type": "number", "description": "Nonce of the transaction.", "example": 2 },
"round": { "type": "number", "description": "The round number.", "example": 186580 },
"epoch": {
"type": "number",
"description": "An epoch is a sequence of consecutive rounds during which the configuration of the network does not change (currently aprox. 24 hrs in length).",
"example": 12
},
"value": {
"type": "string",
"description": "Transferred value.",
"example": "1000000000000000000"
},
"receiver": {
"type": "string",
"description": "Address of the receiver.",
"example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7"
},
"sender": {
"type": "string",
"description": "Address of the sender.",
"example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq1"
},
"gasPrice": {
"type": "number",
"description": "Gas price provided by the sender",
"example": 1000000000
},
"gasLimit": { "type": "number", "description": "Gas provided by the sender", "example": 70000 },
"data": {
"type": "string",
"description": "Data field in transaction.",
"example": "Zm9yIHRlc3Rz"
},
"signature": {
"type": "string",
"description": "Signature of the transaction.",
"example": "c6ab10b401f14b122caf9d2ef80d532b986aa82b589dac77d77929da27ae2382c6ab10b401f14b122caf9d2ef80d532b986aa82b589dac77d77929da27ae238"
},
"sourceShard": { "type": "number", "description": "Source shard.", "example": 2 },
"destinationShard": { "type": "number", "description": "Destination shard.", "example": 1 },
"blockNonce": {
"type": "number",
"description": "Nonce of block which contains current transaction.",
"example": 186535
},
"blockHash": {
"type": "string",
"description": "Hash of block which contains current transaction.",
"example": "bd2de3618929b696807f6ef8a619f93d29d639aec9277f9c6f8569a8487141b1"
},
"miniblockHash": {
"type": "string",
"description": "Miniblock hash.",
"example": "7cb0a10cf9e9ec9ff719ffe99349db3feac3ec217b6de62f6cf7756647194bbf"
},
"timestamp": {
"type": "number",
"description": "The unix timestamp for when the block was collated.",
"example": 1569600592
},
"status": { "type": "string", "description": "Status of the transaction.", "example": "Success" },
"hyperblockNonce": {
"type": "number",
"description": "Nonce of the hyperblockwhere this transaction was in.",
"example": 123321
},
"hyperblockHash": {
"type": "string",
"description": "Hash of the hyperblock where this transaction was in.",
"example": "715224f1f7d8330e3837500d1f82431954e30db6149f3ee4644d0950576d8dfe"
}
}
},
"Error403EgldBroadcast": {
"properties": {
"errorCode": {
"description": "egld.broadcast.failed",
"example": "egld.broadcast.failed",
"type": "string"
},
"message": {
"description": "Unable to broadcast transaction due to ${error}.",
"example": "Unable to broadcast transaction due to ${error}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403EgldTxHash": {
"properties": {
"errorCode": {
"description": "egld.transaction.hash",
"example": "egld.transaction.hash",
"type": "string"
},
"message": {
"description": "Unable to calculate transaction hash. ${error}",
"example": "Unable to calculate transaction hash. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403EgldTxSign": {
"properties": {
"errorCode": {
"description": "egld.transaction.sign",
"example": "egld.transaction.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction. ${error}",
"example": "Unable to sign transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"TransferEgldBlockchain": {
"type": "object",
"properties": {
"from": {
"description": "Account address of the sender",
"example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7",
"maxLength": 62,
"minLength": 62,
"type": "string"
},
"to": {
"description": "Account address of the receiver or smart contract",
"example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq6",
"maxLength": 62,
"minLength": 62,
"type": "string"
},
"amount": { "type": "string", "description": "Value to be sent.", "example": "0" },
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction. If transfer to a smart contract, then 500000 + an appropriate amount for the method call",
"example": "500000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price.",
"example": "1000000000",
"pattern": "^[+]?\\d+$"
}
}
},
"data": {
"description": "Additinal data, that will be passed to blockchain transaction as data property.",
"type": "string",
"example": "Hello world"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 64,
"minLength": 64,
"example": "0cd8e6217b4a218807b858ffb508483cdcdadbb7a21196727f764a510a692760",
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["fromPrivateKey", "from", "to", "amount"]
},
"TransferEgldBlockchainKMS": {
"type": "object",
"properties": {
"from": {
"description": "Account address of the sender",
"example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7",
"maxLength": 62,
"minLength": 62,
"type": "string"
},
"to": {
"description": "Account address of the receiver or smart contract",
"example": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq6",
"maxLength": 62,
"minLength": 62,
"type": "string"
},
"amount": { "type": "string", "description": "Value to be sent.", "example": "0" },
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction.",
"example": "500000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price.",
"example": "1000000000",
"pattern": "^[+]?\\d+$"
}
}
},
"data": {
"description": "Additinal data, that will be passed to blockchain transaction as data property.",
"type": "string",
"example": "Hello world"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["signatureId", "from", "to", "amount"]
},
"AlgoWallet": {
"type": "object",
"properties": {
"address": {
"maxLength": 58,
"minLength": 58,
"description": "address of Algorand account.",
"example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y",
"type": "string"
},
"secret": {
"maxLength": 103,
"minLength": 103,
"description": "secretKey can generate Mnemonic, similar to private Key.",
"type": "string",
"example": "NBYMCVEEDFYV3TPWVRE6APE7PKHUJD4XAKXCKNCLKGUXOC3LFNJGZQCJCRA53HB7ZAHF6NFJH2QIVQ5USQNWG35QCJLD4KZ5IWMB24Q"
}
}
},
"AlgoBlock": {
"type": "object",
"properties": {
"genesisHash": {
"description": "hash to which this block belongs",
"type": "string",
"example": "SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI="
},
"genesisId": {
"description": "ID to which this block belongs",
"type": "string",
"example": "testnet-v1.0"
},
"previousBlockHash": {
"description": "Previous block hash",
"type": "string",
"example": "JeLGQTbqnBsD3NXE8Bf1TpPFMFadEVVyHhkcD61ljAU="
},
"rewards": {
"description": "rewards",
"type": "object",
"example": {
"fee-sink": "A7NMWS3NT3IUDMLVO26ULGXGIIOUQ3ND2TXSER6EBGRZNOBOUIQXHIBGDE",
"rewards-calculation-round": 17000000,
"rewards-level": 27521,
"rewards-pool": "7777777777777777777777777777777777777777777777777774MSJUVU",
"rewards-rate": 0,
"rewards-residue": 2020197303
}
},
"round": {
"description": "Current round on which this block was appended to the chain",
"type": "number",
"example": 16775567
},
"seed": {
"description": "Sortition seed.",
"type": "string",
"example": "VPBpyrHyqbfqrHqJ3l39LXGN4qgEdNnE5kpJfk3vJtA="
},
"timestamp": {
"description": "Block creation timestamp in seconds since eposh",
"type": "number",
"example": 1632167753
},
"txns": {
"description": "Array of transactions",
"type": "array",
"items": { "$ref": "#/components/schemas/AlgoTx" }
},
"txn": {
"description": "TransactionsRoot authenticates the set of transactions appearing in the block.",
"type": "string",
"example": "++MWW82yIvYQ0AEoPP0aDGGHGk/dSp5WHlbkf9SVU1U="
},
"txnc": {
"description": "TxnCounter counts the number of transations committed in the ledger",
"type": "number",
"example": 27814470
},
"upgradeState": {
"description": "upgrade state",
"type": "object",
"example": {
"current-protocol": "https://github.com/algorandfoundation/specs/tree/abc54f79f9ad679d2d22f0fb9909fb005c16f8a1",
"next-protocol-approvals": 0,
"next-protocol-switch-on": 0,
"next-protocol-vote-before": 0
}
},
"upgradeVote": {
"description": "upgrade vote",
"type": "object",
"example": { "upgrade-approve": false, "upgrade-delay": 0 }
}
}
},
"AlgoTx": {
"type": "object",
"properties": {
"closeRewards": {
"description": "rewards applied to close-remainder-to account.",
"type": "number",
"example": 0
},
"closingAmount": {
"description": "closing amount for transaction.",
"type": "number",
"example": 0
},
"confirmedRound": {
"description": "Round when the transaction was confirmed.",
"type": "number",
"example": 16775567
},
"fee": { "description": "Transaction fee", "type": "number", "example": 0.001 },
"firstValid": {
"description": "First valid round for this transaction.",
"type": "number",
"example": 16775565
},
"genesisHash": {
"description": "Hash of genesis block",
"type": "string",
"example": "SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI="
},
"genesisId": { "description": "genesis block ID.", "type": "string", "example": "testnet-v1.0" },
"id": {
"description": "transaction ID",
"type": "string",
"example": "HNIQ76UTJYPOLZP5FWODYABBJPYPGJNEM2QEJSMDMQRWEKHEYJHQ"
},
"intraRoundOffset": {
"description": "Offset into the round where this transaction was confirmed.",
"type": "number",
"example": 1
},
"lastValid": {
"description": "Last valid round for this transaction.",
"type": "number",
"example": 16775571
},
"note": {
"description": "Free form data",
"type": "string",
"example": "cGluZ3Bvbmf0Jyl21QrtLw=="
},
"paymentTransaction": { "description": "payment Transaction", "type": "object" },
"receiverRewards": {
"description": "rewards applied to receiver account.",
"type": "number",
"example": 0
},
"roundTime": {
"description": "Time when the block this transaction is in was confirmed.",
"type": "number",
"example": 1632167753
},
"sender": {
"description": "Sender's address",
"type": "string",
"example": "U6QEM4KM7KKGCLH4FELZBGJEVVSF556ELXHUOZC4ESPFS4O4V4VQXKQRXQ"
},
"senderRewards": {
"description": "rewards applied to sender account.",
"type": "number",
"example": 0
},
"signature": { "description": "signature", "type": "object" },
"txType": {
"description": "indicates what type of transaction this is. Different types have differnet fields.",
"type": "string",
"example": "pay"
}
}
},
"AlgoTxsWithPagination": {
"type": "object",
"properties": {
"nextToken": {
"description": "Used for pagination, when making another request provide this token with the next parameter.",
"type": "string",
"example": "ywAAAAAAAAAAAAAA"
},
"transactions": {
"description": "Array of transactions.",
"type": "array",
"items": { "$ref": "#/components/schemas/AlgoTx" }
}
}
},
"TransferAlgorandBlockchain": {
"type": "object",
"properties": {
"from": {
"description": "The blockchain address of the sender",
"type": "string",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4"
},
"to": {
"description": "The blockchain address of the recipient",
"type": "string",
"example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y"
},
"fee": { "description": "The transaction fee in Algos", "type": "string", "example": "0.001" },
"amount": { "description": "The amount to send in Algos", "type": "string", "example": "1" },
"note": {
"description": "The note for the recipient; must not contain spaces",
"type": "string",
"example": "Helloworld"
},
"fromPrivateKey": {
"description": "Private key of sender address. Private key, or signature Id must be present.",
"type": "string",
"example": "72TCV5BRQPBMSAFPYO3CPWVDBYWNGAYNMTW5QHENOMQF7I6QLNMJWCJZ7A3V5YKD7QD6ZZPEHG2PV2ZVVEDDO6BCRGXWIL3DIUMSUCI"
}
},
"required": ["from", "to", "amount", "fromPrivateKey", "fee"]
},
"ReceiveAlgorandAsset": {
"type": "object",
"properties": {
"assetId": {
"description": "AssetID of the asset you wanna enable for the sender.",
"type": "string",
"example": "0.001"
},
"fromPrivateKey": {
"description": "Private key of sender address. Private key, or signature Id must be present.",
"type": "string",
"example": "72TCV5BRQPBMSAFPYO3CPWVDBYWNGAYNMTW5QHENOMQF7I6QLNMJWCJZ7A3V5YKD7QD6ZZPEHG2PV2ZVVEDDO6BCRGXWIL3DIUMSUCI"
}
},
"required": ["assetId", "fromPrivateKey"]
},
"ReceiveAlgorandAssetKMS": {
"type": "object",
"properties": {
"from": {
"description": "Blockchain sender address.",
"type": "string",
"minLength": 58,
"maxLength": 58,
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4"
},
"assetId": {
"description": "AssetID of the asset you wanna enable for the sender.",
"type": "number",
"example": 98745612
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["assetId", "from", "signatureId"]
},
"AlgoTransactionHashKMS": {
"type": "object",
"properties": {
"txId": {
"description": "TX hash of transaction.",
"example": "GTNOIDCIHZLESKNQPJXOXE476ODYDNNQBA3N2Q75MYQ4SI4XL5SA",
"type": "string"
},
"assetIndex": {
"description": "If transaction created new ASA asset, this value is the index of the asset on the network.",
"example": 87751984,
"type": "number"
},
"confirmed": {
"example": false,
"type": "boolean",
"description": "If transaction was not confirmed within 5 rounds, result is false.",
"default": false
},
"failed": {
"description": "In case of the transaction was broadcast to the blockchain, but it was not possible to complete Tatum KMS signature, reponse is marked as failed and must be marked manually.",
"example": false,
"type": "boolean"
}
},
"required": ["txId"]
},
"TransferAlgorandBlockchainKMS": {
"type": "object",
"properties": {
"from": {
"description": "The blockchain address of the sender",
"type": "string",
"example": "TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4"
},
"to": {
"description": "The blockchain address of the recipient",
"type": "string",
"example": "NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y"
},
"fee": { "description": "The transaction fee in Algos", "type": "string", "example": "0.001" },
"amount": { "description": "The amount to send in Algos", "type": "string", "example": "1" },
"note": {
"description": "The note for the recipient; must not contain spaces",
"type": "string",
"example": "Helloworld"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["from", "to", "amount", "signatureId", "fee"]
},
"TransferTronBlockchain": {
"type": "object",
"properties": {
"fromPrivateKey": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Private key of the address, from which the TRX will be sent.",
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701"
},
"to": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"amount": {
"description": "Amount to be sent in TRX.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["fromPrivateKey", "to", "amount"]
},
"TransferTronBlockchainKMS": {
"type": "object",
"properties": {
"from": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Sender address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"signatureId": {
"type": "string",
"minimum": 36,
"maximum": 36,
"format": "uuid",
"example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"to": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"amount": {
"description": "Amount to be sent in TRX.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
}
},
"required": ["from", "signatureId", "to", "amount", "index"]
},
"TransferTronTrc10Blockchain": {
"type": "object",
"properties": {
"fromPrivateKey": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Private key of the address, from which the TRX will be sent.",
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701"
},
"to": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"tokenId": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "ID of the token to transfer.",
"example": "1000538"
},
"amount": {
"description": "Amount to be sent in TRX.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["fromPrivateKey", "tokenId", "to", "amount"]
},
"TransferTronTrc10BlockchainKMS": {
"type": "object",
"properties": {
"from": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Sender address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"signatureId": {
"type": "string",
"minimum": 36,
"maximum": 36,
"format": "uuid",
"example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"to": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"tokenId": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "ID of the token to transfer.",
"example": "1000538"
},
"amount": {
"description": "Amount to be sent in TRX.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["from", "signatureId", "index", "tokenId", "to", "amount"]
},
"TransferTronTrc20Blockchain": {
"type": "object",
"properties": {
"fromPrivateKey": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Private key of the address, from which the TRX will be sent.",
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701"
},
"to": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"tokenAddress": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Address of the TRC20 token to transfer.",
"example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW"
},
"feeLimit": {
"type": "number",
"minimum": 0,
"description": "Fee in TRX to be paid.",
"example": 0.01
},
"amount": {
"description": "Amount to be sent in TRX.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["fromPrivateKey", "tokenAddress", "to", "amount", "feeLimit"]
},
"TransferTronTrc20BlockchainKMS": {
"type": "object",
"properties": {
"from": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Sender address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"signatureId": {
"type": "string",
"minimum": 36,
"maximum": 36,
"format": "uuid",
"example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"to": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"tokenAddress": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Address of the TRC20 token to transfer.",
"example": "TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW"
},
"feeLimit": {
"type": "number",
"minimum": 0,
"description": "Fee in TRX to be paid.",
"example": 0.01
},
"amount": {
"description": "Amount to be sent in TRX.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["from", "signatureId", "index", "tokenAddress", "to", "amount", "feeLimit"]
},
"CreateTronTrc20Blockchain": {
"type": "object",
"properties": {
"fromPrivateKey": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Private key of the address, from which the TRX will be sent.",
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701"
},
"recipient": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of created TRC20 tokens.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Name of the token.",
"example": "My token"
},
"symbol": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Symbol of the token.",
"example": "SYM"
},
"totalSupply": {
"type": "number",
"minimum": 0,
"description": "Total supply of the tokens.",
"example": 100000
},
"decimals": {
"type": "number",
"minimum": 0,
"maximum": 30,
"description": "Number of decimal places of the token.",
"example": 10
}
},
"required": ["fromPrivateKey", "name", "recipient", "symbol", "totalSupply", "decimals"]
},
"CreateTronTrc20BlockchainKMS": {
"type": "object",
"properties": {
"from": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Sender address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"signatureId": {
"type": "string",
"minimum": 36,
"maximum": 36,
"format": "uuid",
"example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"recipient": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of created TRC20 tokens.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Name of the token.",
"example": "My token"
},
"symbol": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Symbol of the token.",
"example": "SYM"
},
"totalSupply": {
"type": "number",
"minimum": 0,
"description": "Total supply of the tokens.",
"example": 100000
},
"decimals": {
"type": "number",
"minimum": 0,
"maximum": 30,
"description": "Number of decimal places of the token.",
"example": 10
}
},
"required": ["from", "signatureId", "index", "name", "recipient", "symbol", "totalSupply", "decimals"]
},
"CreateTronTrc10Blockchain": {
"type": "object",
"properties": {
"fromPrivateKey": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Private key of the address, from which the TRX will be sent.",
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701"
},
"recipient": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of created TRC 10 tokens.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Name of the token.",
"example": "My token"
},
"abbreviation": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Abbreviation of the token.",
"example": "SYM"
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Description of the token.",
"example": "My short description"
},
"url": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "URL of the token.",
"example": "https://mytoken.com"
},
"totalSupply": {
"type": "number",
"minimum": 0,
"description": "Total supply of the tokens.",
"example": 100000
},
"decimals": {
"type": "number",
"minimum": 0,
"maximum": 5,
"description": "Number of decimal places of the token.",
"example": 10
}
},
"required": [
"fromPrivateKey",
"recipient",
"name",
"abbreviation",
"description",
"url",
"totalSupply",
"decimals"
]
},
"CreateTronTrc10BlockchainKMS": {
"type": "object",
"properties": {
"from": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Sender address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"signatureId": {
"type": "string",
"minimum": 36,
"maximum": 36,
"format": "uuid",
"example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"recipient": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of created TRC 10 tokens.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Name of the token.",
"example": "My token"
},
"abbreviation": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Abbreviation of the token.",
"example": "SYM"
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Description of the token.",
"example": "My short description"
},
"url": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "URL of the token.",
"example": "https://mytoken.com"
},
"totalSupply": {
"type": "number",
"minimum": 0,
"description": "Total supply of the tokens.",
"example": 100000
},
"decimals": {
"type": "number",
"minimum": 0,
"maximum": 5,
"description": "Number of decimal places of the token.",
"example": 10
}
},
"required": [
"from",
"signatureId",
"index",
"recipient",
"name",
"abbreviation",
"description",
"url",
"totalSupply",
"decimals"
]
},
"TronTrc10Detail": {
"type": "object",
"properties": {
"ownerAddress": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Address of the owner of the token, in hex.",
"example": "41d2803f9c22aa429d71554c9427e97ffedcec17c7"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Name of the token.",
"example": "My token"
},
"abbr": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Abbreviation of the token.",
"example": "SYM"
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Description of the token.",
"example": "My short description"
},
"url": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "URL of the token.",
"example": "https://mytoken.com"
},
"totalSupply": {
"type": "number",
"minimum": 0,
"description": "Total supply of the tokens.",
"example": 100000
},
"precision": {
"type": "number",
"minimum": 0,
"maximum": 5,
"description": "Number of decimal places of the token.",
"example": 10
}
}
},
"FreezeTron": {
"type": "object",
"properties": {
"fromPrivateKey": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Private key of the address, from which the TRX will be sent.",
"example": "842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701"
},
"receiver": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of frozen BANDWIDTH or ENERGY.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"duration": {
"type": "number",
"description": "Duration of frozen funds, in days.",
"example": 3,
"minimum": 3
},
"resource": {
"type": "string",
"description": "Resource to obtain, BANDWIDTH or ENERGY.",
"example": "ENERGY",
"enum": ["BANDWIDTH", "ENERGY"]
},
"amount": {
"description": "Amount to be frozen in TRX.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["fromPrivateKey", "receiver", "resource", "duration", "amount"]
},
"FreezeTronKMS": {
"type": "object",
"properties": {
"from": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Sender address of TRON account in Base58 format.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"signatureId": {
"type": "string",
"minimum": 36,
"maximum": 36,
"format": "uuid",
"example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"receiver": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"description": "Recipient address of frozen BANDWIDTH or ENERGY.",
"example": "TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh"
},
"duration": {
"type": "number",
"description": "Duration of frozen funds, in days.",
"example": 3,
"minimum": 3
},
"resource": {
"type": "string",
"description": "Resource to obtain, BANDWIDTH or ENERGY.",
"example": "ENERGY",
"enum": ["BANDWIDTH", "ENERGY"]
},
"amount": {
"description": "Amount to be frozen in TRX.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["from", "signatureId", "index", "receiver", "resource", "duration", "amount"]
},
"Error403Tron": {
"properties": {
"errorCode": { "description": "tron.failed", "example": "tron.failed", "type": "string" },
"message": {
"description": "Unable to communicate to blockchain. ${error}",
"example": "Unable to communicate to blockchain. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"TronWallet": {
"type": "object",
"required": ["mnemonic", "xpub"],
"properties": {
"mnemonic": {
"description": "Generated mnemonic for wallet.",
"example": "urge pulp usage sister evidence arrest palm math please chief egg abuse",
"type": "string"
},
"xpub": {
"description": "Generated Extended public key for wallet with derivation path according to BIP44. This key can be used to generate addresses.",
"example": "0244b3f40c6e570ae0032f6d7be87737a6c4e5314a4a1a82e22d0460a0d0cd794936c61f0c80dc74ace4cd04690d4eeb1aa6555883be006e1748306faa7ed3a26a",
"type": "string"
}
}
},
"TronBlock": {
"type": "object",
"properties": {
"hash": {
"type": "string",
"description": "Block hash",
"example": "000000000195a8cfe2ea4ca60ce921b30e95980a96c6bb1da4a35aa03da9c5a8"
},
"blockNumber": { "type": "number", "description": "Block number.", "example": 26585295 },
"timestamp": {
"type": "number",
"description": "Time of the block in UTC millis.",
"example": 1610134209000
},
"parentHash": {
"type": "string",
"description": "Hash of the parent block.",
"example": "000000000195a8ce6003aa8b6443c52734b80aefdcd079bf40e7f165b046370e"
},
"witnessAddress": {
"type": "string",
"description": "Witness address.",
"example": "4118e2e1c6cdf4b74b7c1eb84682e503213a174955"
},
"witnessSignature": {
"type": "string",
"description": "Witness signature.",
"example": "e20cb7a1f01d279ebe9c20baa0d747bea160042639ba0be63460cbb21ae63f072520e7766cb7aa1bd4e74bebbdea64be431ecf52c2aa2123ca0b1d7495bd581d00"
},
"transactions": {
"type": "array",
"description": "Transactions that occurs in this block.",
"items": { "$ref": "#/components/schemas/TronTx" }
}
}
},
"TronBroadcast": {
"type": "object",
"required": ["txData"],
"properties": {
"txData": {
"type": "string",
"description": "Raw signed transaction to be published to network.",
"minLength": 1,
"maxLength": 50000,
"example": "{\"raw_data\": \"{\\\"contract\\\":[{\\\"parameter\\\":{\\\"value\\\":{\\\"amount\\\":1000,\\\"owner_address\\\":\\\"41608f8da72479edc7dd921e4c30bb7e7cddbe722e\\\",\\\"to_address\\\":\\\"41e9d79cc47518930bc322d9bf7cddd260a0260a8d\\\"},\\\"type_url\\\":\\\"type.googleapis.com/protocol.TransferContract\\\"},\\\"type\\\":\\\"TransferContract\\\"}],\\\"ref_block_bytes\\\":\\\"5e4b\\\",\\\"ref_block_hash\\\":\\\"47c9dc89341b300d\\\",\\\"expiration\\\":1591089627000,\\\"timestamp\\\":1591089567635}\",\"raw_data_hex\": \"0a025e4b220847c9dc89341b300d40f8fed3a2a72e5a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a1541608f8da72479edc7dd921e4c30bb7e7cddbe722e121541e9d79cc47518930bc322d9bf7cddd260a0260a8d18e8077093afd0a2a72e\"}"
}
}
},
"TronTx": {
"type": "object",
"required": ["txID", "signature", "blockNumber", "ret", "rawData"],
"properties": {
"ret": {
"type": "array",
"description": "Result of the smart contract invocation.",
"items": {
"properties": {
"contractRet": {
"type": "string",
"description": "Returns the value of the smart contract invocation.",
"example": "SUCCESS"
}
}
},
"required": ["contractRet"]
},
"signature": {
"type": "array",
"description": "List of signatures of the transaction.",
"items": {
"type": "string",
"example": "91fa5d81f9578970d21fdcde4ebb849674d437b62774f34e8d9e4cb50960c0031362cbcb649553b1f5f9daf19495ae46e517d4401172b5e53bb06bfe6896e2e300"
}
},
"blockNumber": {
"type": "number",
"description": "The block in which the transaction was included.",
"example": 11223344
},
"txID": {
"type": "string",
"description": "Transaction ID.",
"example": "24dd2f121a24516f22df78adf1ccc32119e3edb7760297f76a925b879f2baa98"
},
"netUsage": { "type": "number", "description": "Usage of the network.", "example": 0 },
"rawData": {
"type": "object",
"description": "Raw data of the transaction.",
"required": ["expiration", "timestamp", "contract"],
"properties": {
"contract": {
"type": "array",
"description": "Smart contract invocations details.",
"items": {
"type": "object",
"properties": {
"parameter": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The amount transferred within the transaction.",
"example": 1000000
},
"owner_address": {
"type": "string",
"example": "418632237fd33f62c549ee044dd3da779aba947dcc",
"description": "Address of the sender."
},
"to_address": {
"type": "string",
"description": "Address of the recipient.",
"example": "41a614f803b6fd780986a42c78ec9c7f77e6ded13c"
},
"ownerAddressBase58": {
"type": "string",
"example": "TNCmcTdyrYKMtmE1KU2itzeCX76jGm5Not",
"description": "Address of the sender in Base58 encoding."
},
"toAddressBase58": {
"type": "string",
"example": "TRwS7apsNdRGzMBfhB2hVC4RhqfubUYZ8P",
"description": "Address of the recipient in Base58 encoding."
}
}
},
"type_url": {
"type": "string",
"example": "type.googleapis.com/protocol.TriggerSmartContract",
"description": "Type of the smart contract event."
}
}
},
"type": {
"example": "TriggerSmartContract",
"type": "string",
"description": "Type of the Smart contract."
}
}
}
},
"ref_block_bytes": {
"type": "number",
"description": "The height of the transaction reference block.",
"example": 4946
},
"ref_block_hash": {
"type": "number",
"description": "The hash of the transaction reference block.",
"example": "6d0c1a0af5a52f17"
},
"expiration": {
"description": "Expiration of the transaction.",
"type": "number",
"example": 1610067216000
},
"timestamp": {
"description": "Time of the transaction.",
"type": "number",
"example": 1609980816000
}
}
}
}
},
"TronInternalTx": {
"type": "object",
"required": ["internal_tx_id", "tx_id", "to_address", "from_address"],
"properties": {
"tx_id": {
"type": "string",
"description": "Transaction ID.",
"example": "24dd2f121a24516f22df78adf1ccc32119e3edb7760297f76a925b879f2baa98"
},
"internal_tx_id": {
"type": "string",
"description": "Internal TX ID.",
"example": "e1543ab5ac85e8fbf2397f30f19dc5b7a32abd508a57ff0c13642c9963d9f312"
},
"to_address": {
"type": "string",
"description": "Recipient address.",
"example": "41a614f803b6fd780986a42c78ec9c7f77e6ded13c"
},
"from_address": {
"type": "string",
"description": "Sender address.",
"example": "41a2726afbecbd8e936000ed684cef5e2f5cf43008"
}
}
},
"TronTx20": {
"type": "object",
"required": ["txID", "to", "tokenInfo", "type", "value", "from"],
"properties": {
"txID": {
"type": "string",
"description": "Transaction ID.",
"example": "24dd2f121a24516f22df78adf1ccc32119e3edb7760297f76a925b879f2baa98"
},
"tokenInfo": {
"type": "object",
"required": ["symbol", "decimals", "address", "name"],
"properties": {
"symbol": { "type": "string", "example": "USDT" },
"address": { "type": "string", "example": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t" },
"decimals": { "type": "number", "example": 6 },
"name": { "type": "string", "example": "Tether USD" }
}
},
"from": { "type": "string", "example": "TPn72oEg7WPaffgNBf62vGx8G1s4chx2fp" },
"to": { "type": "string", "example": "TJyhbP1bQfo8tLPxEVjaka9gh2qkN7MvD3" },
"type": { "type": "string", "example": "Transfer" },
"value": { "type": "string", "example": "1800" }
}
},
"TronAccount": {
"type": "object",
"required": ["address", "freeNetUsage", "balance", "bandwidth", "trc10", "trc20", "createTime"],
"properties": {
"address": {
"type": "string",
"description": "Account address",
"example": "TGDqQAP5bduoPKVgdbk7fGyW4DwEt3RRn8"
},
"balance": {
"type": "number",
"description": "Balance of the TRX, in SUN. SUN is 1/1000000 TRX.",
"example": 2342342
},
"trc10": {
"type": "array",
"items": {
"type": "object",
"description": "Balance of the TRC10 assets.",
"properties": {
"key": {
"type": "string",
"description": "Name of the TRC10 asset.",
"example": "TEST_TRC_10"
},
"value": { "type": "number", "description": "Balance of the TRC10 asset.", "example": 123 }
},
"required": ["key", "value"]
}
},
"trc20": {
"type": "array",
"items": {
"type": "object",
"description": "Balance of the TRC20 assets. It is structured as key value array, where key is the address of the TRC20 and value is the balance.",
"example": {
"TRkuKAxmWZ4G74MvZnFpoosQZsfvtNpmwH": "30958",
"TVKXY8DJ9aVTcg3wwVrRRs2FbTUwi4UZWR": "70000"
}
}
},
"createTime": {
"type": "number",
"description": "Date of creation of the account in UTC millis.",
"example": 1602848895000
},
"assetIssuedId": {
"type": "string",
"description": "ID of the issued TRC10 token, if any.",
"example": "1003475"
},
"assetIssuedName": {
"type": "number",
"description": "Balance of the issued TRC10 token, if any.",
"example": 100
},
"freeNetUsage": { "type": "number", "description": "Free usage of the network.", "example": 1000 },
"freeNetLimit": {
"type": "number",
"description": "Free usage limit of the network.",
"example": 1500
},
"netUsage": { "type": "number", "description": "Extra usage of the network.", "example": 5000 },
"netLimit": {
"type": "number",
"description": "Extra usage limit of the network.",
"example": 5000
},
"bandwidth": {
"type": "number",
"description": "Remaining usage of the network, equal to freeNetLimit - freeNetUsed + netLimit - netUsed.",
"example": 1500
}
}
},
"KlaytnBlock": {
"type": "object",
"properties": {
"difficulty": {
"description": "Difficulty for this block.",
"type": "string",
"example": "3296820833"
},
"extraData": {
"description": "The 'extra data' field of this block.",
"type": "string",
"example": "0x"
},
"gasLimit": {
"description": "The maximum gas allowed in this block.",
"type": "number",
"example": 8000000
},
"gasUsed": {
"description": "The total used gas by all transactions in this block.",
"type": "number",
"example": 7985124
},
"hash": {
"description": "Hash of the block. 'null' when its pending block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"logsBloom": {
"description": "The bloom filter for the logs of the block. 'null' when its pending block.",
"type": "string",
"example": "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
},
"miner": {
"description": "The address of the beneficiary to whom the mining rewards were given.",
"type": "string",
"example": "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
},
"mixHash": {
"description": "",
"type": "string",
"example": "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
},
"nonce": {
"description": "Hash of the generated proof-of-work. 'null' when its pending block.",
"type": "string",
"example": "0xfa1692f52a7ac672"
},
"number": {
"description": "The block number. 'null' when its pending block.",
"type": "number",
"example": 6470657
},
"parentHash": {
"description": "Hash of the parent block.",
"type": "string",
"example": "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
},
"receiptsRoot": {
"description": "",
"type": "string",
"example": "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
},
"sha3Uncles": {
"description": "SHA3 of the uncles data in the block.",
"type": "string",
"example": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
},
"size": { "description": "The size of this block in bytes.", "type": "number", "example": 15296 },
"stateRoot": {
"description": "The root of the final state trie of the block.",
"type": "string",
"example": "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
},
"timestamp": {
"description": "The unix timestamp for when the block was collated.",
"type": "number",
"example": 1569600592
},
"totalDifficulty": {
"description": "Total difficulty of the chain until this block.",
"type": "string",
"example": "23329673338013873"
},
"transactions": {
"description": "Array of transactions.",
"type": "array",
"items": { "$ref": "#/components/schemas/KlaytnTx" }
},
"transactionsRoot": {
"description": "The root of the transaction trie of the block.",
"type": "string",
"example": "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
}
}
},
"KlaytnTx": {
"type": "object",
"properties": {
"blockHash": {
"description": "Hash of the block where this transaction was in.",
"type": "string",
"example": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
},
"type": {
"description": "Type of Klaytn Transaction",
"type": "string",
"example": "TxTypeLegacyTransaction"
},
"typeInt": { "description": "Type of Klaytn Transaction", "type": "number", "example": 0 },
"status": {
"type": "boolean",
"example": true,
"description": "TRUE if the transaction was successful, FALSE, if the EVM reverted the transaction."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"from": {
"type": "string",
"description": "Address of the sender.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"gas": { "type": "number", "description": "Gas provided by the sender.", "example": 21000 },
"gasPrice": {
"type": "string",
"description": "Gas price provided by the sender in peb.",
"example": "1000000000"
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
},
"input": {
"type": "string",
"description": "The data sent along with the transaction.",
"example": "0x"
},
"nonce": {
"type": "number",
"description": "The number of transactions made by the sender prior to this one.",
"example": 26836405
},
"to": {
"type": "string",
"description": "Address of the receiver. 'null' when its a contract creation transaction.",
"example": "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transactions index position in the block.",
"example": 3
},
"value": {
"type": "string",
"description": "Value transferred in peb.",
"example": "1000000000000000000"
},
"gasUsed": {
"type": "number",
"description": "The amount of gas used by this specific transaction alone.",
"example": 21000
},
"cumulativeGasUsed": {
"type": "number",
"description": "The total amount of gas used when this transaction was executed in the block.",
"example": 314159
},
"contractAddress": {
"type": "string",
"description": "The contract address created, if the transaction was a contract creation, otherwise null.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"logs": {
"type": "array",
"description": "Log events, that happened in this transaction.",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "From which this event originated from.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"topics": {
"type": "array",
"description": "An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.",
"items": {
"type": "string",
"example": "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
}
},
"data": { "type": "string", "description": "The data containing non-indexed log parameter." },
"logIndex": {
"type": "number",
"description": "Integer of the event index position in the block."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"blockHash": {
"description": "Hash of the block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transaction’s index position, the event was created in."
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction this event was created in.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
}
}
}
}
}
},
"Error403KlaytnBroadcast": {
"properties": {
"errorCode": {
"description": "klaytn.broadcast.failed",
"example": "klaytn.broadcast.failed",
"type": "string"
},
"message": {
"description": "Unable to broadcast transaction due to ${error}.",
"example": "Unable to broadcast transaction due to ${error}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnKlay20NotFound": {
"properties": {
"errorCode": {
"description": "erc20.token.notFound",
"example": "erc20.token.notFound",
"type": "string"
},
"message": {
"description": "No such ERC20 currency ${name}.",
"example": "No such ERC20 currency ${name}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnKlay20Set": {
"properties": {
"errorCode": {
"description": "erc20.address.set",
"example": "erc20.address.set",
"type": "string"
},
"message": {
"description": "ERC20 address was already set.",
"example": "ERC20 address was already set.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnMnemonicPrivateKey": {
"properties": {
"errorCode": {
"description": "private.mnemonic.missing",
"example": "private.mnemonic.missing",
"type": "string"
},
"message": {
"description": "Either mnemonic and index or private key must be present.",
"example": "Either mnemonic and index or private key must be present.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnKlay20Unsupported": {
"properties": {
"errorCode": {
"description": "klaytn.bep20.unsupported",
"example": "klaytn.bep20.unsupported",
"type": "string"
},
"message": {
"description": "Unsupported ETH ERC20 blockchain.",
"example": "Unsupported ETH ERC20 blockchain.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnTxHash": {
"properties": {
"errorCode": {
"description": "klaytn.transaction.hash",
"example": "klaytn.transaction.hash",
"type": "string"
},
"message": {
"description": "Unable to calculate transaction hash. ${error}",
"example": "Unable to calculate transaction hash. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnTxSign": {
"properties": {
"errorCode": {
"description": "klaytn.transaction.sign",
"example": "klaytn.transaction.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction. ${error}",
"example": "Unable to sign transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnErc20TxSign": {
"properties": {
"errorCode": {
"description": "klaytn.bep20.sign",
"example": "klaytn.bep20.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction for contract creation. ${error}",
"example": "Unable to sign transaction for contract creation. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnGasCalculation": {
"properties": {
"errorCode": {
"description": "klaytn.transaction.gas",
"example": "klaytn.transaction.gas",
"type": "string"
},
"message": {
"description": "Unable to calculate gas limit for transaction. ${error}",
"example": "Unable to calculate gas limit for transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnTxBody": {
"properties": {
"errorCode": {
"description": "klaytn.transaction.body",
"example": "klaytn.transaction.body",
"type": "string"
},
"message": {
"description": "Either currency, or tokenAddress must be defined.",
"example": "Either currency, or tokenAddress must be defined.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnScBody": {
"properties": {
"errorCode": {
"description": "klaytn.sc.invalid",
"example": "klaytn.sc.invalid",
"type": "string"
},
"message": {
"description": "Invalid parameters for smart contract invocation.",
"example": "Invalid parameters for smart contract invocation.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KlaytnGasPrice": {
"properties": {
"errorCode": { "description": "gas.price.failed", "example": "gas.price.failed", "type": "string" },
"message": {
"description": "Unable to obtain current GAS price.",
"example": "Unable to obtain current GAS price.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"TransferKlay20Blockchain": {
"type": "object",
"properties": {
"to": {
"maxLength": 50,
"minLength": 1,
"description": "Blockchain address to send ERC20 token to",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount to be sent.",
"example": "100000",
"type": "string",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "Address of ERC20 token",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"digits": {
"description": "Number of decimal points that ERC20 token has.",
"example": 18,
"maximum": 30,
"minimum": 1,
"type": "number"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Klaytn transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gpeb.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["to", "contractAddress", "digits", "fromPrivateKey", "amount"]
},
"CallKlaytnSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount of the assets to be sent.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Klaytn transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gpeb.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "fromPrivateKey", "methodName"]
},
"CallKlaytnSmartContractReadMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
}
},
"required": ["contractAddress", "params", "methodABI", "methodName"]
},
"CallKlaytnSmartContractMethodKMS": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": { "type": "object", "description": "ABI of the method to invoke." },
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Klaytn transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gpeb.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "signatureId", "methodName"]
},
"TransferKlaytnBlockchain": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for KLAY transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Klaytn transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from Klaytn Blockchain Account. ERC20 tokens USDC and USDT are available only for mainnet use.",
"enum": ["KLAY", "USDC_KLAY", "USDT_KLAY"],
"example": "KLAY",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gpeb.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "fromPrivateKey"]
},
"KlaytnEstimateGas": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 42,
"example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef",
"minLength": 42,
"description": "Sender address."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in KLAY.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient.",
"pattern": "^(0x|0h)?[0-9A-F]+$"
}
},
"required": ["to", "amount", "from"]
},
"TransferKlaytnBlockchainKMS": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for KLAY transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Klaytn transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from Klaytn Blockchain Account. ERC20 tokens BETH, BBTC, BADA, WKLAY, BDOT, BXRP, BLTC, BBCH are available only for mainnet use.",
"enum": ["BETH", "BBTC", "BADA", "WKLAY", "BDOT", "BXRP", "BLTC", "BBCH", "KLAY"],
"example": "KLAY",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gpeb.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "signatureId"]
},
"OneBlock": {
"type": "object",
"properties": {
"difficulty": {
"description": "Difficulty for this block.",
"type": "string",
"example": "3296820833"
},
"extraData": {
"description": "The 'extra data' field of this block.",
"type": "string",
"example": "0x"
},
"gasLimit": {
"description": "The maximum gas allowed in this block.",
"type": "number",
"example": 8000000
},
"gasUsed": {
"description": "The total used gas by all transactions in this block.",
"type": "number",
"example": 7985124
},
"hash": {
"description": "Hash of the block. 'null' when its pending block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"logsBloom": {
"description": "The bloom filter for the logs of the block. 'null' when its pending block.",
"type": "string",
"example": "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
},
"miner": {
"description": "The address of the beneficiary to whom the mining rewards were given.",
"type": "string",
"example": "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
},
"mixHash": {
"description": "",
"type": "string",
"example": "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
},
"nonce": {
"description": "Hash of the generated proof-of-work. 'null' when its pending block.",
"type": "string",
"example": "0xfa1692f52a7ac672"
},
"number": {
"description": "The block number. 'null' when its pending block.",
"type": "number",
"example": 6470657
},
"parentHash": {
"description": "Hash of the parent block.",
"type": "string",
"example": "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
},
"receiptsRoot": {
"description": "",
"type": "string",
"example": "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
},
"sha3Uncles": {
"description": "SHA3 of the uncles data in the block.",
"type": "string",
"example": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
},
"size": { "description": "The size of this block in bytes.", "type": "number", "example": 15296 },
"stateRoot": {
"description": "The root of the final state trie of the block.",
"type": "string",
"example": "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
},
"timestamp": {
"description": "The unix timestamp for when the block was collated.",
"type": "number",
"example": 1569600592
},
"totalDifficulty": {
"description": "Total difficulty of the chain until this block.",
"type": "string",
"example": "23329673338013873"
},
"transactions": {
"description": "Array of transactions.",
"type": "array",
"items": { "$ref": "#/components/schemas/OneTx" }
},
"transactionsRoot": {
"description": "The root of the transaction trie of the block.",
"type": "string",
"example": "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
}
}
},
"OneTx": {
"type": "object",
"properties": {
"blockHash": {
"description": "Hash of the block where this transaction was in.",
"type": "string",
"example": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
},
"status": {
"type": "boolean",
"example": true,
"description": "TRUE if the transaction was successful, FALSE, if the EVM reverted the transaction."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"from": {
"type": "string",
"description": "Address of the sender.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"gas": { "type": "number", "description": "Gas provided by the sender.", "example": 21000 },
"gasPrice": {
"type": "string",
"description": "Gas price provided by the sender in wei.",
"example": "1000000000"
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
},
"input": {
"type": "string",
"description": "The data sent along with the transaction.",
"example": "0x"
},
"nonce": {
"type": "number",
"description": "The number of transactions made by the sender prior to this one.",
"example": 26836405
},
"to": {
"type": "string",
"description": "Address of the receiver. 'null' when its a contract creation transaction.",
"example": "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transactions index position in the block.",
"example": 3
},
"value": {
"type": "string",
"description": "Value transferred in wei.",
"example": "1000000000000000000"
},
"gasUsed": {
"type": "number",
"description": "The amount of gas used by this specific transaction alone.",
"example": 21000
},
"cumulativeGasUsed": {
"type": "number",
"description": "The total amount of gas used when this transaction was executed in the block.",
"example": 314159
},
"contractAddress": {
"type": "string",
"description": "The contract address created, if the transaction was a contract creation, otherwise null.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"logs": {
"type": "array",
"description": "Log events, that happened in this transaction.",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "From which this event originated from.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"topics": {
"type": "array",
"description": "An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.",
"items": {
"type": "string",
"example": "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
}
},
"data": { "type": "string", "description": "The data containing non-indexed log parameter." },
"logIndex": {
"type": "number",
"description": "Integer of the event index position in the block."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"blockHash": {
"description": "Hash of the block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transaction’s index position, the event was created in."
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction this event was created in.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
}
}
}
}
}
},
"Error403OneBroadcast": {
"properties": {
"errorCode": {
"description": "bsc.broadcast.failed",
"example": "bsc.broadcast.failed",
"type": "string"
},
"message": {
"description": "Unable to broadcast transaction due to ${error}.",
"example": "Unable to broadcast transaction due to ${error}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneBep20NotFound": {
"properties": {
"errorCode": {
"description": "erc20.token.notFound",
"example": "erc20.token.notFound",
"type": "string"
},
"message": {
"description": "No such HRM20 currency ${name}.",
"example": "No such HRM20 currency ${name}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneBep20Set": {
"properties": {
"errorCode": {
"description": "erc20.address.set",
"example": "erc20.address.set",
"type": "string"
},
"message": {
"description": "HRM20 address was already set.",
"example": "HRM20 address was already set.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneMnemonicPrivateKey": {
"properties": {
"errorCode": {
"description": "private.mnemonic.missing",
"example": "private.mnemonic.missing",
"type": "string"
},
"message": {
"description": "Either mnemonic and index or private key must be present.",
"example": "Either mnemonic and index or private key must be present.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneBep20Unsupported": {
"properties": {
"errorCode": {
"description": "bsc.bep20.unsupported",
"example": "bsc.bep20.unsupported",
"type": "string"
},
"message": {
"description": "Unsupported ETH HRM20 blockchain.",
"example": "Unsupported ETH HRM20 blockchain.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneTxHash": {
"properties": {
"errorCode": {
"description": "bsc.transaction.hash",
"example": "bsc.transaction.hash",
"type": "string"
},
"message": {
"description": "Unable to calculate transaction hash. ${error}",
"example": "Unable to calculate transaction hash. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneTxSign": {
"properties": {
"errorCode": {
"description": "bsc.transaction.sign",
"example": "bsc.transaction.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction. ${error}",
"example": "Unable to sign transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneErc20TxSign": {
"properties": {
"errorCode": { "description": "bsc.bep20.sign", "example": "bsc.bep20.sign", "type": "string" },
"message": {
"description": "Unable to sign transaction for contract creation. ${error}",
"example": "Unable to sign transaction for contract creation. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneGasCalculation": {
"properties": {
"errorCode": {
"description": "bsc.transaction.gas",
"example": "bsc.transaction.gas",
"type": "string"
},
"message": {
"description": "Unable to calculate gas limit for transaction. ${error}",
"example": "Unable to calculate gas limit for transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneTxBody": {
"properties": {
"errorCode": {
"description": "bsc.transaction.body",
"example": "bsc.transaction.body",
"type": "string"
},
"message": {
"description": "Either currency, or tokenAddress must be defined.",
"example": "Either currency, or tokenAddress must be defined.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneScBody": {
"properties": {
"errorCode": { "description": "bsc.sc.invalid", "example": "bsc.sc.invalid", "type": "string" },
"message": {
"description": "Invalid parameters for smart contract invocation.",
"example": "Invalid parameters for smart contract invocation.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403OneGasPrice": {
"properties": {
"errorCode": { "description": "gas.price.failed", "example": "gas.price.failed", "type": "string" },
"message": {
"description": "Unable to obtain current GAS price.",
"example": "Unable to obtain current GAS price.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"CallOneSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount of the assets to be sent.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to ONE transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "fromPrivateKey", "methodName"]
},
"CallOneReadSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
}
},
"required": ["contractAddress", "params", "methodABI", "methodName"]
},
"CallOneSmartContractMethodKMS": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": { "type": "object", "description": "ABI of the method to invoke." },
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to ONE transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "signatureId", "methodName"]
},
"TransferOneBlockchain": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additinal data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient."
},
"currency": {
"type": "string",
"description": "Currency of the transfer.",
"example": "ONE",
"enum": ["ONE"]
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to ONE transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in One.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "fromPrivateKey"]
},
"OneEstimateGas": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 66,
"example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef",
"minLength": 66,
"description": "Sender address."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in One.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additinal data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient.",
"pattern": "^(0x|0h)?[0-9A-F]+$"
}
},
"required": ["to", "amount", "from"]
},
"TransferOneBlockchainKMS": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additinal data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient."
},
"currency": {
"type": "string",
"description": "Currency of the transfer.",
"example": "ONE",
"enum": ["ONE"]
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to ONE transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in One.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "signatureId"]
},
"XdcBlock": {
"type": "object",
"properties": {
"number": {
"description": "The block number. 'null' when its pending block.",
"type": "number",
"example": 6470657
},
"hash": {
"description": "Hash of the block. 'null' when its pending block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"parentHash": {
"description": "Hash of the parent block.",
"type": "string",
"example": "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
},
"nonce": {
"description": "Hash of the generated proof-of-work. 'null' when its pending block.",
"type": "string",
"example": "0xfa1692f52a7ac672"
},
"sha3Uncles": {
"description": "SHA3 of the uncles data in the block.",
"type": "string",
"example": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
},
"logsBloom": {
"description": "The bloom filter for the logs of the block. 'null' when its pending block.",
"type": "string",
"example": "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
},
"transactionsRoot": {
"description": "The root of the transaction trie of the block.",
"type": "string",
"example": "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
},
"stateRoot": {
"description": "The root of the final state trie of the block.",
"type": "string",
"example": "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
},
"receiptsRoot": {
"description": "The root of the transaction trie of the block.",
"type": "string",
"example": "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
},
"miner": {
"description": "The address of the beneficiary to whom the mining rewards were given.",
"type": "string",
"example": "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
},
"difficulty": {
"description": "Difficulty for this block.",
"type": "string",
"example": "3296820833"
},
"totalDifficulty": {
"description": "Total difficulty of the chain until this block.",
"type": "string",
"example": "23329673338013873"
},
"extraData": {
"description": "The 'extra data' field of this block.",
"type": "string",
"example": "0x"
},
"size": { "description": "The size of this block in bytes.", "type": "number", "example": 15296 },
"gasLimit": {
"description": "The maximum gas allowed in this block.",
"type": "number",
"example": 8000000
},
"gasUsed": {
"description": "The total used gas by all transactions in this block.",
"type": "number",
"example": 7985124
},
"timestamp": {
"description": "The unix timestamp for when the block was collated.",
"type": "number",
"example": 1569600592
},
"transactions": {
"description": "Array of transactions.",
"type": "array",
"items": { "$ref": "#/components/schemas/XdcTx" }
},
"uncles": {
"description": "Array of uncle hashes.",
"type": "array",
"items": { "type": "string" },
"example": ["0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"]
}
}
},
"XdcTx": {
"type": "object",
"properties": {
"hash": {
"type": "string",
"description": "Hash of the transaction.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
},
"nonce": {
"type": "number",
"description": "The number of transactions made by the sender prior to this one.",
"example": 26836405
},
"blockHash": {
"description": "Hash of the block where this transaction was in.",
"type": "string",
"example": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transactions index position in the block.",
"example": 3
},
"from": {
"type": "string",
"description": "Address of the sender.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"to": {
"type": "string",
"description": "Address of the receiver. 'null' when its a contract creation transaction.",
"example": "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
},
"value": {
"type": "string",
"description": "Value transferred in wei.",
"example": "1000000000000000000"
},
"gas": { "type": "number", "description": "Gas provided by the sender.", "example": 21000 },
"gasPrice": {
"type": "string",
"description": "Gas price provided by the sender in wei.",
"example": "1000000000"
},
"input": {
"type": "string",
"description": "The data sent along with the transaction.",
"example": "0x"
},
"status": {
"type": "boolean",
"example": true,
"description": "TRUE if the transaction was successful, FALSE, if the EVM reverted the transaction."
},
"gasUsed": {
"type": "number",
"description": "The amount of gas used by this specific transaction alone.",
"example": 21000
},
"cumulativeGasUsed": {
"type": "number",
"description": "The total amount of gas used when this transaction was executed in the block.",
"example": 314159
},
"contractAddress": {
"type": "string",
"description": "The contract address created, if the transaction was a contract creation, otherwise null.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"logs": {
"type": "array",
"description": "Log events, that happened in this transaction.",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "From which this event originated from.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"topics": {
"type": "array",
"description": "An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.",
"items": {
"type": "string",
"example": "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
}
},
"data": { "type": "string", "description": "The data containing non-indexed log parameter." },
"logIndex": {
"type": "number",
"description": "Integer of the event index position in the block."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"blockHash": {
"description": "Hash of the block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transaction’s index position, the event was created in."
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction this event was created in.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
}
}
}
},
"logsBloom": {
"type": "string",
"format": "DATA, 256 Bytes",
"description": "Bloom filter for light clients to quickly retrieve related logs.",
"example": null
},
"root": {
"type": "string",
"description": "32 bytes of post-transaction stateroot (pre Byzantium)",
"example": null
}
}
},
"Error403XdcBroadcast": {
"properties": {
"errorCode": {
"description": "xdc.broadcast.failed",
"example": "xdc.broadcast.failed",
"type": "string"
},
"message": {
"description": "Unable to broadcast transaction due to ${error}.",
"example": "Unable to broadcast transaction due to ${error}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403XdcErc20Set": {
"properties": {
"errorCode": {
"description": "erc20.address.set",
"example": "erc20.address.set",
"type": "string"
},
"message": {
"description": "ERC20 address was already set.",
"example": "ERC20 address was already set.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403XdcMnemonicPrivateKey": {
"properties": {
"errorCode": {
"description": "private.mnemonic.missing",
"example": "private.mnemonic.missing",
"type": "string"
},
"message": {
"description": "Either mnemonic and index or private key must be present.",
"example": "Either mnemonic and index or private key must be present.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403XdcTxHash": {
"properties": {
"errorCode": {
"description": "xdc.transaction.hash",
"example": "xdc.transaction.hash",
"type": "string"
},
"message": {
"description": "Unable to calculate transaction hash. ${error}",
"example": "Unable to calculate transaction hash. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403XdcTxSign": {
"properties": {
"errorCode": {
"description": "xdc.transaction.sign",
"example": "xdc.transaction.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction. ${error}",
"example": "Unable to sign transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403XdcErc20TxSign": {
"properties": {
"errorCode": { "description": "xdc.erc20.sign", "example": "xdc.erc20.sign", "type": "string" },
"message": {
"description": "Unable to sign transaction for contract creation. ${error}",
"example": "Unable to sign transaction for contract creation. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403XdcGasCalculation": {
"properties": {
"errorCode": {
"description": "xdc.transaction.gas",
"example": "xdc.transaction.gas",
"type": "string"
},
"message": {
"description": "Unable to calculate gas limit for transaction. ${error}",
"example": "Unable to calculate gas limit for transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"CallXdcSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "The address of the smart contract",
"example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount of the assets to be sent.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to XDC transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "fromPrivateKey", "methodName"]
},
"CallXdcReadSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "The address of the smart contract",
"example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
}
},
"required": ["contractAddress", "params", "methodABI", "methodName"]
},
"CallXdcSmartContractMethodKMS": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 43,
"minLength": 42,
"description": "The address of the smart contract",
"example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": { "type": "object", "description": "ABI of the method to invoke." },
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to XDC transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "signatureId", "methodName"]
},
"TransferXdcBlockchain": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for XDC transactions.",
"example": "My note to recipient."
},
"currency": {
"type": "string",
"description": "Currency of the transfer.",
"example": "XDC",
"enum": ["XDC"]
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to XDC transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 43,
"minLength": 42,
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "currency", "amount", "fromPrivateKey"]
},
"XdcEstimateGas": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 43,
"example": "xdcfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef",
"minLength": 42,
"description": "Sender address."
},
"to": {
"description": "Blockchain address to send assets",
"example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 43,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in XDC.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
}
},
"required": ["to", "amount", "from"]
},
"TransferXdcBlockchainKMS": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for XDC transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to XDC transaction. If not present, last known nonce will be used."
},
"currency": {
"type": "string",
"description": "Currency of the transfer.",
"example": "XDC",
"enum": ["XDC"]
},
"to": {
"description": "Blockchain address to send assets",
"example": "xdc687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 43,
"minLength": 42,
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in XDC.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "signatureId", "currency"]
},
"KcsBlock": {
"type": "object",
"properties": {
"difficulty": {
"description": "Difficulty for this block.",
"type": "string",
"example": "3296820833"
},
"extraData": {
"description": "The 'extra data' field of this block.",
"type": "string",
"example": "0x"
},
"gasLimit": {
"description": "The maximum gas allowed in this block.",
"type": "number",
"example": 8000000
},
"gasUsed": {
"description": "The total used gas by all transactions in this block.",
"type": "number",
"example": 7985124
},
"hash": {
"description": "Hash of the block. 'null' when its pending block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"logsBloom": {
"description": "The bloom filter for the logs of the block. 'null' when its pending block.",
"type": "string",
"example": "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
},
"miner": {
"description": "The address of the beneficiary to whom the mining rewards were given.",
"type": "string",
"example": "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
},
"mixHash": {
"description": "",
"type": "string",
"example": "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
},
"nonce": {
"description": "Hash of the generated proof-of-work. 'null' when its pending block.",
"type": "string",
"example": "0xfa1692f52a7ac672"
},
"number": {
"description": "The block number. 'null' when its pending block.",
"type": "number",
"example": 6470657
},
"parentHash": {
"description": "Hash of the parent block.",
"type": "string",
"example": "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
},
"receiptsRoot": {
"description": "",
"type": "string",
"example": "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
},
"sha3Uncles": {
"description": "SHA3 of the uncles data in the block.",
"type": "string",
"example": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
},
"size": { "description": "The size of this block in bytes.", "type": "number", "example": 15296 },
"stateRoot": {
"description": "The root of the final state trie of the block.",
"type": "string",
"example": "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
},
"timestamp": {
"description": "The unix timestamp for when the block was collated.",
"type": "number",
"example": 1569600592
},
"totalDifficulty": {
"description": "Total difficulty of the chain until this block.",
"type": "string",
"example": "23329673338013873"
},
"transactions": {
"description": "Array of transactions.",
"type": "array",
"items": { "$ref": "#/components/schemas/KcsTx" }
},
"transactionsRoot": {
"description": "The root of the transaction trie of the block.",
"type": "string",
"example": "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
}
}
},
"KcsTx": {
"type": "object",
"properties": {
"blockHash": {
"description": "Hash of the block where this transaction was in.",
"type": "string",
"example": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
},
"status": {
"type": "boolean",
"example": true,
"description": "TRUE if the transaction was successful, FALSE, if the EVM reverted the transaction."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"from": {
"type": "string",
"description": "Address of the sender.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"gas": { "type": "number", "description": "Gas provided by the sender.", "example": 21000 },
"gasPrice": {
"type": "string",
"description": "Gas price provided by the sender in wei.",
"example": "1000000000"
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
},
"input": {
"type": "string",
"description": "The data sent along with the transaction.",
"example": "0x"
},
"nonce": {
"type": "number",
"description": "The number of transactions made by the sender prior to this one.",
"example": 26836405
},
"to": {
"type": "string",
"description": "Address of the receiver. 'null' when its a contract creation transaction.",
"example": "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transactions index position in the block.",
"example": 3
},
"value": {
"type": "string",
"description": "Value transferred in wei.",
"example": "1000000000000000000"
},
"gasUsed": {
"type": "number",
"description": "The amount of gas used by this specific transaction alone.",
"example": 21000
},
"cumulativeGasUsed": {
"type": "number",
"description": "The total amount of gas used when this transaction was executed in the block.",
"example": 314159
},
"contractAddress": {
"type": "string",
"description": "The contract address created, if the transaction was a contract creation, otherwise null.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"logs": {
"type": "array",
"description": "Log events, that happened in this transaction.",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "From which this event originated from.",
"example": "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
},
"topics": {
"type": "array",
"description": "An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.",
"items": {
"type": "string",
"example": "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
}
},
"data": { "type": "string", "description": "The data containing non-indexed log parameter." },
"logIndex": {
"type": "number",
"description": "Integer of the event index position in the block."
},
"blockNumber": {
"type": "number",
"description": "Block number where this transaction was in.",
"example": 6470854
},
"blockHash": {
"description": "Hash of the block.",
"type": "string",
"example": "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
},
"transactionIndex": {
"type": "number",
"description": "Integer of the transaction’s index position, the event was created in."
},
"transactionHash": {
"type": "string",
"description": "Hash of the transaction this event was created in.",
"example": "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
}
}
}
}
}
},
"Error403KcsBroadcast": {
"properties": {
"errorCode": {
"description": "kcs.broadcast.failed",
"example": "kcs.broadcast.failed",
"type": "string"
},
"message": {
"description": "Unable to broadcast transaction due to ${error}.",
"example": "Unable to broadcast transaction due to ${error}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsBep20NotFound": {
"properties": {
"errorCode": {
"description": "erc20.token.notFound",
"example": "erc20.token.notFound",
"type": "string"
},
"message": {
"description": "No such ERC20 currency ${name}.",
"example": "No such ERC20 currency ${name}.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsBep20Set": {
"properties": {
"errorCode": {
"description": "erc20.address.set",
"example": "erc20.address.set",
"type": "string"
},
"message": {
"description": "ERC20 address was already set.",
"example": "ERC20 address was already set.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsMnemonicPrivateKey": {
"properties": {
"errorCode": {
"description": "private.mnemonic.missing",
"example": "private.mnemonic.missing",
"type": "string"
},
"message": {
"description": "Either mnemonic and index or private key must be present.",
"example": "Either mnemonic and index or private key must be present.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsBep20Unsupported": {
"properties": {
"errorCode": {
"description": "kcs.bep20.unsupported",
"example": "kcs.bep20.unsupported",
"type": "string"
},
"message": {
"description": "Unsupported ETH ERC20 blockchain.",
"example": "Unsupported ETH ERC20 blockchain.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsTxHash": {
"properties": {
"errorCode": {
"description": "kcs.transaction.hash",
"example": "kcs.transaction.hash",
"type": "string"
},
"message": {
"description": "Unable to calculate transaction hash. ${error}",
"example": "Unable to calculate transaction hash. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsTxSign": {
"properties": {
"errorCode": {
"description": "kcs.transaction.sign",
"example": "kcs.transaction.sign",
"type": "string"
},
"message": {
"description": "Unable to sign transaction. ${error}",
"example": "Unable to sign transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsErc20TxSign": {
"properties": {
"errorCode": { "description": "kcs.bep20.sign", "example": "kcs.bep20.sign", "type": "string" },
"message": {
"description": "Unable to sign transaction for contract creation. ${error}",
"example": "Unable to sign transaction for contract creation. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsGasCalculation": {
"properties": {
"errorCode": {
"description": "kcs.transaction.gas",
"example": "kcs.transaction.gas",
"type": "string"
},
"message": {
"description": "Unable to calculate gas limit for transaction. ${error}",
"example": "Unable to calculate gas limit for transaction. ${error}",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsTxBody": {
"properties": {
"errorCode": {
"description": "kcs.transaction.body",
"example": "kcs.transaction.body",
"type": "string"
},
"message": {
"description": "Either currency, or tokenAddress must be defined.",
"example": "Either currency, or tokenAddress must be defined.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsScBody": {
"properties": {
"errorCode": { "description": "kcs.sc.invalid", "example": "kcs.sc.invalid", "type": "string" },
"message": {
"description": "Invalid parameters for smart contract invocation.",
"example": "Invalid parameters for smart contract invocation.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"Error403KcsGasPrice": {
"properties": {
"errorCode": { "description": "gas.price.failed", "example": "gas.price.failed", "type": "string" },
"message": {
"description": "Unable to obtain current GAS price.",
"example": "Unable to obtain current GAS price.",
"type": "string"
},
"statusCode": { "description": "403", "example": 403, "type": "number" }
},
"required": ["errorCode", "message", "statusCode"],
"type": "object"
},
"CallKcsSmartContractMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"amount": {
"description": "Amount of the assets to be sent.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Kcs transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "fromPrivateKey", "methodName"]
},
"CallKcsSmartContractReadMethod": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": {
"type": "object",
"example": {
"inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
"name": "stake",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
"description": "ABI of the method to invoke."
},
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string", "description": "Parameters of the method to be invoked" }
}
},
"required": ["contractAddress", "params", "methodABI", "methodName"]
},
"CallKcsSmartContractMethodKMS": {
"type": "object",
"properties": {
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The address of the smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"methodName": {
"minLength": 1,
"maxLength": 500,
"description": "Name of the method to invoke on smart contract.",
"type": "string",
"example": "transfer"
},
"methodABI": { "type": "object", "description": "ABI of the method to invoke." },
"params": {
"type": "array",
"example": ["0x632"],
"items": { "type": "string" },
"description": "Parameters of the method to be invoked."
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Kcs transaction. If not present, last known nonce will be used."
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"pattern": "^[+]?\\d+$",
"example": "40000"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"pattern": "^[+]?\\d+$",
"example": "20"
}
}
}
},
"required": ["contractAddress", "params", "methodABI", "signatureId", "methodName"]
},
"TransferKcsBlockchain": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for KCS transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Kcs transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from Kcs Blockchain Account. ERC20 tokens USDC and USDT are available only for mainnet use.",
"enum": ["KCS", "USDC_KCS", "USDT_KCS"],
"example": "KCS",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "Private key of sender address. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "fromPrivateKey"]
},
"KcsEstimateGas": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 42,
"example": "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef",
"minLength": 42,
"description": "Sender address."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"amount": {
"description": "Amount to be sent in KCS.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property.",
"example": "My note to recipient.",
"pattern": "^(0x|0h)?[0-9A-F]+$"
}
},
"required": ["to", "amount", "from"]
},
"TransferKcsBlockchainKMS": {
"type": "object",
"properties": {
"data": {
"type": "string",
"maxLength": 50000,
"description": "Additional data, that can be passed to blockchain transaction as data property. Only for KCS transactions.",
"example": "My note to recipient."
},
"nonce": {
"type": "number",
"minimum": 0,
"description": "Nonce to be set to Kcs transaction. If not present, last known nonce will be used."
},
"to": {
"description": "Blockchain address to send assets",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"maxLength": 42,
"minLength": 42,
"type": "string"
},
"currency": {
"description": "Currency to transfer from Kcs Blockchain Account. ERC20 tokens BETH, BBTC, BADA, WMATIC, BDOT, BXRP, BLTC, BBCH, KCS are available only for mainnet use.",
"enum": ["BETH", "BBTC", "BADA", "WMATIC", "BDOT", "BXRP", "BLTC", "BBCH", "MATIC", "KCS"],
"example": "KCS",
"type": "string"
},
"fee": {
"description": "Custom defined fee. If not present, it will be calculated automatically.",
"type": "object",
"required": ["gasLimit", "gasPrice"],
"properties": {
"gasLimit": {
"type": "string",
"description": "Gas limit for transaction in gas price.",
"example": "40000",
"pattern": "^[+]?\\d+$"
},
"gasPrice": {
"type": "string",
"description": "Gas price in Gwei.",
"example": "20",
"pattern": "^[+]?\\d+$"
}
}
},
"amount": {
"description": "Amount to be sent in Ether.",
"example": "100000",
"pattern": "^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$",
"type": "string"
},
"index": {
"type": "number",
"minimum": 0,
"description": "If signatureId is mnemonic-based, this is the index to the specific address from that mnemonic."
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "Identifier of the private key associated in signing application. Private key, or signature Id must be present."
}
},
"required": ["to", "amount", "currency", "signatureId"]
}
},
"securitySchemes": {
"X-API-Key": {
"type": "apiKey",
"name": "x-api-key",
"in": "header",
"description": "The **API key** represents your [pricing plan](https://tatum.io/pricing) and defines how many API calls \nyou can make per second and what the total number of API calls per month is available for you.\n\nOne API key must be used by only one person.\n\nChoose one of the following authentication methods:\n\n* **Provide the API key in each API call.**\n\n To obtain the API key, [create a Tatum account](https://dashboard.tatum.io/sign-up). Once you are logged in,\n you are automatically assigned the Free plan.\n \n With the Free plan:\n * You get two API keys, one tied to the testnet of a blockchain and the other to the mainnet.\n * You can make up to five API calls per second.\n * The number of API calls per month is not limited.\n\n When making an API call, provide the appropriate API key (testnet or mainnet) as either an HTTP header\n or a path parameter of the API call.\n \n If you ever need your API keys, you can find them in [your Tatum account](https://dashboard.tatum.io/).\n\n* **Get an auto-generated API key attached to API calls.**\n \n Make an API call without any API key provided. The API key will be generated and tied to your IP address.\n This API key is stored within the Tatum platform and is automatically attached to all your API calls.\n\n With the auto-generated API key:\n * You can make up to five API calls per second.\n * You get 10,000,000 credits to spend on API calls within a month.\n \n The number of credits is reset on the first day of a month. The unused credits from the current month are not\n rolled over to the next month.\n \n These limits are applied to both the testnet and mainnet.\n \n By default, API calls with the auto-generated API key are executed against the mainnet.\n To make an API call to the testnet, add the `type` query parameter set to `testnet` to the endpoint URL,\n for example:\n \n `https://api-eu1.tatum.io/v3/ledger/account?type=testnet`\n"
}
}
}
}