Fireblocks logo
API docs by Redocly

Fireblocks Provider Connectivity API v2 (0.5.0)

Download OpenAPI specification:

URL: https://fireblocks.com License: Apache 2.0

Placeholder for automatic documentation injection from README.md

capabilities

Server capabilities discovery operations.

Describe server capabilities

Returns the API version and all the capabilities that the server supports.

The capabilities are specified as a map. The map keys are the capability names and the values are lists of account IDs. If all the accounts support a capability, an asterisk could be used, instead of listing all the accounts.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body

Responses

Response samples

Content type
application/json
Example
{
  • "version": "1.0.37",
  • "components": {
    }
}

Get list of supported additional assets

Returns assets, supported in addition to the predefined national currencies and the native cryptocurrencies.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body

Responses

Response samples

Content type
application/json
Example
{
  • "assets": [
    ]
}

Get details of a supported additional asset.

Returns the details of an assets, supported in addition to the predefined national currencies and the native cryptocurrencies.

path Parameters
id
required
string

Entity unique identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "name": "string",
  • "symbol": "string",
  • "description": "string",
  • "decimalPlaces": 0,
  • "testAsset": true,
  • "type": "BucketAsset"
}

List possible asset conversions

Retrieves the list of supported asset conversion pairs that can be quoted. Shows which assets can be converted to other assets through the liquidity service.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "capabilities": [
    ]
}

Get list of supported withdrawal methods

Retrieves the list of supported withdrawal methods available for the specified account. Shows which withdrawal types, networks, and destinations are supported for fund transfers.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json

This response indicates that all USD and USDC bucket balances could be withdrawn using the USDC tokens on the various blockchains. The USD balance can be specified directly while token and bucket balances must be defined in GET /capabilities/assets and referenced using their IDs. The asset IDs in this example are the same IDs used in the examples of GET /capabilities/assets.

{
  • "capabilities": [
    ]
}

Get list of supported deposit methods

Retrieves the list of supported deposit methods available for the specified account. Shows which deposit types, networks, and sources are supported for fund transfers.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json

This response indicates that all USDC token on the various blockchains could be deposited either into the USDC bucket balance or into the USD balance. The USD balance can be specified directly while token and bucket balances must be defined in GET /capabilities/assets and referenced using their IDs. The asset IDs in this example are the same IDs used in the examples of GET /capabilities/assets.

{
  • "capabilities": [
    ]
}

Get list of supported ramp methods

Retrieves the list of supported on-ramp and off-ramp methods available for the specified account. Shows which payment methods and currencies are supported for fiat-to-crypto and crypto-to-fiat conversions.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json

This response indicates that on ramp from USD to USDC, off ramp from USDC to USD and bridging between USDC and USDC on different blockchains are supported. The USD asset can be specified directly while tokens must be defined in GET /capabilities/assets and referenced using their IDs. The asset IDs in this example are the same IDs used in the examples of GET /capabilities/assets.

{
  • "capabilities": [
    ]
}

accounts

User accounts management operations.

Get list of sub-accounts

Retrieves a paginated list of all sub-accounts available to the provider. Can optionally include balance information for each account if requested. Allows defining parent-child relationships between accounts. Notice that Fireblocks currently supports only one level of hierarchy.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

balances
boolean

Flag to include the account balances in the response. Balances are not returned by default for account endpoints.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ]
}

Get sub-account details

Retrieves detailed information about a specific sub-account, including account metadata and optionally balance information if requested.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
balances
boolean

Flag to include the account balances in the response. Balances are not returned by default for account endpoints.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "balances": [
    ],
  • "status": "active",
  • "parentId": "string"
}

balances

Balances management operations.

Get current balances

Retrieves current balance information for the specified account. Can be filtered by asset ID, national currency code, or cryptocurrency symbol.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

assetId
string

ID of one of the assets returned in get-additional-assets. Limits the response to one. Cannot be used in conjunction with cryptocurrencySymbol or nationalCurrencyCode

