/sendBitcoinTransaction

1 min

POST

Send a Bitcoin transaction using the specified parameters. You cannot send more than 299 UTXOs per transaction.

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 --------------------

        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 fee to pay for this transaction, in Satoshi per vByte.

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.

utxos_to_usearrayA list of specific UTXOs (unspent transaction outputs) that must be used to build the MPC transaction.

force_changebooleanWhether to force change output (return excess funds) even if the total input exactly matches the output amount.

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/sendBitcoinTransaction?account_id=1&outputs=array&fee=None&description=Test&specificFromAddress=3Qnv1fyqhSaptkxJrC9ruNfpSCB1Srmkg3&ignore_aml=boolean&aml_note=Flagged%20for%20potential%20money%20laundering&force_change=True' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "ApprovalRequestStatus": 3,
     "CoinType": "BTC",
     "Transactions": [
     {
     "AmountToTransfer": "10000000",
     "DestinationAddress": "3Qnv1fyqhSaptkxJrC9ruNfpSCB1Srmkg3"
     }
     ]
     },
     "Meta": {
     "AccessToken": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
     "Destination": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
     "Source": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
     "Time": "2021-02-14 09:58:52.320"
     }
     }'