POST
/
api
/
v1
/
transfers
/
address
/
get
Get deposit address
curl --request POST \
  --url https://integration-api.meshconnect.com/api/v1/transfers/address/get \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "symbol": "DOGE",
  "chain": "DOGE",
  "authToken": "Secret authentication token",
  "type": "robinhood"
}'
{
  "content": {
    "symbol": "DOGE",
    "address": "D641Fmzx...",
    "chain": "DOGE"
  },
  "status": "ok",
  "message": "",
  "errorHash": "010074a19298a4afea1a5fc2dc51f25ea9313511",
  "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

application/json
authToken
string
required

Auth token that allows connecting to the target institution

Minimum length: 1
type
enum<string>
required

Type of the institution to connect

Supported integrations:

Robinhood Coinbase Kraken CryptoCom Binance Gemini OkCoin KuCoin BinanceInternational Bitstamp GateIo Okx Huobi Bitfinex KrakenDirect BinanceInternationalDirect BitfinexDirect Bybit Paxos CoinbasePrime BtcTurkDirect ParibuDirect RobinhoodConnect BlockchainCom BinanceConnect RevolutConnect BinancePay BybitDirect ParibuOAuth PayPalConnect CoinbaseRamp BybitDirectMobile 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,
bitsoDirect,
binanceConnect,
binanceOAuth,
revolutConnect,
binancePay,
bybitDirect,
paribuOAuth,
payPalConnect,
binanceTrDirect,
coinbaseRamp,
bybitDirectMobile,
sandbox
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

Address successfully obtained or generation initiated.

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
any
content
object