Here you can find a description of all the objects expected and returned by the endpoints described above.
Vault Objects
VaultAccountsPagedResponse
Parameter | Type | Description |
---|---|---|
accounts | Array of VaultAccount | List of vault account objects |
paging | object | This object contains two fields: "before" (string) and “after” (string) |
previousUrl | string | URL string of the request for the previous page |
nextUrl | string | URL string of the request for the next page |
CreateVaultAssetResponse
Parameter | Type | Description |
---|---|---|
id | string | The ID of the Vault Account |
address | string | Address of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, cash address format for BCH |
legacyAddress | string | Legacy address format for BTC/LTC/BCH |
tag | string | Destination tag for XRP, used as memo for EOS/XLM |
eosAccountName | string | Returned for EOS, the account name |
VaultAsset
Parameter | Type | Description |
---|---|---|
id | string | The ID of the asset |
total | string | The total wallet balance. |
balance | string | Deprecated - replaced by "total" |
available | string | Funds available for transfer. Equals the blockchain balance minus any locked amount |
pending | string | The cumulative balance of all transactions pending to be cleared |
staked | string | Staked funds, returned only for DOT |
frozen | string | Frozen by the AML policy in your workspace |
lockedAmount | string | Funds in outgoing transactions that are not yet published to the network |
totalStakedCPU | string | [optional] Deprecated |
totalStakedNetwork | string | [optional] Deprecated |
selfStakedCPU | string | [optional] Deprecated |
selfStakedNetwork | string | [optional] Deprecated |
pendingRefundCPU | string | [optional] Deprecated |
pendingRefundNetwork | string | [optional] Deprecated |
blockHeight | string | The height (number) of the block of the balance |
blockHash | string | The hash of the block of the balance |
VaultAccountAssetAddress
Parameter | Type | Description |
---|---|---|
assetId | string | The ID of the asset |
address | string | Address of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, for BCH cash format |
legacyAddress | string | For BTC/LTC/BCH the legacy format address |
description | string | Description of the address |
tag | string | Destination tag for XRP, used as memo for EOS/XLM, for the fiat providers (Signet by Signature, SEN by Silvergate, BLINC by BCB Group), it is the Bank Transfer Description |
type | string | Address type |
customerRefId | string | [optional] The ID for AML providers to associate the owner of funds with transactions |
bip44AddressIndex | number | [optional] The address_index , addressFormat , and enterpriseAddress in the derivation path of this address based on BIP44 |
CreateAddressResponse
Parameter | Type | Description |
---|---|---|
address | string | Address of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, cash address format for BCH |
legacyAddress | string | Legacy address format for BTC/LTC/BCH |
tag | string | Destination tag for XRP, used as memo for EOS/XLM |
bip44AddressIndex | number | The address_index in the derivation path of this address based on BIP44 |
VaultAccount
Parameter | Type | Description |
---|---|---|
id | string | The ID of the Vault Account |
name | string | Name of the Vault Account |
hiddenOnUI | boolean | Specifies whether this vault account is visible in the web console or not |
customerRefId | string | [optional] The ID for AML providers to associate the owner of funds with transactions |
autoFuel | boolean | Specifies whether this account's Ethereum address is auto fueled by the Gas Station or not |
assets | Array of VaultAsset | List of assets under this Vault Account |
Note: When the VAULT_ACCOUNT_ADDED webhook is used, the VaultAccount object does not contain the customerRefId
and autoFuel
parameters.
PublicKey
Parameter | Type | Description |
---|---|---|
publicKey | sring | The requested public key |
algorithm | string | One of the SigningAlgorithms |
derivationPath | Array of numbers | For BIP32 derivation used to retrieve the public key |
Internal/External Wallets
WalletAsset
Parameter | Type | Description |
---|---|---|
id | string | The ID of the asset |
balance | string | The balance of the wallet |
lockedAmount | string | Locked amount in the wallet |
status | ConfigChangeRequestStatus | Status of the Internal Wallet |
activationTime | string | The time the wallet will be activated in case wallets activation posponed according to workspace definition |
address | string | The address of the wallet |
tag | string | Destination tag (for XRP, used as memo for EOS/XLM) of the wallet. |
ExternalWalletAsset
Parameter | Type | Description |
---|---|---|
id | string | The ID of the asset |
status | ConfigChangeRequestStatus | Status of the External Wallet |
activationTime | string | The time the wallet will be activated in case wallets activation posponed according to workspace definition |
address | string | The address of the wallet |
tag | string | Destination tag (for XRP, used as memo for EOS/XLM) of the wallet, for the fiat providers (Signet by Signature, SEN by Silvergate, BLINC by BCB Group), used as Bank Transfer Description |
UnmanagedWallet
Parameter | Type | Description |
---|---|---|
id | string | The ID of the Unmanaged Wallet |
name | string | Name of the Wallet Container |
customerRefId | string | [optional] The ID for AML providers to associate the owner of funds with transactions |
assets | Array of WalletAsset | Array of the assets available in the unmanaged wallet |
ExternalWallet
Parameter | Type | Description |
---|---|---|
id | string | The ID of the Unmanaged Wallet |
name | string | Name of the Wallet Container |
customerRefId | string | [optional] The ID for AML providers to associate the owner of funds with transactions |
assets | Array of ExternalWalletAsset | Array of the assets available in the exteral wallet |
Contract Objects
ContractAsset
Parameter | Type | Description |
---|---|---|
id | string | The ID of the contract wallet. |
balance | string | The balance of the contract wallet. |
lockedAmount | string | Locked amount in the contract wallet. |
status | ConfigChangeRequestStatus | Status of the contract wallet. |
activationTime | string | The time the contract wallet will be activated if case wallets activation is postponed according to the workspace definition. |
address | string | The address of the contract wallet. |
tag | string | Destination tag (for XRP, used as memo for EOS/XLM) of the contract wallet.a |
UnmanagedContract
Parameter | Type | Description |
---|---|---|
id | string | The ID of the unmanaged contract wallet. |
name | string | Name of the contract wallet container. |
assets | Array of ContractAsset objects | An array of assets available in the unmanaged contract wallet. |
Exchange Objects
ExchangeAccount
Parameter | Type | Description |
---|---|---|
id | string | The ID of the exchange account to return |
type | ExchangeType | |
name | string | Display name of the exchange account |
status | ConfigChangeRequestStatus | Status of the exchange account connection |
assets | Array of ExchangeAsset | Assets in the account |
isSubaccount | boolean | True if the account is a subaccount in an exchange |
mainAccountId | string | The of the exchange main account |
tradingAccounts | Array of TradingAccount | Trading accounts under this exchange account |
fundableAccountType | TradingAccountType | The internal account that is used for deposit or withdrawals of this exchange main or sub account |
ExchangeAsset
Parameter | Type | Description |
---|---|---|
id | string | The ID of the exchange account to return |
total | string | The total balance of the asset in the exchange account |
available | string | The balance that can be withdrawan from the exchange account or moved to a different account |
lockedAmount | string | Locked amount in the account |
balance | string | Deprecated - replaced by "total" |
ExchangeType
Parameter | Type | Description |
---|---|---|
type | string | [BINANCE, BINANCEUS, BITFINEX, BITHUMB, BITMEX, BITSO, BITSTAMP, BITTREX, CIRCLE, COINBASEPRO, COINMETRO, COINSPRO, CRYPTOCOM, DERIBIT, FTX, FIXUS, GEMINI, HITBTC, HUOBI, KORBIT, KRAKEN, LIQUID, POLONIEX, OKCOIN, OKEX, SEEDCX] |
TradingAccount
Parameter | Type | Description |
---|---|---|
type | TradingAccountType | The specific trading account under the exchange account |
assets | Array of ExchangeAsset | Assets in the trading account |
TradingAccountType
Parameter | Type | Description |
---|---|---|
type | string | [SPOT, FUTURES, MARGIN, FUNDING, OPTIONS, EXCHANGE, COIN_MARGINED_SWAP, USDT_FUTURES, COIN_FUTURES, USDT_ISOLATED_MARGINED_SWAP, USDT_MARGINED_SWAP_CROSS, FUNDUBLE, UNIFIED] |
Transactions
TransferPeerPath
Parameter | Type | Description |
---|---|---|
type | string | [ VAULT_ACCOUNT, EXCHANGE_ACCOUNT, FIAT_ACCOUNT, GAS_STATION ] |
id | string | The ID of the peer |
DestinationTransferPeerPath
Parameter | Type | Description |
---|---|---|
type | string | [ VAULT_ACCOUNT, EXCHANGE_ACCOUNT, INTERNAL_WALLET, EXTERNAL_WALLET, ONE_TIME_ADDRESS, NETWORK_CONNECTION, FIAT_ACCOUNT, COMPOUND ] |
id | string | The peer ID (not needed for ONE_TIME_ADDRESS) |
oneTimeAddress | OneTimeAddress | Destination address |
CreateTransactionResponse
Parameter | Type | Description |
---|---|---|
id | string | The ID of the transaction |
status | TransactionStatus | Status of the transaction |
CancelTransactionResponse
Parameter | Type | Description |
---|---|---|
success | boolean | True if the cancellation succeeded |
DropTransactionRequest
Parameter | Type | Description |
---|---|---|
txId | string | The ID of the transaction being dropped. |
feeLevel | string | The fee level for the replacement of non-ETH transactions. |
gasPrice | string | The network fee level for the replacement of ETH transactions. |
DropTransactionResponse
Parameter | Type | Description |
---|---|---|
success | boolean | True if the transaction drop or replacement succeeded. |
transactions | array | Dropped Transaction replacement Transaction ID(s). |
TransferPeerPathResponse
Parameter | Type | Description |
---|---|---|
type | string | [ VAULT_ACCOUNT, EXCHANGE_ACCOUNT, INTERNAL_WALLET, EXTERNAL_WALLET, ONE_TIME_ADDRESS, NETWORK_CONNECTION, FIAT_ACCOUNT, COMPOUND, UNKNOWN ] |
id | string | The ID of the exchange account to return |
name | string | The name of the exchange account |
subType | string |
TransactionResponse
Parameter | Type | Description |
---|---|---|
id | string | ID of the transaction |
assetId | string | Transaction asset |
source | TransferPeerPathResponse | Source of the transaction |
destination | TransferPeerPathResponse | Destination of the transaction |
contractCallDecodedData | array | Contains contractName string field and functionCalls data object. |
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 |
destinationAddress | string | Address where the asset were transfered |
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 | Custome 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. |
TransactionOperation
Parameter | Type | Description |
---|---|---|
operation | string | [ TRANSFER, RAW, CONTRACT_CALL, MINT, BURN, ENABLE_ASSET, SUPPLY_TO_COMPOUND, REDEEM_FROM_COMPOUND, TYPED_MESSAGE ] |
ValidateAddressResponse
Parameter | Type | Description |
---|---|---|
isValid | boolean | The address is valid. |
isActive | boolean | The address is active. |
requiresTag | boolean | The address requires a tag or memo. |
FeePayerInfo
Parameter | Type | Description |
---|---|---|
feePayer | string | For SPL transfers only, the id for the fee payer vault account |
BlockInfo
Parameter | Type | Description |
---|---|---|
blockHeight | string | The height (number) of the block the transaction was mined in |
blockHash | string | The hash of the block the transaction was mined in |
RewardsInfo
Parameter | Type | Description |
---|---|---|
srcRewards | string | The ALGO rewards acknowledged by the source account of the transaction |
destRewards | string | The ALGO rewards acknowledged by the destination account of the transaction |
SignedMessage
Parameter | Type | Description |
---|---|---|
content | string | The message for signing (hex-formatted) |
algorithm | string | The algorithm that was used for signing, one of the SigningAlgorithms |
derivationPath | Array of numbers | BIP32 derivation path of the signing key. E.g. [44,0,46,0,0] |
signature | dictionary | The message signature |
publicKey | string | Signature's public key that can be used for verification. |
NetworkFee
Parameter | Type | Description |
---|---|---|
feePerByte | string | [optional] For UTXOs |
gasPrice | string | [optional] For Ethereum assets (ETH and Tokens) |
networkFee | string | [optional] All other assets |
baseFee | string | [optional] Base Fee according to EIP-1559 (ETH assets) |
priorityFee | string | [optional] Priority Fee according to EIP-1559 (ETH assets) |
TransactionFee
Parameter | Type | Description |
---|---|---|
feePerByte | string | [optional] For UTXOs, |
gasPrice | string | [optional] For Ethereum assets (ETH and Tokens) |
gasLimit | string | [optional] For Ethereum assets (ETH and Tokens), the limit for how much can be used |
networkFee | string | [optional] Transaction fee |
baseFee | string | [optional] Base Fee according to EIP-1559 (ETH assets) |
priorityFee | string | [optional] Priority Fee according to EIP-1559 (ETH assets) |
EstimatedTransactionFeeResponse
Parameter | Type | Description |
---|---|---|
low | TransactionFee | Transactions with this fee will probably take longer to be mined |
medium | TransactionFee | Average transactions fee |
high | TransactionFee | Transactions with this fee should be mined the fastest |
AmountInfo
Parameter | Type | Description |
---|---|---|
amount | string | If the transfer is a withdrawal from an exchange, the actual amount that was requested to be transferred. Otherwise, it is the requested amount. This value will always be equal to the amount (number) parameter of TransactionDetails. |
requestedAmount | string | The amount requested by the user |
netAmount | string | The net amount of the transaction, after fee deduction |
amountUSD | string | The USD value of the requested amount |
FeeInfo
Parameter | Type | Description |
---|---|---|
networkFee | string | The fee paid to the network |
serviceFee | string | The total fee deducted by the exchange from the actual requested amount (serviceFee = amount - netAmount) |
SetConfirmationsThresholdResponse
Parameter | Type | Description |
---|---|---|
success | boolean | |
transactions | array of strings | txIds of the transactions |
AmlScreeningResult
Parameter | Type | Description |
---|---|---|
provider | string | The AML service provider |
payload | string | The response of the AML service provider |
RawMessageData
Parameter | Type | Description |
---|---|---|
messages | array of UnsignedRawMessage objects | The messages that should be signed |
algorithm | string | [optional] The algorithm which will be used to sign the transaction, one of the SigningAlgorithms |
UnsignedRawMessage
Parameter | Type | Description |
---|---|---|
content | string | The message to be signed in hex format encoding |
bip44AddressIndex | number | [optional] BIP44 address_index path level |
bip44change | number | [optional] BIP44 change path level |
The 2 fields above complement the derivation path given the source id and asset were provided in the transaction body request. | ||
In case none of the above was provided, please specify the derivation path. | ||
derivationPath | array of numbers | [optional] Should be passed only if asset and source were not specified |
SigningAlgorithm
Parameter | Type | Description |
---|---|---|
algorithm | string | [ MPC_ECDSA_SECP256K1, MPC_ECDSA_SECP256R1, MPC_EDDSA_ED25519 ] |
OneTimeAddress
Parameter | Type | Description |
---|---|---|
address | string | Transfer destination address |
tag | string | Transfer destination tag for Ripple; memo for EOS/XLM, for the fiat providers (Signet by Signature, SEN by Silvergate, BLINC by BCB Group), it is the Bank Transfer Description |
TransactionRequestDestination
Parameter | Type | Description |
---|---|---|
amount | string | The amount to be sent to this destination |
destination | DestinationTransferPeerPath | The specific destination |
TransactionRequestCallbackDestination
Parameter | Type | Description |
---|---|---|
amountNative | sumber | The amount transfered to this destination as a number |
amountNativeStr | string | The amount transfered to this destination in a string representation |
amountUSD | number | The USD value transfered to this destination |
dstAddressType | WHITELISTED or ONE_TIME | |
dstId | string | The ID of the destination |
dstName | string | The name of the destination |
dstSubType | string | The specific exchnage, Fiat account or Unmanaged (INTERNAL / EXTERNAL) |
dstType | string | The destination of the transaction (VAULT, EXCHANGE or UNMANAGED) |
displayDstAddress | string | The address of this specific destination |
RawTX
Parameter | Type | Description |
---|---|---|
rawTx | string | Hex-encoded details of a transaction sent to the blockchain |
keyDerivationPath | Array of numbers | Location of the encryption key within the customer’s HD Wallet URL used to sign this transaction. |
InputsSelection
Input
Parameter | Type | Description |
---|---|---|
txHash | string | txHash |
index | string | vOut of the txHash |
UnspentInputsData
Parameter | Type | Description |
---|---|---|
input | Input | An object containing the txHash and index of this input |
address | string | The destination address of this input |
amount | string | The amount of this input |
confirmations | number | Number of confirmations for the transaction of this input |
status | string | The status is based on the status of the transaction |
DestinationsResponse
Parameter | Type | Description |
---|---|---|
amount | string | The amount to be sent to this destination |
destination | TransferPeerPathResponse | Destination of the transaction |
amountUSD | number | The USD value of the requested amount |
destinationAddress | string | Address where the asset were transfered |
destinationAddressDescription | string | Description of the address |
amlScreeningResult | AmlScreeningResult | The result of the AML screening |
customerRefId | string | The ID for AML providers to associate the owner of funds with transactions |
AddressStatus
Parameter | Type | Description |
---|---|---|
isValid | boolean | Returns "false" if the address is in a wrong format |
isActive | boolean | Returns "false" if the address doesn't have enough balance or wasn't activate |
requiresTag | boolean | Returns "true" if the address requires tag when used as a transaction destination |
AuthorizationInfo
Parameter | Type | Description |
---|---|---|
allowOperatorAsAuthorizer | boolean | Set to "true" if the intiator of the transaction can be one of the approvers |
logic | string | "AND" or "OR", this is the logic that is applied between the different authorization groups listed below |
groups | list of AuthorizationGroups | The list of authorization groups and users that are required to approve this transaction. The logic applied between the different groups is the “logic” field above. Each element in the response is the user ID (the can found see via the users endpoint) and theirApprovalStatus |
AuthorizationGroup
Parameter | Type | Description |
---|---|---|
th | number | The threshold of required approvers in this authorization group |
users | list of users | The list of users that the threshold number is applied to for transaction approval. Each user in the response is a "key:value" where the key is the user ID (the can found see via the users endpoint) and the value is the theirApprovalStatus. |
ApprovalStatus
Parameter | Type | Description |
---|---|---|
approval | string | [ PENDING_AUTHORIZATION, APPROVED, REJECTED, NA ] |
Network Objects
NetworkRecord
Parameter | Type | Description |
---|---|---|
source | TransferPeerPathResponse | Source of the transaction |
destination | TransferPeerPathResponse | Destination of the transaction |
txHash | string | Blockchain hash of the transaction |
networkFee | number | The fee paid to the network |
assetId | string | Transaction asset |
netAmount | number | The net amount of the transaction, after fee deduction |
status | NetworkStatus | Status of the blockchain transaction |
type | string | Type of the operation |
destinationAddress | string | Destination address |
sourceAddress | string | For account based assets only, the source address of the transaction |
NetworkConnectionResponse
Parameter | Type | Description |
---|---|---|
id | string | The ID of the Network Connection |
localNetworkId | NetworkId | Local network ID |
remoteNetworkId | NetworkId | Remote network ID |
routingPolicy | NetworkConnectionRoutingPolicy | The routing policy for the network connection. |
NetworkConnectionRoutingPolicy
Parameter | Type | Description |
---|---|---|
crypto | CustomCryptoRoutingDest, DefaultNetworkRoutingDest, -OR- NoneNetworkRoutingDest | The crypto routing policy. |
sen | CustomFiatRoutingDest, DefaultNetworkRoutingDest, -OR- NoneNetworkRoutingDest | The fiat routing policy. |
signet | DefaultNetworkRoutingDest, CustomFiatRoutingDest, -OR- NoneNetworkRoutingDest | The network routing policy |
sen_test | DefaultNetworkRoutingDest, NoneNetworkRoutingDest, -OR-CustomFiatRoutingDest | The test fiat routing policy |
signet_test | NoneNetworkRoutingDest, CustomFiatRoutingDest, -OR- DefaultNetworkRoutingDest | The test network routing policy |
CustomCryptoRoutingDest
Parameter | Type | Description |
---|---|---|
scheme | string | The network routing logic. Valid value: CUSTOM |
dstType | string | The type of account the funds are being sent to. Valid values: VAULT , EXCHANGE |
dstId | string | The ID of the fiat account the funds are being sent to. |
CustomFiatRoutingDest
Parameter | Type | Description |
---|---|---|
scheme | string | The network routing logic. Valid value: CUSTOM |
dstType | string | The type of account the funds are being sent to. Valid value: FIAT_ACCOUNT |
dstId | string | The ID of the fiat account the funds are being sent to. |
DefaultNetworkRoutingDest
Parameter | Type | Description |
---|---|---|
scheme | string | The default network routing logic. Valid value: DEFAULT |
NoneNetworkRoutingDest
Parameter | Type | Description |
---|---|---|
scheme | string | No network routing logic. Valid value: NONE |
NetworkId
Parameter | Type | Description |
---|---|---|
id | string | 8 characters ID of the network |
name | string | The name of the network |
NetworkIdResponse
Parameter | Type | Description |
---|---|---|
id | string | 8 characters ID of the network |
name | string | The name of the network |
routingPolicy | NetworkIdRoutingPolicy | The routing policy for the network connection. |
isDiscoverable | boolean | Whether the specific network is discoverable. |
Fiat Account Objects
FiatAccount
Parameter | Type | Description |
---|---|---|
id | string | The ID of the account |
type | string | [ BLINC, SIGNET, SILVERGATE ] |
name | string | Display name of the fiat account |
address | string | The address of the account |
assets | Array of FiatAssets | Array of the assets under the account |
FiatAsset
Parameter | Type | Description |
---|---|---|
id | string | The ID of the asset |
balance | string | The balance of the asset |
Supported Assets Object
AssetTypeResponse
Parameter | Type | Description |
---|---|---|
id | string | The ID of the asset |
name | string | The name of the asset |
type | string | [ ALGO_ASSET, BASE_ASSET, BEP20, COMPOUND, ERC20, FIAT, SOL_ASSET, TRON_TRC20, XLM_ASSET ] |
contractAddress | string | Contract address for ERC-20 smart contracts |
nativeAsset | string | The name of the native asset |
decimals | number | The number of digits after the decimal point |
Gas Station Objects
GasStationPropertiesResponse
Parameter | Type | Description |
---|---|---|
balance | dictionary | A dictionary of an asset and its balance in the Gas Station |
configuration | GasStationConfiguration | The settings of your Gas Station |
GasStationConfiguration
Parameter | Type | Description |
---|---|---|
gasThreshold | string | Below this ETH balane the address will be funded up until gasCap value, in ETH units |
gasCap | string | Up to this level the address will be funded with ETH, in ETH units |
maxGasPrice | string | The funding transaction will be sent with this maximum value gas price, in Gwei units |
Webhooks
ResendWebhooksResponse
Parameter | Type | Description |
---|---|---|
messagesCount | number | The number of resent webhook notifications. |
Users
GetUsersResponse
Parameter | Type | Description |
---|---|---|
id | string | User ID on the Fireblocks platform |
firstName | string | First name |
lastName | string | Last name |
role | string | The role of the user in the workspace, one of the options as described here |
string | The email of the user | |
enabled | boolean | The status of the user in the workspace |
Payments Objects
XBSettlementConfigCreationRequestBody
Parameter | Type | Description |
---|---|---|
name | string | The text name of the settlement configuration. |
corridorId | string | The ID of the cross-border corridor. |
steps | XBSettlementConfigStepsRecord | The recorded steps of the cross-border settlement configuration. |
XBSettlementConfigCreationResponse
Parameter | Type | Description |
---|---|---|
tenantId | string | The ID of the tenant. |
configId | string | The ID of the cross-border settlement configuration. |
corridorId | string | The ID of the cross-border corridor. |
name | string | The text name of the settlement configuration. |
steps | XBSettlementConfigStepsRecord | The recorded steps of the cross-border settlement configuration. |
XBSettlementConfigEditRequestBody
Parameter | Type | Description |
---|---|---|
name | string | Optional - The text name of the settlement configuration. |
steps | XBSettlementConfigStepsRecord | Optional - The recorded steps of the cross-border settlement configuration. |
XBSettlementConfigEditResponse
Parameter | Type | Description |
---|---|---|
tenantId | string | The ID of the tenant. |
configId | string | The ID of the cross-border settlement configuration. |
corridorId | string | The ID of the cross-border corridor. |
name | string | The text name of the settlement configuration. |
steps | XBSettlementConfigStepsRecord | The recorded steps of the cross-border settlement configuration. |
XBSettlementConfigDeletionResponse
Parameter | Type | Description |
---|---|---|
configId | string | The ID of the cross-border settlement configuration. |
GetXBSettlementConfigResponse
Parameter | Type | Description |
---|---|---|
tenantId | string | The ID of the tenant. |
configId | string | The ID of the cross-border settlement configuration. |
corridorId | string | The ID of the cross-border corridor. |
name | string | The text name of the settlement configuration. |
steps | XBSettlementConfigStepsRecord | The recorded steps of the cross-border settlement configuration. |
GetAllXBSettlementConfigsResponse
Parameter | Type | Description |
---|---|---|
configurations | XBSettlementConfigModel | The configuration of the cross-border settlement. |
XBCreateSettlementFlowRequestBody
Parameter | Type | Description |
---|---|---|
configId | string | The ID of the cross-border settlement configuration. |
amount | XBSettlementAsset | The type and amount of an asset setup in the cross-border settlement configuration. |
XBCreateSettlementFlowResponse
Parameter | Type | Description |
---|---|---|
tenantId | string | The ID of the tenant. |
flowId | string | The ID of the settlement flow configuration. |
configId | string | The ID of the cross-border settlement configuration. |
steps | XBSettlementConfigStepsRecord | The recorded steps of the cross-border settlement configuration. |
inputAmount | XBSettlementAsset | The type and amount of an asset input in the cross-border settlement configuration. |
outputAmount | XBSettlementAsset | The type and amount of an asset output in the cross-border settlement configuration. |
totalEstimatedFees | XBSettlementAsset | The type and amount of estimated asset fees setup in the cross-border settlement configuration. |
totalEstimatedTime | number | The total amount of time estimated for the complete cross-border settlement flow to be executed. |
XBSettlementFlowExecutionResponse
Parameter | Type | Description |
---|---|---|
tenantId | string | The ID of the tenant. |
flowId | string | The ID of the settlement flow configuration. |
configId | string | The ID of the cross-border settlement configuration. |
steps | XBSettlementConfigStepsRecord | The recorded steps of the cross-border settlement configuration. |
inputAmount | XBSettlementAsset | The type and amount of an asset input in the cross-border settlement configuration. |
outputAmount | XBSettlementAsset | The type and amount of an asset output in the cross-border settlement configuration. |
totalFees | XBSettlementAsset | The type and amount of estimated asset fees setup in the cross-border settlement configuration. |
initiatedAt | number | The time the flow execution was initiated. |
initiatedBy | string | The ID of the user who initiated the flow execution. |
state | XBSettlementFlowExecutionStatus | The status of the flow execution. |
XBSettlementFlowExecutionStep
Parameter | Type | Description |
---|---|---|
id | string | The ID of the individual flow execution step. |
accountId | string | The ID of the account initiating the flow execution step. |
status | XBSettlementFlowExecutionStepStatus | The status of the individual step of the flow execution. |
inputAmount | XBSettlementAsset | The type and amount of an asset input in the cross-border settlement configuration. |
outputAmount | XBSettlementAsset | The type and amount of an asset output in the cross-border settlement configuration. |
fee | XBSettlementAsset | The type and amount of an asset setup in the cross-border settlement configuration. |
startedAt | number | The time the specific flow execution step began. |
XBSettlementFlowExecutionStepStatus
Parameter | Type | Description |
---|---|---|
XBSettlementFlowExecutionStepStatus | string | Valid values: NOT_STARTED, PROCESSING, COMPLETED, FAILED. |
XBSettlementFlowExecutionStatus
Parameter | Type | Description |
---|---|---|
XBSettlementFlowExecutionStatus | string | Valid values: NOT_STARTED, PROCESSING, COMPLETED, FAILED. |
XBSettlementConfigModel
Parameter | Type | Description |
---|---|---|
tenantId | string | The ID of the tenant. |
flowId | string | The ID of the settlement flow configuration. |
configId | string | The ID of the cross-border settlement configuration. |
name | string | The text name of the cross-border settlement configuration. |
steps | XBSettlementConfigStepsRecord | The recorded steps of the cross-border settlement configuration. |
XBSettlementConfigStep
Parameter | Type | Description |
---|---|---|
stepType | XBSettlementStepType | The type of step specified in the configuration. |
accountId | string | The ID of the account initiating the flow execution step. |
XBSettlementStepType
Parameter | Type | Description |
---|---|---|
XBSettlementStepType | string | Valid values: ON_RAMP, VAULT_ACCOUNT, OFF_RAMP, FIAT_DESTINATION . |
XBSettlementFlowSetupStep
Parameter | Type | Description |
---|---|---|
accountId | string | The ID of the account initiating the flow execution step. |
inputAmount | XBSettlementAsset | The type and amount of an asset input in the cross-border settlement configuration. |
outputAmount | XBSettlementAsset | The type and amount of an asset output in the cross-border settlement configuration. |
estimatedFeeAmount | XBSettlementAsset | The type and amount of asset fees estimated in the cross-border settlement configuration. |
estimatedTime | number | The amount of time estimated for the complete cross-border settlement flow setup step to be executed |
XBSettlementFlowSetupModel
Parameter | Type | Description |
---|---|---|
tenantId | string | The ID of the tenant. |
flowId | string | [Optional] The ID of the settlement flow configuration. |
configId | string | The ID of the cross-border settlement configuration. |
steps | XBSettlementFlowStepsRecord | The specified steps for the cross-border settlement flow configuration. |
inputAmount | XBSettlementAsset | The type and amount of an asset input in the cross-border settlement configuration. |
outputAmount | XBSettlementAsset | The type and amount of an asset output in the cross-border settlement configuration. |
totalEstimatedFeeAmount | XBSettlementAsset | The type and total amount of asset fees estimated in the cross-border settlement configuration. |
totalEstimatedTime | number | The amount of total time estimated for each cross-border settlement flow setup step to be executed. |
XBSettlementFlowExecutionModel
Parameter | Type | Description |
---|---|---|
tenantId | string | The ID of the tenant. |
flowId | string | The ID of the settlement flow configuration. |
configId | string | The ID of the cross-border settlement configuration. |
steps | XBSettlementFlowExecutionStep | The instructions for the specified cross-border settlement flow configuration step. |
inputAmount | XBSettlementAsset | The type and amount of an asset input in the cross-border settlement configuration. |
outputAmount | XBSettlementAsset | The type and amount of an asset output in the cross-border settlement configuration. |
totalFees | XBSettlementAsset | The type and amount of total asset fees in the cross-border settlement configuration. |
initiatedAt | number | The time the flow execution was initiated. |
initiatedBy | string | The ID of the user who initiated the flow execution. |
state | XBSettlementFlowExecutionStatus | The status of the flow execution. |
XBSettlementConfigStepsRecord
Parameter | Type | Description |
---|---|---|
stepType | XBSettlementStepType | The type of step specified in the configuration. |
accountId | string | The ID of the account initiating the flow execution step. |
XBSettlementFlowStepsRecord
Parameter | Type | Description |
---|---|---|
stepType | XBSettlementStepType | The type of step specified in the configuration. |
XBSettlementFlowSetupStep | XBSettlementFlowSetupStep | The arrangement and setup of steps for the cross-border configuration flow. |
XBSettlementAsset
Parameter | Type | Description |
---|---|---|
amount | string | The amount of the asset being used in the cross-border settlement. |
assetId | string | The ID of the specific asset type being used in the cross-border settlement. |
NFT Objects
MediaEntityResponse
Parameter | Type | Description |
---|---|---|
url | string | Cached accessible URL. |
contentType | string | Media Type. |
TokenCollectionResponse
Parameter | Type | Description |
---|---|---|
id | string | Unique token collection ID with Fireblocks. |
name | string | The display name of the token collection. |
symbol | string | The ticker symbol for the token. |
TokenResponse
Parameter | Type | Description |
---|---|---|
id | string | Unique token ID with Fireblocks. |
tokenId | string | Token ID within the contract/collection. |
standard | string | ERC721 or ERC1155 |
metadataURI | string | URL to original token metadata JSON |
media | MediaEntityResponse object | Media items extracted from metadata JSON |
collection | TokenCollectionResponse object | Parent collection information |
blockchainDescriptor | string | Blockchain descriptor filter. Available values : ETH, ETH_TEST3, POLYGON, POLYGON_TEST_MUMBAI |
description | string | A summary of the token. |
name | string | The display name of the token. |
TokenOwnershipResponse
Parameter | Type | Description |
---|---|---|
id | string | Unique token ID with Fireblocks. |
tokenId | string | Token ID within the contract/collection. |
standard | string | ERC721 or ERC1155 |
metadataURI | string | URL to original token metadata JSON |
media | MediaEntityResponse object | Media items extracted from metadata JSON |
collection | TokenCollectionResponse object | Parent collection information |
vaultAccountId | string | The ID for the vault account that owns the token. |
balance | number | Balance of vault token collection. |
blockchainDescriptor | string | Blockchain descriptor filter. Available values : ETH, ETH_TEST3, POLYGON, POLYGON_TEST_MUMBAI |
description | string | The description of the NFT |
name | string | The display name of the NFT |
Web3 Connection Objects
SessionMetadata
Parameter | Type | Description |
---|---|---|
appUrl | string | URL for Walletconnect Web3 dapp |
appName | string | Display name for the Web3 dapp |
appDescription | string | Description of the Web3 dapp |
appIcon | string | Given ticker symbol to represent the dapp. |
SessionDTO
Parameter | Type | Description |
---|---|---|
id | string | ID of the connection. |
userId | string | ID of the user that created the connection. |
sessionMetadata | SessionMetadata object | Metadata of the connection (provided by the Dapp). |
vaultAccountId | string | The vault to connect. |
feeLevel | string | The default fee level. Valid values are MEDIUM and HIGH . |
chainIds | array | The chains approved for the connection. |
connectionType | string | The connection's type - Valid value: "WalletConnect". |
connectionMethod | string | The method through which the connection was established. Valid values are: "DESKTOP", "MOBILE" or "API". |
creationDate | string | Timestamp of the session's creation. |
GetConnectionResponse
Parameter | Type | Description |
---|---|---|
data | SessionDTO object | Array with the requested Web3 connection's data. |
paging | Paging | Paging cursor settings |
CreateConnectionRequest
Parameter | Type | Description |
---|---|---|
vaultAccountId | string | The ID of the vault to connect to the Web3 connection. |
feeLevel | string | The default fee level. Valid values are MEDIUM and HIGH . |
uri | string | The WalletConnect URI provided by the Dapp. |
chainIds | array | The ID of the blockchain network(s) used in the Web3 connection. |
CreateConnectionResponse
Parameter | Type | Description |
---|---|---|
id | string | The ID of the Web3 connection initiated. |
sessionMetadata | array | Metadata of the Web3 connection (provided by the DApp). |
RespondToConnectionRequest
Parameter | Type | Description |
---|---|---|
approve | boolean | Approval of the initiated Web3 connection. Default value is "true". |
General Objects
ConfigChangeRequestStatus
Parameter | Type | Description |
---|---|---|
status | string | [ WAITING_FOR_APPROVAL, APPROVED, CANCELLED, REJECTED, FAILED ] |
Paging
Parameter | Type | Description |
---|---|---|
next | string | Cursor to the next page. |