Skip to main content
GET
/
transactions
/
external_tx_id
/
{externalTxId}
TypeScript
const response: Promise<FireblocksResponse<TransactionResponse>> = fireblocks.transactions.getTransactionByExternalId(transactionsApiGetTransactionByExternalIdRequest);
{
  "id": "<string>",
  "externalTxId": "<string>",
  "status": "<string>",
  "subStatus": "<string>",
  "txHash": "<string>",
  "operation": "TRANSFER",
  "note": "<string>",
  "assetId": "<string>",
  "assetType": "ERC20",
  "source": {
    "type": "VAULT_ACCOUNT",
    "subType": "<string>",
    "id": "<string>",
    "name": "<string>",
    "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tradingAccount": "<string>"
  },
  "sourceAddress": "<string>",
  "tag": "<string>",
  "destination": {
    "type": "VAULT_ACCOUNT",
    "subType": "<string>",
    "id": "<string>",
    "name": "<string>",
    "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tradingAccount": "<string>"
  },
  "destinations": [
    {
      "amount": "<string>",
      "amountUSD": "<string>",
      "travelRuleMessageId": "trm_12345678-1234-1234-1234-123456789012",
      "amlScreeningResult": {
        "provider": "<string>",
        "payload": {}
      },
      "destination": {
        "type": "VAULT_ACCOUNT",
        "subType": "<string>",
        "id": "<string>",
        "name": "<string>",
        "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tradingAccount": "<string>"
      },
      "authorizationInfo": {
        "allowOperatorAsAuthorizer": true,
        "logic": "AND",
        "groups": [
          {
            "th": 123,
            "users": {}
          }
        ]
      }
    }
  ],
  "destinationAddress": "<string>",
  "destinationAddressDescription": "<string>",
  "destinationTag": "<string>",
  "contractCallDecodedData": {
    "contractName": "<string>",
    "functionCalls": [
      {}
    ]
  },
  "amountInfo": {
    "amount": "<string>",
    "requestedAmount": "<string>",
    "netAmount": "<string>",
    "amountUSD": "<string>"
  },
  "treatAsGrossAmount": true,
  "feeInfo": {
    "networkFee": "<string>",
    "serviceFee": "<string>",
    "gasPrice": "<string>",
    "L1networkFee": "0.003955",
    "L2networkFee": "0.0005",
    "paidByRelay": true,
    "relayType": "LOCAL",
    "relayId": 1,
    "relayName": "Tenant Name",
    "feeUSD": "0.0013"
  },
  "feeCurrency": "<string>",
  "networkRecords": [
    {
      "source": {
        "type": "VAULT_ACCOUNT",
        "subType": "<string>",
        "id": "<string>",
        "name": "<string>",
        "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tradingAccount": "<string>"
      },
      "destination": {
        "type": "VAULT_ACCOUNT",
        "subType": "<string>",
        "id": "<string>",
        "name": "<string>",
        "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tradingAccount": "<string>"
      },
      "txHash": "<string>",
      "networkFee": "<string>",
      "assetId": "<string>",
      "netAmount": "<string>",
      "isDropped": true,
      "type": "<string>",
      "destinationAddress": "<string>",
      "amountUSD": "<string>",
      "rewardInfo": {
        "srcRewards": "<string>",
        "destRewards": "<string>"
      }
    }
  ],
  "createdAt": 123,
  "lastUpdated": 123,
  "createdBy": "<string>",
  "signedBy": [
    "<string>"
  ],
  "rejectedBy": "<string>",
  "authorizationInfo": {
    "allowOperatorAsAuthorizer": true,
    "logic": "AND",
    "groups": [
      {
        "th": 123,
        "users": {}
      }
    ]
  },
  "exchangeTxId": "<string>",
  "customerRefId": "<string>",
  "travelRuleMessageId": "trm_12345678-1234-1234-1234-123456789012",
  "amlScreeningResult": {
    "provider": "<string>",
    "payload": {}
  },
  "complianceResults": {
    "aml": {
      "provider": "NOTABENE",
      "payload": {},
      "timestamp": 1753459111824,
      "screeningStatus": "COMPLETED",
      "bypassReason": "UNSUPPORTED_ASSET",
      "status": "COMPLETED",
      "prevStatus": "COMPLETED",
      "prevBypassReason": "BELOW_THRESHOLD",
      "verdict": "PASS",
      "risk": "lowRisk",
      "extendedRisk": "lowRisk",
      "externalId": "aml_screening_12345",
      "customerRefId": "customer_ref_789",
      "refId": "ref_12345",
      "category": "EXCHANGE",
      "categoryId": 5,
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "destTag": "memo_12345",
      "destRecordId": "record_001",
      "addressResolutionSignature": "0x1234567890abcdef",
      "amlResult": {
        "alerts": [
          {
            "alertLevel": "HIGH",
            "externalId": "alert_12345",
            "alertAmount": 1000.5,
            "exposureType": "DIRECT",
            "alertName": "Sanctions Match",
            "category": "SANCTIONED_ENTITY",
            "service": "CHAINALYSIS",
            "policyAction": "BLOCK",
            "categoryId": 101
          }
        ],
        "providerResponse": {},
        "matchedRule": {
          "ruleId": "rule_001",
          "ruleName": "High Risk Sanctions Check",
          "action": "ALLOW"
        },
        "matchedAlert": {
          "alertLevel": "HIGH",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      },
      "result": {
        "direction": "OUTBOUND",
        "isVerified": true,
        "action": "ACCEPT",
        "providerResponse": {},
        "matchedRule": {
          "direction": "OUTBOUND",
          "status": "COMPLETED",
          "amountUSD": 1000.5,
          "amount": 0.025,
          "asset": "BTC",
          "action": "ACCEPT"
        }
      },
      "detailsMessage": "Travel rule screening completed successfully",
      "matchedAlert": {},
      "matchedRule": {},
      "matchedPrescreeningRule": {
        "bypassReason": "MANUAL",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "transferPeerType": "VAULT_ACCOUNT",
        "transferPeerSubType": "INTERNAL",
        "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
        "sourceId": "0",
        "destId": "ext_address_001",
        "asset": "ETH",
        "baseAsset": "ETH",
        "amount": 0.5,
        "amountUSD": 1000,
        "networkProtocol": "ETH",
        "operation": "TRANSFER",
        "action": "SCREEN"
      },
      "matchedNoTrmScreeningRule": {},
      "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerShortName": "ACME Corp",
      "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "providerResponse": {}
    },
    "tr": {
      "provider": "NOTABENE",
      "payload": {},
      "timestamp": 1753459111824,
      "screeningStatus": "COMPLETED",
      "bypassReason": "UNSUPPORTED_ASSET",
      "status": "COMPLETED",
      "prevStatus": "COMPLETED",
      "prevBypassReason": "BELOW_THRESHOLD",
      "verdict": "PASS",
      "risk": "lowRisk",
      "extendedRisk": "lowRisk",
      "externalId": "aml_screening_12345",
      "customerRefId": "customer_ref_789",
      "refId": "ref_12345",
      "category": "EXCHANGE",
      "categoryId": 5,
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "destTag": "memo_12345",
      "destRecordId": "record_001",
      "addressResolutionSignature": "0x1234567890abcdef",
      "amlResult": {
        "alerts": [
          {
            "alertLevel": "HIGH",
            "externalId": "alert_12345",
            "alertAmount": 1000.5,
            "exposureType": "DIRECT",
            "alertName": "Sanctions Match",
            "category": "SANCTIONED_ENTITY",
            "service": "CHAINALYSIS",
            "policyAction": "BLOCK",
            "categoryId": 101
          }
        ],
        "providerResponse": {},
        "matchedRule": {
          "ruleId": "rule_001",
          "ruleName": "High Risk Sanctions Check",
          "action": "ALLOW"
        },
        "matchedAlert": {
          "alertLevel": "HIGH",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      },
      "result": {
        "direction": "OUTBOUND",
        "isVerified": true,
        "action": "ACCEPT",
        "providerResponse": {},
        "matchedRule": {
          "direction": "OUTBOUND",
          "status": "COMPLETED",
          "amountUSD": 1000.5,
          "amount": 0.025,
          "asset": "BTC",
          "action": "ACCEPT"
        }
      },
      "detailsMessage": "Travel rule screening completed successfully",
      "matchedAlert": {},
      "matchedRule": {},
      "matchedPrescreeningRule": {
        "bypassReason": "MANUAL",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "transferPeerType": "VAULT_ACCOUNT",
        "transferPeerSubType": "INTERNAL",
        "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
        "sourceId": "0",
        "destId": "ext_address_001",
        "asset": "ETH",
        "baseAsset": "ETH",
        "amount": 0.5,
        "amountUSD": 1000,
        "networkProtocol": "ETH",
        "operation": "TRANSFER",
        "action": "SCREEN"
      },
      "matchedNoTrmScreeningRule": {},
      "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerShortName": "ACME Corp",
      "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "providerResponse": {}
    },
    "amlList": [
      {
        "provider": "NOTABENE",
        "payload": {},
        "timestamp": 1753459111824,
        "screeningStatus": "COMPLETED",
        "bypassReason": "UNSUPPORTED_ASSET",
        "status": "COMPLETED",
        "prevStatus": "COMPLETED",
        "prevBypassReason": "BELOW_THRESHOLD",
        "verdict": "PASS",
        "risk": "lowRisk",
        "extendedRisk": "lowRisk",
        "externalId": "aml_screening_12345",
        "customerRefId": "customer_ref_789",
        "refId": "ref_12345",
        "category": "EXCHANGE",
        "categoryId": 5,
        "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
        "destTag": "memo_12345",
        "destRecordId": "record_001",
        "addressResolutionSignature": "0x1234567890abcdef",
        "amlResult": {
          "alerts": [
            {
              "alertLevel": "HIGH",
              "externalId": "alert_12345",
              "alertAmount": 1000.5,
              "exposureType": "DIRECT",
              "alertName": "Sanctions Match",
              "category": "SANCTIONED_ENTITY",
              "service": "CHAINALYSIS",
              "policyAction": "BLOCK",
              "categoryId": 101
            }
          ],
          "providerResponse": {},
          "matchedRule": {
            "ruleId": "rule_001",
            "ruleName": "High Risk Sanctions Check",
            "action": "ALLOW"
          },
          "matchedAlert": {
            "alertLevel": "HIGH",
            "externalId": "alert_12345",
            "alertAmount": 1000.5,
            "exposureType": "DIRECT",
            "alertName": "Sanctions Match",
            "category": "SANCTIONED_ENTITY",
            "service": "CHAINALYSIS",
            "policyAction": "BLOCK",
            "categoryId": 101
          }
        },
        "result": {
          "direction": "OUTBOUND",
          "isVerified": true,
          "action": "ACCEPT",
          "providerResponse": {},
          "matchedRule": {
            "direction": "OUTBOUND",
            "status": "COMPLETED",
            "amountUSD": 1000.5,
            "amount": 0.025,
            "asset": "BTC",
            "action": "ACCEPT"
          }
        },
        "detailsMessage": "Travel rule screening completed successfully",
        "matchedAlert": {},
        "matchedRule": {},
        "matchedPrescreeningRule": {
          "bypassReason": "MANUAL",
          "sourceType": "VAULT_ACCOUNT",
          "sourceSubType": "INTERNAL",
          "destType": "VAULT_ACCOUNT",
          "destSubType": "INTERNAL",
          "transferPeerType": "VAULT_ACCOUNT",
          "transferPeerSubType": "INTERNAL",
          "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
          "sourceId": "0",
          "destId": "ext_address_001",
          "asset": "ETH",
          "baseAsset": "ETH",
          "amount": 0.5,
          "amountUSD": 1000,
          "networkProtocol": "ETH",
          "operation": "TRANSFER",
          "action": "SCREEN"
        },
        "matchedNoTrmScreeningRule": {},
        "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "customerShortName": "ACME Corp",
        "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "providerResponse": {}
      }
    ],
    "status": "Completed",
    "amlRegistration": {
      "provider": "<string>",
      "success": true,
      "timestamp": 123
    },
    "trlinkRegistration": {
      "status": "COMPLETED",
      "timestamp": 1640995200000,
      "provider": "SUMSUB",
      "success": true,
      "destRecordId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerShortName": "ACME Corp",
      "result": {
        "providerResponse": {}
      },
      "matchedPrescreeningRule": {
        "action": "SCREEN",
        "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "direction": "OUTBOUND",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "sourceId": "1",
        "destId": "1",
        "asset": "BTC",
        "baseAsset": "USD",
        "amount": {
          "range": {
            "min": "100",
            "max": "10000"
          },
          "currency": "USD"
        },
        "networkProtocol": "BITCOIN",
        "operation": "TRANSFER",
        "description": "<string>",
        "isDefault": false
      }
    },
    "trlinkDestinations": [
      {
        "provider": "SUMSUB",
        "timestamp": 1640995200000,
        "status": "COMPLETED",
        "verdict": "ACCEPT",
        "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
        "destTag": "memo_12345",
        "bypassReason": "MANUAL",
        "detailsMessage": "Screening completed successfully",
        "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "customerShortName": "ACME Corp",
        "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "result": {
          "providerResponse": {},
          "matchedRule": {
            "action": "ACCEPT",
            "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "direction": "OUTBOUND",
            "sourceType": "VAULT_ACCOUNT",
            "sourceSubType": "INTERNAL",
            "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
            "destType": "VAULT_ACCOUNT",
            "destSubType": "INTERNAL",
            "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
            "sourceId": "1",
            "destId": "1",
            "asset": "BTC",
            "baseAsset": "USD",
            "amount": {
              "range": {
                "min": "100",
                "max": "10000"
              },
              "currency": "USD"
            },
            "networkProtocol": "BITCOIN",
            "operation": "TRANSFER",
            "description": "<string>",
            "isDefault": false,
            "providerIdent": "sumsub",
            "trmStatus": "ACCEPTED",
            "validBefore": 1672531200000,
            "validAfter": 1640995200000
          }
        },
        "matchedPrescreeningRule": {
          "action": "SCREEN",
          "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "direction": "OUTBOUND",
          "sourceType": "VAULT_ACCOUNT",
          "sourceSubType": "INTERNAL",
          "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "destType": "VAULT_ACCOUNT",
          "destSubType": "INTERNAL",
          "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "sourceId": "1",
          "destId": "1",
          "asset": "BTC",
          "baseAsset": "USD",
          "amount": {
            "range": {
              "min": "100",
              "max": "10000"
            },
            "currency": "USD"
          },
          "networkProtocol": "BITCOIN",
          "operation": "TRANSFER",
          "description": "<string>",
          "isDefault": false
        },
        "matchedNoTrmScreeningRule": {
          "action": "WAIT",
          "source": "policy",
          "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "direction": "OUTBOUND",
          "sourceType": "VAULT_ACCOUNT",
          "sourceSubType": "INTERNAL",
          "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "destType": "VAULT_ACCOUNT",
          "destSubType": "INTERNAL",
          "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "sourceId": "1",
          "destId": "1",
          "asset": "BTC",
          "baseAsset": "USD",
          "amount": {
            "range": {
              "min": "100",
              "max": "10000"
            },
            "currency": "USD"
          },
          "networkProtocol": "BITCOIN",
          "operation": "TRANSFER",
          "description": "<string>",
          "isDefault": false,
          "validBefore": 1672531200000,
          "validAfter": 1640995200000,
          "timestamp": "2023-11-07T05:31:56Z",
          "reason": "Missing travel rule message"
        }
      }
    ]
  },
  "notBroadcastByFireblocks": false,
  "dappUrl": "https://app.uniswap.org",
  "gasLimit": "21000",
  "blockchainIndex": "1.1.1",
  "paidRent": "0.00203928",
  "extraParameters": {
    "nodeControls": {},
    "rawMessageData": {},
    "contractCallData": "<string>",
    "programCallData": "<string>",
    "inputsSelection": {},
    "allowBaseAssetAddress": true,
    "piiData": {}
  },
  "signedMessages": [
    {
      "content": "<string>",
      "algorithm": "MPC_ECDSA_SECP256K1",
      "derivationPath": [
        123
      ],
      "signature": {
        "fullSig": "<string>",
        "r": "<string>",
        "s": "<string>",
        "v": 123
      },
      "publicKey": "<string>"
    }
  ],
  "numOfConfirmations": 123,
  "blockInfo": {
    "blockHeight": "<string>",
    "blockHash": "<string>"
  },
  "index": 123,
  "rewardInfo": {
    "srcRewards": "<string>",
    "destRewards": "<string>"
  },
  "feePayerInfo": {
    "feePayerAccountId": "123"
  },
  "systemMessages": [
    {
      "type": "WARN",
      "message": "Slow transaction processing. Outgoing transactions might be stuck."
    }
  ],
  "addressType": "",
  "requestedAmount": 123,
  "amount": 123,
  "netAmount": 123,
  "amountUSD": 123,
  "serviceFee": 123,
  "fee": 123,
  "networkFee": 123,
  "errorDescription": "<string>",
  "replacedTxHash": "<string>",
  "nonce": "11228",
  "blockchainInfo": {
    "evmTransferType": "NATIVE"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
externalTxId
string
required

The external ID of the transaction to return

Response

An Transaction object

​
id
string

ID of the transaction.

​
externalTxId
string

Unique transaction ID provided by the user. Fireblocks highly recommends setting an externalTxId for every transaction created, to avoid submitting the same transaction twice.

​
status
string

The primary status of the transaction. For details, see Primary transaction statuses.

​
subStatus
string

See Transaction substatuses for the list of transaction sub statuses.

​
txHash
string

The hash of the transaction on the blockchain.

  • This parameter exists if at least one of the following conditions is met:

    1. The transaction’s source type is UNKNOWN, WHITELISTED_ADDRESS, NETWORK_CONNECTION, ONE_TIME_ADDRESS, FIAT_ACCOUNT or GAS_STATION.

    2. The transaction’s source type is VAULT and the status is either: CONFIRMING, COMPLETED, or was in any of these statuses prior to changing to FAILED or REJECTED. In some instances, transactions in status BROADCASTING will include the txHash as well.

    3. The transaction’s source type is EXCHANGE_ACCOUNT and the transaction’s destination type is VAULT, and the status is either: CONFIRMING, COMPLETED, or was in any of these status prior to changing to FAILED.

  • In addition, the following conditions must be met:

    1. The asset is a crypto asset (not fiat).

    2. The transaction operation is not RAW or TYPED_MESSAGE.

​
operation
enum<string>
  • TRANSFER - Transfers funds from one account to another. UTXO blockchains allow multi-input and multi-output transfers. All other blockchains allow transfers with one source address and one destination address.
  • MINT - Mints new tokens. Supported for Stellar, Ripple and EVM-based blockchains.
  • BURN - Burns tokens. Supported for Stellar, Ripple and EVM-based blockchains.
  • CONTRACT_CALL - Calls a smart contract method for web3 operations on any EVM blockchain. The Fireblocks development libraries are recommended for building contract call transactions.
  • TYPED_MESSAGE - An off-chain message in either Ethereum Personal Message or EIP712 format. Use it to sign specific readable messages that are not actual transactions. Learn more about typed messages.
  • RAW - An off-chain message with no predefined format. Use it to sign any message with your private key, including protocols such as blockchains and custom transaction types that are not natively supported by Fireblocks. Learn more about raw signing transactions.
  • ENABLE_ASSET - Algorand, DigitalBits, Solana, and Stellar require an on-chain transaction to create an asset wallet and enable the deposit address. This transaction is automatically created when adding assets on these blockchains at a vault account.
  • STAKE - Assign assets to a staking pool managed by a staking validator. Supported for Stellar and EVM-based blockchains. This transaction is automatically created when performing staking operations.
  • SUPPLY_TO_COMPOUND - Deprecated since April 1st, 2023. Older transactions may have this as their operation, in case users in the workspace have used the direct integration between Fireblocks and the Compound DeFI protocol.
  • REDEEM_FROM_COMPOUND - Deprecated since April 1st, 2023. Older transactions may have this as their operation, in case users in the workspace have used the direct integration between Fireblocks and the Compound DeFI protocol.
  • PROGRAM_CALL - In Solana refers to invoking on-chain programs (smart contracts) to execute transactions and interact with the blockchain.
  • APPROVE - Enables the approve function for a smart contract or wallet to withdraw from a designated wallet. Learn more.
Available options:
TRANSFER,
BURN,
CONTRACT_CALL,
MINT,
RAW,
TYPED_MESSAGE,
ENABLE_ASSET,
STAKE,
REDEEM_FROM_COMPOUND,
SUPPLY_TO_COMPOUND,
PROGRAM_CALL,
APPROVE
​
note
string

Custom note, not sent to the blockchain, that describes the transaction at your Fireblocks workspace.

​
assetId
string

The ID of the asset to transfer for TRANSFER, MINT, BURN, ENABLE_ASSET, or STAKE operations. See the list of supported assets and their IDs on Fireblocks.

​
assetType
string

Type classification of the asset

Example:

"ERC20"

​
source
object

Source of the transaction.

​
sourceAddress
string

For account based assets only, the source address of the transaction. Note: If the status is CONFIRMING, COMPLETED, or has been CONFIRMING; then moved forward to FAILED or REJECTED, then this parameter will contain the source address. In any other case, this parameter will be empty.

​
tag
string

Source address tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat provider BLINC (by BCB Group).

​
destination
object

Destination of the transaction.

Note: In case the transaction is sent to multiple destinations, the destinations parameter is be used instead of this.

​
destinations
object[]

The transaction’s destinations. Note: In case the transaction is sent to a single destination, the destination parameter is used instead of this.

​
destinationAddress
string

Address where the asset were transferred. Notes:

  • For Multi destination transactions, this parameter will be empty. In this case, you should refer to the destinations field.
  • If the status is CONFIRMING, COMPLETED, or has been CONFIRMING; then moved forward to FAILED or REJECTED, then this parameter will contain the destination address. In any other case, this parameter will be empty.
​
destinationAddressDescription
string

Description of the address.

​
destinationTag
string

Destination address tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat provider BLINC (by BCB Group).

​
contractCallDecodedData
object

Decoded data for CONTRACT_CALL operations. The Fireblocks development libraries are recommended for setting this parameter's value.

​
amountInfo
object

The details of the requested amount to transfer.

​
treatAsGrossAmount
boolean

For transactions initiated via this Fireblocks workspace, when set to true, the fee is deducted from the requested amount.

Note: This parameter can only be considered if a transaction's asset is a base asset, such as ETH or MATIC. If the asset can't be used for transaction fees, like USDC, this parameter is ignored and the fee is deducted from the relevant base asset wallet in the source account.

​
feeInfo
object

Details of the transaction's fee.

​
feeCurrency
string

The asset which was withdrawn to pay the transaction fee, for example ETH for EVM-based blockchains, BTC for Tether Omni.

​
networkRecords
object[]

In case a single transaction resulted with multiple transfers, for example a result of a contract call, then this parameter specifies each transfer that took place on the blockchain. In case of a single transfer transaction, this parameter is empty.

​
createdAt
number

The transaction’s creation date and time, in unix timestamp.

​
lastUpdated
number

The transaction’s last update date and time, in unix timestamp.

​
createdBy
string

User ID of the initiator of the transaction.

​
signedBy
string[]

User ID’s of the signers of the transaction.

​
rejectedBy
string

User ID of the user that rejected the transaction (in case it was rejected).

​
authorizationInfo
object

The information about your Transaction Authorization Policy (TAP).

​
exchangeTxId
string

If the transaction originated from an exchange, this is the ID of this transaction at the exchange.

​
customerRefId
string

The ID for AML providers to associate the owner of funds with transactions.

​
travelRuleMessageId
string

The ID of the travel rule message from any travel rule provider. Used for travel rule supporting functionality to associate transactions with existing travel rule messages.

Example:

"trm_12345678-1234-1234-1234-123456789012"

​
amlScreeningResult
object

The result of the AML screening.

​
complianceResults
object

The result of the Compliance AML/Travel Rule screening.

​
notBroadcastByFireblocks
boolean

Indicates the transaction was not broadcast by Fireblocks

Example:

false

​
dappUrl
string

DApp URL for Web3 transactions

Example:

"https://app.uniswap.org"

​
gasLimit
string

Gas limit for EVM-based blockchain transactions

Example:

"21000"

​
blockchainIndex
string

Blockchain-specific index or identifier for the transaction

Example:

"1.1.1"

​
paidRent
string

Solana rent payment amount

Example:

"0.00203928"

​
extraParameters
object

Additional protocol / operation specific key-value parameters:

For UTXO-based blockchain input selection, add the key inputsSelection with the value set to the input selection structure. The inputs can be retrieved from the Retrieve Unspent Inputs endpoint.

For RAW operations, add the key rawMessageData with the value set to the raw message data structure.

For CONTRACT_CALL operations, add the key contractCallData with the value set to the Ethereum smart contract Application Binary Interface (ABI) payload. The Fireblocks development libraries are recommended for building contract call transactions. For exchange compliance (e.g., Binance) and Travel Rule purposes, include the key piiData containing a custom JSON structure with Personally Identifiable Information (PII) relevant to the transaction. This data must be fully encrypted by the sender before being submitted to the Fireblocks API. The recommended encryption method is hybrid encryption using AES-256-GCM for the payload and RSA-OAEP for key exchange, with the recipient exchange's public key. development libraries

Note: rawMessageData, contractCallData, and inputsSelection cannot be used together in the same call.

​
signedMessages
object[]
​
numOfConfirmations
number

The number of confirmations of the transaction. The number will increase until the transaction will be considered completed according to the confirmation policy.

​
blockInfo
object

The block hash and height of the block that this transaction was mined in. Note: If an outgoing transaction uses the destinations object with more than one value in the array, blockHash is set to null.

​
index
number

For UTXO based assets this is the vOut, for Ethereum based, this is the index of the event of the contract call. Note: This field is not returned if a transaction uses the destinations object with more than one value.

​
rewardInfo
object

This field is relevant only for Algorand transactions. Both srcRewards and destRewards will appear only for Vault to Vault transactions, otherwise you will receive only the Fireblocks’ side of the transaction.

​
feePayerInfo
object
​
systemMessages
object[]
​
addressType
enum<string>
Available options:
,
WHITELISTED,
ONE_TIME
​
requestedAmount
number
deprecated

The amount requested by the user. Deprecated - please use the amountInfo field for accuracy.

​
amount
number
deprecated

If the transfer is a withdrawal from an exchange, the actual amount that was requested to be transferred. Otherwise, the requested amount. Deprecated - please use the amountInfo field for accuracy.

​
netAmount
number
deprecated

The net amount of the transaction, after fee deduction. Deprecated - please use the amountInfo field for accuracy.

​
amountUSD
number | null
deprecated

The USD value of the requested amount. Deprecated - please use the amountInfo field for accuracy.

​
serviceFee
number
deprecated

The total fee deducted by the exchange from the actual requested amount (serviceFee = amount - netAmount). Deprecated - please use the feeInfo field for accuracy.

​
fee
number
deprecated

Deprecated - please use the feeInfo field for accuracy.

​
networkFee
number
deprecated

The fee paid to the network. Deprecated - please use the feeInfo field for accuracy.

​
errorDescription
string

The transaction's revert reason. This field will be returned when subStatus = 'SMART_CONTRACT_EXECUTION_FAILED'.

​
replacedTxHash
string

if the transaction is a replace by fee (RBF) transaction, this is the hash of the transsaction that was replaced

​
nonce
string

blockchain nonce for the transaction

Example:

"11228"

​
blockchainInfo
object

A JSON used to store additional data that is blockchain-specific.

Example:
{ "evmTransferType": "NATIVE" }