Type alias TransferAssetBody

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

Type declaration

  • amount: string
  • Optional createDestinationAccount?: boolean
  • Optional expiresAt?: string

    Optional field for Canton, especially useful in the context of offers

  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Native"
  • Optional memo?: string
  • Optional offer?: boolean

    Optional field for Canton, if true it will create a transfer offer

  • Optional priority?: "Slow" | "Standard" | "Fast"
  • Optional targetChain?: string
  • to: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • amount: string
  • assetId: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

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

Type declaration

  • amount: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Aip21"
  • metadata: string
  • to: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • amount: string
  • assetId: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

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

Type declaration

  • amount: string
  • coin: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

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

Type declaration

  • amount: string
  • contract: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Erc20"
  • Optional priority?: "Slow" | "Standard" | "Fast"
  • to: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • contract: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Erc721"
  • Optional priority?: "Slow" | "Standard" | "Fast"
  • to: string
  • tokenId: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Hip17"
  • serialNumber: string
  • to: string
  • tokenId: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • amount: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Hts"
  • to: string
  • tokenId: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • amount: string
  • assetCode: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • issuer: string
  • kind: "Sep41"
  • Optional memo?: string
  • to: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • amount: string
  • Optional createDestinationAccount?: boolean
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Spl" | "Spl2022"
  • mint: string
  • to: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • amount: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Tep74"
  • master: string
  • Optional memo?: string
  • to: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • amount: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Trc10"
  • to: string
  • tokenId: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Type declaration

  • amount: string
  • contract: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

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

Type declaration

  • contract: string
  • Optional externalId?: string
  • Optional feeSponsorId?: string

    Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains

  • kind: "Trc721"
  • to: string
  • tokenId: string
  • Optional travelRule?: {
        beneficiary: {
            [x: string]: any;
        };
        beneficiaryProof?: {
            [x: string]: any;
        };
        beneficiaryVASPdid?: string;
        kind: "Notabene";
        originator: {
            [x: string]: any;
        };
    }
    • beneficiary: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryProof?: {
          [x: string]: any;
      }
      • [x: string]: any
    • Optional beneficiaryVASPdid?: string
    • kind: "Notabene"
    • originator: {
          [x: string]: any;
      }
      • [x: string]: any

Settings

Member Visibility

Theme

Generated using TypeDoc