nationalCurrencyCode
string (NationalCurrencyCode)
Enum: "ADP" "AED" "AFA" "AFN" "ALK" "ALL" "AMD" "ANG" "AOA" "AOK" "AON" "AOR" "ARA" "ARP" "ARS" "ARY" "ATS" "AUD" "AWG" "AYM" "AZM" "BAD" "BAM" "BBD" "BDT" "BEC" "BEF" "BEL" "BGJ" "BGK" "BGL" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOP" "BOV" "BRB" "BRC" "BRE" "BRL" "BRN" "BRR" "BSD" "BTN" "BUK" "BWP" "BYB" "BYN" "BYR" "BZD" "CAD" "CDF" "CHC" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CSD" "CSJ" "CSK" "CUC" "CUP" "CVE" "CYP" "CZK" "DDM" "DEM" "DJF" "DKK" "DOP" "DZD" "ECS" "ECV" "EEK" "EGP" "ERN" "ESA" "ESB" "ESP" "ETB" "EUR" "FIM" "FJD" "FKP" "FRF" "GBP" "GEK" "GEL" "GHC" "GHP" "GHS" "GIP" "GMD" "GNE" "GNF" "GNS" "GQE" "GRD" "GTQ" "GWE" "GWP" "GYD" "HKD" "HNL" "HRD" "HRK" "HTG" "HUF" "IDR" "IEP" "ILP" "ILR" "ILS" "INR" "IQD" "IRR" "ISJ" "ISK" "ITL" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAJ" "LAK" "LBP" "LKR" "LRD" "LSL" "LSM" "LTL" "LTT" "LUC" "LUF" "LUL" "LVL" "LVR" "LYD" "MAD" "MDL" "MGA" "MGF" "MKD" "MLF" "MMK" "MNT" "MOP" "MRO" "MRU" "MTL" "MTP" "MUR" "MVQ" "MVR" "MWK" "MXN" "MXP" "MXV" "MYR" "MZE" "MZM" "NAD" "NGN" "NIC" "NIO" "NLG" "NOK" "NPR" "NZD" "OMR" "PAB" "PEH" "PEI" "PEN" "PES" "PGK" "PHP" "PKR" "PLN" "PLZ" "PTE" "PYG" "QAR" "RHD" "ROK" "ROL" "RON" "RSD" "RUB" "RUR" "RWF" "SAR" "SBD" "SCR" "SDD" "SDG" "SDP" "SEK" "SGD" "SHP" "SIT" "SKK" "SLL" "SOS" "SRD" "SRG" "SSP" "STD" "STN" "SUR" "SVC" "SYP" "SZL" "THB" "TJR" "TJS" "TMM" "TMT" "TND" "TOP" "TPE" "TRL" "TRY" "TTD" "TWD" "TZS" "UAH" "UAK" "UGS" "UGW" "UGX" "USD" "USN" "USS" "UYI" "UYN" "UYP" "UYU" "UYW" "UZS" "VEB" "VEF" "VES" "VNC" "VND" "VUV" "WST" "XAF" "XCD" "XOF" "XPF" "XSU" "XTS" "XUA" "XXX" "YDD" "YER" "YUD" "YUM" "YUN" "ZAL" "ZAR" "ZMK" "ZMW" "ZRN" "ZRZ" "ZWC" "ZWD" "ZWL" "ZWN" "ZWR"

Limits the response to one asset with the provided NationalCurrencyCode Cannot be used in conjunction with cryptocurrencySymbol or assetId

cryptocurrencySymbol
string (CryptocurrencySymbol)
Enum: "ADA" "ALGO" "ARB" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BASE" "BCH" "BCHA" "BITKUB" "BNB" "BSV" "BTC" "CANTO" "CELESTIA" "CELO" "CHZ" "CHZ2" "CTXC" "DASH" "DOGE" "DOT" "DYDX" "EOS" "ETC" "ETH" "ETHW" "EVMOS" "FLR" "FTM" "GLMR" "HBAR" "HT" "KAVA" "KSM" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OPT" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC"

Limits the response to one asset with the provided CryptocurrencySymbol Cannot be used in conjunction with nationalCurrencyCode or assetId

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body

Responses

Response samples

Content type
application/json
Example
{
  • "balances": [
    ]
}

rates

Rates operations.

Get rate by account and assets

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
conversionPairId
string

Conversion pair to get the rate for.

rampsPairId
string

Ramps pair to get the rate for.

