Crypto Bot API
    Preparing search index...

    Type Alias CreateInvoiceOptions

    Options object type for Client.createInvoice method

    type CreateInvoiceOptions = {
        amount: number | string;
        acceptedAssets?: CryptoCurrencyCode[];
        asset?: CryptoCurrencyCode;
        currencyType?: Crypto | Fiat;
        description?: string;
        expiresIn?: number;
        fiat?: FiatCurrencyCode;
        hiddenMessage?: string;
        isAllowAnonymous?: boolean;
        isAllowComments?: boolean;
        paidBtnName?: PaidBtnName;
        paidBtnUrl?: string;
        payload?: any;
        swapTo?: SwappableTargetCurrencies;
    }
    Index

    Properties

    amount acceptedAssets? asset? currencyType? description? expiresIn? fiat? hiddenMessage? isAllowAnonymous? isAllowComments? paidBtnName? paidBtnUrl? payload? swapTo?

    Properties

    amount: number | string

    Invoice amount

    acceptedAssets?: CryptoCurrencyCode[]

    List of cryptocurrency alphabetic codes

    asset?: CryptoCurrencyCode

    Invoice asset

    currencyType?: Crypto | Fiat

    Currency type

    description?: string

    Invoice description, displayed to user, up to 1024 symbols

    expiresIn?: number

    You can set a payment time limit for the invoice in seconds

    fiat?: FiatCurrencyCode

    Invoice fiat

    hiddenMessage?: string

    Text of the message which will be presented to a user after the invoice is paid

    isAllowAnonymous?: boolean

    Is can user pay invoice anonymously

    isAllowComments?: boolean

    Is can user leave a comment for invoice

    paidBtnName?: PaidBtnName

    Text for button which will be shown when invoice was paid

    paidBtnUrl?: string

    Url for button which will be shown when invoice was paid

    payload?: any

    Invoice payload, visible only for app, if it not string, JSON.stringify using for preparing to backend API parameters, may be up to 4096 symbols after preparing

    swapTo?: SwappableTargetCurrencies

    Asset that will be attempted to be swapped into after the user makes a payment

    Settings

    Member Visibility

    On This Page

    Properties