/sendTezosTransaction

1 min

POST

Send a Tezos (XTZ) transaction using the specified parameters.

Use getSuggestedFee and getGasLimitSuggestedForTransaction to get the current suggested fee and gas limit before running the transaction.

NOTE: Success or failure in this API call does not necessarily mean success or failure in the transaction itself. For one example, the transaction may succeed, but the "success" response to the client can be lost if the internet is down for the client. To verify the status of the transaction:

Call getCurrentToken and store it.
Send your transaction. The transaction will use the token from step 1.
Call getTransactionByToken using the stored token to track the status of the transaction.

This function is part of the transaction flow detailed at https://docs.gk8.io/api-v19/sending-transactions-from-the-api. See the linked article for more details.

return: JSON object containing the transaction details.

example: sendTezosTransaction(1, [("tz1c...2H3", "6000")], 1, 1451, 257)

account_idintegerThe account ID we want to use in this operation

outputsarrayList of tuples representing the destination address and amount to transfer. <ul> <li>Format: [(destination_address: str, amount_to_transfer: int)]</li> </ul>

feeintegerThe amount to pay for this transaction, in uXTZ.

gas_limitintegerThe maximum units of gas to spend for this transaction.

storage_limitintegerThe maximum storage for this transaction. Use 257 for non-existing addresses in the blockchain and 0 for exist

descriptionstringText for describing the transaction in your records. This is not sent to the blockchain.

data_for_contractstringIf a smart contract transaction, see <a href="https://opentezos.com/michelson/smart-contracts" target="_blank">https://opentezos.com/michelson/smart-contracts</a> for spec info.

specificFromAddressstringDeposit address to send from. Cannot be used if the account is defined as an Omnibus account.

acceptstringGenerated from available response content types

bodyobjectRequest data for a Tezos (XTZ) transfer.

200success

curl --request POST \
     --url '/sendTezosTransaction?account_id=1&outputs=array&fee=1&gas_limit=None&storage_limit=None&description=Test&specificFromAddress=KT1WvzYHCNBvDSdwafTHv7nJ1dWmZ8GCYuuC' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "AccountId": 1,
     "CoinType": "XTZ",
     "Fee": {
     "GasLimit": "1451",
     "GasPrice": "1",
     "StorageLimit": 257
     },
     "SpecificFromAddress": "tz1Nc9Cf8FjnUwTV4mUY3MYuTwg3P8EhPvP1",
     "Transactions": [
     {
     "AmountToTransfer": "6000",
     "DestinationAddress": "tz1ckGsovfBqqXyZSW3WfSRDTmLrnE65f2H3"
     }
     ],
     "UserDescription": "Test",
     "Meta": {
     "FunctionName": "sendTezosTransaction",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'