Managed Transfers

Configure transfer

Get the list of networks and tokens eligible for a transfer, based on the provided request data.

Transfers can be configured either from one connected account to another connected account, or from a connected account to any arbitrary address or addresses.

From one connected account to another connected account:

The API client provides FromAuthToken that is representing the source account and ToAuthToken that is representing the target account. Front API maps networks and tokens supported by both accounts and returns all tokens and networks eligible for a transfer as the result.

From a connected account to any arbitrary address:

The API client provides FromAuthToken that is representing the source account and the list of target addresses using the ToAddresses field. Front API verifies the addresses and returns the list of tokens, eligible to be transferred as the result of the operation.

Returns the list of holdings on the account that can be used to perform the transfer. Each holdings item contains the list of supported networks that can be used to transfer the corresponding asset. Each network contains details such as gas fees and the amount eligible to be transferred.

POST

api

transfers

managed

configure

curl --request POST \
  --url https://integration-api.meshconnect.com/api/v1/transfers/managed/configure \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "isInclusiveFeeEnabled": false,
  "fromAuthToken": "Secret authentication token",
  "fromType": "robinhood",
  "toAddresses": [
    {
      "networkId": "7436e9d0-ba42-4d2b-b4c0-8e4e606b2c12",
      "symbol": "USDT",
      "address": "0x9Bf6207f8A3f4278E0C989527015deFe10e5D7c6"
    },
    {
      "networkId": "0291810a-5947-424d-9a59-e88bb33e999d",
      "symbol": "USDT",
      "address": "HN7cABqLq46Es1jh92dQQisAq662SmxELLLsHHe4YWrH"
    },
    {
      "networkId": "0880db06-7c7c-4738-898f-cf74efc03c47",
      "symbol": "BTC",
      "address": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"
    }
  ]
}'

