POST
/
api
/
v1
/
transfers
/
address
/
get

Authorizations

X-Client-Secret
string
headerrequired

Contact Mesh to get client Secret

X-Client-Id
string
headerrequired

Contact Mesh to get client Id

Body

application/json
authToken
string
required

Auth token that allows connecting to the target institution

type
enum<string>
required

Type of the institution to connect

Supported integrations:

Robinhood Coinbase Kraken CoinbasePro CryptoCom Binance Gemini OkCoin KuCoin BinanceInternational Bitstamp GateIo Okx Huobi Bitfinex KrakenDirect BinanceInternationalDirect BitfinexDirect Bybit Paxos CoinbasePrime BtcTurkDirect ParibuDirect RobinhoodConnect BlockchainCom DeFiWallet

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

Symbol of the required cryptocurrency, e.g. ETH or BTC. Can be used instead of the AddressType field.

addressType
enum<string>

Type of the address of symbol to be transferred. Providing EthAddress will assume a transfer of ETH over Ethereum blockchain. Can be used instead of Symbol field.

Available options:
ethAddress,
btcAddress,
ltcAddress,
solAddress,
algoAddress,
celoAddress,
cardanoAddress,
polygonAddress,
bnbAddress,
elrondAddress,
neoAddress,
xrpAddress,
flowAddress,
harmonyOneAddress,
tronAddress,
dogeAddress,
opAddress
chain
string | null

Chain of the required cryptocurrency, e.g. USDT has USDT-ERC20, USDT-TRC20, and USDT-Omni

mfaCode
string | null

Some of integrations require MFA code to create a deposit address, e.g. KrakenDirect

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
Initiate a transferGet details of asset