POST
/
api
/
v1
/
transactions
/
cancel

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
id
string
required
Minimum length: 1
isCryptocurrency
boolean
required

Some Stock and Crypto symbols can intersect, so we need to explicitly specify what type of asset is requested to be bought.

type
enum<string>
required

Type of the institution to connect

Supported integrations:

Robinhood ETrade Alpaca WeBull Stash InteractiveBrokers Public Coinbase Kraken CoinbasePro CryptoCom Binance Gemini OkCoin KuCoin Etoro CexIo BinanceInternational Bitstamp GateIo Okx BitFlyer Coinlist Huobi Bitfinex KrakenDirect Vanguard BinanceInternationalDirect Bybit CoinbasePrime RobinhoodConnect

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

MFA Code to cancel an order (requested by Kraken if MFA is enabled in user settings)

side
enum<string>

Should be provided for Coinbase.

Available options:
unknown,
buy,
sell
symbolPair
string | null

Symbol pair of the order (requested by some brokers).

Response

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