Type Alias GetTransferResponse

type GetTransferResponse = {
    approvalId?: string;
    dateBroadcasted?: string;
    dateConfirmed?: string;
    datePolicyResolved?: string;
    dateRequested: string;
    externalId?: string;
    fee?: string;
    feeSponsorId?: string;
    id: string;
    metadata: {
        asset: {
            decimals?: number;
            quotes?: { [x: string]: number };
            symbol?: string;
            verified?: boolean;
        };
    };
    network: | "Algorand"
    | "AlgorandTestnet"
    | "Aptos"
    | "AptosTestnet"
    | "ArbitrumOne"
    | "ArbitrumGoerli"
    | "ArbitrumSepolia"
    | "AvalancheC"
    | "AvalancheCFuji"
    | "Adi"
    | "AdiTestnet"
    | "BabylonGenesis"
    | "BabylonTestnet5"
    | "Base"
    | "BaseGoerli"
    | "BaseSepolia"
    | "Berachain"
    | "BerachainBArtio"
    | "BerachainBepolia"
    | "Bitcoin"
    | "BitcoinSignet"
    | "BitcoinTestnet3"
    | "BitcoinCash"
    | "BitcoinCashTestnet"
    | "Bob"
    | "BobSepolia"
    | "Bsc"
    | "BscTestnet"
    | "Canton"
    | "CantonDevnet"
    | "CantonTestnet"
    | "Cardano"
    | "CardanoPreprod"
    | "Celo"
    | "CeloAlfajores"
    | "Codex"
    | "CodexSepolia"
    | "CosmosHub4"
    | "CosmosIcsTestnet"
    | "Dogecoin"
    | "DogecoinTestnet"
    | "Ethereum"
    | "EthereumGoerli"
    | "EthereumSepolia"
    | "EthereumHolesky"
    | "EthereumHoodi"
    | "FantomOpera"
    | "FantomTestnet"
    | "FlareC"
    | "FlareCCoston2"
    | "Hedera"
    | "HederaTestnet"
    | "Ink"
    | "InkSepolia"
    | "InternetComputer"
    | "Ion"
    | "IonTestnet"
    | "Iota"
    | "IotaTestnet"
    | "IotaZodianet"
    | "KadenaTestnet4"
    | "KadenaTestnet4:1"
    | "KadenaTestnet4:2"
    | "KadenaTestnet4:3"
    | "KadenaTestnet4:4"
    | "KadenaTestnet4:5"
    | "KadenaTestnet4:6"
    | "KadenaTestnet4:7"
    | "KadenaTestnet4:8"
    | "KadenaTestnet4:9"
    | "KadenaTestnet4:10"
    | "KadenaTestnet4:11"
    | "KadenaTestnet4:12"
    | "KadenaTestnet4:13"
    | "KadenaTestnet4:14"
    | "KadenaTestnet4:15"
    | "KadenaTestnet4:16"
    | "KadenaTestnet4:17"
    | "KadenaTestnet4:18"
    | "KadenaTestnet4:19"
    | "Kadena"
    | "Kadena:1"
    | "Kadena:2"
    | "Kadena:3"
    | "Kadena:4"
    | "Kadena:5"
    | "Kadena:6"
    | "Kadena:7"
    | "Kadena:8"
    | "Kadena:9"
    | "Kadena:10"
    | "Kadena:11"
    | "Kadena:12"
    | "Kadena:13"
    | "Kadena:14"
    | "Kadena:15"
    | "Kadena:16"
    | "Kadena:17"
    | "Kadena:18"
    | "Kadena:19"
    | "Kaspa"
    | "KaspaTestnet11"
    | "Kusama"
    | "Litecoin"
    | "LitecoinTestnet"
    | "Near"
    | "NearTestnet"
    | "Optimism"
    | "OptimismGoerli"
    | "OptimismSepolia"
    | "Origyn"
    | "Plume"
    | "PlumeSepolia"
    | "Polkadot"
    | "Polygon"
    | "PolygonAmoy"
    | "PolygonMumbai"
    | "Polymesh"
    | "PolymeshTestnet"
    | "Race"
    | "RaceSepolia"
    | "SeiAtlantic2"
    | "SeiPacific1"
    | "Solana"
    | "SolanaDevnet"
    | "Sonic"
    | "SonicTestnet"
    | "Stellar"
    | "StellarTestnet"
    | "Sui"
    | "SuiTestnet"
    | "Tsc"
    | "TscTestnet1"
    | "Tezos"
    | "TezosGhostnet"
    | "Ton"
    | "TonTestnet"
    | "Tron"
    | "TronNile"
    | "Westend"
    | "XrpLedger"
    | "XrpLedgerTestnet";
    reason?: string;
    requestBody: | {
        amount: string;
        createDestinationAccount?: boolean;
        expiresAt?: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Native";
        memo?: string;
        offer?: boolean;
        priority?: "Slow"
        | "Standard"
        | "Fast";
        targetChain?: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        assetId: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Asa";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Aip21";
        metadata: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        assetId: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Asset";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        coin: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Coin";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Erc20";
        priority?: "Slow"
        | "Standard"
        | "Fast";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Erc721";
        priority?: "Slow"
        | "Standard"
        | "Fast";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        externalId?: string;
        feeSponsorId?: string;
        kind: "Hip17";
        serialNumber: string;
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Hts";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        assetCode: string;
        externalId?: string;
        feeSponsorId?: string;
        issuer: string;
        kind: "Sep41";
        memo?: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        createDestinationAccount?: boolean;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Spl"
        | "Spl2022";
        mint: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Tep74";
        master: string;
        memo?: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Trc10";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Trc20";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Trc721";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    };
    requester: { tokenId?: string; userId: string };
    status:
        | "Pending"
        | "Executing"
        | "Broadcasted"
        | "Confirmed"
        | "Failed"
        | "Rejected";
    txHash?: string;
    walletId: string;
}

Index

Properties

approvalId? dateBroadcasted? dateConfirmed? datePolicyResolved? dateRequested externalId? fee? feeSponsorId? id metadata network reason? requestBody requester status txHash? walletId

Properties

`Optional`approvalId

approvalId?: string

`Optional`dateBroadcasted

dateBroadcasted?: string

`Optional`dateConfirmed

dateConfirmed?: string

`Optional`datePolicyResolved

datePolicyResolved?: string

dateRequested

dateRequested: string

`Optional`externalId

externalId?: string

`Optional`fee

fee?: string

`Optional`feeSponsorId

feeSponsorId?: string

id

id: string

metadata

metadata: {
    asset: {
        decimals?: number;
        quotes?: { [x: string]: number };
        symbol?: string;
        verified?: boolean;
    };
}

`Optional`reason

reason?: string

requestBody

requestBody:
    | {
        amount: string;
        createDestinationAccount?: boolean;
        expiresAt?: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Native";
        memo?: string;
        offer?: boolean;
        priority?: "Slow"
        | "Standard"
        | "Fast";
        targetChain?: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        assetId: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Asa";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Aip21";
        metadata: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        assetId: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Asset";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        coin: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Coin";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Erc20";
        priority?: "Slow"
        | "Standard"
        | "Fast";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Erc721";
        priority?: "Slow"
        | "Standard"
        | "Fast";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        externalId?: string;
        feeSponsorId?: string;
        kind: "Hip17";
        serialNumber: string;
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Hts";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        assetCode: string;
        externalId?: string;
        feeSponsorId?: string;
        issuer: string;
        kind: "Sep41";
        memo?: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        createDestinationAccount?: boolean;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Spl"
        | "Spl2022";
        mint: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Tep74";
        master: string;
        memo?: string;
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Trc10";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Trc20";
        to: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Trc721";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }

Type Declaration

{
    amount: string;
    createDestinationAccount?: boolean;
    expiresAt?: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Native";
    memo?: string;
    offer?: boolean;
    priority?: "Slow" | "Standard" | "Fast";
    targetChain?: string;
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of native tokens to transfer in minimum denomination.
- OptionalcreateDestinationAccount?: boolean
  Whether to create the destination account on chains that require account creation (e.g., Stellar, Kadena). Only valid for chains that require the receiver account to exist before transfer.
- OptionalexpiresAt?: string
  Optional field for Canton, especially useful in the context of offers
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Native"
- Optionalmemo?: string
  The memo or destination tag. Stellar, TON and XrpLedger support memo. Not valid for other networks.
- Optionaloffer?: boolean
  Optional field for Canton, if true it will create a transfer offer.
- Optionalpriority?: "Slow" | "Standard" | "Fast"
  The priority that determines the fees paid for the transfer. All EVM compatible networks and Bitcoin support priority. Not supported for other networks. It uses the estimate fees API to calculate the transfer fees. When not specified, defaults to Standard priority.
- OptionaltargetChain?: string
  For multi-chain networks (e.g., Kadena), specify the destination chain for cross-chain transfers.
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    assetId: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Asa";
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- assetId: string
  The token asset id.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Asa"
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Aip21";
    metadata: string;
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Aip21"
- metadata: string
  The asset metadata address.
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    assetId: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Asset";
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- assetId: string
  The token asset id.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Asset"
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    coin: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Coin";
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- coin: string
  The coin identifier.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Coin"
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    contract: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Erc20";
    priority?: "Slow" | "Standard" | "Fast";
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- contract: string
  The ERC-20 contract address.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Erc20"
- Optionalpriority?: "Slow" | "Standard" | "Fast"
  The priority that determines the fees paid for the transfer.
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    contract: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Erc721";
    priority?: "Slow" | "Standard" | "Fast";
    to: string;
    tokenId: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- contract: string
  The ERC-721 contract address.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Erc721"
- Optionalpriority?: "Slow" | "Standard" | "Fast"
  The priority that determines the fees paid for the transfer.
- to: string
  The destination address.
- tokenId: string
  The token to transfer.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    externalId?: string;
    feeSponsorId?: string;
    kind: "Hip17";
    serialNumber: string;
    to: string;
    tokenId: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Hip17"
- serialNumber: string
- to: string
  The destination address.
- tokenId: string
  The token to transfer.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Hts";
    to: string;
    tokenId: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Hts"
- to: string
  The destination address.
- tokenId: string
  The token to transfer.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    assetCode: string;
    externalId?: string;
    feeSponsorId?: string;
    issuer: string;
    kind: "Sep41";
    memo?: string;
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- assetCode: string
  The asset code.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- issuer: string
  The asset issuer address.
- kind: "Sep41"
- Optionalmemo?: string
  The memo or destination tag.
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    createDestinationAccount?: boolean;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Spl" | "Spl2022";
    mint: string;
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- OptionalcreateDestinationAccount?: boolean
  If true, pay to create the associated token account for the recipient if it doesn't exist. Defaults to false.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Spl" | "Spl2022"
- mint: string
  The mint account address.
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Tep74";
    master: string;
    memo?: string;
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Tep74"
- master: string
  The Jetton master contract address.
- Optionalmemo?: string
  The memo or destination tag.
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Trc10";
    to: string;
    tokenId: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Trc10"
- to: string
  The destination address.
- tokenId: string
  The token ID.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    amount: string;
    contract: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Trc20";
    to: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- amount: string
  The amount of tokens to transfer in minimum denomination.
- contract: string
  The smart contract address.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Trc20"
- to: string
  The destination address.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)
{
    contract: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Trc721";
    to: string;
    tokenId: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- contract: string
  The smart contract address.
- OptionalexternalId?: string
  A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more here)
- OptionalfeeSponsorId?: string
  Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more here)
- kind: "Trc721"
- to: string
  The destination address.
- tokenId: string
  The token to transfer.
- OptionaltravelRule?: {
      beneficiary: { [x: string]: any };
      beneficiaryProof?: { [x: string]: any };
      beneficiaryVASPdid?: string;
      kind: "Notabene";
      originator: { [x: string]: any };
  }
  A travel rule payload to associate with the transfer. (read more here)

requester

requester: { tokenId?: string; userId: string }

status

`Optional`txHash

txHash?: string

walletId

walletId: string

Type Alias GetTransferResponse

Index

Properties

Properties

OptionalapprovalId

OptionaldateBroadcasted

OptionaldateConfirmed

OptionaldatePolicyResolved

dateRequested

OptionalexternalId

Optionalfee

OptionalfeeSponsorId

id

metadata

network

Optionalreason

requestBody

Type Declaration

amount: string

OptionalcreateDestinationAccount?: boolean

OptionalexpiresAt?: string

OptionalexternalId?: string

OptionalfeeSponsorId?: string

kind: "Native"

Optionalmemo?: string

Optionaloffer?: boolean

Optionalpriority?: "Slow" | "Standard" | "Fast"

OptionaltargetChain?: string

to: string

OptionaltravelRule?: { beneficiary: { [x: string]: any }; beneficiaryProof?: { [x: string]: any }; beneficiaryVASPdid?: string; kind: "Notabene"; originator: { [x: string]: any };}

amount: string

assetId: string

OptionalexternalId?: string

OptionalfeeSponsorId?: string

kind: "Asa"

to: string

OptionaltravelRule?: { beneficiary: { [x: string]: any }; beneficiaryProof?: { [x: string]: any }; beneficiaryVASPdid?: string; kind: "Notabene"; originator: { [x: string]: any };}

amount: string

OptionalexternalId?: string

OptionalfeeSponsorId?: string

kind: "Aip21"

metadata: string

to: string

OptionaltravelRule?: { beneficiary: { [x: string]: any }; beneficiaryProof?: { [x: string]: any }; beneficiaryVASPdid?: string; kind: "Notabene"; originator: { [x: string]: any };}

amount: string

assetId: string

OptionalexternalId?: string

OptionalfeeSponsorId?: string

kind: "Asset"

to: string

OptionaltravelRule?: { beneficiary: { [x: string]: any }; beneficiaryProof?: { [x: string]: any }; beneficiaryVASPdid?: string; kind: "Notabene"; originator: { [x: string]: any };}

amount: string

coin: string

OptionalexternalId?: string

OptionalfeeSponsorId?: string

kind: "Coin"

to: string

OptionaltravelRule?: { beneficiary: { [x: string]: any }; beneficiaryProof?: { [x: string]: any }; beneficiaryVASPdid?: string; kind: "Notabene"; originator: { [x: string]: any };}

amount: string

contract: string

OptionalexternalId?: string

OptionalfeeSponsorId?: string

kind: "Erc20"

Optionalpriority?: "Slow" | "Standard" | "Fast"

to: string

OptionaltravelRule?: { beneficiary: { [x: string]: any }; beneficiaryProof?: { [x: string]: any }; beneficiaryVASPdid?: string; kind: "Notabene"; originator: { [x: string]: any };}

contract: string

OptionalexternalId?: string

OptionalfeeSponsorId?: string

kind: "Erc721"

Optionalpriority?: "Slow" | "Standard" | "Fast"

to: string

tokenId: string

OptionaltravelRule?: { beneficiary: { [x: string]: any }; beneficiaryProof?: { [x: string]: any }; beneficiaryVASPdid?: string; kind: "Notabene"; originator: { [x: string]: any };}

OptionalexternalId?: string

OptionalfeeSponsorId?: string

kind: "Hip17"

serialNumber: string

to: string

tokenId: string

`Optional`approvalId

`Optional`dateBroadcasted

`Optional`dateConfirmed

`Optional`datePolicyResolved

`Optional`externalId

`Optional`fee

`Optional`feeSponsorId

`Optional`reason

`Optional`createDestinationAccount?: boolean

`Optional`expiresAt?: string

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`memo?: string

`Optional`offer?: boolean

`Optional`priority?: "Slow" | "Standard" | "Fast"

`Optional`targetChain?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`priority?: "Slow" | "Standard" | "Fast"

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`priority?: "Slow" | "Standard" | "Fast"

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`memo?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`createDestinationAccount?: boolean

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`memo?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`externalId?: string

`Optional`feeSponsorId?: string

`Optional`travelRule?: {
beneficiary: { [x: string]: any };
beneficiaryProof?: { [x: string]: any };
beneficiaryVASPdid?: string;
kind: "Notabene";
originator: { [x: string]: any };
}

`Optional`txHash