Get transfer details

POST

api

transfers

details

curl --request POST \
  --url https://integration-api.getfront.com/api/v1/transfers/details \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "transactionId": "63F1A6B6-BF45-4E51-A624-EC52B5680D48",
  "authToken": "Secret authentication token",
  "type": "robinhood"
}'

{
  "content": {
    "id": "8E25ACB5-A9E2-4D00-8772-A255F010A2A9",
    "status": "succeeded",
    "type": "deposit",
    "fromAddress": "D5PumQwt...",
    "targetAddress": "D641Fmzx...",
    "symbol": "DOGE",
    "hash": "3310c6202aaeb44754a118ce11f255382d012060ade0d6d9f...",
    "amount": 15,
    "transactionAmount": 10,
    "createdTimestamp": 1653215600,
    "updatedTimestamp": 1653215600,
    "networkTransactionFee": {
      "amount": 5,
      "symbol": "DOGE"
    },
    "confirmations": 17,
    "blockchainMethod": "transfer"
  },
  "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

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 CoinbasePro CryptoCom Binance Gemini OkCoin KuCoin BinanceInternational Bitstamp GateIo Okx Huobi Bitfinex KrakenDirect BinanceInternationalDirect Bybit Paxos CoinbasePrime 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

addressType

enum<string>

Type of the address of the transferred asset. Can be used instead of the Symbol field.

Available options:

ethAddress,

btcAddress,

ltcAddress,

solAddress,

algoAddress,

celoAddress,

cardanoAddress,

polygonAddress,

bnbAddress,

elrondAddress,

neoAddress,

xrpAddress,

flowAddress,

harmonyOneAddress,

tronAddress,

dogeAddress,

opAddress

transactionId

string | null

Transaction Id by the financial institution

transactionHash

string | null

Hash of the transaction on the blockchain

symbol

string | null

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

Response

200

application/json

Transfer details obtained.

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.id

string | null

Identifier of the transfer, if provided by the financial institution

content.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

content.statusDetails

string | null

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

content.type

enum<string>

The direction of the transaction

Available options:

unknown,

deposit,

withdrawal

content.fromAddress

string | null

Address where the transaction was sent from

content.targetAddress

string | null

Address where the transaction was sent to

content.symbol

string | null

Ticker of the transaction

content.chain

string | null

Crypto Chain the transaction belongs to

content.memo

string | null

Memo of the transaction (also called "Tag")

content.hash

string | null

Hash of the transaction

content.amount

number

Full amount affected the balance, typically transaction amount plus fee

content.transactionAmount

number | null

Transaction amount

content.createdTimestamp

integer

Unix timestamp in seconds indicating when the transaction was created

content.updatedTimestamp

integer

Unix timestamp in seconds indicating when the transaction was last updated

content.networkTransactionFee

object

Fee taken by the network

content.transferFee

number | null

Fee taken by the financial institution

content.confirmations

integer | null

Number of confirmations on the blockchain

content.blockchainMethodName

string | null

Name of the executed blockchain function based on decoded input data

content.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

Get transfer history Initiate a transfer

curl --request POST \
  --url https://integration-api.getfront.com/api/v1/transfers/details \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "transactionId": "63F1A6B6-BF45-4E51-A624-EC52B5680D48",
  "authToken": "Secret authentication token",
  "type": "robinhood"
}'

{
  "content": {
    "id": "8E25ACB5-A9E2-4D00-8772-A255F010A2A9",
    "status": "succeeded",
    "type": "deposit",
    "fromAddress": "D5PumQwt...",
    "targetAddress": "D641Fmzx...",
    "symbol": "DOGE",
    "hash": "3310c6202aaeb44754a118ce11f255382d012060ade0d6d9f...",
    "amount": 15,
    "transactionAmount": 10,
    "createdTimestamp": 1653215600,
    "updatedTimestamp": 1653215600,
    "networkTransactionFee": {
      "amount": 5,
      "symbol": "DOGE"
    },
    "confirmations": 17,
    "blockchainMethod": "transfer"
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

Managed Account Authentication

Managed Transfers

Portfolio

Balance

Verify

Transactions

Self Managed Account Authentication

Transfers

Get transfer details

Authorizations

Body

Supported integrations:

Response