Skip to main content
POST

Authorizations

X-Client-Secret
string
header
required

Contact Mesh to get client Secret

X-Client-Id
string
header
required

Contact Mesh to get client Id

Body

application/json
amountInFiat
number<double>
required

Base amount of fiat currency being transferred

fiatCurrency
string
required

3 character currency code, e.g. USD

Maximum string length: 3
symbol
string
required

Symbol of destination cryptocurrency, e.g. ETH

Maximum string length: 10
networkId
string<uuid>
required

Unique id of destination network

toAddress
string
required

The designated destination for sending the asset.

Maximum string length: 1024
brokerType
enum<string>
required

The type of the integration to send the asset from

Available options:
robinhood,
eTrade,
alpaca,
tdAmeritrade,
weBull,
stash,
interactiveBrokers,
public,
coinbase,
kraken,
coinbasePro,
cryptoCom,
openSea,
binanceUs,
gemini,
cryptocurrencyAddress,
cryptocurrencyWallet,
okCoin,
bittrex,
kuCoin,
etoro,
cexIo,
binanceInternational,
bitstamp,
gateIo,
acorns,
okx,
bitFlyer,
coinlist,
huobi,
bitfinex,
deFiWallet,
krakenDirect,
vanguard,
binanceInternationalDirect,
bitfinexDirect,
bybit,
paxos,
coinbasePrime,
btcTurkDirect,
kuCoinDirect,
okxOAuth,
paribuDirect,
robinhoodConnect,
blockchainCom,
bitsoDirect,
binanceConnect,
binanceOAuth,
revolutConnect,
binancePay,
bybitDirect,
paribuOAuth,
payPalConnect,
binanceTrDirect,
coinbaseRamp,
bybitDirectMobile,
sandbox,
cryptoComPay,
bybitEuDirect,
uphold,
binancePayOnchain,
sandboxCoinbase,
bybitPay,
krakenOAuth,
bluvoKrakenOAuth,
cashApp,
sandboxKrakenOAuth,
krakPay,
unlimit,
alchemyPay,
okxPay
feeFlat
number<double> | null

Flat fee in crypto to be charged as a partner fee

feePercentage
number<double> | null

Percentage of transfer amount to be charged as a partner fee, expressed as decimal (ie 0.1 = 10%)

Response

Quote obtained.

status
enum<string>
Available options:
ok,
serverFailure,
permissionDenied,
badRequest,
notFound,
conflict,
tooManyRequest,
locked,
unavailableForLegalReasons
message
string | null

A message generated by the API

displayMessage
string | null

User-friendly display message that can be presented to the end user

errorHash
string | null
read-only

An error grouping hash from string components and caller information. Used by bugsnag on FE for correct error grouping

teamCode
string | null
read-only

Opaque team code for error routing. Resolved from exception origin or caller file path via CODEOWNERS. Format: 2-character code (e.g., "7K", "M2"). Use for alerting/routing, not display.

errorType
string | null

Strictly-typed error type that is explaining the reason of an unsuccessful status of the operation. All possible error types are available in the documentation.

errorData
unknown
content
object | null