Type Alias TransferAssetBody

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)