Type Alias TransferOptions

TransferOptions: {
    amount: number | string;
    asset: CryptoCurrencyCode;
    spendId: string;
    userId: number;
    comment?: string;
    disableSendNotification?: boolean;
}

Options object type for Client.transfer method

Type declaration

  • amount: number | string

    Transfer amount

  • asset: CryptoCurrencyCode

    Transfer asset

  • spendId: string

    Random UTF-8 string unique per transfer for idempotent requests. The same spend_id can be accepted only once from your app. Up to 64 symbols.

  • userId: number

    User ID in Telegram

  • Optionalcomment?: string

    Comment for the transfer. Users will see this comment in the notification about the transfer

  • OptionaldisableSendNotification?: boolean

    Pass true to not send to the user the notification about the transfer

Settings

Member Visibility