Preview transfer

POST

api

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,
      "amountInUsd": 10,
      "totalEstimatedAmount": 11.21,
      "totalEstimatedAmountInFiat": 11.21,
      "totalEstimatedAmountInUsd": 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",
  "teamCode": "P4",
  "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,

krakenOAuth,

bluvoKrakenOAuth,

cashApp,

sandboxKrakenOAuth,

krakPay,

unlimit,

alchemyPay,

okxPay,

bybitPayPsp

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 that must arrive at the destination, in crypto, denominated in the destination asset's units. Symbol is always the sent (source) asset; on a non-bridging transfer the two coincide, so this is also the amount sent. On a cross-symbol bridging/swap direction the source-side amount is derived from this value via prices and the bridging quote.

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

bridgingRouteType

enum<string> | null

Specifies whether the transfer is a bridge (cross-chain) or a swap (same-chain). Null = vanilla deposit. Replaces the legacy Org.Front.Core.Contracts.Models.Brokers.B2B.ManagedTransfers.BasePreviewTransferRequest.IsBridging flag.

Available options:

bridge,

swap,

direct

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.

isAtomicBatchTxAvailable

boolean | null

Specifies if connected wallet supports batched transactions.

isInclusiveFeeEnabled

boolean

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

Response

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

Show child attributes

⌘I

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,
      "amountInUsd": 10,
      "totalEstimatedAmount": 11.21,
      "totalEstimatedAmountInFiat": 11.21,
      "totalEstimatedAmountInUsd": 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",
  "teamCode": "P4",
  "errorType": ""
}

Guides

API Reference

Preview transfer

Authorizations

Body

Response