Data Objects

Here you can find a description of all the objects expected and returned by the endpoints described above.

Vault Objects

VaultAccountsPagedResponse

ParameterTypeDescription
accountsArray of VaultAccountList of vault account objects
pagingobjectThis object contains two fields: "before" (string) and “after” (string)
previousUrlstringURL string of the request for the previous page
nextUrlstringURL string of the request for the next page

CreateVaultAssetResponse

ParameterTypeDescription
idstringThe ID of the Vault Account
addressstringAddress of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, cash address format for BCH
legacyAddressstringLegacy address format for BTC/LTC/BCH
tagstringDestination tag for XRP, used as memo for EOS/XLM
eosAccountNamestringReturned for EOS, the account name

VaultAsset

ParameterTypeDescription
idstringThe ID of the asset
totalstringThe total wallet balance.
balancestringDeprecated - replaced by "total"
availablestringFunds available for transfer. Equals the blockchain balance minus any locked amount
pendingstringThe cumulative balance of all transactions pending to be cleared
stakedstringStaked funds, returned only for DOT
frozenstringFrozen by the AML policy in your workspace
lockedAmountstringFunds in outgoing transactions that are not yet published to the network
totalStakedCPUstring[optional] Deprecated
totalStakedNetworkstring[optional] Deprecated
selfStakedCPUstring[optional] Deprecated
selfStakedNetworkstring[optional] Deprecated
pendingRefundCPUstring[optional] Deprecated
pendingRefundNetworkstring[optional] Deprecated
blockHeightstringThe height (number) of the block of the balance
blockHashstringThe hash of the block of the balance

VaultAccountAssetAddress

ParameterTypeDescription
assetIdstringThe ID of the asset
addressstringAddress of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, for BCH cash format
legacyAddressstringFor BTC/LTC/BCH the legacy format address
descriptionstringDescription of the address
tagstringDestination 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
typestringAddress type
customerRefIdstring[optional] The ID for AML providers to associate the owner of funds with transactions
bip44AddressIndexnumber[optional] The address_index, addressFormat, and enterpriseAddress in the derivation path of this address based on BIP44

CreateAddressResponse

ParameterTypeDescription
addressstringAddress of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, cash address format for BCH
legacyAddressstringLegacy address format for BTC/LTC/BCH
tagstringDestination tag for XRP, used as memo for EOS/XLM
bip44AddressIndexnumberThe address_index in the derivation path of this address based on BIP44

VaultAccount

ParameterTypeDescription
idstringThe ID of the Vault Account
namestringName of the Vault Account
hiddenOnUIbooleanSpecifies whether this vault account is visible in the web console or not
customerRefIdstring[optional] The ID for AML providers to associate the owner of funds with transactions
autoFuelbooleanSpecifies whether this account's Ethereum address is auto fueled by the Gas Station or not
assetsArray of VaultAssetList 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

ParameterTypeDescription
publicKeysringThe requested public key
algorithmstringOne of the SigningAlgorithms
derivationPathArray of numbersFor BIP32 derivation used to retrieve the public key

Internal/External Wallets

WalletAsset

ParameterTypeDescription
idstringThe ID of the asset
balancestringThe balance of the wallet
lockedAmountstringLocked amount in the wallet
statusConfigChangeRequestStatusStatus of the Internal Wallet
activationTimestringThe time the wallet will be activated in case wallets activation posponed according to workspace definition
addressstringThe address of the wallet
tagstringDestination tag (for XRP, used as memo for EOS/XLM) of the wallet.

ExternalWalletAsset

ParameterTypeDescription
idstringThe ID of the asset
statusConfigChangeRequestStatusStatus of the External Wallet
activationTimestringThe time the wallet will be activated in case wallets activation posponed according to workspace definition
addressstringThe address of the wallet
tagstringDestination 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

ParameterTypeDescription
idstringThe ID of the Unmanaged Wallet
namestringName of the Wallet Container
customerRefIdstring[optional] The ID for AML providers to associate the owner of funds with transactions
assetsArray of WalletAssetArray of the assets available in the unmanaged wallet

ExternalWallet

ParameterTypeDescription
idstringThe ID of the Unmanaged Wallet
namestringName of the Wallet Container
customerRefIdstring[optional] The ID for AML providers to associate the owner of funds with transactions
assetsArray of ExternalWalletAssetArray of the assets available in the exteral wallet

