Get Link token with parameters

POST

api

linktoken

object

userId

string

brokerType

enum<string>, deprecated

restrictMultipleAccounts

boolean

transferOptions

object

toAddresses

array

amountInFiat

number

transactionId

string

clientFee

number

transferType

enum<string>

fundingOptions

object

enabled

boolean

isInclusiveFeeEnabled

boolean

integrationId

string

disableApiKeyGeneration

boolean

verifyWalletOptions

object

message

string

verificationMethods

array

addresses

array

networkId

string

networkType

enum<string>

subClientId

string

Authorizations

X-Client-Secret

string

headerrequired

Contact Mesh to get client Secret

X-Client-Id

string

headerrequired

Contact Mesh to get client Id

Body

userId

string

required

A unique Id representing the end user. Typically this will be a user Id from the client application. Personally identifiable information, such as an email address or phone number, should not be used. 50 characters length maximum.

Required string length: 1 - 50

brokerType

enum<string>

deprecated

Type of integration to redirect to. Will redirect to catalog if not provided. Not supported types: DeFiWallet, CryptocurrencyAddress, CryptocurrencyWallet.

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

restrictMultipleAccounts

boolean

The final screen of Link allows users to “continue” back to your app or “Link another account.” If this param is present then this button will be hidden.

transferOptions

object

Encapsulates transaction-related parameters, including destination addresses and the amount to transfer in fiat currency.

transferOptions.toAddresses

object[] | null

The list of destination addresses with corresponding networks are asset symbols that can be used to initiate incoming transfers. If this parameter is present, the Link session will continue to transfer flow after connecting the origin account.

transferOptions.amountInFiat

number | null

Amount in USD to transfer. If not provided users can specify amount by themselves.

transferOptions.transactionId

string | null

Transaction ID Provided by client to track transaction in future calls

Maximum length: 128

transferOptions.clientFee

number | null

A percentage fee (input as a ratio, eg. 0.02500 = 2.500%) added onto your users' gross payments to your company. This will override any default fee entered in your Mesh dashboard for an individual transaction. Please note: this fee should only be used for Payments (when the transfer destination is an address owned by your company), and not for Deposits (when the transfer destination is an address owned by the end user). If used for Deposits, it will increase the size of the user's Deposit by the fee amount, but will incorrectly show to the user as a fee.

Required range: 0 < x < 1

transferOptions.transferType

enum<string>

Deposit: The user is transferring crypto to a wallet they own on your platform. Payment: The user is transferring crypto to a wallet your company owns in exchange for receiving a good or service. Onramp: The user is using balances and linked payment methods in an exchange account to fund the purchase of crypto in their wallet on your platform.

Available options:

deposit,

payment,

onramp

transferOptions.fundingOptions

object

Specifies the permitted options to use the end user's available buying power and/or payment methods to supplement the cryptocurrency balance if it is insufficient for the transfer.

transferOptions.isInclusiveFeeEnabled

boolean

Specifies if all the fees are included in the amount to transfer.

integrationId

string | null

A unique identifier representing a specific integration obtained from the list of available integrations.

disableApiKeyGeneration

boolean

For direct integrations that also support API keys, Link presents the user with the option to generate an API key for seamless access. If this param is true, this feature will be disabled.

verifyWalletOptions

object

Encapsulates verify DeFi wallet parameters.

subClientId

string | null

Sub Client ID, for B2B2B clients to tailor Link experience for their clients.

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

Refresh auth token

Managed Account Authentication

Managed Transfers

Portfolio

Balance

Verify

Transactions

Self Managed Account Authentication

Transfers

Get Link token with parameters

Authorizations

Body

Response