TransactionCreated
| Parameter | Type | Description |
|---|---|---|
| type | string | TRANSACTION_CREATED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | TransactionDetails | All the transaction information |
TransactionStatusUpdated
| Parameter | Type | Description |
|---|---|---|
| type | string | TRANSACTION_STATUS_UPDATED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | TransactionDetails | All the transaction information |
TransactionApprovalStatusUpdated
| Parameter | Type | Description |
|---|---|---|
| type | string | TRANSACTION_APPROVAL_STATUS_UPDATED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | TransactionDetails | All the transaction information |
TransactionDetails
| Parameter | Type | Description |
|---|---|---|
| id | string | ID of the transaction |
| assetId | string | Transaction asset |
| assetType | string | one of the following - XLM_ASSET XDB_ASSET TRON_TRC20 SOL_ASSET HBAR_ERC20 FIAT ERC721 ERC20 ERC1155 COMPOUND BEP20 BASE_ASSET ALGO_ASSET |
| source | TransferPeerPathResponse | Source of the transaction |
| destination | TransferPeerPathResponse | Fireblocks supports multiple destinations for UTXO-based blockchains. For other blockchains, this array will always be composed of one element |
| requestedAmount | number | The amount requested by the user |
| amountInfo | AmountInfo | Details of the transaction's amount in string format |
| feeInfo | FeeInfo | Details of the transaction's fee in string format |
| amount | number | If the transfer is a withdrawal from an exchange, the actual amount that was requested to be transferred. Otherwise, the requested amount |
| netAmount | number | The net amount of the transaction, after fee deduction |
| amountUSD | number | The USD value of the requested amount |
| serviceFee | number | The total fee deducted by the exchange from the actual requested amount (serviceFee = amount - netAmount) |
| treatAsGrossAmount | boolean | For outgoing transactions, if true, the network fee is deducted from the requested amount |
| networkFee | number | The fee paid to the network |
| createdAt | number | Unix timestamp |
| lastUpdated | number | Unix timestamp |
| status | TransactionStatus | The current status of the transaction |
| txHash | string | Blockchain hash of the transaction |
| index | number | [optional] For UTXO based assets this is the vOut, for Ethereum based, this is the index of the event of the contract call |
| subStatus | TransactionSubStatus | More detailed status of the transaction |
| sourceAddress | string | For account based assets only, the source address of the transaction. (Note: This parameter will be empty for transactions that are not: CONFIRMING, COMPLETED, or REJECTED/FAILED after passing CONFIRMING status.) |
| destinationAddress | string | Address where the asset were transferred |
| destinationAddressDescription | string | Description of the address |
| destinationTag | string | Destination tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat providers: Signet (by Signature), SEN (by Silvergate), or BLINC (by BCB Group) |
| signedBy | Array of strings | Signers of the transaction |
| createdBy | string | Initiator of the transaction |
| rejectedBy | string | User ID of the user that rejected the transaction (in case it was rejected) |
| addressType | string | [ ONE_TIME, WHITELISTED ] |
| note | string | Custom note of the transaction |
| exchangeTxId | string | If the transaction originated from an exchange, this is the exchange tx ID |
| feeCurrency | string | The asset which was taken to pay the fee (ETH for ERC-20 tokens, BTC for Tether Omni) |
| operation | TransactionOperation | Default operation is "TRANSFER" |
| amlScreeningResult | AmlScreeningResult | The result of the AML screening |
| customerRefId | string | The ID for AML providers to associate the owner of funds with transactions |
| 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 |
| networkRecords | Array of NetworkRecord objects | Transaction on the Fireblocks platform can aggregate several blockchain transactions, in such a case these records specify all the transactions that took place on the blockchain |
| replacedTxHash | string | In case of an RBF transaction, the hash of the dropped transaction |
| externalTxId | string | Unique transaction ID provided by the user |
| destinations | Array of DestinationsResponse | For UTXO based assets, all outputs specified here |
| blockInfo | BlockInfo | The information of the block that this transaction was mined in, the blocks's hash and height |
| rewardsInfo | RewardsInfo | This field is relevant only for ALGO transactions. Both srcRewrds and destRewards will appear only for Vault to Vault transactions, otherwise you will receive only the Fireblocks' side of the transaction |
| authorizationInfo | AuthorizationInfo | The information about your Transaction Authorization Policy (TAP). For more information about the TAP, refer to this section in the Help Center |
| signedMessages | Array of SignedMessage objects | A list of signed messages returned for raw signing |
| extraParameters | JSON object | Protocol / operation specific parameters |
| systemMessages | Array of SystemMessageInfo objects | A response from Fireblocks that communicates a message about the health of the process being performed. If this object is returned with data, you should expect potential delays or incomplete transaction statuses |
VaultAccountAdded
| Parameter | Type | Description |
|---|---|---|
| type | string | VAULT_ACCOUNT_ADDED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | VaultAccount | Vault Account details |
VaultAccountAssetAdded
| Parameter | Type | Description |
|---|---|---|
| type | string | VAULT_ACCOUNT_ASSET_ADDED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | AssetAddedData | Vault-Account-Asset details |
AssetAddedData
| Parameter | Type | Description |
|---|---|---|
| accountId | string | The ID of the vault account under which the wallet was added |
| tenantId | string | Unique id of your Fireblocks' workspace |
| accountName | string | The name of the vault account under which the wallet was added |
| assetId | string | Wallet's asset |
InternalWalletAssetAdded
| Parameter | Type | Description |
|---|---|---|
| type | string | INTERNAL_WALLET_ASSET_ADDED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | WalletAssetWebhook | Internal wallet details |
ExternalWalletAssetAdded
| Parameter | Type | Description |
|---|---|---|
| type | string | EXTERNAL_WALLET_ASSET_ADDED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | WalletAssetWebhook | External wallet details |
ExchangeAccountAdded
| Parameter | Type | Description |
|---|---|---|
| type | string | EXCHANGE_ACCOUNT_ADDED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | ThirdPartyWebhook | Exchange accounts details |
FiatAccountAdded
| Parameter | Type | Description |
|---|---|---|
| type | string | FIAT_ACCOUNT_ADDED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | ThirdPartyWebhook | Fiat account details |
NetworkConnectionAdded
| Parameter | Type | Description |
|---|---|---|
| type | string | NETWORK_CONNECTION_ADDED |
| tenantId | string | Unique id of your Fireblocks' workspace |
| timestamp | number | Timestamp in milliseconds |
| data | NetworkConnection | Network connection details |
Data Objects
WalletAssetWebhook
| Parameter | Type | Description |
|---|---|---|
| assetId | string | The wallet's asset |
| walletId | string | The ID of the wallet |
| name | string | The name of wallet |
| address | string | The address of the wallet |
| tag | string | For XRP wallets, the destination tag; for EOS/XLM, the memo; for the fiat providers (Signet by Signature, SEN by Silvergate, or BLINC by BCB Group), the Bank Transfer Description |
| activationTime | string | The time the wallet will be activated in case wallets activation posponed according to workspace definition |
ThirdPartyWebhook
| Parameter | Type | Description |
|---|---|---|
| id | string | Id of the thirdparty account on the Fireblocks platform |
| subType | string | Subtype of the third party, ie. exchange or fiat name |
| name | string | Account name |