Execute transfer

POST

api

transfers

managed

execute

curl --request POST \
  --url https://integration-api.getfront.com/api/v1/transfers/managed/execute \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "fromAuthToken": "Secret authentication token",
  "fromType": "robinhood",
  "previewId": "29b185b1-2305-40fb-a0e2-929d61451568"
}'

{
  "content": {
    "status": "succeeded",
    "executeTransferResult": {
      "transferId": "e332336c-de22-11ed-b5ea-0242ac120002",
      "status": "pending",
      "statusDetails": "In progress",
      "fromAddress": "0x9Bf6207f8A3f4278E0C989527015deFe10e5D7c6",
      "toAddress": "0x326a8825472bb0f4719998e708a1eeeb4473ed1b",
      "symbol": "USDT",
      "networkName": "Ethereum",
      "networkId": "e3c7fdd8-b1fc-4e51-85ae-bb276e075611",
      "hash": "0xdcfd72635a9b16d3bc0e75311f6fe0612970e9714a1e9e93de0ea5acffc6a454",
      "amount": 10,
      "amountInFiat": 10,
      "totalAmountInFiat": 11.1,
      "completedConfirmations": 1,
      "institutionTransferFee": {
        "fee": 0,
        "feeCurrency": "USDT",
        "feeInFiat": 0
      },
      "networkGasFee": {
        "fee": 1.1,
        "feeCurrency": "USDT",
        "feeInFiat": 1.1
      }
    }
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

Authorizations

X-Client-Secret

string

header

required

Contact Front to get client Secret

X-Client-Id

string

header

required

Contact Front to get client Id

Body

fromAuthToken

string

required

The authentication token to send the asset from.

Minimum length: 1

fromType

enum<string>

required

The type of the integration to send the asset from.

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

previewId

string

required

Id of the Preview of the transfer.

mfaCode

string | null

Multi-factor auth code that should be provided if the status of the transfer was MfaRequired.

Response

200

application/json

Success

status

enum<string>

Available options:

ok,

serverFailure,

permissionDenied,

badRequest,

notFound,

conflict,

tooManyRequest,

locked

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.

content

object

content.status

enum<string>

The status of the transfer.

Available options:

succeeded,

failed,

mfaRequired,

emailConfirmationRequired,

deviceConfirmationRequired,

mfaFailed,

addressWhitelistRequired,

secondMfaRequired

content.mfaType

enum<string>

The type of the MFA when the status is MfaRequired.

Available options:

unspecified,

phone,

email,

totp,

face

content.verificationSteps

enum<string>[] | null

The type of the MFA when the status is MfaRequired.

Available options:

unspecified,

phone,

email,

totp,

face

content.qrCode

string | null

content.qrCodeLink

string | null

content.errorMessage

string | null

Error message, if the operation did not complete successfully.

content.executeTransferResult

object

Result of the transfer initiation.

content.executeTransferResult.transferId

string | null

The Id of the transfer by the integration.

content.executeTransferResult.status

enum<string>

The current status of the transfer.

Available options:

unknown,

failed,

frozen,

succeeded,

mfaRequired,

pending,

expired,

canceled,

waitingForSignature,

waitingForClearing,

awaitingApproval,

awaitingConfirmation,

awaitingVerification,

rejected,

pendingCancel,

emailVerification,

deviceConfirmationRequired,

mfaFailed,

addressWhitelistRequired,

secondMfaRequired

content.executeTransferResult.statusDetails

string | null

Details of the current status of the transfer, as provided by the integration.

content.executeTransferResult.fromAddress

string | null

The address of the source account or wallet.

content.executeTransferResult.toAddress

string | null

The address of the target account or wallet.

content.executeTransferResult.symbol

string | null

Transferred symbol.

content.executeTransferResult.networkName

string | null

The name of the used network.

content.executeTransferResult.networkId

string

The Id of the used network in Front system.

content.executeTransferResult.hash

string | null

The hash of the blockchain transaction.

content.executeTransferResult.amount

number

The transferred amount, in the symbol of the transfer.

content.executeTransferResult.amountInFiat

number

The transferred amount, converted to the fiat currency.

content.executeTransferResult.totalAmountInFiat

number

Total amount of the transfer including all fees, converted to fiat.

content.executeTransferResult.completedConfirmations

integer | null

Current number of network confirmations.

content.executeTransferResult.institutionTransferFee

object

The fee that was taken by the institution.

content.executeTransferResult.networkGasFee

object

The gas fee that was taken by the network. Depending on the integration, the network gas fee might be covered by the InstitutionTransferFee.

content.executeTransferResult.smartContract

object

Details of the allocated Smart Contract in case of 'Deposit' type transfers.

Preview transfer Get deposit address

curl --request POST \
  --url https://integration-api.getfront.com/api/v1/transfers/managed/execute \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "fromAuthToken": "Secret authentication token",
  "fromType": "robinhood",
  "previewId": "29b185b1-2305-40fb-a0e2-929d61451568"
}'

{
  "content": {
    "status": "succeeded",
    "executeTransferResult": {
      "transferId": "e332336c-de22-11ed-b5ea-0242ac120002",
      "status": "pending",
      "statusDetails": "In progress",
      "fromAddress": "0x9Bf6207f8A3f4278E0C989527015deFe10e5D7c6",
      "toAddress": "0x326a8825472bb0f4719998e708a1eeeb4473ed1b",
      "symbol": "USDT",
      "networkName": "Ethereum",
      "networkId": "e3c7fdd8-b1fc-4e51-85ae-bb276e075611",
      "hash": "0xdcfd72635a9b16d3bc0e75311f6fe0612970e9714a1e9e93de0ea5acffc6a454",
      "amount": 10,
      "amountInFiat": 10,
      "totalAmountInFiat": 11.1,
      "completedConfirmations": 1,
      "institutionTransferFee": {
        "fee": 0,
        "feeCurrency": "USDT",
        "feeInFiat": 0
      },
      "networkGasFee": {
        "fee": 1.1,
        "feeCurrency": "USDT",
        "feeInFiat": 1.1
      }
    }
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

Managed Account Authentication

Managed Transfers

Portfolio

Balance

Verify

Transactions

Self Managed Account Authentication

Transfers

Execute transfer

Authorizations

Body

Response