Skip to main content
POST
/
api
/
v1
/
transfers
/
managed
/
preview
curl --request POST \
  --url https://integration-api.meshconnect.com/api/v1/transfers/managed/preview \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "fromAuthToken": "Secret authentication token",
  "fromType": "robinhood",
  "networkId": "7436e9d0-ba42-4d2b-b4c0-8e4e606b2c12",
  "symbol": "USDT",
  "toAddress": "0x9Bf6207f8A3f4278E0C989527015deFe10e5D7c6",
  "amount": 10
}
'
{
  "content": {
    "status": "succeeded",
    "previewResult": {
      "previewId": "29b185b1-2305-40fb-a0e2-929d61451568",
      "previewExpiresIn": 300,
      "fromAddress": "0x9Bf6207f8A3f4278E0C989527015deFe10e5D7c6",
      "toAddress": "0x326a8825472bb0f4719998e708a1eeeb4473ed1b",
      "symbol": "USDT",
      "amount": 10,
      "amountInFiat": 10,
      "totalEstimatedAmount": 11.21,
      "totalEstimatedAmountInFiat": 11.21,
      "networkId": "e3c7fdd8-b1fc-4e51-85ae-bb276e075611",
      "institutionTransferFee": {
        "fee": 0,
        "feeCurrency": "USDT",
        "feeInFiat": 0,
        "feeInTransferCurrency": 0
      },
      "estimatedNetworkGasFee": {
        "fee": 1.1,
        "feeCurrency": "USDT",
        "feeInFiat": 1.1,
        "feeInTransferCurrency": 0
      },
      "unitPrice": 0,
      "customClientFee": {
        "fee": 0.011,
        "feeCurrency": "USDT",
        "feeInFiat": 0.011,
        "feeInTransferCurrency": 0
      },
      "transferType": "deposit",
      "isCustomClientFeeProvided": false,
      "amountWithCustomClientFee": "0",
      "isFeeIncluded": false,
      "amountToReceive": 0,
      "amountToReceiveInFiat": 0,
      "transferAmountToRequest": 0,
      "isMaximumAmount": false,
      "isBridging": false,
      "totalEstimatedAmountPlusConversionFeesInFiat": 0,
      "brokerType": "robinhood"
    }
  },
  "status": "ok",
  "message": "",
  "errorHash": "69ede01c",
  "errorType": ""
}

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

​
fromAuthToken
string
required

The authentication token to send the asset from.

Minimum string length: 1
​
fromType
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
​
toAuthToken
string | null

The authentication token of the target integration. Can be used alternatively to the address in the ToAddress field. If used, toType should also be provided.

​
toType
enum<string>

The type of the target integration to send assets to. Used along with the toAuthToken alternatively to ToAddress.

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
​
networkId
string<uuid>

The network to send the asset over.

​
symbol
string | null

The symbol of the digital asset to send.

​
toAddress
string | null

The target address to send the asset to.

​
addressTag
string | null

Secondary address identifier for coins like XRP,XMR etc.

​
amount
number<double> | null

The amount to send, in crypto.

​
amountInFiat
number<double> | null

The amount to send, in fiat currency. Can be used alternatively to Amount.

​
fiatCurrency
string | null

Fiat currency that is to get corresponding converted fiat values of transfer and fee amounts. If not provided, defaults to USD.

​
transactionId
string | null

Transaction ID Provided by client to track transaction in future calls.

Maximum string length: 128
​
isBridging
boolean | null

Indicates that the transfer is a bridging transfer.

​
bridgingDirectionId
string<uuid> | null

The ID of the bridging direction configuration to use for this transfer.

​
isInclusiveFeeEnabled
boolean

Specifies if all the fees are included in the amount to transfer.

Response

OK

​
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

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

​
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