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"
    | "ArcTestnet"
    | "AvalancheC"
    | "AvalancheCFuji"
    | "Adi"
    | "AdiTestnet"
    | "AdiTestnetAb"
    | "BabylonGenesis"
    | "BabylonTestnet5"
    | "Base"
    | "BaseGoerli"
    | "BaseSepolia"
    | "Berachain"
    | "BerachainBArtio"
    | "BerachainBepolia"
    | "Bitcoin"
    | "BitcoinSignet"
    | "BitcoinTestnet3"
    | "BitcoinCash"
    | "BitcoinCashTestnet"
    | "Bob"
    | "BobSepolia"
    | "Bsc"
    | "BscTestnet"
    | "Canton"
    | "CantonDevnet"
    | "CantonTestnet"
    | "Cardano"
    | "CardanoPreprod"
    | "Concordium"
    | "ConcordiumTestnet"
    | "Celo"
    | "CeloAlfajores"
    | "Codex"
    | "CodexSepolia"
    | "CosmosHub4"
    | "CosmosIcsTestnet"
    | "Dogecoin"
    | "DogecoinTestnet"
    | "Ethereum"
    | "EthereumClassic"
    | "EthereumClassicMordor"
    | "EthereumGoerli"
    | "EthereumSepolia"
    | "EthereumHolesky"
    | "EthereumHoodi"
    | "FantomOpera"
    | "FantomTestnet"
    | "FlareC"
    | "FlareCCoston2"
    | "FlowEvm"
    | "FlowEvmTestnet"
    | "Hedera"
    | "HederaTestnet"
    | "Ink"
    | "InkSepolia"
    | "InternetComputer"
    | "Ion"
    | "IonTestnet"
    | "Iota"
    | "IotaTestnet"
    | "IotaZodianet"
    | "Kaspa"
    | "KaspaTestnet11"
    | "Kusama"
    | "KusamaAssetHub"
    | "Litecoin"
    | "LitecoinTestnet"
    | "Near"
    | "NearTestnet"
    | "Optimism"
    | "OptimismGoerli"
    | "OptimismSepolia"
    | "Origyn"
    | "Plasma"
    | "PlasmaTestnet"
    | "Plume"
    | "PlumeSepolia"
    | "Paseo"
    | "PaseoAssetHub"
    | "Polkadot"
    | "PolkadotAssetHub"
    | "Polygon"
    | "PolygonAmoy"
    | "PolygonMumbai"
    | "Polymesh"
    | "PolymeshTestnet"
    | "Race"
    | "RaceSepolia"
    | "SeiAtlantic2"
    | "SeiPacific1"
    | "Solana"
    | "SolanaDevnet"
    | "Sonic"
    | "SonicTestnet"
    | "Starknet"
    | "StarknetSepolia"
    | "Stellar"
    | "StellarTestnet"
    | "Sui"
    | "SuiTestnet"
    | "Tezos"
    | "TezosGhostnet"
    | "Tempo"
    | "TempoAndantino"
    | "TempoModerato"
    | "Tsc"
    | "TscTestnet1"
    | "Ton"
    | "TonTestnet"
    | "Tron"
    | "TronNile"
    | "Westend"
    | "WestendAssetHub"
    | "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";
        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: "Asa";
        memo?: 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;
        externalId?: string;
        feeSponsorId?: string;
        instrumentAdmin: string;
        instrumentId: string;
        kind: "Cip56";
        offer?: boolean;
        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: "Cis2";
        to: string;
        tokenAddress: 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: "Cis7";
        memo?: string
        | "";
        to: string;
        tokenId: 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";
        memo?: string
        | "";
        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";
        memo?: string
        | "";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        currency: string;
        externalId?: string;
        feeSponsorId?: string;
        issuer: string;
        kind: "Iou";
        memo?: string
        | "";
        to: 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;
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Snip2";
        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: "Snip3";
        to: string;
        tokenId: 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";
        memo?: string | "";
        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 };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        issuanceId: string;
        kind: "Xls33";
        memo?: string
        | "";
        to: 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

The id of the approval request if this transfer triggered a policy.

`Optional`dateBroadcasted

dateBroadcasted?: string

`Optional`dateConfirmed

dateConfirmed?: string

`Optional`datePolicyResolved

datePolicyResolved?: string

dateRequested

dateRequested: string

`Optional`externalId

externalId?: string

The external id provided at transfer creation time.

`Optional`fee

fee?: string

The fee paid for this transfer in minimum denomination.

`Optional`feeSponsorId

feeSponsorId?: string

The fee sponsor id used to pay for the transfer fees.

id

id: string

Transfer id.

metadata

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

Additional metadata about the transfered asset.

The blockchain network this transfer is on.

`Optional`reason

reason?: string

The reason for a failed transfer.

requestBody

