| X-FBAPI-SIGNATURE required | string 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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
- |
Responseshttp://0.0.0.0:8000/capabilities Response samples Content typeapplication/json Example {"version": "1.0.37", "components": {"accounts": "*", "balances": "*", "transfers": "*", "transfersBlockchain": "*", "transfersFiat": "*", "transfersPeerAccounts": "*", "transfersInternal": "*", "liquidity": "*", "collateral": "*", "ramps": "*", "rates": "*"
}
}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 Responses http://0.0.0.0:8000/capabilities Response samples Content typeapplication/json Example {"version": "1.0.37", "components": {"accounts": "*", "balances": "*", "transfers": "*", "transfersBlockchain": "*", "transfersFiat": "*", "transfersPeerAccounts": "*", "transfersInternal": "*", "liquidity": "*", "collateral": "*", "ramps": "*", "rates": "*"
}
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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
- |
Responseshttp://0.0.0.0:8000/capabilities/assets Response samples Content typeapplication/json Example {"assets": [{"id": "360de0ad-9ba1-45d5-8074-22453f193d65", "type": "Erc20Token", "blockchain": "Ethereum", "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "USDC", "symbol": "USDC", "description": "USDC is a fully collateralized US Dollar stablecoin developed by CENTRE, the open source project with Circle being the first of several forthcoming issuers.", "decimalPlaces": 6
}, {"id": "606bce6b-ff15-4704-9390-b9e32a6cfcff", "type": "Erc20Token", "blockchain": "Polygon PoS", "contractAddress": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174", "name": "USDC", "symbol": "USDC", "description": "USD Coin is an ERC-20 stablecoin brought to you by Circle and Coinbase. It is issued by regulated and licensed financial institutions that maintain full reserves of the equivalent fiat currency.", "decimalPlaces": 6
}, {"id": "4386cf4d-83b2-4410-96da-0d3919a45506", "type": "StellarToken", "blockchain": "Stellar", "issuerAddress": "GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN", "stellarCurrencyCode": "USDC", "name": "USDC", "symbol": "USDC", "description": "USDC is a fully collateralized US Dollar stablecoin, based on the open source fiat stablecoin framework developed by Centre.", "decimalPlaces": 2
}
]
}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 Responses http://0.0.0.0:8000/capabilities/assets Response samples Content typeapplication/json Example {"assets": [{"id": "360de0ad-9ba1-45d5-8074-22453f193d65", "type": "Erc20Token", "blockchain": "Ethereum", "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "USDC", "symbol": "USDC", "description": "USDC is a fully collateralized US Dollar stablecoin developed by CENTRE, the open source project with Circle being the first of several forthcoming issuers.", "decimalPlaces": 6
}, {"id": "606bce6b-ff15-4704-9390-b9e32a6cfcff", "type": "Erc20Token", "blockchain": "Polygon PoS", "contractAddress": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174", "name": "USDC", "symbol": "USDC", "description": "USD Coin is an ERC-20 stablecoin brought to you by Circle and Coinbase. It is issued by regulated and licensed financial institutions that maintain full reserves of the equivalent fiat currency.", "decimalPlaces": 6
}, {"id": "4386cf4d-83b2-4410-96da-0d3919a45506", "type": "StellarToken", "blockchain": "Stellar", "issuerAddress": "GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN", "stellarCurrencyCode": "USDC", "name": "USDC", "symbol": "USDC", "description": "USDC is a fully collateralized US Dollar stablecoin, based on the open source fiat stablecoin framework developed by Centre.", "decimalPlaces": 2
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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
- |
Responseshttp://0.0.0.0:8000/capabilities/assets/{id} Response samples Content typeapplication/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 Responses http://0.0.0.0:8000/capabilities/assets/{id} Response samples Content typeapplication/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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/capabilities/liquidity/quotes Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/capabilities/liquidity/quotes Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/capabilities/transfers/withdrawals Response samples Content typeapplication/json | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/capabilities/transfers/withdrawals Response samples Content typeapplication/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.
+" class="sc-iKOlBD sc-cCzKKD cslxVo fFQqWu"> 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.
- 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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/capabilities/transfers/deposits Response samples Content typeapplication/json | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/capabilities/transfers/deposits Response samples Content typeapplication/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.
+" class="sc-iKOlBD sc-cCzKKD cslxVo fFQqWu"> 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.
- 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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/capabilities/ramps Response samples Content typeapplication/json | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/capabilities/ramps Response samples Content typeapplication/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.
+" class="sc-iKOlBD sc-cCzKKD cslxVo fFQqWu"> 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.
- 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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts Response samples Content typeapplication/json {"accounts": [{"id": "string", "title": "string", "description": "string", "balances": [{"id": "string", "availableAmount": "string", "lockedAmount": "string", "creditAmount": "string"
}
], "status": "active", "parentId": "string"
}
]
}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 | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | |
Responseshttp://0.0.0.0:8000/accounts Response samples Content typeapplication/json {"accounts": [{"id": "string", "title": "string", "description": "string", "balances": [{"id": "string", "availableAmount": "string", "lockedAmount": "string", "creditAmount": "string"
}
], "status": "active", "parentId": "string"
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId} Response samples Content typeapplication/json {"id": "string", "title": "string", "description": "string", "balances": [{"id": "string", "availableAmount": "string", "lockedAmount": "string", "creditAmount": "string"
}
], "status": "active", "parentId": "string"
}| X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId} Response samples Content typeapplication/json {"id": "string", "title": "string", "description": "string", "balances": [{"id": "string", "availableAmount": "string", "lockedAmount": "string", "creditAmount": "string"
}
], "status": "active", "parentId": "string"
}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" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BCH" "BCHA" "BERA" "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" "FRAX" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC" "GRAM" "BABY" "CANTON" "HYPE" "SUI" 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 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" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BCH" "BCHA" "BERA" "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" "FRAX" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC" "GRAM" "BABY" "CANTON" "HYPE" "SUI" 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/balances Response samples Content typeapplication/json Example {"balances": [{"id": "4ff63424-7e09-4cdf-b7f1-da7b7c65eabe", "availableAmount": "1743.43", "lockedAmount": "0"
}
]
}| X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/balances Response samples Content typeapplication/json Example {"balances": [{"id": "4ff63424-7e09-4cdf-b7f1-da7b7c65eabe", "availableAmount": "1743.43", "lockedAmount": "0"
}
]
}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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/rate Response samples Content typeapplication/json Example | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/rate Response samples Content typeapplication/json Example 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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Request Body schema: application/jsonDetails 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+)? |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/liquidity/quotes Request samples Content typeapplication/json Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Request Body schema: application/jsonDetails 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+)? |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/liquidity/quotes Request samples Content typeapplication/json Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/liquidity/quotes Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/liquidity/quotes Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/liquidity/quotes/{id} Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/liquidity/quotes/{id} Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/liquidity/quotes/{id}/execute Response samples Content typeapplication/json | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/liquidity/quotes/{id}/execute Response samples Content typeapplication/json 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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/{id} Response samples Content typeapplication/json Example {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/{id} Response samples Content typeapplication/json Example {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits Response samples Content typeapplication/json {"deposits": [{"id": "string", "balanceAmount": "string", "depositAddressId": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z"
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits Response samples Content typeapplication/json {"deposits": [{"id": "string", "balanceAmount": "string", "depositAddressId": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z"
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/{id} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "depositAddressId": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z"
}| X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/{id} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "depositAddressId": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z"
}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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/blockchain Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/blockchain Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- | | X-FBAPI-APPROVED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- | | X-FBAPI-SIGNED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Request Body schema: application/jsonrequired | idempotencyKey required | | | 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/blockchain Request samples Content typeapplication/json {"idempotencyKey": "string", "balanceAmount": "string", "participantsIdentification": {"originator": {"externalReferenceId": "string", "entityType": "Individual", "participantRelationshipType": "FirstParty", "fullName": {"firstName": "string", "lastName": "string"
}, "dateOfBirth": "1999-01-01", "email": "john.doe@example.com", "phone": "string", "idNumber": "string", "idType": "NIN Slip/Card", "additionalIdNumber": "string", "additionalIdType": "NIN Slip/Card"
}, "beneficiary": {"externalReferenceId": "string", "entityType": "Individual", "participantRelationshipType": "FirstParty", "fullName": {"firstName": "string", "lastName": "string"
}, "dateOfBirth": "1999-01-01", "email": "john.doe@example.com", "phone": "string", "idNumber": "string", "idType": "NIN Slip/Card", "additionalIdNumber": "string", "additionalIdType": "NIN Slip/Card"
}, "originatingVasp": {"vaspName": "string", "vaspCountry": "string", "vaspCode": "string", "vaspWebsite": "string", "vaspRegion": "string"
}, "beneficiaryVasp": {"vaspName": "string", "vaspCountry": "string", "vaspCode": "string", "vaspWebsite": "string", "vaspRegion": "string"
}
}
} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | | X-FBAPI-APPROVED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | | X-FBAPI-SIGNED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Request Body schema: application/jsonrequired | idempotencyKey required | | | 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.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/blockchain Request samples Content typeapplication/json {"idempotencyKey": "string", "balanceAmount": "string", "participantsIdentification": {"originator": {"externalReferenceId": "string", "entityType": "Individual", "participantRelationshipType": "FirstParty", "fullName": {"firstName": "string", "lastName": "string"
}, "dateOfBirth": "1999-01-01", "email": "john.doe@example.com", "phone": "string", "idNumber": "string", "idType": "NIN Slip/Card", "additionalIdNumber": "string", "additionalIdType": "NIN Slip/Card"
}, "beneficiary": {"externalReferenceId": "string", "entityType": "Individual", "participantRelationshipType": "FirstParty", "fullName": {"firstName": "string", "lastName": "string"
}, "dateOfBirth": "1999-01-01", "email": "john.doe@example.com", "phone": "string", "idNumber": "string", "idType": "NIN Slip/Card", "additionalIdNumber": "string", "additionalIdType": "NIN Slip/Card"
}, "originatingVasp": {"vaspName": "string", "vaspCountry": "string", "vaspCode": "string", "vaspWebsite": "string", "vaspRegion": "string"
}, "beneficiaryVasp": {"vaspName": "string", "vaspCountry": "string", "vaspCode": "string", "vaspWebsite": "string", "vaspRegion": "string"
}
}
} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Request Body schema: application/jsonrequired Deposit address details
- | idempotencyKey required | | required | PublicBlockchainCapability (object) or IbanCapability (object) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "string", "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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Request Body schema: application/jsonrequired Deposit address details
+ | idempotencyKey required | | required | PublicBlockchainCapability (object) or IbanCapability (object) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "string", "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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses Response samples Content typeapplication/json {"addresses": [{"id": "string", "status": "enabled"
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses Response samples Content typeapplication/json {"addresses": [{"id": "string", "status": "enabled"
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses/{id} Response samples Content typeapplication/json {"id": "string", "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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses/{id} Response samples Content typeapplication/json {"id": "string", "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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses/{id} Response samples Content typeapplication/json {"message": "string", "errorType": "schema-error", "propertyName": "/topLevelProperyName/childPropertyName/thirdLevelPropertyName", "requestPart": "params"
}| X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses/{id} Response samples Content typeapplication/json {"message": "string", "errorType": "schema-error", "propertyName": "/topLevelProperyName/childPropertyName/thirdLevelPropertyName", "requestPart": "params"
}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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/fiat Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/fiat Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- | | X-FBAPI-APPROVED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- | | X-FBAPI-SIGNED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Request Body schema: application/jsonrequired | idempotencyKey required | | | balanceAmount required | string (PositiveAmount) ^\d+(\.\d+)? | required | NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference) | required | IbanAddress (object) (FiatTransferDestination) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/fiat Request samples Content typeapplication/json {"idempotencyKey": "string", "balanceAmount": "string",
} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | | X-FBAPI-APPROVED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | | X-FBAPI-SIGNED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Request Body schema: application/jsonrequired | idempotencyKey required | | | balanceAmount required | string (PositiveAmount) ^\d+(\.\d+)? | required | NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference) | required | IbanAddress (object) (FiatTransferDestination) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/fiat Request samples Content typeapplication/json {"idempotencyKey": "string", "balanceAmount": "string",
} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Request Body schema: application/jsonrequired Deposit address details
- | idempotencyKey required | | required | PublicBlockchainCapability (object) or IbanCapability (object) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "string", "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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Request Body schema: application/jsonrequired Deposit address details
+ | idempotencyKey required | | required | PublicBlockchainCapability (object) or IbanCapability (object) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "string", "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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses Response samples Content typeapplication/json {"addresses": [{"id": "string", "status": "enabled"
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses Response samples Content typeapplication/json {"addresses": [{"id": "string", "status": "enabled"
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses/{id} Response samples Content typeapplication/json {"id": "string", "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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses/{id} Response samples Content typeapplication/json {"id": "string", "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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses/{id} Response samples Content typeapplication/json {"message": "string", "errorType": "schema-error", "propertyName": "/topLevelProperyName/childPropertyName/thirdLevelPropertyName", "requestPart": "params"
}| X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/deposits/addresses/{id} Response samples Content typeapplication/json {"message": "string", "errorType": "schema-error", "propertyName": "/topLevelProperyName/childPropertyName/thirdLevelPropertyName", "requestPart": "params"
}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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/peeraccount Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}Create new withdrawal to a peer account | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/peeraccount Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}Create new withdrawal to a peer account Withdrawal to a peer account is enabled for fiat or tokenized assets only.
+" class="sc-iKOlBD sc-cCzKKD cslxVo fFQqWu"> Withdrawal to a peer account is enabled for fiat or tokenized assets only.
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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- | | X-FBAPI-APPROVED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- | | X-FBAPI-SIGNED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Request Body schema: application/jsonrequired | idempotencyKey required | | | balanceAmount required | string (PositiveAmount) ^\d+(\.\d+)? | required | NationalCurrency (object) or OtherAssetReference (object) Balance asset for peer account withdrawals. Native cryptocurrencies are not supported; only fiat assets and other (e.g., tokenized) assets are allowed.
- | required | object (PeerAccountTransferDestination) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/peeraccount Request samples Content typeapplication/json {"idempotencyKey": "string", "balanceAmount": "string",
} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}| X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | | X-FBAPI-APPROVED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | | X-FBAPI-SIGNED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Request Body schema: application/jsonrequired | idempotencyKey required | | | balanceAmount required | string (PositiveAmount) ^\d+(\.\d+)? | required | NationalCurrency (object) or OtherAssetReference (object) Balance asset for peer account withdrawals. Native cryptocurrencies are not supported; only fiat assets and other (e.g., tokenized) assets are allowed.
+ | required | object (PeerAccountTransferDestination) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/peeraccount Request samples Content typeapplication/json {"idempotencyKey": "string", "balanceAmount": "string",
} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/subaccount Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/subaccount Response samples Content typeapplication/json {"withdrawals": [{"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- | | X-FBAPI-APPROVED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- | | X-FBAPI-SIGNED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Request Body schema: application/jsonrequired | idempotencyKey required | | | 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/subaccount Request samples Content typeapplication/json {"idempotencyKey": "string", "balanceAmount": "string", "referenceId": "string"
} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}| X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | | X-FBAPI-APPROVED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ | | X-FBAPI-SIGNED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Request Body schema: application/jsonrequired | idempotencyKey required | | | 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.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/subaccount Request samples Content typeapplication/json {"idempotencyKey": "string", "balanceAmount": "string", "referenceId": "string"
} Response samples Content typeapplication/json {"id": "string", "balanceAmount": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "finalizedAt": "2019-08-24T14:15:22Z",
}Collateral management operations.
- Initiate collateral account link Creates a new link between a collateral account and a provider account.
- path Parameters| accountId required | string^[A-Za-z0-9_-]+$ Sub-account 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 Initiate collateral account link Creates a new link between a collateral account and a provider account.
+ path Parameters| accountId required | string^[A-Za-z0-9_-]+$ Sub-account 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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/jsonrequired Collateral account link details
- | collateralId required | string (CollateralId) Unique string representing the collateral account Id (..)
- | | collateralSigners required | Array of strings (CollateralSignerId) | | env required | string (AccountEnvironment) Enum: "prod" "sandbox" "stage" AccountEnvironment field describes which environment is being run at the moment
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/link Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "string", "status": "Eligible", "eligibleCollateralAssets": [{"blockchain": "Algorand", "cryptocurrencySymbol": "ADA", "testAsset": true
}
], "rejectionReason": "string", "collateralId": "f861c6ca-f4c8-44dd-a02e-081a38745623.95e40c1e-407e-405c-871e-d69218611a79.4cd3e66b-4ee4-4750-bcfd-d2d43054fc5d", "env": "prod"
}Get list of collateral account links Retrieves all collateral account links associated with the specified account. Returns details about link status, eligible assets, and collateral configuration.
- 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-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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Request Body schema: application/jsonrequired Collateral account link details
+ | collateralId required | string (CollateralId) Unique string representing the collateral account Id (..)
+ | | collateralSigners required | Array of strings (CollateralSignerId) | | env required | string (AccountEnvironment) Enum: "prod" "sandbox" "stage" AccountEnvironment field describes which environment is being run at the moment
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/link Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "string", "status": "Eligible", "eligibleCollateralAssets": [{"blockchain": "Algorand", "cryptocurrencySymbol": "ADA", "testAsset": true
}
], "rejectionReason": "string", "collateralId": "f861c6ca-f4c8-44dd-a02e-081a38745623.95e40c1e-407e-405c-871e-d69218611a79.4cd3e66b-4ee4-4750-bcfd-d2d43054fc5d", "env": "prod"
}Get list of collateral account links Retrieves all collateral account links associated with the specified account. Returns details about link status, eligible assets, and collateral configuration.
+ 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-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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/link Response samples Content typeapplication/json This response indicates that the provider account is linked to a collateral account.
- {"collateralLinks": [{"collateralId": "f861c6ca-f4c8-44dd-a02e-081a38745623.95e40c1e-407e-405c-871e-d69218611a79.4cd3e66b-4ee4-4750-bcfd-d2d43054fc5d", "id": "360de0ad-9ba1-45d5-8074-22453f193d65", "eligibleCollateralAssets": [], "status": "Linked", "env": "prod"
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/link Response samples Content typeapplication/json This response indicates that the provider account is linked to a collateral account.
+ {"collateralLinks": [{"collateralId": "f861c6ca-f4c8-44dd-a02e-081a38745623.95e40c1e-407e-405c-871e-d69218611a79.4cd3e66b-4ee4-4750-bcfd-d2d43054fc5d", "id": "360de0ad-9ba1-45d5-8074-22453f193d65", "eligibleCollateralAssets": [], "status": "Linked", "env": "prod"
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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/jsonrequired Collateral deposit address details
- required | object (PublicBlockchainAddress) | | recoveryAccountId required | string An account ID used when recovering the assets of an off-exchange client
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/addresses Request samples Content typeapplication/json Response samples Content typeapplication/json 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" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BCH" "BCHA" "BERA" "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" "FRAX" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC" "GRAM" "BABY" "CANTON" "HYPE" "SUI" 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Request Body schema: application/jsonrequired Collateral deposit address details
+ required | object (PublicBlockchainAddress) | | recoveryAccountId required | string An account ID used when recovering the assets of an off-exchange client
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/addresses Request samples Content typeapplication/json Response samples Content typeapplication/json 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" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BCH" "BCHA" "BERA" "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" "FRAX" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC" "GRAM" "BABY" "CANTON" "HYPE" "SUI" 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/addresses Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/addresses Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/addresses/{id} Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/addresses/{id} Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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/jsonrequired Collateral deposit transaction preflight request details
- required | NativeCryptocurrency (object) or OtherAssetReference (object) (CryptocurrencyReference) | | amount required | string (PositiveAmount) ^\d+(\.\d+)? | required | object (IntentApprovalRequest) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/intents/deposits Request samples Content typeapplication/json {"asset": {"blockchain": "Algorand", "cryptocurrencySymbol": "ADA", "testAsset": true
}, "amount": "string", "intentApprovalRequest": {}
} Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Request Body schema: application/jsonrequired Collateral deposit transaction preflight request details
+ required | NativeCryptocurrency (object) or OtherAssetReference (object) (CryptocurrencyReference) | | amount required | string (PositiveAmount) ^\d+(\.\d+)? | required | object (IntentApprovalRequest) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/intents/deposits Request samples Content typeapplication/json {"asset": {"blockchain": "Algorand", "cryptocurrencySymbol": "ADA", "testAsset": true
}, "amount": "string", "intentApprovalRequest": {}
} Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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/jsonrequired 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/deposits Request samples Content typeapplication/json Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Request Body schema: application/jsonrequired 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.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/deposits Request samples Content typeapplication/json Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/deposits Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/deposits Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/deposits/{collateralTxId} Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/deposits/{collateralTxId} Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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/jsonrequired Collateral withdrawal transaction preflight request details
- | amount required | string (PositiveAmount) ^\d+(\.\d+)? | required | object (PublicBlockchainAddress) | required | object (IntentApprovalRequest) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/intents/withdrawals Request samples Content typeapplication/json {"amount": "string", "destinationAddress": {}, "intentApprovalRequest": {}
} Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Request Body schema: application/jsonrequired Collateral withdrawal transaction preflight request details
+ | amount required | string (PositiveAmount) ^\d+(\.\d+)? | required | object (PublicBlockchainAddress) | required | object (IntentApprovalRequest) |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/intents/withdrawals Request samples Content typeapplication/json {"amount": "string", "destinationAddress": {}, "intentApprovalRequest": {}
} Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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/jsonrequired Collateral withdrawal transaction details
- | collateralTxId required | | 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/withdrawals Request samples Content typeapplication/json Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Request Body schema: application/jsonrequired Collateral withdrawal transaction details
+ | collateralTxId required | | 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.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/withdrawals Request samples Content typeapplication/json Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/withdrawals Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/withdrawals Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/withdrawals/{collateralTxId} Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/withdrawals/{collateralTxId} Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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/jsonrequired Collateral withdrawal transaction details
- | settlementId required | | | 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/settlement Request samples Content typeapplication/json Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Request Body schema: application/jsonrequired Collateral withdrawal transaction details
+ | settlementId required | | | 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.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/settlement Request samples Content typeapplication/json Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/settlement Response samples Content typeapplication/json 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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/settlement Response samples Content typeapplication/json 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/settlements/{settlementVersion} Response samples Content typeapplication/json | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/collateral/{collateralId}/settlements/{settlementVersion} Response samples Content typeapplication/json Webhook notifications sent by Fireblocks to exchanges for collateral events.
- 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 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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/ramps Response samples Content typeapplication/json This response indicates that there are 3 ramps in the account.
- {"ramps": [{"id": "16b8b2c3-bd61-4745-9c48-3d30c2bc6907", "createdAt": "2021-09-01T12:00:00Z", "updatedAt": "2021-09-01T12:00:00Z", "status": "Pending", "amount": "1231.45", "type": "OnRamp", "to": {"transferMethod": "PublicBlockchain", "address": "0x1234567890abcdef1234567890abcdef12345678", "tag": "1234567890abcdef"
}, "paymentInstructions": {}, "estimatedFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "100.00"
}
}
], "expiresAt": "2021-09-01T12:00:00Z"
}, {"id": "69fa4f38-c1fd-4215-a310-82272225c4ef", "createdAt": "2021-09-01T12:00:00Z", "updatedAt": "2021-09-01T12:00:00Z", "status": "Completed", "amount": "1231.45", "type": "OffRamp", "paymentInstructions": {}, "payment": {"blockchainTxId": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef", "amount": "1231.45", "address": "0x1234567890abcdef1234567890abcdef12345678", "transferMethod": "PublicBlockchain"
}, "expiresAt": "2021-09-01T12:00:00Z"
}, {"id": "afc7caa0-5b7e-4c98-8f2a-a037d0c6bbea", "createdAt": "2021-09-01T12:00:00Z", "updatedAt": "2021-09-01T12:00:00Z", "status": "Processing", "amount": "1231.45", "type": "Bridge", "to": {"transferMethod": "PublicBlockchain", "address": "0x1234567890abcdef1234567890abcdef12345678", "tag": "1234567890abcdef"
}, "paymentInstructions": {}, "payment": {"blockchainTxId": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef", "amount": "1231.45", "address": "0x1234567890abcdef1234567890abcdef12355678", "transferMethod": "PublicBlockchain"
}, "receipt": {"actualFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "100.00"
}
}
], "blockchainTxId": "0x1234567890abcdef1234567899abcdef1234567890abcdef1234567890abcdef", "amount": "1231.45", "address": "0x1234567890abcdef1234567890abcdef12345678", "transferMethod": "PublicBlockchain"
}, "estimatedFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "100.00"
}
}
], "expiresAt": "2021-09-01T12:00:00Z"
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/ramps Response samples Content typeapplication/json This response indicates that there are 3 ramps in the account.
+ {"ramps": [{"id": "16b8b2c3-bd61-4745-9c48-3d30c2bc6907", "createdAt": "2021-09-01T12:00:00Z", "updatedAt": "2021-09-01T12:00:00Z", "status": "Pending", "amount": "1231.45", "type": "OnRamp", "to": {"transferMethod": "PublicBlockchain", "address": "0x1234567890abcdef1234567890abcdef12345678", "tag": "1234567890abcdef"
}, "paymentInstructions": {}, "estimatedFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "100.00"
}
}
], "expiresAt": "2021-09-01T12:00:00Z"
}, {"id": "69fa4f38-c1fd-4215-a310-82272225c4ef", "createdAt": "2021-09-01T12:00:00Z", "updatedAt": "2021-09-01T12:00:00Z", "status": "Completed", "amount": "1231.45", "type": "OffRamp", "paymentInstructions": {}, "payment": {"blockchainTxId": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef", "amount": "1231.45", "address": "0x1234567890abcdef1234567890abcdef12345678", "transferMethod": "PublicBlockchain"
}, "expiresAt": "2021-09-01T12:00:00Z"
}, {"id": "afc7caa0-5b7e-4c98-8f2a-a037d0c6bbea", "createdAt": "2021-09-01T12:00:00Z", "updatedAt": "2021-09-01T12:00:00Z", "status": "Processing", "amount": "1231.45", "type": "Bridge", "to": {"transferMethod": "PublicBlockchain", "address": "0x1234567890abcdef1234567890abcdef12345678", "tag": "1234567890abcdef"
}, "paymentInstructions": {}, "payment": {"blockchainTxId": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef", "amount": "1231.45", "address": "0x1234567890abcdef1234567890abcdef12355678", "transferMethod": "PublicBlockchain"
}, "receipt": {"actualFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "100.00"
}
}
], "blockchainTxId": "0x1234567890abcdef1234567899abcdef1234567890abcdef1234567890abcdef", "amount": "1231.45", "address": "0x1234567890abcdef1234567890abcdef12345678", "transferMethod": "PublicBlockchain"
}, "estimatedFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "100.00"
}
}
], "expiresAt": "2021-09-01T12:00:00Z"
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Request Body schema: application/jsonrequired One of | idempotencyKey required | | | amount required | string (PositiveAmount) ^\d+(\.\d+)? | | customerReferenceId | string Optional customer reference identifier for tracking purposes
- | | type required | | 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) | | | | object (ParticipantsIdentification) An object that ensures the inclusion of either the originator or beneficiary details for transactions.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/ramps Request samples Content typeapplication/json Example {"idempotencyKey": "string", "amount": "string", "customerReferenceId": "string", "type": "OnRamp", "executionDetails": {"type": "Quote", "quoteId": "string", "reQuote": {"type": "Retry", "slippage": 0, "count": 0
}
}, "participantsIdentification": {"originator": {"externalReferenceId": "string", "entityType": "Individual", "participantRelationshipType": "FirstParty", "fullName": {"firstName": "string", "lastName": "string"
}, "dateOfBirth": "1999-01-01", "email": "john.doe@example.com", "phone": "string", "idNumber": "string", "idType": "NIN Slip/Card", "additionalIdNumber": "string", "additionalIdType": "NIN Slip/Card"
}, "beneficiary": {"externalReferenceId": "string", "entityType": "Individual", "participantRelationshipType": "FirstParty", "fullName": {"firstName": "string", "lastName": "string"
}, "dateOfBirth": "1999-01-01", "email": "john.doe@example.com", "phone": "string", "idNumber": "string", "idType": "NIN Slip/Card", "additionalIdNumber": "string", "additionalIdType": "NIN Slip/Card"
}, "originatingVasp": {"vaspName": "string", "vaspCountry": "string", "vaspCode": "string", "vaspWebsite": "string", "vaspRegion": "string"
}, "beneficiaryVasp": {"vaspName": "string", "vaspCountry": "string", "vaspCode": "string", "vaspWebsite": "string", "vaspRegion": "string"
}
}
} Response samples Content typeapplication/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", "paymentInstructions": {}, "estimatedFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "100.00"
}
}
]
}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 | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Request Body schema: application/jsonrequired One of | idempotencyKey required | | | amount required | string (PositiveAmount) ^\d+(\.\d+)? | | customerReferenceId | string Optional customer reference identifier for tracking purposes
+ | | type required | | 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 FpsUkCapability (object) or InternalTransferMethod (object) (OnRampRequestFrom) | required | object (PublicBlockchainAddress) | | | | object (ParticipantsIdentification) An object that ensures the inclusion of either the originator or beneficiary details for transactions.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/ramps Request samples Content typeapplication/json Example {"idempotencyKey": "string", "amount": "string", "customerReferenceId": "string", "type": "OnRamp", "executionDetails": {"type": "Quote", "quoteId": "string", "reQuote": {"type": "Retry", "slippage": 0, "count": 0
}
}, "participantsIdentification": {"originator": {"externalReferenceId": "string", "entityType": "Individual", "participantRelationshipType": "FirstParty", "fullName": {"firstName": "string", "lastName": "string"
}, "dateOfBirth": "1999-01-01", "email": "john.doe@example.com", "phone": "string", "idNumber": "string", "idType": "NIN Slip/Card", "additionalIdNumber": "string", "additionalIdType": "NIN Slip/Card"
}, "beneficiary": {"externalReferenceId": "string", "entityType": "Individual", "participantRelationshipType": "FirstParty", "fullName": {"firstName": "string", "lastName": "string"
}, "dateOfBirth": "1999-01-01", "email": "john.doe@example.com", "phone": "string", "idNumber": "string", "idType": "NIN Slip/Card", "additionalIdNumber": "string", "additionalIdType": "NIN Slip/Card"
}, "originatingVasp": {"vaspName": "string", "vaspCountry": "string", "vaspCode": "string", "vaspWebsite": "string", "vaspRegion": "string"
}, "beneficiaryVasp": {"vaspName": "string", "vaspCountry": "string", "vaspCode": "string", "vaspWebsite": "string", "vaspRegion": "string"
}
}
} Response samples Content typeapplication/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", "paymentInstructions": {}, "estimatedFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "100.00"
}
}
]
}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:
+" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE"> 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.
- | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
- |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/ramps/{id} Response samples Content typeapplication/json Example {"id": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "status": "Pending", "amount": "string", "estimatedFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "string"
}
}
], "executionDetails": {"type": "Quote", "quoteId": "string", "reQuote": {"type": "Retry", "slippage": 0, "count": 0
}
}, "expiresAt": "2019-08-24T14:15:22Z", "failureReason": "unsupported-ramp-method", "paymentInstructions": {}, "type": "OnRamp", "receipt": {"asset": {"blockchain": "Algorand", "cryptocurrencySymbol": "ADA", "testAsset": true
}, "transferMethod": "PublicBlockchain", "address": "string", "addressTag": "string", "amount": "string", "blockchainTxId": "string", "actualFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "string"
}
}
]
}
} | | X-FBAPI-TIMESTAMP required | number Request timestamp in milliseconds since Unix epoch.
+ | | X-FBAPI-INITIATED-BY | string Conditional. This header is provided only when the corresponding capability requirement is enabled.
+ |
Responseshttp://0.0.0.0:8000/accounts/{accountId}/ramps/{id} Response samples Content typeapplication/json Example {"id": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "status": "Pending", "amount": "string", "estimatedFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "string"
}
}
], "executionDetails": {"type": "Quote", "quoteId": "string", "reQuote": {"type": "Retry", "slippage": 0, "count": 0
}
}, "expiresAt": "2019-08-24T14:15:22Z", "failureReason": "unsupported-ramp-method", "paymentInstructions": {}, "type": "OnRamp", "receipt": {"asset": {"blockchain": "Algorand", "cryptocurrencySymbol": "ADA", "testAsset": true
}, "transferMethod": "PublicBlockchain", "address": "string", "addressTag": "string", "amount": "string", "blockchainTxId": "string", "actualFees": [{"feeType": "ORDER", "fee": {"amountType": "FIXED", "amount": "string"
}
}
]
}
} |
|
|
