Type Alias CreateInvoiceOptions

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

Options object type for Client.createInvoice method

Type declaration

  • amount: number | string

    Invoice amount

  • OptionalacceptedAssets?: CryptoCurrencyCode[]

    List of cryptocurrency alphabetic codes

  • Optionalasset?: CryptoCurrencyCode

    Invoice asset

  • OptionalcurrencyType?: Crypto | Fiat

    Currency type

  • Optionaldescription?: string

    Invoice description, displayed to user, up to 1024 symbols

  • OptionalexpiresIn?: number

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

  • Optionalfiat?: FiatCurrencyCode

    Invoice fiat

  • OptionalhiddenMessage?: string

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

  • OptionalisAllowAnonymous?: boolean

    Is can user pay invoice anonymously

  • OptionalisAllowComments?: boolean

    Is can user leave a comment for invoice

  • OptionalpaidBtnName?: PaidBtnName

    Text for button which will be shown when invoice was paid

  • OptionalpaidBtnUrl?: string

    Url for button which will be shown when invoice was paid

  • Optionalpayload?: 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

Settings

Member Visibility