orderBookPairId
string

Order book pair to get the rate for.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body

Responses

Response samples

Content type
application/json
Example
{
  • "rate": "0.9",
  • "timestamp": 1546658861000,
  • "baseAsset": {
    },
  • "quoteAsset": {
    }
}

liquidity

Liquidity operations

Quote creation request

Either fromAmount or toAmount must be specified, while the unspecified amount will be populated by the server and returned in the response.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json

Details of the quote request

One of
required
NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference)
required
NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference)
fromAmount
required
string (PositiveAmount) ^\d+(\.\d+)?

Responses

Request samples

Content type
application/json
{
  • "fromAsset": {
    },
  • "toAsset": {
    },
  • "toAmount": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "fromAsset": {
    },
  • "fromAmount": "string",
  • "toAsset": {
    },
  • "toAmount": "string",
  • "conversionFeeBps": 0,
  • "conversionFeeAsset": {
    },
  • "status": "ready",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Get list of quotes sorted by creation time

Retrieves a paginated list of all quotes for the specified account. Quotes are sorted by creation time and can be ordered ascending or descending.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

order
string
Default: "desc"
Enum: "asc" "desc"

Controls the order of the items in the returned list.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "quotes": [
    ]
}

Get quote details

Retrieves detailed information about a specific quote, including conversion rates, amounts, expiration time, and current status.

path Parameters
id
required
string

Entity unique identifier.

accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "fromAsset": {
    },
  • "fromAmount": "string",
  • "toAsset": {
    },
  • "toAmount": "string",
  • "conversionFeeBps": 0,
  • "conversionFeeAsset": {
    },
  • "status": "ready",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Execute quote

Executes a previously created quote, performing the actual asset conversion. The quote must be valid and not expired for execution to succeed.

path Parameters
id
required
string

Entity unique identifier.

accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "fromAsset": {
    },
  • "fromAmount": "string",
  • "toAsset": {
    },
  • "toAmount": "string",
  • "conversionFeeBps": 0,
  • "conversionFeeAsset": {
    },
  • "status": "ready",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

transfers

Fund transfers management operations.

Get list of withdrawals sorted by creation time

Retrieves a paginated list of all withdrawal transactions for the specified account. Withdrawals are sorted by creation time and include all types of withdrawal operations.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

order
string
Default: "desc"
Enum: "asc" "desc"

Controls the order of the items in the returned list.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "withdrawals": [
    ]
}

Get withdrawal details

Retrieves detailed information about a specific withdrawal transaction, including status, amounts, fees, destination details, and processing information.

path Parameters
id
required
string

Entity unique identifier.

accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "balanceAsset": {
    },
  • "balanceAmount": "string",
  • "status": "pending",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finalizedAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "destination": {
    }
}

Get list of deposits sorted by creation time in a descending order

Retrieves a paginated list of all deposit transactions for the specified account. Deposits are sorted by creation time in descending order and include all types of deposit operations.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "deposits": [
    ]
}

Get deposit details

Retrieves detailed information about a specific deposit transaction, including status, amounts, source details, confirmation information, and processing details.

path Parameters
id
required
string

Entity unique identifier.

accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "balanceAsset": {
    },
  • "balanceAmount": "string",
  • "source": {
    },
  • "depositAddressId": "string",
  • "status": "pending",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finalizedAt": "2019-08-24T14:15:22Z"
}

transfersBlockchain

Fund transfers over public blockchains.

Get list of withdrawals over public blockchains sorted by creation time

Retrieves a paginated list of withdrawal transactions sent over public blockchains. Includes cryptocurrency transfers to external blockchain addresses, sorted by creation time.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

order
string
Default: "desc"
Enum: "asc" "desc"

Controls the order of the items in the returned list.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "withdrawals": [
    ]
}

Create new withdrawal over public blockchain

Should reject any non blockchain withdrawal request.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Withdrawal details

idempotencyKey
required
string
balanceAmount
required
string (PositiveAmount) ^\d+(\.\d+)?
required
NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference)
required
object (PublicBlockchainTransactionDestination)
object (ParticipantsIdentification)

An object that ensures the inclusion of either the originator or beneficiary details for transactions.

Responses

Request samples

