Skip to Content

Adapter Reference

The Fireblocks Adapter mirrors the Fireblocks REST paths and payloads listed below. Every call is translated into a Vault operation and evaluated by the Policy Engine.

Supported Endpoints

Vault accounts

MethodPathDescription
POST/v1/vault/accountsCreate a vault account
GET/v1/vault/accounts/{vaultAccountId}Get a vault account
GET/v1/vault/accounts_pagedList vault accounts
POST/v1/vault/accounts/{vaultAccountId}/hideHide a vault account
POST/v1/vault/accounts/{vaultAccountId}/unhideUnhide a vault account

Vault assets

MethodPathDescription
POST/v1/vault/accounts/{vaultAccountId}/{assetId}Activate an asset
GET/v1/vault/accounts/{vaultAccountId}/{assetId}Get asset balance
GET/v1/vault/accounts/{vaultAccountId}/{assetId}/addressesList asset addresses

Transactions

MethodPathDescription
POST/v1/transactionsCreate a transaction
POST/v1/transactions/estimate_feeEstimate a transaction fee
GET/v1/transactions/{txId}Get a transaction

Whitelists

MethodPathDescription
GET/v1/external_walletsList external wallets

Assets

MethodPathDescription
POST/v1/assetsSupported assets

Webhook Events

EventTrigger
transaction.createdA deposit was detected on one of your vault accounts
transaction.status.updatedAn outgoing transaction moved to a new status: awaiting approval, signed, broadcast, confirmed or failed
test.pingA synthetic event sent from the console to verify the endpoint

Every delivery goes through a persistent outbox with retries. The console shows each attempt, its status and the last error, so a broken endpoint becomes visible to you before it becomes visible to your customers.

Authentication and Base URL

  • Base URL: the adapter endpoint for your environment, in the form https://<your-stand>/fb-gateway. Your account manager provides the exact URL.
  • Authentication: the API key, sent in the X-API-Key header.

Idempotency

POST /v1/vault/accounts and POST /v1/transactions accept the Fireblocks Idempotency-Key header. The header is optional, at most 40 characters, valid UTF-8; otherwise the adapter answers 400 and creates nothing. A key is scoped to your integration and answers for 24 hours.

  • Vault accounts. A retry with the same key returns the vault account created by the first request. No second account is created.
  • Transactions. A retry with the same key returns the transfer created by the first request, with its current status. The same applies to externalTxId, without a time limit. A retry must ask for the same transfer: the amount, asset, source and destination have to match.
SituationResponse
A transfer is already recorded for the key or externalTxId200 with that transfer and its current status
The key or externalTxId was used for a different transfer422
The first request is still being processed409; retry later. If it persists, contact your account manager

Send an Idempotency-Key or an externalTxId with every transaction request, so that a retry is safe. If a request failed before anything was created, a retry with the same key runs again.