/sendEthereumTransaction

1 min

POST

Send an Ethereum transaction using the specified parameters.

Use getSuggestedFee and getGasLimitSuggestedForTransaction to get current fee and gas information 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 --------------------

        sendBitcoinTransaction(
              account_id=1, 
              outputs=[("3Qnv...g3", 600)],
              fee=10,
              description="My BTC transaction",
              specificFromAddress="bc1q...xyz",   
              ignore_aml=False,
              aml_note="",
              utxos_to_use=["txid1:vout1", "txid2:vout2"],
              force_change=True
          )

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

{
          "FunctionData": {
              "ApprovalRequestStatus": 3,
              "CoinType": "BTC",
              "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>

feeintegerThe amount to pay for a unit of gas, in Wei. In London fork currencies, this is the maximum fee to pay per gas unit.

gas_limitintegerThe maximum units of gas to spend for this transaction.

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.

max_priority_feeintegerThe maximum priority fee to tip the miner.

data_for_contractstringAdditional data for contract interactions. See <a href="https://solidity.readthedocs.io/en/develop/abi-spec.html" target="_blank">https://solidity.readthedocs.io/en/develop/abi-spec.html</a> for more information.

isMetaMaskTransactionbooleanDO NOT USE. Indicates whether to perform this transaction via MetaMask.

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 an Ethereum (ETH) transaction.

200success

curl --request POST \
     --url '/sendEthereumTransaction?account_id=1&outputs=array&fee=None&gas_limit=21000&description=Test&specificFromAddress=0xE4Fd4d9190075de22826DdeC437594d27fb549Ab&max_priority_fee=None&ignore_aml=boolean&aml_note=Flagged%20for%20potential%20money%20laundering' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "AccountId": 1,
     "CoinType": "ETH",
     "Fee": {
     "GasLimit": 21000,
     "GasPrice": "10000000000",
     "MaxPriorityFee": "100000000"
     },
     "IsMetaMaskTransaction": "false",
     "SpecificFromAddress": "0xE4Fd4d9190075de22826DdeC437594d27fb549Ab",
     "Transactions": [
     {
     "AmountToTransfer": "6000",
     "DestinationAddress": 1.3072987414614707e+48
     }
     ],
     "UserDescription": "Test"
     },
     "Meta": {
     "FunctionName": "sendEthereumTransaction",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'