Off Exchange Webhooks v2

Settlement Created

A notification is sent when a new settlement is initiated in the workspace.

Field	Type	Description
id	UUID	Unique identifier of the object.
eventType	string (enum)	internal_wallet.asset.removed
eventVersion	integer	The version of the specific event.
resourceId (optional)	UUID	Optional ID of the entity that triggered the event (i.e., txId).
data	object	Object containing data associated with the event.
createdAt	timestamp	Time at which the object was created and measured in seconds since the Unix epoch.
workspaceId	UUID	The workspace ID

settlementDetails

Parameter	Type	Description
collateralAccountId	string	The collateral account ID.
settlementId	string	Unique settlement ID provided by Fireblocks.
isForceSettlement	boolean	A flag or condition that indicates whether a settlement should be forcibly executed, overriding normal settlement procedures.
toExchange	data [array]	All settlement transaction details are required to be sent to the exchange.
toCollateral	data [array]	All settlement transaction details are required to be sent to the collateral account.

toExchange

Parameter	Type	Description
txId	string	The transaction ID (within the main workspace).
assetId	string	The ID of the transaction's asset, applicable to `TRANSFER`, `MINT, BURN`, or `ENABLE_ASSET` operations. For a list of supported assets and their corresponding IDs, please refer here.
amount	string	The actual amount requested for transfer.

toCollateral

Parameter	Type	Description
txId	string	The transaction ID (within the main workspace).
assetId	string	The ID of the transaction's asset, applicable to `TRANSFER`, `MINT, BURN`, or `ENABLE_ASSET` operations. For a list of supported assets and their corresponding IDs, please refer here .
amount	string	The actual amount requested for transfer.