/sendIotaTransaction

1 min

POST

Send an IOTA (MIOTA) transaction using the specified parameters.

Use getSuggestedFee to get the current suggested fee before running the transaction.

NOTE: Success or failure in this API call does not necessarily mean success or failure in the transaction itself. For example, the transaction may succeed, but the "success" response to the client can be lost if the client's internet connection is down. 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.

-------------------- Request --------------------

        sendIotaTransaction(
              account_id=1, 
              outputs=[("0x7b06614f3df58158ff2dd00249d616aa7072469e54de553dfbff7c6e8b8d324f", 600)],
              gas_price=10000,
              gas_limit=3000000,
              description="My IOTA transaction",
              specificFromAddress=None,   
              ignore_aml=False,
              aml_note=""                                        
          )

-------------------- Response --------------------

{
          "FunctionData": {
              "ApprovalRequestStatus": 3,
              "CoinType": "IOTA",
              "Transactions": [
                  {
                      "AmountToTransfer": "600",
                      "DestinationAddress": "3Qnv...g3"
                  }
              ]
          },
          "Meta": {
              "AccessToken": "f192762c...",
              "Destination": "045bd19d...",
              "Source": "6f8fd2e8...",
              "Time": "2024-09-29 20:48:21.158"
          }
      }

account_idintegerThe account ID 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>

gas_pricestringThe gas price to transfer with, in Wei. In London fork currencies, this is the maximum fee to pay per gas unit.

gas_limitintegerThe gas limit to transfer, in gas units (must be at least 21500).

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

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

ignore_amlbooleanIf True, the AML (Anti-Money Laundering) check will be bypassed.

aml_notestringRequired note explaining why AML decision is being overridden. Only applicable when ignore_aml is True.

acceptstringGenerated from available response content types

bodyobjectRequest data for a IOTA (MIOTA) transaction.

200success

curl --request POST \
     --url '/sendIotaTransaction?account_id=1&outputs=array&gas_price=10000&gas_limit=90000000&description=Test&specificFromAddress=iota1qqxwhm3dy28ekt9fuymxhzdyxz6d26ka8ne2shnp3zscuzrxlptdv866nd7&ignore_aml=boolean&aml_note=Flagged%20for%20potential%20money%20laundering' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "AccountId": 1,
     "CoinType": "MIOTA",
     "Fee": {},
     "SpecificFromAddress": "iota1qqxwhm3dy28ekt9fuymxhzdyxz6d26ka8ne2shnp3zscuzrxlptdv866nd7",
     "Transactions": [
     {
     "AmountToTransfer": "2000000",
     "DestinationAddress": "iota1qqxwhm3dy28ekt9fuymxhzdyxz6d26ka8ne2shnp3zscuzrxlptdv866nd7"
     }
     ],
     "UserDescription": "Test"
     },
     "Meta": {
     "FunctionName": "sendIotaTransaction",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'