POST
/
api
/
v1
/
transfers
curl --request POST \
  --url https://integration-api.meshconnect.com/api/v1/transfers \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "data": "Some memo",
  "targetAddress": "D641Fmzx...",
  "amount": 100,
  "fee": 5,
  "addressType": "dogeAddress",
  "mfaCode": "000000",
  "password": "$sb7u26",
  "tryAnotherMfa": false,
  "authToken": "Secret authentication token",
  "type": "coinbase"
}'
{
  "content": {
    "failed": false,
    "status": "pending",
    "statusDetails": "Accepted",
    "transaction": {
      "id": "8E25ACB5-A9E2-4D00-8772-A255F010A2A9",
      "status": "pending",
      "type": "withdrawal",
      "fromAddress": "D5PumQwt...",
      "targetAddress": "D641Fmzx...",
      "symbol": "DOGE",
      "hash": "3310c6202aaeb44754a118ce11f255382d012060ade0d6d9f...",
      "amount": 105,
      "transactionAmount": 100,
      "createdTimestamp": 1653215600,
      "updatedTimestamp": 1653215600,
      "networkTransactionFee": {
        "amount": 5,
        "symbol": "DOGE"
      },
      "confirmations": 3,
      "blockchainMethod": "transfer"
    },
    "fallbackMfaAvailable": 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

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 PayPalConnect 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
​
targetAddress
string
required

Target address to transfer the asset to

Minimum length: 1
​
data
string | null

Additional data to send on-chain (optional, depends on an integration)

​
amount
number

Amount to transfer

​
fee
number

On-chain fee (optional, depends on an integration)

​
addressType
enum<string>

Type of the address of symbol to be transferred. Providing EthAddress will initiate a transfer of ETH over Ethereum blockchain. Can be used instead of Symbol and Chain fields. To transfer assets over non-default chains (e.g. sending USDT over ERC20) please Symbol and Chain fields.

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

2 Factor auth code (optional, depends on an integration)

​
travelRuleTransactionId
integer | null

Travel rule transaction id (optional, depends on an integration)

​
mfaType
enum<string>

2 Factor auth type (optional, depends on an integration)

Available options:
phone,
email,
totp,
phoneAndEmail,
requireNextSecurityQuestion,
readEmail,
face,
tradingPin,
qrCode,
password,
roaming,
mobile
​
verificationSteps
enum<string>[] | null
Available options:
phone,
email,
totp,
phoneAndEmail,
requireNextSecurityQuestion,
readEmail,
face,
tradingPin,
qrCode,
password,
roaming,
mobile
​
password
string | null

Password or pass-phrase, required to send transfers (optional, depends on an integration)

​
chain
string | null

Custom chain name, required by some of the integrations. E.g. USDT can be sent over USDT-ERC20, USDT-TRC20, and USDT-Omni. Can be used to transfer assets over non-default chains (e.g. sending USDT over ERC20). Please use symbol/details endpoint to get the list of all possible chains.

​
memo
string | null

Memo (also called "Tag") - address remark.

​
symbol
string | null

Symbol to be transferred. Can be provided instead of the AddressType field.

​
challengeId
string | null
​
tryAnotherMfa
boolean
​
travelRuleOptions
object

Response

200
application/json
Transfer successfully 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

​
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