{
  "content": {
    "status": "succeeded",
    "holdings": [
      {
        "symbol": "USDC",
        "availableBalance": 130,
        "availableBalanceInFiat": 0,
        "eligibleForTransfer": true,
        "networks": [
          {
            "name": "Ethereum",
            "id": "e3c7fdd8-b1fc-4e51-85ae-bb276e075611",
            "minimumAmount": 1,
            "totalEstimatedTransferFeeInFiat": 1.8,
            "estimatedNetworkGasFee": {
              "fee": 0.000850608941007,
              "feeCurrency": "ETH",
              "feeInFiat": 1.8
            },
            "institutionTransferFee": {
              "fee": 0,
              "feeCurrency": "ETH",
              "feeInFiat": 0
            },
            "eligibleForTransfer": true,
            "eligibleForTransferWithFunding": false
          },
          {
            "name": "Solana",
            "id": "0291810a-5947-424d-9a59-e88bb33e999d",
            "minimumAmount": 1,
            "totalEstimatedTransferFeeInFiat": 0.1,
            "estimatedNetworkGasFee": {
              "fee": 0.00025,
              "feeCurrency": "SOL",
              "feeInFiat": 0.1
            },
            "institutionTransferFee": {
              "fee": 0,
              "feeCurrency": "SOL",
              "feeInFiat": 0
            },
            "eligibleForTransfer": true,
            "eligibleForTransferWithFunding": false
          }
        ],
        "eligibleForTransferWithFunding": false
      }
    ]
  },
  "status": "ok",
  "message": "",
  "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 assets from.

Minimum length: 1

fromType

enum<string>

required

The type of the integration to send assets 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

amount

number | null

If provided, Front API configures the response to only return holdings with enough amount of this crypto for the transfer

amountInFiat

number | null

If provided, Front API configures the response to only contain holdings with enough value (converted to fiat) for the transfer.

fiatCurrency

string | null

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

isInclusiveFeeEnabled

boolean

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

networkId

string | null

If provided, from API configures the response to include the requested network only.

symbol

string | null

If provided, Front API returns only networks that support transferring of this symbol.

toAddresses

object[] | null

A list of available addresses provided by the API client. The list can contain all supported addresses by the client. Front API validates the addresses and returns the list of supported tokens and networks as the result of the operation.

toAuthToken

string | null

The authentication token of the target integration. Can be used alternatively to the list of requested address (toAddresses). 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 toAddresses.

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

Response

200 - application/json

content

object

content.amountInFiat

number | null

Amount in USD to transfer.

content.errorMessage

string | null

Error message, if the operation did not complete successfully.

content.fiatCurrency

string | null

Used fiat currency.

content.holdings

object[] | null

List of holdings on the source account.

content.holdings.availableBalance

number

The available balance of the digital asset.

content.holdings.availableBalanceInFiat

number

The available balance of the digital asset, converted to fiat currency.

content.holdings.eligibleForTransfer

boolean

Specifies if the asset is eligible for a transfer.

content.holdings.eligibleForTransferWithFunding

boolean

Indicates that the asset is not eligible for a transfer with the current holding balance, but can be made eligible after funding the balance using the cryptocurrency balance funding feature.

content.holdings.ineligibilityReason

enum<string>

The reason indicating why the transfer of the current asset cannot be performed.

Available options:

noEligibleNetworks,

symbolDoesNotMatch,

notSupportedForTransferByTarget,

notSupportedForTransferBySource,

eligibleWithFunding,

amountNotSufficient,

noPrice

content.holdings.logoUrl

string | null

Logo url for holding.

content.holdings.networks

object[] | null

Supported networks.

content.holdings.networks.eligibleForTransfer

boolean

Specifies if the asset is eligible for a transfer over the current network.

content.holdings.networks.eligibleForTransferWithFunding

boolean

content.holdings.networks.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.holdings.networks.id

string

The Id of the network in Front system.

content.holdings.networks.ineligibilityReason

enum<string>

The reason indicating why the transfer cannot be performed over this network.

Available options:

amountNotSufficient,

gasFeeAssetBalanceNotEnough,

noTargetNetworkFound,

refusedByInstitution,

eligibleWithFunding,

balanceBelowRequestedAmount,

requestedAmountBelowMinimum,

balanceBelowMinimum,

requestedAmountBelowFees,

requestedAmountBelowClientMinimum,

requestedAmountAboveClientMaximum,

noPrice

content.holdings.networks.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.holdings.networks.logoUrl

string | null

Logo url for network.

content.holdings.networks.maximumAmount

number | null

The maximum amount that can be withdrawn using this network.

content.holdings.networks.maximumAmountInFiat

number | null

The maximum amount that can be withdrawn using this network, converted to fiat currency.

content.holdings.networks.minimumAmount

number | null

Then minimum amount that can be withdrawn using this network.

content.holdings.networks.minimumAmountInFiat

number | null

The minimum amount that can be withdrawn using this network, converted to fiat currency.

content.holdings.networks.minimumRequiredForTransferAmount

number | null

The minimum amount of cryptocurrency that is required to be present in the account to perform the transfer. Unlike minimum field that indicates the minimum amount that can generally be transferred, this field indicates the minimum that can be transferred given the current transfer configuration values, such as amountInFiat and clientFee.

content.holdings.networks.name

string | null

The name of the network.

content.holdings.networks.toAddress

string | null

The designated destination for sending the asset.

content.holdings.networks.totalEstimatedTransferFeeInFiat

number | null

Total estimated transfer fee converted to fiat. Can consist of the fee taken by the financial institution and the gas fee.

content.holdings.networks.transferAmount

number | null

Token's amount to transfer specified by the client.

content.holdings.symbol

string | null

The symbol of the digital asset on the source account.

content.maximumTransferAmountInFiat

number | null

Maximum transfer amount in fiat

content.minimumTransferAmountInFiat

number | null

Minimum transfer amount in fiat.

content.status

enum<string>

Status of the operation.

Available options:

succeeded,

failed,

validationFailed,

notAuthorizedTo,

notAuthorizedFrom,

kycRequired,

fromIntegrationNotSupported,

toIntegrationNotSupported

content.supportedFiatCurrencies

string[] | null

Supported fiat currencies for this transfer

content.transferBalanceFundingAvailability

object

displayMessage

string | null

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

errorData

any | null

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.

message

string | null

A message generated by the API

status

enum<string>

Available options:

ok,

serverFailure,

permissionDenied,

badRequest,

notFound,

conflict,

tooManyRequest,

locked,

unavailableForLegalReasons

Get supported tokens list Preview transfer

curl --request POST \
  --url https://integration-api.meshconnect.com/api/v1/transfers/managed/configure \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "isInclusiveFeeEnabled": false,
  "fromAuthToken": "Secret authentication token",
  "fromType": "robinhood",
  "toAddresses": [
    {
      "networkId": "7436e9d0-ba42-4d2b-b4c0-8e4e606b2c12",
      "symbol": "USDT",
      "address": "0x9Bf6207f8A3f4278E0C989527015deFe10e5D7c6"
    },
    {
      "networkId": "0291810a-5947-424d-9a59-e88bb33e999d",
      "symbol": "USDT",
      "address": "HN7cABqLq46Es1jh92dQQisAq662SmxELLLsHHe4YWrH"
    },
    {
      "networkId": "0880db06-7c7c-4738-898f-cf74efc03c47",
      "symbol": "BTC",
      "address": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"
    }
  ]
}'

{
  "content": {
    "status": "succeeded",
    "holdings": [
      {
        "symbol": "USDC",
        "availableBalance": 130,
        "availableBalanceInFiat": 0,
        "eligibleForTransfer": true,
        "networks": [
          {
            "name": "Ethereum",
            "id": "e3c7fdd8-b1fc-4e51-85ae-bb276e075611",
            "minimumAmount": 1,
            "totalEstimatedTransferFeeInFiat": 1.8,
            "estimatedNetworkGasFee": {
              "fee": 0.000850608941007,
              "feeCurrency": "ETH",
              "feeInFiat": 1.8
            },
            "institutionTransferFee": {
              "fee": 0,
              "feeCurrency": "ETH",
              "feeInFiat": 0
            },
            "eligibleForTransfer": true,
            "eligibleForTransferWithFunding": false
          },
          {
            "name": "Solana",
            "id": "0291810a-5947-424d-9a59-e88bb33e999d",
            "minimumAmount": 1,
            "totalEstimatedTransferFeeInFiat": 0.1,
            "estimatedNetworkGasFee": {
              "fee": 0.00025,
              "feeCurrency": "SOL",
              "feeInFiat": 0.1
            },
            "institutionTransferFee": {
              "fee": 0,
              "feeCurrency": "SOL",
              "feeInFiat": 0
            },
            "eligibleForTransfer": true,
            "eligibleForTransferWithFunding": false
          }
        ],
        "eligibleForTransferWithFunding": false
      }
    ]
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

Managed Account Authentication

Managed Transfers

Portfolio

Balance

Verify

Transactions

Self Managed Account Authentication

Transfers

Configure transfer

Authorizations

Body

Response