Overview
- Audience: provider engineering/product teams integrating with Fireblocks Connectivity API v2.
- Purpose: to show the customer UX in Fireblocks and map each flow to the endpoints you must implement.
- Scope: this article summarizes customer user flows in the Fireblocks Console and API and maps them to Connectivity API v2 endpoints to implement on the provider side.
-
Spec & Reference:
- Fireblocks Network Link Integration guide for provider connectivity
- Fireblocks Network Link Readme
- Fireblocks Network Link GitHub Repository
-
Network Link integration overview:
Fireblocks provides Network Link partners with a full range of endpoints to integrate their services with Fireblocks customers. Partners can utilize all endpoints relevant to their use case. For full information on how exchanges and other third-party services connect to Fireblocks using Network Link, see here. See the GitHub repository for the complete OpenAPI specification.Note:
Network Link is implemented through the Connectivity API v2 specification.
Fireblocks lets external providers (banks, exchanges, on/off ramp, swap/market venues) integrate via Connectivity API v2 so that Fireblocks customers can connect accounts, move crypto/fiat, trade, use off-exchange collateral, and review history directly from the Fireblocks Console and API.
This article caters to providers. It shows the customer experience and, for each flow, the provider endpoints you must implement, plus screenshots, sequence diagrams, and testing notes.
Fireblocks user experience examples
Fireblocks customers use the web console or API to connect to third-party services, securely manage their assets, transact with counterparties, stake assets, access web3 dApps, mint and burn tokens, manage cross-border and merchant payments, and interact with many other features. Fireblocks currently supports integrations with banks, exchanges, digital asset on/offramp services, and asset swap providers.
The following Help Center and the Developer’s Portal articles describe part of the Fireblocks user experience:
-
Fireblocks Provider Connectivity and Supported account types describe the capabilities offered by different third-party exchanges to Fireblocks customers. Exchanges choose the features they want to include in their integration. To support the accounts visibility, capabilities, and balances shown on these pages, a provider must implement the following Connectivity API v2 elements:
- GET /capabilities: must return "accounts": ["*"] and "balances": ["*"] in its advertised capabilities.
- GET /capabilities/assets: supplies asset-level information for each supported account type.
- GET /accounts: provides the list of customer accounts displayed in the Console.
- GET /accounts/{accountId}: returns detailed account information and declared capabilities.
- GET /accounts/{accountId}/balances: returns asset balances for each account.
These requirements align with the Minimum viable provider and Balance support sections of the Network Link Integration Guide.
- Customer exchange transaction process: a simple description of how users transact with provider accounts using the Fireblocks web console.
- Fiat Accounts overview: an overview of features that fiat providers currently offer Fireblocks customers.
-
Console Transfer Overview: a comprehensive description of all options available when creating a transfer in the Fireblocks web console.
-
Provider transfer support: details the Connectivity API v2 endpoints a provider must implement to support Fireblocks transfer flows. See the following sections in the Network Link Integration Guide:
- Transfer support: required endpoints for initiating and managing provider transfers.
- Blockchain transfer: if the provider supports sending or receiving on-chain transactions.
- Peer transfer: if the provider enables transfers between accounts within the same platform.
- Internal transfer: if the provider supports internal ledger movements between sub-accounts.
- Fiat transfer: if the provider supports bank/fiat funding and withdrawals.
- Transaction lifecycle: a complete overview of how transactions are processed and tracked by Fireblocks on the blockchain.
-
Transaction history: a description of how users review their current and past transactions in the Fireblocks web console.
-
Conversion UI (Swap & Payment Engine): shows how Fireblocks customers convert assets when using Swap, as well as the conversion step within the Payment Engine. Providers that want to support these customer-facing conversion flows must implement Liquidity RFQ endpoints, as described in the Network Link Integration Guide:
-
Liquidity RFQ support: required endpoints for providers offering request-for-quote (RFQ) liquidity for asset conversions.
-
Liquidity RFQ support: required endpoints for providers offering request-for-quote (RFQ) liquidity for asset conversions.
-
On/Off-Ramp UI: shows how Fireblocks customers deposit fiat or crypto into a provider account, or withdraw funds from that account. To support these flows, providers must implement the endpoints described in the On/Off-Ramp & Bridging section of the Network Link Integration Guide:
- On-ramp: endpoints that allow customers to fund provider accounts using fiat or crypto.
- Off-ramp: endpoints that allow customers to withdraw funds from the provider into their Fireblocks accounts.
- Bridging: endpoints for cross-network movements between chains or provider-led bridge routes.
We also created a short video demonstrating these flows.
-
Off-Exchange Collateral & Settlement flow: shows how Fireblocks customers manage locked collateral, initiate deposits and withdrawals, and review settlement activity with connected providers. To support these Off-Exchange flows, providers must implement the endpoints described in the Collateral section of the Network Link Integration Guide:
- Collateral operations: endpoints for retrieving collateral balances, locking collateral (deposit), and unlocking collateral (withdrawal).
- Settlement operations: endpoints for creating settlements, updating settlement status, and retrieving settlement details.
See these links for more information on Off-Exchange and for its setup and onboarding.