diff --git a/v2/api-validator/src/client/generated/models/Blockchain.ts b/v2/api-validator/src/client/generated/models/Blockchain.ts index cbb2777f..ca3f88f2 100644 --- a/v2/api-validator/src/client/generated/models/Blockchain.ts +++ b/v2/api-validator/src/client/generated/models/Blockchain.ts @@ -75,4 +75,5 @@ export enum Blockchain { LINEA = 'Linea', BABYLON = 'Babylon', CANTON = 'Canton', + BNB_SMART_CHAIN = 'BNB Smart Chain', } diff --git a/v2/openapi/docs.html b/v2/openapi/docs.html index d0633a19..6e836b97 100644 --- a/v2/openapi/docs.html +++ b/v2/openapi/docs.html @@ -36,7 +36,7 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

Fireblocks Provider Connectivity API v2 (0.5.0)

Download OpenAPI specification:

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

Fireblocks Provider Connectivity API v2 (0.5.1)

Download OpenAPI specification:

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

Fireblocks Provider Connectivity API defines the interface for integration of third-party providers into Fireblocks platform.

@@ -1492,7 +1492,7 @@

USA

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

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

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

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

-
cryptocurrencySymbol
string (CryptocurrencySymbol)
Enum: "ADA" "ALGO" "ARB" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BASE" "BCH" "BCHA" "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" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OPT" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC"
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"

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.

@@ -2336,8 +2336,10 @@

USA

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Failed to process request.

Response samples

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

Create new withdrawal to a peer account

Should reject any non peer acount withdrawal request.

+
http://0.0.0.0:8000/accounts/{accountId}/transfers/withdrawals/peeraccount

Response samples

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

Create new withdrawal to a peer account

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
USA " class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

Conditional. This header is provided only when the corresponding capability requirement is enabled.

Request Body schema: application/json
required

Withdrawal details

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

Responses

idempotencyKey
required
string
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)

Responses

assetId
string

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

-
cryptocurrencySymbol
string (CryptocurrencySymbol)
Enum: "ADA" "ALGO" "ARB" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BASE" "BCH" "BCHA" "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" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OPT" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC"
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"

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

@@ -3202,7 +3206,7 @@

USA

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

Local server

http://0.0.0.0:8000/accounts/{accountId}/ramps/{id}

Response samples

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