Initiate a transfer

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

targetAddress

string

required

Target address to transfer the asset to

Minimum length: 1

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 BinanceConnect BinancePay 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

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

amount

number

Amount to transfer

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.

challengeId

string | null

data

string | null

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

fee

number

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

memo

string | null

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

mfaCode

string | null

2 Factor auth code (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

password

string | null

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

symbol

string | null

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

travelRuleOptions

object

travelRuleTransactionId

integer | null

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

tryAnotherMfa

boolean

verificationSteps

enum<string>[] | null

Available options:

phone,

email,

totp,

phoneAndEmail,

requireNextSecurityQuestion,

readEmail,

face,

tradingPin,

qrCode,

password,

roaming,

mobile

Response

200 - application/json

content

object

content.challengeId

string | null

content.failed

boolean

content.fallbackMfaAvailable

boolean

content.mfaType

enum<string>

Available options:

phone,

email,

totp,

phoneAndEmail,

requireNextSecurityQuestion,

readEmail,

face,

tradingPin,

qrCode,

password,

roaming,

mobile

content.qrCode

string | null

content.qrCodeLink

string | null

content.status

enum<string>

Status of the operation

Available options:

unknown,

failed,

frozen,

succeeded,

mfaRequired,

pending,

expired,

canceled,

waitingForSignature,

waitingForClearing,

awaitingApproval,

awaitingConfirmation,

awaitingVerification,

rejected,

pendingCancel,

emailVerification,

deviceConfirmationRequired,

mfaFailed,

addressWhitelistRequired,

secondMfaRequired,

emailConfirmationApprovalRequired

content.statusDetails

string | null

Details of the current status of the transfer, as provided by the financial institution

content.transaction

object

Details of the created transaction

content.transaction.amount

number

Full amount affected the balance, typically transaction amount plus fee

content.transaction.blockchainMethod

enum<string>

Executed blockchain function based on decoded input data. Not guaranteed to be identified

Available options:

transfer,

swap,

mint,

withdraw,

claimRewards,

deposit,

approve,

forgeToken,

multicall,

migrateToken,

claim,

openSeaTransfer,

cancel,

commit,

run,

repay,

execute,

stake,

merge

content.transaction.blockchainMethodName

string | null

Name of the executed blockchain function based on decoded input data

content.transaction.chain

string | null

Crypto Chain the transaction belongs to

content.transaction.confirmations

integer | null

Number of confirmations on the blockchain

content.transaction.createdTimestamp

integer

Unix timestamp in seconds indicating when the transaction was created

content.transaction.fromAddress

string | null

Address where the transaction was sent from

content.transaction.hash

string | null

Hash of the transaction

content.transaction.id

string | null

Identifier of the transfer, if provided by the financial institution

content.transaction.memo

string | null

Memo of the transaction (also called "Tag")

content.transaction.networkTransactionFee

object

Fee taken by the network

content.transaction.status

enum<string>

Current status of the transaction

Available options:

unknown,

failed,

frozen,

succeeded,

mfaRequired,

pending,

expired,

canceled,

waitingForSignature,

waitingForClearing,

awaitingApproval,

awaitingConfirmation,

awaitingVerification,

rejected,

pendingCancel,

emailVerification,

deviceConfirmationRequired,

mfaFailed,

addressWhitelistRequired,

secondMfaRequired,

emailConfirmationApprovalRequired

content.transaction.statusDetails

string | null

Details of the current status of the transfer, as provided by the financial institution

content.transaction.symbol

string | null

Ticker of the transaction

content.transaction.targetAddress

string | null

Address where the transaction was sent to

content.transaction.transactionAmount

number | null

Transaction amount

content.transaction.transferFee

number | null

Fee taken by the financial institution

content.transaction.type

enum<string>

The direction of the transaction

Available options:

unknown,

deposit,

withdrawal

content.transaction.updatedTimestamp

integer

Unix timestamp in seconds indicating when the transaction was last updated

content.transactionId

string | null

Transaction Id by the financial institution

content.verificationSteps

enum<string>[] | null

Available options:

phone,

email,

totp,

phoneAndEmail,

requireNextSecurityQuestion,

readEmail,

face,

tradingPin,

qrCode,

password,

roaming,

mobile

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