Content type
application/json
{
  • "idempotencyKey": "string",
  • "balanceAmount": "string",
  • "balanceAsset": {
    },
  • "destination": {
    },
  • "participantsIdentification": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "balanceAsset": {
    },
  • "balanceAmount": "string",
  • "status": "pending",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finalizedAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "destination": {
    }
}

Create new deposit address

Creates a new deposit address for the specified account and asset. The generated address can be used to receive deposits for the specified cryptocurrency or token.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Deposit address details

idempotencyKey
required
string
required
PublicBlockchainCapability (object) or IbanCapability (object)

Responses

Request samples

Content type
application/json
{
  • "idempotencyKey": "string",
  • "transferMethod": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "destination": {
    },
  • "status": "enabled"
}

Get list of existing deposit addresses

Retrieves a paginated list of all deposit addresses associated with the specified account. Shows addresses for different cryptocurrencies and networks that can receive deposits.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ]
}

Get details of a deposit address

Retrieves detailed information about a specific deposit address, including the address string, associated network, asset type, and usage metadata.

path Parameters
id
required
string

Entity unique identifier.

accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "destination": {
    },
  • "status": "enabled"
}

Disable a deposit address

Disables a specific deposit address, preventing it from receiving new deposits. Existing funds sent to the address may still be processed depending on timing and confirmation status.

path Parameters
id
required
string

Entity unique identifier.

accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errorType": "schema-error",
  • "propertyName": "/topLevelProperyName/childPropertyName/thirdLevelPropertyName",
  • "requestPart": "params"
}

transfersFiat

National currency fund transfers.

Get list of fiat withdrawals sorted by creation time

Retrieves a paginated list of fiat currency withdrawal transactions. Includes traditional banking transfers and wire transfers, sorted by creation time.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

order
string
Default: "desc"
Enum: "asc" "desc"

Controls the order of the items in the returned list.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "withdrawals": [
    ]
}

Create new fiat withdrawal

Should reject any non fiat withdrawal request.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Withdrawal details

idempotencyKey
required
string
balanceAmount
required
string (PositiveAmount) ^\d+(\.\d+)?
required
NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference)
required
IbanAddress (object) (FiatTransferDestination)

Responses

Request samples

Content type
application/json
{
  • "idempotencyKey": "string",
  • "balanceAmount": "string",
  • "balanceAsset": {
    },
  • "destination": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "balanceAsset": {
    },
  • "balanceAmount": "string",
  • "status": "pending",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finalizedAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "destination": {
    }
}

Create new deposit address

Creates a new deposit address for the specified account and asset. The generated address can be used to receive deposits for the specified cryptocurrency or token.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Deposit address details

idempotencyKey
required
string
required
PublicBlockchainCapability (object) or IbanCapability (object)

Responses

Request samples

Content type
application/json
{
  • "idempotencyKey": "string",
  • "transferMethod": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "destination": {
    },
  • "status": "enabled"
}

Get list of existing deposit addresses

Retrieves a paginated list of all deposit addresses associated with the specified account. Shows addresses for different cryptocurrencies and networks that can receive deposits.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ]
}

Get details of a deposit address

Retrieves detailed information about a specific deposit address, including the address string, associated network, asset type, and usage metadata.

path Parameters
id
required
string

Entity unique identifier.

accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "destination": {
    },
  • "status": "enabled"
}

Disable a deposit address

Disables a specific deposit address, preventing it from receiving new deposits. Existing funds sent to the address may still be processed depending on timing and confirmation status.

path Parameters
id
required
string

Entity unique identifier.

accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errorType": "schema-error",
  • "propertyName": "/topLevelProperyName/childPropertyName/thirdLevelPropertyName",
  • "requestPart": "params"
}

transfersPeerAccounts

Transfers to a peer account managed by the same provider.

Get list of withdrawals to peer accounts, sorted by creation time

Retrieves a paginated list of withdrawal transactions sent to peer accounts. Includes transfers to other accounts within the same provider ecosystem, sorted by creation time.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

order
string
Default: "desc"
Enum: "asc" "desc"

Controls the order of the items in the returned list.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "withdrawals": [
    ]
}

Create new withdrawal to a peer account

