Skip to main content

​
Prerequisites

Before you begin, you need to have a Fireblocks account. Make sure you have a Fireblocks API key and secret, with the least amount of permissions required to access the functionality of the Fireblocks Connector you plan to use.
Make sure to create an API key dedicated to Formance. Doing so will improve your auditability and security and will allow you to revoke access to Formance at any time if needed.

​
Installation

fctl payments connectors install fireblocks config.json
With config.json containing: 
{
  "apiKey": "string",
  "endpoint": "string",
  "name": "string",
  "pollingPeriod": "30m",
  "privateKey": "string"
}

​
Configuration fields

​
apiKey
string
required
API key created from the Fireblocks workspace.
​
endpoint
string
required
Base URL for the Fireblocks API. The value depends on your workspace environment:
EnvironmentURL
US Sandboxhttps://sandbox-api.fireblocks.io
US Mainnet/Testnethttps://api.fireblocks.io
EU Mainnet/Testnethttps://eu-api.fireblocks.io
EU2 Mainnet/Testnethttps://eu2-api.fireblocks.io
​
name
string
required
A unique name for this connector instance.
​
pollingPeriod
string
default:"30m"
How often the connector polls Fireblocks for new data.
​
privateKey
string
required
Fireblocks API secret key. Used to sign the JWT for the Authorization Bearer header.The key must be formatted as a single-line string with literal \n characters. You can convert a PEM file with:
cat fireblocks_private.pem | awk '{printf "%s\\n", $0}'

​
Capabilities

The Fireblocks connector supports:
  • FetchAccounts — sync vault accounts from Fireblocks
  • FetchBalances — retrieve account balances
  • FetchPayments — import transactions, including withdrawals, transfers, staking/unstaking, and minting/burning

​
Rate limits

Rate limits are per endpoint, per transaction, per minute and depend on your contract with Fireblocks. See the Fireblocks rate limiting documentation for details.