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,
      "totalEstimatedAmount": 11.21,
      "totalEstimatedAmountInFiat": 11.21,
      "networkId": "e3c7fdd8-b1fc-4e51-85ae-bb276e075611",
      "institutionTransferFee": {
        "fee": 0,
        "feeCurrency": "USDT",
        "feeInFiat": 0
      },
      "estimatedNetworkGasFee": {
        "fee": 1.1,
        "feeCurrency": "USDT",
        "feeInFiat": 1.1
      },
      "unitPrice": 0,
      "customClientFee": {
        "fee": 0.011,
        "feeCurrency": "USDT",
        "feeInFiat": 0.011
      },
      "transferType": "deposit",
      "isCustomClientFeeProvided": false,
      "amountWithCustomClientFee": "0",
      "isFeeIncluded": false,
      "amountToReceive": 0,
      "amountToReceiveInFiat": 0,
      "transferAmountToRequest": 0,
      "isMaximumAmount": false
    }
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

Authorizations

X-Client-Secret

string

headerrequired

Contact Mesh to get client Secret

X-Client-Id

string

headerrequired

Contact Mesh to get client Id

Body

fromAuthToken

string

required

The authentication token to send the asset from.

Minimum 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

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

networkId

string

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 | null

The amount to send, in crypto.

amountInFiat

number | 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 length: 128

isInclusiveFeeEnabled

boolean

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

Response

200 - application/json

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

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

any | null

content

object

content.status

enum<string>

The status of the operation.

Available options:

succeeded,

failed,

requiresFunding

content.errorMessage

string | null

Error message, if the operation did not complete successfully.

content.previewResult

object

Result of the preview.

content.previewResult.previewId

string

The Id of the preview of the transfer. Should be used to commit the transfer using Execute endpoint.

content.previewResult.previewExpiresIn

integer

The period of time in seconds during which the transfer can be committed.

content.previewResult.fromAddress

string | null

Obtained address that will be used to send the transfer. Not guaranteed to be returned by some of integrations.

content.previewResult.toAddress

string | null

The target address to send the asset to.

content.previewResult.addressTag

string | null

Secondary address identifier for coins like XRP, XMR etc.

content.previewResult.symbol

string | null

Symbol of the asset to be sent.

content.previewResult.amount

number

Amount in symbol. If the transfer was requested using AmounInFiat field, this field represents the exact amount of the asset that will be transferred.

content.previewResult.amountInFiat

number

Transfer amount in fiat. If the transfer was requested in crypto amount using the Amount field, this field contains the corresponding converted to fiat value.

content.previewResult.totalEstimatedAmount

number

Total estimated amount of the transfer including all fees, in cryptocurrency.

content.previewResult.totalEstimatedAmountInFiat

number

Total estimated amount of the transfer including all fees, converted to fiat.

content.previewResult.networkId

string

Id of the network in Front system.

content.previewResult.networkName

string | null

Name of the network in Front system.

content.previewResult.contractAddress

string | null

Blockchain address of the transferred token's contract

content.previewResult.institutionTransferFee

object

The fee that is taken by the institution. Depending on the institution, can cover the gas fee. Some institutions do not take the transfer fee and only network fee is used for the transfer.

content.previewResult.estimatedNetworkGasFee

object

The gas fee that is estimated to be taken by the network. Depending on the integration, the network gas fee might be covered by the InstitutionTransferFee.

content.previewResult.decimalPlaces

integer | null

Number of decimal places used to represent the token's smallest unit

content.previewResult.unitPrice

number

The price of the cryptocurrency asset in the fiat currency.

content.previewResult.clientTransactionId

string | null

Transaction id provided by the client

Maximum length: 128

content.previewResult.clientFee

number | null

A percentage fee (input as a ratio, eg. 0.02500 = 2.500%) added onto your users' gross payments. This will override any default fee entered in your Mesh dashboard for an individual transaction. Please note: this fee should only be used for Payments (when the transfer destination is an address owned by your company), and not for Deposits (when the transfer destination is an address owned by the end user). If used for Deposits, it will increase the size of the user's Deposit by the fee amount, but will incorrectly show to the user as a fee.

Required range: 0 < x < 1

content.previewResult.customClientFee

object

The client fee that is estimated to be added to the total estimated transfer amount, based on the user's requested transfer amount and client fee percentage.

content.previewResult.processingFeeRetainMethod

object

content.previewResult.transferType

enum<string>

Deposit: The user is transferring crypto to a wallet they own on your platform. Payment: The user is transferring crypto to a wallet your company owns in exchange for receiving a good or service. Onramp: The user is using balances and linked payment methods in an exchange account to fund the purchase of crypto in their wallet on your platform.

Available options:

deposit,

payment,

onramp

content.previewResult.isCustomClientFeeProvided

boolean

content.previewResult.amountWithCustomClientFee

number

Amount in symbol after the client fees are applied. This field represents the exact amount of the asset that will be requested for transfer.

content.previewResult.isFeeIncluded

boolean

Indicates if all the fees are included in the amount. For example, if this field's value is true and the user wants to send 1 BTC and the sum of all fees is 0.1 BTC, the user will be charged 1 BTC, and the target address will receive 0.9 BTC. If the fees are no inclusive, the user will be charged 1.1 BTC and the target address will receive 1 BTC.

content.previewResult.amountToReceive

number

Indicates the final amount to receive after all fees are applied. In case fees are not inclusive (IsFeeIncluded is false), this field will be equal to the Amount field.

content.previewResult.amountToReceiveInFiat

number

Indicates the final amount in fiat to receive after all fees are applied. In case fees are not inclusive (IsFeeIncluded is false), this field will be equal to the AmountInFiat field.

content.previewResult.transferAmountToRequest

number

Exact amount in cryptocurrency requested to transfer to the destination address using the target integration.

content.previewResult.isMaximumAmount

boolean

Indicates if the transfer's intention is to transfer all available assets using the requested network and symbol.

content.previewResult.fiatCurrency

string | null

Indicates the fiat currency that is used to calculate transfer amounts.

content.transferBalanceFundingAvailability

object

content.transferFromAnotherAccountAvailabilityInfo

object

For instance if not enough assets in Spot account, and we can fill it from Funding account

Configure transfer Execute transfer

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
      },
      "estimatedNetworkGasFee": {
        "fee": 1.1,
        "feeCurrency": "USDT",
        "feeInFiat": 1.1
      },
      "unitPrice": 0,
      "customClientFee": {
        "fee": 0.011,
        "feeCurrency": "USDT",
        "feeInFiat": 0.011
      },
      "transferType": "deposit",
      "isCustomClientFeeProvided": false,
      "amountWithCustomClientFee": "0",
      "isFeeIncluded": false,
      "amountToReceive": 0,
      "amountToReceiveInFiat": 0,
      "transferAmountToRequest": 0,
      "isMaximumAmount": false
    }
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

Managed Account Authentication

Managed Transfers

Portfolio

Balance

Verify

Transactions

Self Managed Account Authentication

Transfers

Preview transfer

Authorizations

Body

Response