Should reject any non peer acount withdrawal request.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Withdrawal details

idempotencyKey
required
string
balanceAmount
required
string (PositiveAmount) ^\d+(\.\d+)?
required
NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference)
required
object (PeerAccountTransferDestination)

Responses

Request samples

Content type
application/json
{
  • "idempotencyKey": "string",
  • "balanceAmount": "string",
  • "balanceAsset": {
    },
  • "destination": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "balanceAsset": {
    },
  • "balanceAmount": "string",
  • "status": "pending",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finalizedAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "destination": {
    }
}

transfersInternal

Transfers to a sub account in the same account.

Get list of withdrawals to sub-accounts, sorted by creation time

Retrieves a paginated list of internal withdrawal transactions between sub-accounts. Includes transfers within the same organization or account structure, sorted by creation time.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

order
string
Default: "desc"
Enum: "asc" "desc"

Controls the order of the items in the returned list.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "withdrawals": [
    ]
}

Create new transfer to another sub-account

Transfers assets between different sub-accounts of the same user. Should reject any withdrawals that are not sub-account transfers.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Withdrawal details

idempotencyKey
required
string
balanceAmount
required
string (PositiveAmount) ^\d+(\.\d+)?
required
NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference)
required
object (InternalTransferDestination)
referenceId
string

A unique identifier assigned by an external system to track the transaction or entity across different platforms.

Responses

Request samples

Content type
application/json
{
  • "idempotencyKey": "string",
  • "balanceAmount": "string",
  • "balanceAsset": {
    },
  • "destination": {
    },
  • "referenceId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "balanceAsset": {
    },
  • "balanceAmount": "string",
  • "status": "pending",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finalizedAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "destination": {
    }
}

collateral

Collateral management operations.

Create/register a collateral deposit address for a specific asset

Notifies the provider to have a new collateral deposit address for a specific asset. The provider is expected to listen to this address and credit the account accordingly, or sending the funds to this address if a withdrawal is requested.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Collateral deposit address details

required
object (PublicBlockchainAddress)
recoveryAccountId
required
string

An account ID used when recovering the assets of an off-exchange client

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "recoveryAccountId": "12"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "address": {
    },
  • "recoveryAccountId": "12"
}

Get list of collateral account deposit addresses

Retrieves all registered deposit addresses for the specified collateral account. Can be filtered by asset ID or cryptocurrency symbol to get addresses for specific assets.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

assetId
string

ID of one of the assets returned in get-additional-assets. Limits the response to one. Cannot be used in conjunction with cryptocurrencySymbol or nationalCurrencyCode

cryptocurrencySymbol
string (CryptocurrencySymbol)
Enum: "ADA" "ALGO" "ARB" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BASE" "BCH" "BCHA" "BITKUB" "BNB" "BSV" "BTC" "CANTO" "CELESTIA" "CELO" "CHZ" "CHZ2" "CTXC" "DASH" "DOGE" "DOT" "DYDX" "EOS" "ETC" "ETH" "ETHW" "EVMOS" "FLR" "FTM" "GLMR" "HBAR" "HT" "KAVA" "KSM" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OPT" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC"

Limits the response to one asset with the provided CryptocurrencySymbol Cannot be used in conjunction with nationalCurrencyCode or assetId

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ]
}

Get details of a specific deposit address in a collateral account.

Retrieves detailed information about a specific deposit address within a collateral account, including the address details and recovery account configuration.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

id
required
string

Entity unique identifier.

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "address": {
    },
  • "recoveryAccountId": "12"
}

Preflight check before initiating a collateral deposit

Initiates a preflight request for a new collateral deposit transaction. The provider is notified, and Fireblocks waits for their approval before proceeding.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Collateral deposit transaction preflight request details

required
NativeCryptocurrency (object) or OtherAssetReference (object) (CryptocurrencyReference)
amount
required
string (PositiveAmount) ^\d+(\.\d+)?
required
object (IntentApprovalRequest)

Responses

Request samples

Content type
application/json
{
  • "asset": {
    },
  • "amount": "string",
  • "intentApprovalRequest": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "Approved",
  • "asset": {
    },
  • "amount": "string",
  • "approvalRequest": {
    },
  • "rejectionReason": "string"
}

