Type Alias ListTransfersResponse

Type Declaration

• OptionalapprovalId?: string

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

• OptionaldateBroadcasted?: string

• OptionaldateConfirmed?: string

• OptionaldatePolicyResolved?: string

• dateRequested: string

• OptionalexternalId?: string

  The external id provided at transfer creation time.

• Optionalfee?: string

  The fee paid for this transfer in minimum denomination.

• OptionalfeeSponsorId?: string

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

• id: string

  Transfer id.

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

  Additional metadata about the transfered asset.

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

    • Optionaldecimals?: number

      Number of decimals used by the asset, see this guide for more details.

    • Optionalquotes?: { [x: string]: number }

      Corresponding asset price in USD at the time of transfer.

    • Optionalsymbol?: string

    • Optionalverified?: boolean

      Whether the asset is verified by DFNS as legitimate.

• 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"

  The blockchain network this transfer is on.

• Optionalreason?: string

  The reason for a failed transfer.

• 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 }

  The user who initiated the request.

  • OptionaltokenId?: string

    Token id.

  • userId: string

    User id.

• status: "Pending" | "Executing" | "Broadcasted" | "Confirmed" | "Failed" | "Rejected"

  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.

• OptionaltxHash?: string

  The blockchain transaction hash for this transfer.

• walletId: string

  The source wallet for this tranfer.