Contract Objects

ContractAsset

ParameterTypeDescription
idstringThe ID of the contract wallet.
balancestringThe balance of the contract wallet.
lockedAmountstringLocked amount in the contract wallet.
statusConfigChangeRequestStatusStatus of the contract wallet.
activationTimestringThe time the contract wallet will be activated if case wallets activation is postponed according to the workspace definition.
addressstringThe address of the contract wallet.
tagstringDestination tag (for XRP, used as memo for EOS/XLM) of the contract wallet.a

UnmanagedContract

ParameterTypeDescription
idstringThe ID of the unmanaged contract wallet.
namestringName of the contract wallet container.
assetsArray of ContractAsset objectsAn array of assets available in the unmanaged contract wallet.

Exchange Objects

ExchangeAccount

ParameterTypeDescription
idstringThe ID of the exchange account to return
typeExchangeType
namestringDisplay name of the exchange account
statusConfigChangeRequestStatusStatus of the exchange account connection
assetsArray of ExchangeAssetAssets in the account
isSubaccountbooleanTrue if the account is a subaccount in an exchange
mainAccountIdstringThe of the exchange main account
tradingAccountsArray of TradingAccountTrading accounts under this exchange account
fundableAccountTypeTradingAccountTypeThe internal account that is used for deposit or withdrawals of this exchange main or sub account

ExchangeAsset

ParameterTypeDescription
idstringThe ID of the exchange account to return
totalstringThe total balance of the asset in the exchange account
availablestringThe balance that can be withdrawan from the exchange account or moved to a different account
lockedAmountstringLocked amount in the account
balancestringDeprecated - replaced by "total"

ExchangeType