Register a collateral deposit transaction

Notifies the provider to have start listening to a new collateral deposit transaction. The provider is expected to listen to this address and credit the account accordingly

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Collateral deposit transaction details

collateralTxId
required
string

A unique identifier of the transaction to track. This field will contain information to help the provider poll the status of the transaction from Fireblocks.

required
object (ApprovalRequest)

Approval request object.

Responses

Request samples

Content type
application/json
{
  • "collateralTxId": "0.8e4cfce8-0182-4c6d-b9dd-a291c105e1d2.0.5a814998-ec0f-4f1c-92bf-fb5f7dc09ea2",
  • "approvalRequest": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "Pending",
  • "collateralTxId": "0.8e4cfce8-0182-4c6d-b9dd-a291c105e1d2.0.5a814998-ec0f-4f1c-92bf-fb5f7dc09ea2",
  • "approvalRequest": {
    }
}

Get list of collateral account deposit transactions sorted by creation time

Retrieves a paginated list of all deposit transactions for the specified collateral account. Transactions are sorted by creation time and include status information and approval details.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Get a collateral account deposit transaction details

Retrieves detailed information about a specific collateral deposit transaction, including transaction status, approval details, and processing information.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

collateralTxId
required
string

A Fireblocks' ID of a collateral transaction

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "Pending",
  • "collateralTxId": "0.8e4cfce8-0182-4c6d-b9dd-a291c105e1d2.0.5a814998-ec0f-4f1c-92bf-fb5f7dc09ea2",
  • "approvalRequest": {
    }
}

Preflight check before initiating a collateral withdrawal

Initiates a preflight request for a new collateral withdrawal transaction. The provider is notified, and Fireblocks waits for their approval before proceeding.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Collateral withdrawal transaction preflight request details

amount
required
string (PositiveAmount) ^\d+(\.\d+)?
required
object (PublicBlockchainAddress)
required
object (IntentApprovalRequest)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "destinationAddress": {
    },
  • "intentApprovalRequest": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": "string",
  • "destinationAddress": {
    },
  • "approvalRequest": {
    },
  • "status": "Approved",
  • "rejectionReason": "string"
}

Notify of a withdrawal from a collateral account

Initiate a withdrawal from the customers collateral account. The withdrawal has been confirmed by the provider and signed by the customer. The amount can be reduced from the customers available balance in the provider main account based on the withdrawal amount.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Collateral withdrawal transaction details

collateralTxId
required
string
required
object (ApprovalRequest)

Approval request object.

object (CollateralWithdrawalSettlementTransaction)

Represents a collateral withdrawal settlement transaction. Provide details about a withdrawal transaction in case of a settlement.

Responses

Request samples

Content type
application/json
{
  • "collateralTxId": "string",
  • "approvalRequest": {
    },
  • "settlementDetails": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "Pending",
  • "collateralTxId": "string",
  • "approvalRequest": {
    },
  • "rejectionReason": "string"
}

Get list of collateral withdrawal transactions sorted by creation time

Retrieves a paginated list of all withdrawal transactions for the specified collateral account. Transactions are sorted by creation time and include status, approval details, and settlement information.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Get a collateral withdrawal transaction details

Retrieves detailed information about a specific collateral withdrawal transaction, including transaction status, approval details, settlement information, and rejection reasons if applicable.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

collateralTxId
required
string

A Fireblocks' ID of a collateral transaction

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "Pending",
  • "collateralTxId": "string",
  • "approvalRequest": {
    },
  • "rejectionReason": "string"
}

Initiate a settlement request from the provider

Request a settlement from the provider.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Collateral withdrawal transaction details

settlementId
required
string
settlementVersion
required
string

A unique identifier of the settlement state version. This field is optional and can be used to indicate the version of the settlement state the client is referring to.

Responses

Request samples

Content type
application/json
{
  • "settlementId": "string",
  • "settlementVersion": "string"
}

Response samples

Content type
application/json
{
  • "settlementVersion": "string",
  • "withdrawInstructions": [
    ],
  • "depositInstructions": [
    ]
}

Get current Instructions for settlement

Gets a list of required transactions to finalize the settlement

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "settlementVersion": "string",
  • "withdrawInstructions": [
    ],
  • "depositInstructions": [
    ]
}