requestBody:
    | {
        amount: string;
        createDestinationAccount?: boolean;
        expiresAt?: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Native";
        memo?: string
        | "";
        offer?: boolean;
        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;
        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: "Asa";
        memo?: 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;
        externalId?: string;
        feeSponsorId?: string;
        instrumentAdmin: string;
        instrumentId: string;
        kind: "Cip56";
        offer?: boolean;
        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: "Cis2";
        to: string;
        tokenAddress: 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: "Cis7";
        memo?: string
        | "";
        to: string;
        tokenId: 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";
        memo?: string
        | "";
        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";
        memo?: string
        | "";
        to: string;
        tokenId: string;
        travelRule?: {
            beneficiary: { [x: string]: any };
            beneficiaryProof?: { [x: string]: any };
            beneficiaryVASPdid?: string;
            kind: "Notabene";
            originator: { [x: string]: any };
        };
    }
    | {
        amount: string;
        currency: string;
        externalId?: string;
        feeSponsorId?: string;
        issuer: string;
        kind: "Iou";
        memo?: string
        | "";
        to: 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;
        contract: string;
        externalId?: string;
        feeSponsorId?: string;
        kind: "Snip2";
        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: "Snip3";
        to: string;
        tokenId: 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";
        memo?: string | "";
        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 };
        };
    }
    | {
        amount: string;
        externalId?: string;
        feeSponsorId?: string;
        issuanceId: string;
        kind: "Xls33";
        memo?: string
        | "";
        to: 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";
    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). 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 (supported networks only).
- 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.
- 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: "Asa";
    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.
- 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"
- 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;
    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;
    externalId?: string;
    feeSponsorId?: string;
    instrumentAdmin: string;
    instrumentId: string;
    kind: "Cip56";
    offer?: boolean;
    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)
- instrumentAdmin: string
  The instrument admin address.
- instrumentId: string
  The instrument id.
- kind: "Cip56"
- Optionaloffer?: boolean
  If true it will create a transfer offer.
- 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: "Cis2";
    to: string;
    tokenAddress: 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: "Cis2"
- to: string
  The destination address.
- tokenAddress: string
  The token address following (https://proposals.concordium.com/CIS/cis-2.html#token-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: "Cis7";
    memo?: string | "";
    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: "Cis7"
- Optionalmemo?: string | ""
  The memo or destination tag.
- to: string
  The destination address.
- tokenId: string
  The Cis7 token identifier.
- 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";
    memo?: string | "";
    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"
- Optionalmemo?: string | ""
  The memo or destination tag.
- 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";
    memo?: string | "";
    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"
- Optionalmemo?: string | ""
  The memo.
- 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;
    currency: string;
    externalId?: string;
    feeSponsorId?: string;
    issuer: string;
    kind: "Iou";
    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.
- currency: string
  The IOU currency 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 IOU issuer address.
- kind: "Iou"
- 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;
    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;
    contract: string;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Snip2";
    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 SNIP-2 (ERC-20-like) 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: "Snip2"
- 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: "Snip3";
    to: string;
    tokenId: string;
    travelRule?: {
        beneficiary: { [x: string]: any };
        beneficiaryProof?: { [x: string]: any };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: { [x: string]: any };
    };
}
- contract: string
  The SNIP-3 (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: "Snip3"
- 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;
    createDestinationAccount?: boolean;
    externalId?: string;
    feeSponsorId?: string;
    kind: "Spl" | "Spl2022";
    memo?: string | "";
    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"
- Optionalmemo?: string | ""
  The memo or destination tag.
- 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)
{
    amount: string;
    externalId?: string;
    feeSponsorId?: string;
    issuanceId: string;
    kind: "Xls33";
    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)
- issuanceId: string
  The XLS-33 issuance identifier.
- kind: "Xls33"
- 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)

requester

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

The user who initiated the request.

Type Declaration

OptionaltokenId?: string
Token id.
userId: string
User id.

status

Transfer status.

Status	Definition
`Pending`	The request is pending approval due to a policy applied to the wallet.
`Executing`	The request is approved and is in the process of being executed. note this status is only set for a short time between pending and broadcasted.
`Broadcasted`	The transaction has been successfully written to the mempool.
`Confirmed`	The transaction has been confirmed on-chain by our indexing pipeline.
`Failed`	Indicates either system failure to complete the request or the transaction failed on chain.
`Rejected`	The request has been rejected by a policy approval action.

`Optional`txHash

txHash?: string

The blockchain transaction hash for this transfer.

walletId

walletId: string

The source wallet for this tranfer.

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"

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: "Asa"

Optionalmemo?: 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

OptionalexternalId?: string

OptionalfeeSponsorId?: string

instrumentAdmin: string

instrumentId: string

kind: "Cip56"

Optionaloffer?: boolean

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: "Cis2"

to: string

tokenAddress: 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: "Cis7"

Optionalmemo?: string | ""

to: string

tokenId: 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"

`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`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`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`offer?: boolean

`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`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`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`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`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`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`createDestinationAccount?: boolean

`Optional`externalId?: string

`Optional`feeSponsorId?: string