ParameterTypeDescription
typestring[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

ParameterTypeDescription
typeTradingAccountTypeThe specific trading account under the exchange account
assetsArray of ExchangeAssetAssets in the trading account

TradingAccountType

ParameterTypeDescription
typestring[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

ParameterTypeDescription
typestring[ VAULT_ACCOUNT, EXCHANGE_ACCOUNT, FIAT_ACCOUNT, GAS_STATION ]
idstringThe ID of the peer

DestinationTransferPeerPath

ParameterTypeDescription
typestring[ VAULT_ACCOUNT, EXCHANGE_ACCOUNT, INTERNAL_WALLET, EXTERNAL_WALLET, ONE_TIME_ADDRESS, NETWORK_CONNECTION, FIAT_ACCOUNT, COMPOUND ]
idstringThe peer ID (not needed for ONE_TIME_ADDRESS)
oneTimeAddressOneTimeAddressDestination address

CreateTransactionResponse

ParameterTypeDescription
idstringThe ID of the transaction
statusTransactionStatusStatus of the transaction

CancelTransactionResponse

ParameterTypeDescription
successbooleanTrue if the cancellation succeeded

DropTransactionRequest

ParameterTypeDescription
txIdstringThe ID of the transaction being dropped.
feeLevelstringThe fee level for the replacement of non-ETH transactions.
gasPricestringThe network fee level for the replacement of ETH transactions.

DropTransactionResponse

ParameterTypeDescription
successbooleanTrue if the transaction drop or replacement succeeded.
transactionsarrayDropped Transaction replacement Transaction ID(s).

TransferPeerPathResponse

ParameterTypeDescription
typestring[ VAULT_ACCOUNT, EXCHANGE_ACCOUNT, INTERNAL_WALLET, EXTERNAL_WALLET, ONE_TIME_ADDRESS, NETWORK_CONNECTION, FIAT_ACCOUNT, COMPOUND, UNKNOWN ]
idstringThe ID of the exchange account to return
namestringThe name of the exchange account
subTypestring

TransactionResponse

ParameterTypeDescription
idstringID of the transaction
assetIdstringTransaction asset
sourceTransferPeerPathResponseSource of the transaction
destinationTransferPeerPathResponseDestination of the transaction
contractCallDecodedDataarrayContains contractName string field and functionCalls data object.
requestedAmountnumberThe amount requested by the user
amountInfoAmountInfoDetails of the transaction's amount in string format
feeInfoFeeInfoDetails of the transaction's fee in string format
amountnumberIf the transfer is a withdrawal from an exchange, the actual amount that was requested to be transferred. Otherwise, the requested amount
netAmountnumberThe net amount of the transaction, after fee deduction
amountUSDnumberThe USD value of the requested amount
serviceFeenumberThe total fee deducted by the exchange from the actual requested amount (serviceFee = amount - netAmount)
treatAsGrossAmountbooleanFor outgoing transactions, if true, the network fee is deducted from the requested amount
networkFeenumberThe fee paid to the network
createdAtnumberUnix timestamp
lastUpdatednumberUnix timestamp
statusTransactionStatusThe current status of the transaction
txHashstringBlockchain hash of the transaction
indexnumber[optional] For UTXO based assets this is the vOut, for Ethereum based, this is the index of the event of the contract call
subStatusTransactionSubStatusMore detailed status of the transaction
sourceAddressstringFor account based assets only, the source address of the transaction
destinationAddressstringAddress where the asset were transfered
destinationAddressDescriptionstringDescription of the address
destinationTagstringDestination 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)
signedByArray of stringsSigners of the transaction
createdBystringInitiator of the transaction
rejectedBystringUser ID of the user that rejected the transaction (in case it was rejected)
addressTypestring[ ONE_TIME, WHITELISTED ]
notestringCustome note of the transaction
exchangeTxIdstringIf the transaction originated from an exchange, this is the exchange tx ID
feeCurrencystringThe asset which was taken to pay the fee (ETH for ERC-20 tokens, BTC for Tether Omni)
operationTransactionOperationDefault operation is "TRANSFER"
amlScreeningResultAmlScreeningResultThe result of the AML screening
customerRefIdstringThe ID for AML providers to associate the owner of funds with transactions
numOfConfirmationsnumberThe number of confirmations of the transaction. The number will increase until the transaction will be considered completed according to the confirmation policy.
networkRecordsArray of NetworkRecord objectsTransaction 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.
replacedTxHashstringIn case of an RBF transaction, the hash of the dropped transaction
externalTxIdstringUnique transaction ID provided by the user
destinationsArray of DestinationsResponseFor UTXO based assets, all outputs specified here
blockInfoBlockInfoThe information of the block that this transaction was mined in, the blocks's hash and height
rewardsInfoRewardsInfoThis 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.
authorizationInfoAuthorizationInfoThe information about your Transaction Authorization Policy (TAP). For more information about the TAP, refer to this section in the Help Center.
signedMessagesArray of SignedMessage objectsA list of signed messages returned for raw signing
extraParametersJSON objectProtocol / operation specific parameters.

TransactionOperation

ParameterTypeDescription
operationstring[ TRANSFER, RAW, CONTRACT_CALL, MINT, BURN, ENABLE_ASSET, SUPPLY_TO_COMPOUND, REDEEM_FROM_COMPOUND, TYPED_MESSAGE ]

ValidateAddressResponse

ParameterTypeDescription
isValidbooleanThe address is valid.
isActivebooleanThe address is active.
requiresTagbooleanThe address requires a tag or memo.

FeePayerInfo

ParameterTypeDescription
feePayerstringFor SPL transfers only, the id for the fee payer vault account

BlockInfo

ParameterTypeDescription
blockHeightstringThe height (number) of the block the transaction was mined in
blockHashstringThe hash of the block the transaction was mined in

RewardsInfo

ParameterTypeDescription
srcRewardsstringThe ALGO rewards acknowledged by the source account of the transaction
destRewardsstringThe ALGO rewards acknowledged by the destination account of the transaction

SignedMessage

ParameterTypeDescription
contentstringThe message for signing (hex-formatted)
algorithmstringThe algorithm that was used for signing, one of the SigningAlgorithms
derivationPathArray of numbersBIP32 derivation path of the signing key. E.g. [44,0,46,0,0]
signaturedictionaryThe message signature
publicKeystringSignature's public key that can be used for verification.

NetworkFee

ParameterTypeDescription
feePerBytestring[optional] For UTXOs
gasPricestring[optional] For Ethereum assets (ETH and Tokens)
networkFeestring[optional] All other assets
baseFeestring[optional] Base Fee according to EIP-1559 (ETH assets)
priorityFeestring[optional] Priority Fee according to EIP-1559 (ETH assets)

TransactionFee

ParameterTypeDescription
feePerBytestring[optional] For UTXOs,
gasPricestring[optional] For Ethereum assets (ETH and Tokens)
gasLimitstring[optional] For Ethereum assets (ETH and Tokens), the limit for how much can be used
networkFeestring[optional] Transaction fee
baseFeestring[optional] Base Fee according to EIP-1559 (ETH assets)
priorityFeestring[optional] Priority Fee according to EIP-1559 (ETH assets)

EstimatedTransactionFeeResponse

ParameterTypeDescription
lowTransactionFeeTransactions with this fee will probably take longer to be mined
mediumTransactionFeeAverage transactions fee
highTransactionFeeTransactions with this fee should be mined the fastest

AmountInfo

ParameterTypeDescription
amountstringIf 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.
requestedAmountstringThe amount requested by the user
netAmountstringThe net amount of the transaction, after fee deduction
amountUSDstringThe USD value of the requested amount

FeeInfo

ParameterTypeDescription
networkFeestringThe fee paid to the network
serviceFeestringThe total fee deducted by the exchange from the actual requested amount (serviceFee = amount - netAmount)

SetConfirmationsThresholdResponse

ParameterTypeDescription
successboolean
transactionsarray of stringstxIds of the transactions

AmlScreeningResult

ParameterTypeDescription
providerstringThe AML service provider
payloadstringThe response of the AML service provider

RawMessageData

ParameterTypeDescription
messagesarray of UnsignedRawMessage objectsThe messages that should be signed
algorithmstring[optional] The algorithm which will be used to sign the transaction, one of the SigningAlgorithms

UnsignedRawMessage

ParameterTypeDescription
contentstringThe message to be signed in hex format encoding
bip44AddressIndexnumber[optional] BIP44 address_index path level
bip44changenumber[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.
derivationPatharray of numbers[optional] Should be passed only if asset and source were not specified

SigningAlgorithm

ParameterTypeDescription
algorithmstring[ MPC_ECDSA_SECP256K1, MPC_ECDSA_SECP256R1, MPC_EDDSA_ED25519 ]

OneTimeAddress

ParameterTypeDescription
addressstringTransfer destination address
tagstringTransfer 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

ParameterTypeDescription
amountstringThe amount to be sent to this destination
destinationDestinationTransferPeerPathThe specific destination

TransactionRequestCallbackDestination

ParameterTypeDescription
amountNativesumberThe amount transfered to this destination as a number
amountNativeStrstringThe amount transfered to this destination in a string representation
amountUSDnumberThe USD value transfered to this destination
dstAddressTypeWHITELISTED or ONE_TIME
dstIdstringThe ID of the destination
dstNamestringThe name of the destination
dstSubTypestringThe specific exchnage, Fiat account or Unmanaged (INTERNAL / EXTERNAL)
dstTypestringThe destination of the transaction (VAULT, EXCHANGE or UNMANAGED)
displayDstAddressstringThe address of this specific destination

RawTX

ParameterTypeDescription
rawTxstringHex-encoded details of a transaction sent to the blockchain
keyDerivationPathArray of numbersLocation of the encryption key within the customer’s HD Wallet URL used to sign this transaction.

InputsSelection

ParameterTypeDescription
inputsToSpendArray of InputsInputs that should be used in the transaction
inputsToExcludeArray of InputsInputs that shouldn't be used in the transaction

Input

ParameterTypeDescription
txHashstringtxHash
indexstringvOut of the txHash

UnspentInputsData

ParameterTypeDescription
inputInputAn object containing the txHash and index of this input
addressstringThe destination address of this input
amountstringThe amount of this input
confirmationsnumberNumber of confirmations for the transaction of this input
statusstringThe status is based on the status of the transaction

DestinationsResponse

ParameterTypeDescription
amountstringThe amount to be sent to this destination
destinationTransferPeerPathResponseDestination of the transaction
amountUSDnumberThe USD value of the requested amount
destinationAddressstringAddress where the asset were transfered
destinationAddressDescriptionstringDescription of the address
amlScreeningResultAmlScreeningResultThe result of the AML screening
customerRefIdstringThe ID for AML providers to associate the owner of funds with transactions

AddressStatus

ParameterTypeDescription
isValidbooleanReturns "false" if the address is in a wrong format
isActivebooleanReturns "false" if the address doesn't have enough balance or wasn't activate
requiresTagbooleanReturns "true" if the address requires tag when used as a transaction destination

AuthorizationInfo

ParameterTypeDescription
allowOperatorAsAuthorizerbooleanSet to "true" if the intiator of the transaction can be one of the approvers
logicstring"AND" or "OR", this is the logic that is applied between the different authorization groups listed below
groupslist of AuthorizationGroupsThe 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

ParameterTypeDescription
thnumberThe threshold of required approvers in this authorization group
userslist of usersThe 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

ParameterTypeDescription
approvalstring[ PENDING_AUTHORIZATION, APPROVED, REJECTED, NA ]

Network Objects

NetworkRecord

ParameterTypeDescription
sourceTransferPeerPathResponseSource of the transaction
destinationTransferPeerPathResponseDestination of the transaction
txHashstringBlockchain hash of the transaction
networkFeenumberThe fee paid to the network
assetIdstringTransaction asset
netAmountnumberThe net amount of the transaction, after fee deduction
statusNetworkStatusStatus of the blockchain transaction
typestringType of the operation
destinationAddressstringDestination address
sourceAddressstringFor account based assets only, the source address of the transaction

NetworkConnectionResponse

ParameterTypeDescription
idstringThe ID of the Network Connection
localNetworkIdNetworkIdLocal network ID
remoteNetworkIdNetworkIdRemote network ID
routingPolicyNetworkConnectionRoutingPolicyThe routing policy for the network connection.

NetworkConnectionRoutingPolicy

ParameterTypeDescription
cryptoCustomCryptoRoutingDest, DefaultNetworkRoutingDest, -OR- NoneNetworkRoutingDestThe crypto routing policy.
senCustomFiatRoutingDest, DefaultNetworkRoutingDest, -OR- NoneNetworkRoutingDestThe fiat routing policy.
signetDefaultNetworkRoutingDest, CustomFiatRoutingDest, -OR- NoneNetworkRoutingDestThe network routing policy
sen_testDefaultNetworkRoutingDest, NoneNetworkRoutingDest, -OR-CustomFiatRoutingDestThe test fiat routing policy
signet_testNoneNetworkRoutingDest, CustomFiatRoutingDest, -OR- DefaultNetworkRoutingDestThe test network routing policy

CustomCryptoRoutingDest

ParameterTypeDescription
schemestringThe network routing logic. Valid value: CUSTOM
dstTypestringThe type of account the funds are being sent to. Valid values: VAULT, EXCHANGE
dstIdstringThe ID of the fiat account the funds are being sent to.

CustomFiatRoutingDest

ParameterTypeDescription
schemestringThe network routing logic. Valid value: CUSTOM
dstTypestringThe type of account the funds are being sent to. Valid value: FIAT_ACCOUNT
dstIdstringThe ID of the fiat account the funds are being sent to.

DefaultNetworkRoutingDest

ParameterTypeDescription
schemestringThe default network routing logic. Valid value: DEFAULT

NoneNetworkRoutingDest

ParameterTypeDescription
schemestringNo network routing logic. Valid value: NONE

NetworkId

ParameterTypeDescription
idstring8 characters ID of the network
namestringThe name of the network

NetworkIdResponse

ParameterTypeDescription
idstring8 characters ID of the network
namestringThe name of the network
routingPolicyNetworkIdRoutingPolicyThe routing policy for the network connection.
isDiscoverablebooleanWhether the specific network is discoverable.

Fiat Account Objects

FiatAccount

ParameterTypeDescription
idstringThe ID of the account
typestring[ BLINC, SIGNET, SILVERGATE ]
namestringDisplay name of the fiat account
addressstringThe address of the account
assetsArray of FiatAssetsArray of the assets under the account

FiatAsset

ParameterTypeDescription
idstringThe ID of the asset
balancestringThe balance of the asset

Supported Assets Object

AssetTypeResponse

ParameterTypeDescription
idstringThe ID of the asset
namestringThe name of the asset
typestring[ ALGO_ASSET, BASE_ASSET, BEP20, COMPOUND, ERC20, FIAT, SOL_ASSET, TRON_TRC20, XLM_ASSET ]
contractAddressstringContract address for ERC-20 smart contracts
nativeAssetstringThe name of the native asset
decimalsnumberThe number of digits after the decimal point

Gas Station Objects

GasStationPropertiesResponse

ParameterTypeDescription
balancedictionaryA dictionary of an asset and its balance in the Gas Station
configurationGasStationConfigurationThe settings of your Gas Station

GasStationConfiguration

ParameterTypeDescription
gasThresholdstringBelow this ETH balane the address will be funded up until gasCap value, in ETH units
gasCapstringUp to this level the address will be funded with ETH, in ETH units
maxGasPricestringThe funding transaction will be sent with this maximum value gas price, in Gwei units

Webhooks

ResendWebhooksResponse

ParameterTypeDescription
messagesCountnumberThe number of resent webhook notifications.

Users

GetUsersResponse

ParameterTypeDescription
idstringUser ID on the Fireblocks platform
firstNamestringFirst name
lastNamestringLast name
rolestringThe role of the user in the workspace, one of the options as described here
emailstringThe email of the user
enabledbooleanThe status of the user in the workspace

Payments Objects

XBSettlementConfigCreationRequestBody

ParameterTypeDescription
namestringThe text name of the settlement configuration.
corridorIdstringThe ID of the cross-border corridor.
stepsXBSettlementConfigStepsRecordThe recorded steps of the cross-border settlement configuration.

XBSettlementConfigCreationResponse

ParameterTypeDescription
tenantIdstringThe ID of the tenant.
configIdstringThe ID of the cross-border settlement configuration.
corridorIdstringThe ID of the cross-border corridor.
namestringThe text name of the settlement configuration.
stepsXBSettlementConfigStepsRecordThe recorded steps of the cross-border settlement configuration.

XBSettlementConfigEditRequestBody

ParameterTypeDescription
namestringOptional - The text name of the settlement configuration.
stepsXBSettlementConfigStepsRecordOptional - The recorded steps of the cross-border settlement configuration.

XBSettlementConfigEditResponse

ParameterTypeDescription
tenantIdstringThe ID of the tenant.
configIdstringThe ID of the cross-border settlement configuration.
corridorIdstringThe ID of the cross-border corridor.
namestringThe text name of the settlement configuration.
stepsXBSettlementConfigStepsRecordThe recorded steps of the cross-border settlement configuration.

XBSettlementConfigDeletionResponse

ParameterTypeDescription
configIdstringThe ID of the cross-border settlement configuration.

GetXBSettlementConfigResponse

ParameterTypeDescription
tenantIdstringThe ID of the tenant.
configIdstringThe ID of the cross-border settlement configuration.
corridorIdstringThe ID of the cross-border corridor.
namestringThe text name of the settlement configuration.
stepsXBSettlementConfigStepsRecordThe recorded steps of the cross-border settlement configuration.

GetAllXBSettlementConfigsResponse

ParameterTypeDescription
configurationsXBSettlementConfigModelThe configuration of the cross-border settlement.

XBCreateSettlementFlowRequestBody

ParameterTypeDescription
configIdstringThe ID of the cross-border settlement configuration.
amountXBSettlementAssetThe type and amount of an asset setup in the cross-border settlement configuration.

XBCreateSettlementFlowResponse

ParameterTypeDescription
tenantIdstringThe ID of the tenant.
flowIdstringThe ID of the settlement flow configuration.
configIdstringThe ID of the cross-border settlement configuration.
stepsXBSettlementConfigStepsRecordThe recorded steps of the cross-border settlement configuration.
inputAmountXBSettlementAssetThe type and amount of an asset input in the cross-border settlement configuration.
outputAmountXBSettlementAssetThe type and amount of an asset output in the cross-border settlement configuration.
totalEstimatedFeesXBSettlementAssetThe type and amount of estimated asset fees setup in the cross-border settlement configuration.
totalEstimatedTimenumberThe total amount of time estimated for the complete cross-border settlement flow to be executed.

XBSettlementFlowExecutionResponse

ParameterTypeDescription
tenantIdstringThe ID of the tenant.
flowIdstringThe ID of the settlement flow configuration.
configIdstringThe ID of the cross-border settlement configuration.
stepsXBSettlementConfigStepsRecordThe recorded steps of the cross-border settlement configuration.
inputAmountXBSettlementAssetThe type and amount of an asset input in the cross-border settlement configuration.
outputAmountXBSettlementAssetThe type and amount of an asset output in the cross-border settlement configuration.
totalFeesXBSettlementAssetThe type and amount of estimated asset fees setup in the cross-border settlement configuration.
initiatedAtnumberThe time the flow execution was initiated.
initiatedBystringThe ID of the user who initiated the flow execution.
stateXBSettlementFlowExecutionStatusThe status of the flow execution.

XBSettlementFlowExecutionStep

ParameterTypeDescription
idstringThe ID of the individual flow execution step.
accountIdstringThe ID of the account initiating the flow execution step.
statusXBSettlementFlowExecutionStepStatusThe status of the individual step of the flow execution.
inputAmountXBSettlementAssetThe type and amount of an asset input in the cross-border settlement configuration.
outputAmountXBSettlementAssetThe type and amount of an asset output in the cross-border settlement configuration.
feeXBSettlementAssetThe type and amount of an asset setup in the cross-border settlement configuration.
startedAtnumberThe time the specific flow execution step began.

XBSettlementFlowExecutionStepStatus

ParameterTypeDescription
XBSettlementFlowExecutionStepStatusstringValid values: NOT_STARTED, PROCESSING, COMPLETED, FAILED.

XBSettlementFlowExecutionStatus

ParameterTypeDescription
XBSettlementFlowExecutionStatusstringValid values: NOT_STARTED, PROCESSING, COMPLETED, FAILED.

XBSettlementConfigModel

ParameterTypeDescription
tenantIdstringThe ID of the tenant.
flowIdstringThe ID of the settlement flow configuration.
configIdstringThe ID of the cross-border settlement configuration.
namestringThe text name of the cross-border settlement configuration.
stepsXBSettlementConfigStepsRecordThe recorded steps of the cross-border settlement configuration.

XBSettlementConfigStep

ParameterTypeDescription
stepTypeXBSettlementStepTypeThe type of step specified in the configuration.
accountIdstringThe ID of the account initiating the flow execution step.

XBSettlementStepType

ParameterTypeDescription
XBSettlementStepTypestringValid values: ON_RAMP, VAULT_ACCOUNT, OFF_RAMP, FIAT_DESTINATION .

XBSettlementFlowSetupStep

ParameterTypeDescription
accountIdstringThe ID of the account initiating the flow execution step.
inputAmountXBSettlementAssetThe type and amount of an asset input in the cross-border settlement configuration.
outputAmountXBSettlementAssetThe type and amount of an asset output in the cross-border settlement configuration.
estimatedFeeAmountXBSettlementAssetThe type and amount of asset fees estimated in the cross-border settlement configuration.
estimatedTimenumberThe amount of time estimated for the complete cross-border settlement flow setup step to be executed

XBSettlementFlowSetupModel

ParameterTypeDescription
tenantIdstringThe ID of the tenant.
flowIdstring[Optional] The ID of the settlement flow configuration.
configIdstringThe ID of the cross-border settlement configuration.
stepsXBSettlementFlowStepsRecordThe specified steps for the cross-border settlement flow configuration.
inputAmountXBSettlementAssetThe type and amount of an asset input in the cross-border settlement configuration.
outputAmountXBSettlementAssetThe type and amount of an asset output in the cross-border settlement configuration.
totalEstimatedFeeAmountXBSettlementAssetThe type and total amount of asset fees estimated in the cross-border settlement configuration.
totalEstimatedTimenumberThe amount of total time estimated for each cross-border settlement flow setup step to be executed.

XBSettlementFlowExecutionModel

ParameterTypeDescription
tenantIdstringThe ID of the tenant.
flowIdstringThe ID of the settlement flow configuration.
configIdstringThe ID of the cross-border settlement configuration.
stepsXBSettlementFlowExecutionStepThe instructions for the specified cross-border settlement flow configuration step.
inputAmountXBSettlementAssetThe type and amount of an asset input in the cross-border settlement configuration.
outputAmountXBSettlementAssetThe type and amount of an asset output in the cross-border settlement configuration.
totalFeesXBSettlementAssetThe type and amount of total asset fees in the cross-border settlement configuration.
initiatedAtnumberThe time the flow execution was initiated.
initiatedBystringThe ID of the user who initiated the flow execution.
stateXBSettlementFlowExecutionStatusThe status of the flow execution.

XBSettlementConfigStepsRecord

ParameterTypeDescription
stepTypeXBSettlementStepTypeThe type of step specified in the configuration.
accountIdstringThe ID of the account initiating the flow execution step.

XBSettlementFlowStepsRecord

ParameterTypeDescription
stepTypeXBSettlementStepTypeThe type of step specified in the configuration.
XBSettlementFlowSetupStepXBSettlementFlowSetupStepThe arrangement and setup of steps for the cross-border configuration flow.

XBSettlementAsset

ParameterTypeDescription
amountstringThe amount of the asset being used in the cross-border settlement.
assetIdstringThe ID of the specific asset type being used in the cross-border settlement.

NFT Objects

MediaEntityResponse

ParameterTypeDescription
urlstringCached accessible URL.
contentTypestringMedia Type.

TokenCollectionResponse

ParameterTypeDescription
idstringUnique token collection ID with Fireblocks.
namestringThe display name of the token collection.
symbolstringThe ticker symbol for the token.

TokenResponse

ParameterTypeDescription
idstringUnique token ID with Fireblocks.
tokenIdstringToken ID within the contract/collection.
standardstringERC721 or ERC1155
metadataURIstringURL to original token metadata JSON
mediaMediaEntityResponse objectMedia items extracted from metadata JSON
collectionTokenCollectionResponse objectParent collection information
blockchainDescriptorstringBlockchain descriptor filter. Available values : ETH, ETH_TEST3, POLYGON, POLYGON_TEST_MUMBAI
descriptionstringA summary of the token.
namestringThe display name of the token.

TokenOwnershipResponse

ParameterTypeDescription
idstringUnique token ID with Fireblocks.
tokenIdstringToken ID within the contract/collection.
standardstringERC721 or ERC1155
metadataURIstringURL to original token metadata JSON
mediaMediaEntityResponse objectMedia items extracted from metadata JSON
collectionTokenCollectionResponse objectParent collection information
vaultAccountIdstringThe ID for the vault account that owns the token.
balancenumberBalance of vault token collection.
blockchainDescriptorstringBlockchain descriptor filter. Available values : ETH, ETH_TEST3, POLYGON, POLYGON_TEST_MUMBAI
descriptionstringThe description of the NFT
namestringThe display name of the NFT

Web3 Connection Objects

SessionMetadata

ParameterTypeDescription
appUrlstringURL for Walletconnect Web3 dapp
appNamestringDisplay name for the Web3 dapp
appDescriptionstringDescription of the Web3 dapp
appIconstringGiven ticker symbol to represent the dapp.

SessionDTO

ParameterTypeDescription
idstringID of the connection.
userIdstringID of the user that created the connection.
sessionMetadataSessionMetadata objectMetadata of the connection (provided by the Dapp).
vaultAccountIdstringThe vault to connect.
feeLevelstringThe default fee level. Valid values are MEDIUM and HIGH.
chainIdsarrayThe chains approved for the connection.
connectionTypestringThe connection's type - Valid value: "WalletConnect".
connectionMethodstringThe method through which the connection was established. Valid values are: "DESKTOP", "MOBILE" or "API".
creationDatestringTimestamp of the session's creation.

GetConnectionResponse

ParameterTypeDescription
dataSessionDTO objectArray with the requested Web3 connection's data.
pagingPagingPaging cursor settings

CreateConnectionRequest

ParameterTypeDescription
vaultAccountIdstringThe ID of the vault to connect to the Web3 connection.
feeLevelstringThe default fee level. Valid values are MEDIUM and HIGH.
uristringThe WalletConnect URI provided by the Dapp.
chainIdsarrayThe ID of the blockchain network(s) used in the Web3 connection.

CreateConnectionResponse

ParameterTypeDescription
idstringThe ID of the Web3 connection initiated.
sessionMetadataarrayMetadata of the Web3 connection (provided by the DApp).

RespondToConnectionRequest

ParameterTypeDescription
approvebooleanApproval of the initiated Web3 connection. Default value is "true".

General Objects

ConfigChangeRequestStatus

ParameterTypeDescription
statusstring[ WAITING_FOR_APPROVAL, APPROVED, CANCELLED, REJECTED, FAILED ]

Paging

ParameterTypeDescription
nextstringCursor to the next page.