Get a settlement details

Retrieves detailed information about a specific settlement state for a collateral account, including withdrawal and deposit transaction details, settlement status, and completion information.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

collateralId
required
string

ID of a collateral account

settlementVersion
required
string

A provider version ID of a settlement state

header Parameters
X-FB-PLATFORM-SIGNATURE
required
string

Authentication signature of Fireblocks as the originator of the request

X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
{
  • "settlementVersion": "string",
  • "withdrawTransactions": [
    ],
  • "depositTransactions": [
    ],
  • "status": "Invalid"
}

collateralNotifications

Webhook notifications sent by Fireblocks to exchanges for collateral events.

ramps

Beta Feature – Limited Access.

On-ramp, off-ramp and bridging operations.

Get list of ramps sorted by creation time

Retrieves a paginated list of all ramp transactions for the specified account. Ramps are sorted by creation time and include both on-ramp and off-ramp operations.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

query Parameters
limit
integer [ 1 .. 200 ]
Default: 10

Maximum number of returned items.

startingAfter
string

Object ID. Instructs to return the items immediately following this object and not including it. Cannot be used together with endingBefore.

endingBefore
string

Object ID. Instructs to return the items immediately preceding this object and not including it. Cannot be used together with startingAfter.

order
string
Default: "desc"
Enum: "asc" "desc"

Controls the order of the items in the returned list.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json

This response indicates that there are 3 ramps in the account.

{
  • "ramps": [
    ]
}

Initiates a new ramp

Creates the payment instructions for the new ramp and return it in the response.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Request Body schema: application/json
required

Ramp details

One of
idempotencyKey
required
string
amount
required
string (PositiveAmount) ^\d+(\.\d+)?
type
required
string
Value: "OnRamp"
required
IbanCapability (object) or AchCapability (object) or WireCapability (object) or SpeiCapability (object) or PixCapability (object) or EuropeanSEPACapability (object) or LocalBankTransferAddressOnRamp (object) or MobileMoneyAddressBase (object) or PayIdCapability (object) or InteracCapability (object) or ChapsCapability (object) or InternalTransferMethod (object) (OnRampRequestFrom)
required
object (PublicBlockchainAddress)
OrderQuote (object)
object (ParticipantsIdentification)

An object that ensures the inclusion of either the originator or beneficiary details for transactions.

Responses

Request samples

Content type
application/json
Example
{
  • "idempotencyKey": "string",
  • "amount": "string",
  • "type": "OnRamp",
  • "from": {
    },
  • "to": {
    },
  • "executionDetails": {
    },
  • "participantsIdentification": {
    }
}

Response samples

Content type
application/json
Example

A standard fiat to crypto on-ramp without additional features.

{
  • "id": "16b8b2c3-bd61-4745-9c48-3d30c2bc6907",
  • "createdAt": "2021-09-01T12:00:00Z",
  • "updatedAt": "2021-09-01T12:00:00Z",
  • "status": "Pending",
  • "amount": "1000.00",
  • "type": "OnRamp",
  • "expiresAt": "2021-09-01T12:00:00Z",
  • "from": {
    },
  • "to": {
    },
  • "paymentInstructions": {
    },
  • "estimatedFees": [
    ]
}

Get details of a specific ramp

Retrieves detailed information about a specific ramp transaction, including payment instructions, status, amounts, and processing details.

path Parameters
accountId
required
string^[A-Za-z0-9_-]+$

Sub-account identifier.

id
required
string

Entity unique identifier.

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

X-FBAPI-NONCE
required
string

Unique identifier of the request.

X-FBAPI-SIGNATURE
required
string

Request signature using the chosen cryptographic algorithm. The signature is to be calculated on concatenation of the following request fields in the specified order:

  • X-FBAPI-TIMESTAMP - X-FBAPI-NONCE - HTTP request method in upper case - Endpoint path, including the query parameters - Request body
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "Pending",
  • "amount": "string",
  • "estimatedFees": [
    ],
  • "executionDetails": {
    },
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "paymentInstructions": {
    },
  • "type": "OnRamp",
  • "from": {
    },
  • "to": {
    },
  • "receipt": {
    }
}